me.chanjar.weixin.open.api

接口 WxOpenComponentService

所有已知实现类:

WxOpenComponentServiceImpl

public interface WxOpenComponentService

作者:

007

字段概要

字段

限定符和类型	字段和说明
static String	ADD_TO_TEMPLATE_URL
static String	API_AUTHORIZER_TOKEN_URL
static String	API_COMPONENT_TOKEN_URL
static String	API_CREATE_PREAUTHCODE_URL
static String	API_GET_AUTHORIZER_INFO_URL
static String	API_GET_AUTHORIZER_OPTION_URL
static String	API_QUERY_AUTH_URL
static String	API_SET_AUTHORIZER_OPTION_URL
static String	COMPONENT_LOGIN_PAGE_URL
static String	COMPONENT_MOBILE_LOGIN_PAGE_URL 手机端打开授权链接
static String	CONNECT_OAUTH2_AUTHORIZE_URL
static String	DELETE_TEMPLATE_URL
static String	GET_TEMPLATE_DRAFT_LIST_URL 代小程序实现业务 小程序代码模版库管理：https://open.weixin.qq.com/cgi-bin/showdocument?
static String	GET_TEMPLATE_LIST_URL
static String	MINIAPP_JSCODE_2_SESSION
static String	OAUTH2_ACCESS_TOKEN_URL 用code换取oauth2的access token
static String	OAUTH2_REFRESH_TOKEN_URL 刷新oauth2的access token

方法概要

限定符和类型	方法和说明
void	addToTemplate(long draftId) 将草稿箱的草稿选为小程序代码模版
boolean	checkSignature(String timestamp, String nonce, String signature)
boolean	checkSignature(String appId, String timestamp, String nonce, String signature)
void	deleteTemplate(long templateId) 删除指定小程序代码模版
String	getAuthorizerAccessToken(String appid, boolean forceRefresh)
WxOpenAuthorizerInfoResult	getAuthorizerInfo(String authorizerAppid) 获取授权方的帐号基本信息
WxOpenAuthorizerOptionResult	getAuthorizerOption(String authorizerAppid, String optionName) 获取授权方的选项设置信息
String	getComponentAccessToken(boolean forceRefresh)
String	getMobilePreAuthUrl(String redirectURI) 获取预授权链接（手机端预授权）
String	getMobilePreAuthUrl(String redirectURI, String authType, String bizAppid) 获取预授权链接（手机端预授权）
String	getPreAuthUrl(String redirectURI) 获取用户授权页URL（来路URL和成功跳转URL 的域名都需要为三方平台设置的 登录授权的发起页域名）
String	getPreAuthUrl(String redirectURI, String authType, String bizAppid) authType 要授权的帐号类型：1则商户点击链接后，手机端仅展示公众号、2表示仅展示小程序，3表示公众号和小程序都展示。
WxOpenQueryAuthResult	getQueryAuth(String authorizationCode) 使用授权码换取公众号或小程序的接口调用凭据和授权信息
List<WxOpenMaCodeTemplate>	getTemplateDraftList() 获取草稿箱内的所有临时代码草稿
List<WxOpenMaCodeTemplate>	getTemplateList() 获取代码模版库中的所有小程序代码模版
WxOpenMaService	getWxMaServiceByAppid(String appid) 获取指定appid的开放平台小程序服务（继承一般小程序服务能力）
WxMpService	getWxMpServiceByAppid(String appid)
WxOpenConfigStorage	getWxOpenConfigStorage()
WxMaJscode2SessionResult	miniappJscode2Session(String appId, String jsCode)
String	oauth2buildAuthorizationUrl(String appid, String redirectURI, String scope, String state)
WxMpOAuth2AccessToken	oauth2getAccessToken(String appid, String code)
WxMpOAuth2AccessToken	oauth2refreshAccessToken(String appid, String refreshToken)
String	route(WxOpenXmlMessage wxMessage)
void	setAuthorizerOption(String authorizerAppid, String optionName, String optionValue) 设置授权方的选项信息

