View Source WeChat.Refresher.DefaultSettings (wechat v0.18.0)

刷新 AccessToken 的方法

Summary

Types

expires_in()
key_name()
refresh_fun()
refresh_fun_result()
refresh_option()
refresh_options()
token()
token_list()

Functions

component_refresh_options(client)

输出[第三方平台]的 refresh_options

get_refresh_options_by_client(client)

根据不同的 client 的 app_type & by_component? 输出不同的 refresh_options

mini_program_refresh_options(client)

输出[小程序]的 refresh_options

official_account_refresh_options(client)

输出[公众号]的 refresh_options

refresh_access_token(client)
refresh_authorizer_access_token(client)
refresh_component_access_token(client)
refresh_mini_program_access_token(client)
refresh_ticket(ticket_type, client)
refresh_work_access_token(client, cache_id, agent_id)
refresh_work_jsapi_ticket(client, cache_id, agent_id, store_key, is_agent)
work_refresh_options(client)

输出[企业微信]的 refresh_options

work_refresh_options(client, agent)

Types

expires_in()

@type expires_in() :: non_neg_integer()

key_name()

@type key_name() :: atom()

refresh_fun()

@type refresh_fun() :: (WeChat.client() -> refresh_fun_result())

refresh_fun_result()

@type refresh_fun_result() ::
  {:ok, token(), expires_in()}
  | {:ok, token_list(), expires_in()}
  | {:error, any()}

refresh_option()

@type refresh_option() ::
  {WeChat.Storage.Adapter.store_id(), key_name(), refresh_fun()}

refresh_options()

@type refresh_options() :: [refresh_option()]

token()

@type token() :: String.t()

token_list()

@type token_list() :: [{key_name(), token(), expires_in()}]

Functions

component_refresh_options(client)

@spec component_refresh_options(WeChat.client()) :: refresh_options()

输出[第三方平台]的 refresh_options

刷新如下 AccessToken：

  • component_access_token
  • AuthorizerRefreshOptions (get by client.app_type())

get_refresh_options_by_client(client)

@spec get_refresh_options_by_client(WeChat.client()) :: refresh_options()

根据不同的 client 的 app_type & by_component? 输出不同的 refresh_options

rules:

mini_program_refresh_options(client)

@spec mini_program_refresh_options(WeChat.Work.client()) :: refresh_options()

输出[小程序]的 refresh_options

刷新如下 AccessToken：

  • access_token

official_account_refresh_options(client)

@spec official_account_refresh_options(WeChat.client()) :: refresh_options()

输出[公众号]的 refresh_options

刷新如下 AccessToken：

  • access_token
  • js_api_ticket
  • wx_card_ticket

refresh_access_token(client)

@spec refresh_access_token(WeChat.client()) :: refresh_fun_result()

refresh_authorizer_access_token(client)

@spec refresh_authorizer_access_token(WeChat.client()) :: refresh_fun_result()

refresh_component_access_token(client)

@spec refresh_component_access_token(WeChat.client()) :: refresh_fun_result()

refresh_mini_program_access_token(client)

@spec refresh_mini_program_access_token(WeChat.client()) :: refresh_fun_result()

refresh_ticket(ticket_type, client)

@spec refresh_ticket(WeChat.WebPage.js_api_ticket_type(), WeChat.client()) ::
  refresh_fun_result()

refresh_work_access_token(client, cache_id, agent_id)

@spec refresh_work_access_token(
  WeChat.Work.client(),
  WeChat.Storage.Cache.cache_id(),
  WeChat.Work.agent_id()
) :: refresh_fun_result()

refresh_work_jsapi_ticket(client, cache_id, agent_id, store_key, is_agent)

@spec refresh_work_jsapi_ticket(
  WeChat.Work.client(),
  WeChat.Storage.Cache.cache_id(),
  WeChat.Work.agent_id(),
  WeChat.Storage.Cache.cache_sub_key(),
  is_agent :: boolean()
) :: refresh_fun_result()

work_refresh_options(client)

@spec work_refresh_options(WeChat.client()) :: refresh_options()

输出[企业微信]的 refresh_options

刷新如下 AccessToken：

  • access_token

work_refresh_options(client, agent)

@spec work_refresh_options(WeChat.client(), WeChat.Work.Agent.t()) ::
  refresh_options()