cn.felord.reactive.api

Interface InternalAgentManagerApi

interface InternalAgentManagerApi

应用配置管理.

Since:

1.0.0

Author:

felord.cn

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<WeComResponse>	createMenu(String agentId, AgentMenuBtns request) 创建菜单
io.reactivex.rxjava3.core.Single<WeComResponse>	deleteMenu(String agentId) 删除菜单
io.reactivex.rxjava3.core.Single<AgentDetailsResponse>	getAgentDetails(String agentId) 获取应用详情
io.reactivex.rxjava3.core.Single<GenericResponse<List<AgentMenuBtn>>>	getMenu(String agentId) 获取菜单
io.reactivex.rxjava3.core.Single<WorkbenchDetailResponse>	getWorkbenchTemplate(Map<String,String> agentId) 获取应用在工作台展示的模版
io.reactivex.rxjava3.core.Single<WeComResponse>	settings(AgentManagerApi.Settings settings) 设置应用
io.reactivex.rxjava3.core.Single<WeComResponse>	setWorkbenchData(UserWorkbenchTemplate template) 设置应用在用户工作台展示的数据
io.reactivex.rxjava3.core.Single<WeComResponse>	setWorkbenchTemplate(WorkbenchTemplate template) 设置应用在工作台展示的模版

Method Detail

getAgentDetails

@GET(value="agent/get")
io.reactivex.rxjava3.core.Single<AgentDetailsResponse> getAgentDetails(@Query(value="agentid")
                                                                                               String agentId)

获取应用详情

应用ID要和对应的token一致

Parameters:

agentId - the agent id

Returns:

the agent details

settings

@POST(value="agent/set")
io.reactivex.rxjava3.core.Single<WeComResponse> settings(@Body
                                                                                  AgentManagerApi.Settings settings)

设置应用

Parameters:

settings - the settings

Returns:

WeComResponse

createMenu

@POST(value="menu/create")
io.reactivex.rxjava3.core.Single<WeComResponse> createMenu(@Query(value="agentid")
                                                                                      String agentId,
                                                                                      @Body
                                                                                      AgentMenuBtns request)

创建菜单

Parameters:

agentId - the agent id

request - the request

Returns:

the we com response @ the weComException

getMenu

@GET(value="menu/get")
io.reactivex.rxjava3.core.Single<GenericResponse<List<AgentMenuBtn>>> getMenu(@Query(value="agentid")
                                                                                                     String agentId)

获取菜单

Parameters:

agentId - the agent id

Returns:

the menu @ the weComException

deleteMenu

@GET(value="menu/delete")
io.reactivex.rxjava3.core.Single<WeComResponse> deleteMenu(@Query(value="agentid")
                                                                                     String agentId)

删除菜单

Parameters:

agentId - the agent id

Returns:

the we com response @ the weComException

setWorkbenchTemplate

@POST(value="agent/set_workbench_template")
io.reactivex.rxjava3.core.Single<WeComResponse> setWorkbenchTemplate(@Body
                                                                                                                 WorkbenchTemplate template)

设置应用在工作台展示的模版

该接口指定应用自定义模版类型。同时也支持设置企业默认模版数据。若type指定为 "normal" 则为取消自定义模式，改为普通展示模式

Parameters:

template - the template

Returns:

the workbench template @ the weComException

getWorkbenchTemplate

@POST(value="agent/get_workbench_template")
io.reactivex.rxjava3.core.Single<WorkbenchDetailResponse> getWorkbenchTemplate(@Body
                                                                                                                           Map<String,String> agentId)

获取应用在工作台展示的模版

Parameters:

agentId - the agent id

Returns:

the workbench template @ the weComException

setWorkbenchData

@POST(value="agent/set_workbench_data")
io.reactivex.rxjava3.core.Single<WeComResponse> setWorkbenchData(@Body
                                                                                                         UserWorkbenchTemplate template)

设置应用在用户工作台展示的数据

可设置当前凭证对应的应用；设置的userid必须在应用可见范围； 每个用户每个应用接口限制10次/分钟；

Parameters:

template - the template

Returns:

the workbench data @ the weComException