me.chanjar.weixin.open.api

接口 WxOpenMaEmbeddedService

所有已知实现类:

WxOpenMaEmbeddedServiceImpl

public interface WxOpenMaEmbeddedService

半屏小程序管理服务

   半屏小程序管理
 

版本:

1.0.0

作者:

Yuan

字段概要

字段

限定符和类型	字段和说明
static String	API_ADD_EMBEDDED 添加半屏小程序 本接口用于添加半屏小程序
static String	API_DELETE_AUTHORIZED_EMBEDDED 取消授权小程序 调用本接口可以取消已经授权的小程序 说明：可通过get_own_list接口获取当前半屏小程序已经授权的小程序列表，可通过当前接口取消对某个小程序的调用权限
static String	API_DELETE_EMBEDDED 删除半屏小程序 用本接口可以删除已经获得授权调用的半屏小程序 说明：通过add_embedded接口添加半屏小程序后，可通过当前接口删除已经添加到半屏小程序列表的小程序
static String	API_GET_EMBEDDED_LIST 获取半屏小程序调用列表 调用本接口可以获取半屏小程序调用列表 说明：通过addEmbedded接口添加半屏小程序后，可通过当前接口获取半屏小程序调用列表
static String	API_GET_OWN_LIST 获取半屏小程序授权列表 调用本接口可以获取半屏小程序授权列表 说明：一个半屏小程序可授权给1000个小程序调用，通过该接口可获取已经授权的小程序列表
static String	API_SET_AUTHORIZED_EMBEDDED 设置授权方式

方法概要

限定符和类型	方法和说明
void	addEmbedded(String embeddedAppId, String applyReason) 添加半屏小程序
void	deleteAuthorizedEmbedded(String embeddedAppId) 取消授权小程序
void	deleteEmbedded(String embeddedAppId) 删除半屏小程序
WxOpenMaEmbeddedListResult	getEmbeddedList() 获取半屏小程序调用列表
WxOpenMaEmbeddedListResult	getOwnList() 获取半屏小程序授权列表,默认分页起始值为0，一次拉取最大值为1000
WxOpenMaEmbeddedListResult	getOwnList(Integer start, Integer num) 获取半屏小程序授权列表
void	setAuthorizedEmbedded(Integer flag) 设置授权方式

字段详细资料

API_ADD_EMBEDDED

static final String API_ADD_EMBEDDED

添加半屏小程序

     本接口用于添加半屏小程序
 

另请参阅:

常量字段值

API_DELETE_EMBEDDED

static final String API_DELETE_EMBEDDED

删除半屏小程序

     用本接口可以删除已经获得授权调用的半屏小程序
     说明：通过add_embedded接口添加半屏小程序后，可通过当前接口删除已经添加到半屏小程序列表的小程序
 

另请参阅:

常量字段值

API_GET_EMBEDDED_LIST

static final String API_GET_EMBEDDED_LIST

获取半屏小程序调用列表

     调用本接口可以获取半屏小程序调用列表
     说明：通过addEmbedded接口添加半屏小程序后，可通过当前接口获取半屏小程序调用列表
 

另请参阅:

常量字段值

API_DELETE_AUTHORIZED_EMBEDDED

static final String API_DELETE_AUTHORIZED_EMBEDDED

取消授权小程序

     调用本接口可以取消已经授权的小程序
     说明：可通过get_own_list接口获取当前半屏小程序已经授权的小程序列表，可通过当前接口取消对某个小程序的调用权限
 

另请参阅:

常量字段值

API_GET_OWN_LIST

static final String API_GET_OWN_LIST

获取半屏小程序授权列表

     调用本接口可以获取半屏小程序授权列表
     说明：一个半屏小程序可授权给1000个小程序调用，通过该接口可获取已经授权的小程序列表
 

另请参阅:

常量字段值

API_SET_AUTHORIZED_EMBEDDED

static final String API_SET_AUTHORIZED_EMBEDDED

设置授权方式

另请参阅:

常量字段值

方法详细资料

addEmbedded

void addEmbedded(String embeddedAppId,
                 String applyReason)
          throws WxErrorException

添加半屏小程序

参数:

embeddedAppId - 半屏小程序appId

applyReason - 申请理由

抛出:

WxErrorException

deleteEmbedded

void deleteEmbedded(String embeddedAppId)
             throws WxErrorException

删除半屏小程序

参数:

embeddedAppId - 半屏小程序appId

抛出:

WxErrorException

getEmbeddedList

WxOpenMaEmbeddedListResult getEmbeddedList()
                                    throws WxErrorException

获取半屏小程序调用列表

返回:

WxOpenMaEmbeddedListResult

抛出:

WxErrorException

deleteAuthorizedEmbedded

void deleteAuthorizedEmbedded(String embeddedAppId)
                       throws WxErrorException

取消授权小程序

参数:

embeddedAppId - 半屏小程序appId

抛出:

WxErrorException

getOwnList

WxOpenMaEmbeddedListResult getOwnList()
                               throws WxErrorException

获取半屏小程序授权列表,默认分页起始值为0，一次拉取最大值为1000

返回:

WxOpenMaEmbeddedListResult

抛出:

WxErrorException

getOwnList

WxOpenMaEmbeddedListResult getOwnList(Integer start,
                                      Integer num)
                               throws WxErrorException

获取半屏小程序授权列表

参数:

start - 分页起始值 ，默认值为0

num - 一次拉取最大值，最大 1000，默认值为10

返回:

WxOpenMaEmbeddedListResult

抛出:

WxErrorException

setAuthorizedEmbedded

void setAuthorizedEmbedded(Integer flag)
                    throws WxErrorException

设置授权方式

参数:

flag - 半屏小程序授权方式。0表示需要管理员验证；1表示自动通过；2表示自动拒绝。

抛出:

WxErrorException