字段详细资料

API_COMPONENT_TOKEN_URL

static final String API_COMPONENT_TOKEN_URL

另请参阅:

常量字段值

API_CREATE_PREAUTHCODE_URL

static final String API_CREATE_PREAUTHCODE_URL

另请参阅:

常量字段值

API_QUERY_AUTH_URL

static final String API_QUERY_AUTH_URL

另请参阅:

常量字段值

API_AUTHORIZER_TOKEN_URL

static final String API_AUTHORIZER_TOKEN_URL

另请参阅:

常量字段值

API_GET_AUTHORIZER_INFO_URL

static final String API_GET_AUTHORIZER_INFO_URL

另请参阅:

常量字段值

API_GET_AUTHORIZER_OPTION_URL

static final String API_GET_AUTHORIZER_OPTION_URL

另请参阅:

常量字段值

API_SET_AUTHORIZER_OPTION_URL

static final String API_SET_AUTHORIZER_OPTION_URL

另请参阅:

常量字段值

COMPONENT_LOGIN_PAGE_URL

static final String COMPONENT_LOGIN_PAGE_URL

另请参阅:

常量字段值

COMPONENT_MOBILE_LOGIN_PAGE_URL

static final String COMPONENT_MOBILE_LOGIN_PAGE_URL

手机端打开授权链接

另请参阅:

常量字段值

CONNECT_OAUTH2_AUTHORIZE_URL

static final String CONNECT_OAUTH2_AUTHORIZE_URL

另请参阅:

常量字段值

OAUTH2_ACCESS_TOKEN_URL

static final String OAUTH2_ACCESS_TOKEN_URL

用code换取oauth2的access token

另请参阅:

常量字段值

OAUTH2_REFRESH_TOKEN_URL

static final String OAUTH2_REFRESH_TOKEN_URL

刷新oauth2的access token

另请参阅:

常量字段值

MINIAPP_JSCODE_2_SESSION

static final String MINIAPP_JSCODE_2_SESSION

另请参阅:

常量字段值

GET_TEMPLATE_DRAFT_LIST_URL

static final String GET_TEMPLATE_DRAFT_LIST_URL

代小程序实现业务

小程序代码模版库管理：https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1506504150_nMMh6&token=&lang=zh_CN access_token 为 component_access_token

另请参阅:

常量字段值

GET_TEMPLATE_LIST_URL

static final String GET_TEMPLATE_LIST_URL

另请参阅:

常量字段值

ADD_TO_TEMPLATE_URL

static final String ADD_TO_TEMPLATE_URL

另请参阅:

常量字段值

DELETE_TEMPLATE_URL

static final String DELETE_TEMPLATE_URL

另请参阅:

常量字段值

方法详细资料

getWxMpServiceByAppid

WxMpService getWxMpServiceByAppid(String appid)

getWxMaServiceByAppid

WxOpenMaService getWxMaServiceByAppid(String appid)

获取指定appid的开放平台小程序服务（继承一般小程序服务能力）

参数:

appid -

返回:

getWxOpenConfigStorage

WxOpenConfigStorage getWxOpenConfigStorage()

checkSignature

boolean checkSignature(String timestamp,
                       String nonce,
                       String signature)

getComponentAccessToken

String getComponentAccessToken(boolean forceRefresh)
                        throws WxErrorException

抛出:

WxErrorException

getPreAuthUrl

String getPreAuthUrl(String redirectURI)
              throws WxErrorException

获取用户授权页URL（来路URL和成功跳转URL 的域名都需要为三方平台设置的 登录授权的发起页域名）

抛出:

WxErrorException

getPreAuthUrl

String getPreAuthUrl(String redirectURI,
                     String authType,
                     String bizAppid)
              throws WxErrorException

authType 要授权的帐号类型：1则商户点击链接后，手机端仅展示公众号、2表示仅展示小程序，3表示公众号和小程序都展示。如果为未指定，则默认小程序和公众号都展示。第三方平台开发者可以使用本字段来控制授权的帐号类型。 bizAppid 指定授权唯一的小程序或公众号 注：auth_type、biz_appid两个字段互斥。

