com.github.tingyugetc520.ali.dingtalk.api

接口 DtService

所有超级接口:

BaseService

所有已知实现类:

BaseDtServiceImpl, DtServiceImpl, DtServiceOkHttpImpl

public interface DtService
extends BaseService

方法概要

限定符和类型	方法和说明
boolean	checkSignature(String signature, String timestamp, String nonce, String data) 验证推送过来的消息的正确性
<T,E> T	execute(RequestExecutor<T,E> executor, String uri, E data) Service没有实现某个API的时候，可以用这个， 比BaseService.get(java.lang.String, java.lang.String)和BaseService.post(java.lang.String, java.lang.String)方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
String	getAccessToken() 获取access_token, 不强制刷新access_token
String	getAccessToken(boolean forceRefresh) 获取access_token，本方法线程安全 且在多线程同时刷新时只刷新一次，避免触发调用次数频繁限制 非必要情况下尽量不要主动调用此方法
DtAgentService	getAgentService() agent service
DtCorpConversationMessageService	getCorpConversationMsgService()
DtDepartmentService	getDepartmentService() 获取部门相关接口的服务类对象
DtConfigStorage	getDtConfigStorage() 获取DtConfigStorage对象
DtOAuth2Service	getOauth2Service() 获取Oauth2相关接口的服务类对象
DtUserService	getUserService() 获取用户相关接口的服务类对象
void	initHttp() 初始化http请求对象
void	setDtConfigStorage(DtConfigStorage configProvider) 注入 DtConfigStorage 的实现

从接口继承的方法 com.github.tingyugetc520.ali.dingtalk.api.BaseService

get, post, post, post

方法详细资料

checkSignature

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

 验证推送过来的消息的正确性
 

参数:

signature - 消息签名

timestamp - 时间戳

nonce - 随机数

data - 传输过来的数据

返回:

the boolean

getAccessToken

String getAccessToken()
               throws DtErrorException

获取access_token, 不强制刷新access_token

返回:

the access token

抛出:

DtErrorException - the error exception

另请参阅:

getAccessToken(boolean)

getAccessToken

String getAccessToken(boolean forceRefresh)
               throws DtErrorException

获取access_token，本方法线程安全 且在多线程同时刷新时只刷新一次，避免触发调用次数频繁限制 非必要情况下尽量不要主动调用此方法

参数:

forceRefresh - 强制刷新

返回:

the access token

抛出:

DtErrorException - the error exception

execute

<T,E> T execute(RequestExecutor<T,E> executor,
                String uri,
                E data)
         throws DtErrorException

Service没有实现某个API的时候，可以用这个， 比BaseService.get(java.lang.String, java.lang.String)和BaseService.post(java.lang.String, java.lang.String)方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。

类型参数:

T - 请求值类型

E - 返回值类型

参数:

executor - 执行器

uri - 请求地址

data - 参数

返回:

the t

抛出:

DtErrorException - the error exception

initHttp

void initHttp()

初始化http请求对象

getDtConfigStorage

DtConfigStorage getDtConfigStorage()

获取DtConfigStorage对象

返回:

DtConfigStorage config storage

setDtConfigStorage

void setDtConfigStorage(DtConfigStorage configProvider)

注入 DtConfigStorage 的实现

参数:

configProvider - 配置对象

getDepartmentService

DtDepartmentService getDepartmentService()

获取部门相关接口的服务类对象

返回:

department service

getUserService

DtUserService getUserService()

获取用户相关接口的服务类对象

返回:

the user service

getOauth2Service

DtOAuth2Service getOauth2Service()

获取Oauth2相关接口的服务类对象

返回:

the oauth 2 service

getAgentService

DtAgentService getAgentService()

agent service

返回:

service

getCorpConversationMsgService

DtCorpConversationMessageService getCorpConversationMsgService()