cn.felord.reactive.api

Class AgentManagerApi

java.lang.Object

cn.felord.reactive.api.AgentManagerApi

public class AgentManagerApi
extends Object

The type Agent manager api.

Since:

2024/6/27 11:33

Author:

dax

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentManagerApi.Settings The type Settings.

Field Summary

Fields

Modifier and Type	Field and Description
private AgentDetails	agentDetails
private InternalAgentManagerApi	internalAgentManagerApi

Constructor Summary

Constructors

Constructor and Description
AgentManagerApi(retrofit2.Retrofit retrofit, AgentDetails agentDetails) Instantiates a new Agent manager api.

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<WeComResponse>	createMenu(AgentMenuBtns request) 创建菜单
io.reactivex.rxjava3.core.Single<WeComResponse>	deleteMenu() 删除菜单
io.reactivex.rxjava3.core.Single<AgentDetailsResponse>	getAgentDetails() Gets agent details.
io.reactivex.rxjava3.core.Single<GenericResponse<List<AgentMenuBtn>>>	getMenu() 获取菜单
io.reactivex.rxjava3.core.Single<WorkbenchDetailResponse>	getWorkbenchTemplate() 获取应用在工作台展示的模版
io.reactivex.rxjava3.core.Single<WeComResponse>	settings(AgentSettingRequest request) 设置应用
io.reactivex.rxjava3.core.Single<WeComResponse>	setWorkbenchData(UserWorkBenchSetting<?> userSetting) 设置应用在用户工作台展示的数据
io.reactivex.rxjava3.core.Single<WeComResponse>	setWorkbenchTemplate(WorkBenchSetting<?> setting) 设置应用在工作台展示的模版

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

internalAgentManagerApi

private final InternalAgentManagerApi internalAgentManagerApi

agentDetails

private final AgentDetails agentDetails

Constructor Detail

AgentManagerApi

AgentManagerApi(retrofit2.Retrofit retrofit,
                AgentDetails agentDetails)

Instantiates a new Agent manager api.

Parameters:

retrofit - the retrofit

agentDetails - the agent details

Method Detail

getAgentDetails

public io.reactivex.rxjava3.core.Single<AgentDetailsResponse> getAgentDetails()

Gets agent details.

Returns:

the agent details

settings

public io.reactivex.rxjava3.core.Single<WeComResponse> settings(AgentSettingRequest request)

设置应用

Parameters:

request - the request

Returns:

WeComResponse

createMenu

public io.reactivex.rxjava3.core.Single<WeComResponse> createMenu(AgentMenuBtns request)

创建菜单

Parameters:

request - the request

Returns:

the we com response @ the weComException

getMenu

public io.reactivex.rxjava3.core.Single<GenericResponse<List<AgentMenuBtn>>> getMenu()

获取菜单

Returns:

the menu @ the weComException

deleteMenu

public io.reactivex.rxjava3.core.Single<WeComResponse> deleteMenu()

删除菜单

Returns:

the we com response @ the weComException

setWorkbenchTemplate

public io.reactivex.rxjava3.core.Single<WeComResponse> setWorkbenchTemplate(WorkBenchSetting<?> setting)

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

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

Parameters:

setting - the setting

Returns:

the workbench template @ the weComException

getWorkbenchTemplate

public io.reactivex.rxjava3.core.Single<WorkbenchDetailResponse> getWorkbenchTemplate()

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

Returns:

the workbench template @ the weComException

setWorkbenchData

public io.reactivex.rxjava3.core.Single<WeComResponse> setWorkbenchData(@Body
                                                                        UserWorkBenchSetting<?> userSetting)

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

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

Parameters:

userSetting - the user setting

Returns:

the workbench data @ the weComException