抛出:

WxErrorException

getMobilePreAuthUrl

String getMobilePreAuthUrl(String redirectURI)
                    throws WxErrorException

获取预授权链接（手机端预授权）

参数:

redirectURI -

返回:

抛出:

WxErrorException

getMobilePreAuthUrl

String getMobilePreAuthUrl(String redirectURI,
                           String authType,
                           String bizAppid)
                    throws WxErrorException

获取预授权链接（手机端预授权）

参数:

redirectURI -

authType -

bizAppid -

返回:

抛出:

WxErrorException

route

String route(WxOpenXmlMessage wxMessage)
      throws WxErrorException

抛出:

WxErrorException

getQueryAuth

WxOpenQueryAuthResult getQueryAuth(String authorizationCode)
                            throws WxErrorException

使用授权码换取公众号或小程序的接口调用凭据和授权信息

抛出:

WxErrorException

getAuthorizerInfo

WxOpenAuthorizerInfoResult getAuthorizerInfo(String authorizerAppid)
                                      throws WxErrorException

获取授权方的帐号基本信息

抛出:

WxErrorException

getAuthorizerOption

WxOpenAuthorizerOptionResult getAuthorizerOption(String authorizerAppid,
                                                 String optionName)
                                          throws WxErrorException

获取授权方的选项设置信息

抛出:

WxErrorException

setAuthorizerOption

void setAuthorizerOption(String authorizerAppid,
                         String optionName,
                         String optionValue)
                  throws WxErrorException

设置授权方的选项信息

抛出:

WxErrorException

getAuthorizerAccessToken

String getAuthorizerAccessToken(String appid,
                                boolean forceRefresh)
                         throws WxErrorException

抛出:

WxErrorException

oauth2getAccessToken

WxMpOAuth2AccessToken oauth2getAccessToken(String appid,
                                           String code)
                                    throws WxErrorException

抛出:

WxErrorException

checkSignature

boolean checkSignature(String appId,
                       String timestamp,
                       String nonce,
                       String signature)

oauth2refreshAccessToken

WxMpOAuth2AccessToken oauth2refreshAccessToken(String appid,
                                               String refreshToken)
                                        throws WxErrorException

抛出:

WxErrorException

oauth2buildAuthorizationUrl

String oauth2buildAuthorizationUrl(String appid,
                                   String redirectURI,
                                   String scope,
                                   String state)

miniappJscode2Session

WxMaJscode2SessionResult miniappJscode2Session(String appId,
                                               String jsCode)
                                        throws WxErrorException

抛出:

WxErrorException

getTemplateDraftList

List<WxOpenMaCodeTemplate> getTemplateDraftList()
                                         throws WxErrorException

获取草稿箱内的所有临时代码草稿

返回:

草稿箱代码模板列表（draftId）

抛出:

WxErrorException - 获取失败时返回，具体错误码请看此接口的注释文档

getTemplateList

List<WxOpenMaCodeTemplate> getTemplateList()
                                    throws WxErrorException

获取代码模版库中的所有小程序代码模版

返回:

小程序代码模版列表（templateId）

抛出:

WxErrorException - 获取失败时返回，具体错误码请看此接口的注释文档

addToTemplate

void addToTemplate(long draftId)
            throws WxErrorException

将草稿箱的草稿选为小程序代码模版

参数:

draftId - 草稿ID，本字段可通过“获取草稿箱内的所有临时代码草稿”接口获得

抛出:

WxErrorException - 操作失败时抛出，具体错误码请看此接口的注释文档

另请参阅:

getTemplateDraftList()

deleteTemplate

void deleteTemplate(long templateId)
             throws WxErrorException

删除指定小程序代码模版

参数:

templateId - 要删除的模版ID

抛出:

WxErrorException - 操作失败时抛出，具体错误码请看此接口的注释文档

另请参阅:

getTemplateList()