@@ -34,7 +34,7 @@ public interface WxCpTpService {
34
34
*
35
35
* @return the suite access token
36
36
* @throws WxErrorException the wx error exception
37
- * @see #getSuiteAccessToken(boolean) #getSuiteAccessToken(boolean)
37
+ * @see #getSuiteAccessToken(boolean) #getSuiteAccessToken(boolean)#getSuiteAccessToken(boolean)
38
38
*/
39
39
String getSuiteAccessToken () throws WxErrorException ;
40
40
@@ -58,10 +58,23 @@ public interface WxCpTpService {
58
58
*
59
59
* @return the suite ticket
60
60
* @throws WxErrorException the wx error exception
61
- * @see #getSuiteTicket(boolean) #getSuiteTicket(boolean)
61
+ * @see #getSuiteTicket(boolean) #getSuiteTicket(boolean)#getSuiteTicket(boolean)
62
62
*/
63
63
String getSuiteTicket () throws WxErrorException ;
64
64
65
+ /**
66
+ * <pre>
67
+ * 保存企业微信定时推送的suite_ticket,(每10分钟)
68
+ * 详情请见:https://work.weixin.qq.com/api/doc#90001/90143/90628
69
+ *
70
+ * 注意:微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟
71
+ * https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
72
+ * </pre>
73
+ *
74
+ * @param suiteTicket the suite ticket
75
+ */
76
+ void setSuiteTicket (String suiteTicket );
77
+
65
78
/**
66
79
* <pre>
67
80
* 获得suite_ticket
@@ -73,8 +86,8 @@ public interface WxCpTpService {
73
86
* @param forceRefresh 强制刷新
74
87
* @return the suite ticket
75
88
* @throws WxErrorException the wx error exception
76
- * @Deprecated 由于无法主动刷新,所以这个接口实际已经没有意义,需要在接收企业微信的主动推送后,保存这个ticket
77
- * @see #setSuiteTicket(String)
89
+ * @deprecated 由于无法主动刷新 ,所以这个接口实际已经没有意义,需要在接收企业微信的主动推送后,保存这个ticket
90
+ * @see #setSuiteTicket(String) #setSuiteTicket(String)
78
91
*/
79
92
@ Deprecated
80
93
String getSuiteTicket (boolean forceRefresh ) throws WxErrorException ;
@@ -88,21 +101,8 @@ public interface WxCpTpService {
88
101
* https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
89
102
* </pre>
90
103
*
91
- * @param suiteTicket
92
- */
93
- void setSuiteTicket (String suiteTicket );
94
-
95
- /**
96
- * <pre>
97
- * 保存企业微信定时推送的suite_ticket,(每10分钟)
98
- * 详情请见:https://work.weixin.qq.com/api/doc#90001/90143/90628
99
- *
100
- * 注意:微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟
101
- * https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
102
- * </pre>
103
- *
104
- * @param suiteTicket
105
- * @param expiresInSeconds
104
+ * @param suiteTicket the suite ticket
105
+ * @param expiresInSeconds the expires in seconds
106
106
*/
107
107
void setSuiteTicket (String suiteTicket , int expiresInSeconds );
108
108
@@ -111,6 +111,7 @@ public interface WxCpTpService {
111
111
*
112
112
* @param authCorpId 授权企业的cropId
113
113
* @return jsapi ticket
114
+ * @throws WxErrorException the wx error exception
114
115
*/
115
116
String getSuiteJsApiTicket (String authCorpId ) throws WxErrorException ;
116
117
@@ -172,14 +173,12 @@ public interface WxCpTpService {
172
173
/**
173
174
* <pre>
174
175
* 获取预授权链接,测试环境下使用
175
- * @Link https://work.weixin.qq.com/api/doc/90001/90143/90602
176
- * </pre>
177
- *
178
176
* @param redirectUri 授权完成后的回调网址
179
- * @param state a-zA-Z0-9的参数值(不超过128个字节),用于第三方自行校验session,防止跨域攻击
180
- * @param authType 授权类型:0 正式授权, 1 测试授权。
177
+ * @param state a-zA-Z0-9的参数值(不超过128个字节),用于第三方自行校验session,防止跨域攻击
178
+ * @param authType 授权类型:0 正式授权, 1 测试授权。
181
179
* @return pre auth url
182
180
* @throws WxErrorException the wx error exception
181
+ * @Link https ://work.weixin.qq.com/api/doc/90001/90143/90602 </pre>
183
182
*/
184
183
String getPreAuthUrl (String redirectUri , String state , int authType ) throws WxErrorException ;
185
184
@@ -198,6 +197,7 @@ public interface WxCpTpService {
198
197
*
199
198
* @param authCorpId 授权企业的cropId
200
199
* @return jsapi ticket
200
+ * @throws WxErrorException the wx error exception
201
201
*/
202
202
String getAuthCorpJsApiTicket (String authCorpId ) throws WxErrorException ;
203
203
@@ -267,7 +267,7 @@ public interface WxCpTpService {
267
267
* 获取WxMpConfigStorage 对象.
268
268
*
269
269
* @return WxMpConfigStorage wx cp tp config storage
270
- * @deprecated storage应该在service内部使用,提供这个接口,容易破坏这个封装
270
+ * @deprecated storage应该在service内部使用 ,提供这个接口,容易破坏这个封装
271
271
*/
272
272
@ Deprecated
273
273
WxCpTpConfigStorage getWxCpTpConfigStorage ();
@@ -298,8 +298,9 @@ public interface WxCpTpService {
298
298
* 获取访问用户身份
299
299
* </pre>
300
300
*
301
- * @param code
302
- * @return
301
+ * @param code the code
302
+ * @return user info 3 rd
303
+ * @throws WxErrorException the wx error exception
303
304
*/
304
305
WxCpTpUserInfo getUserInfo3rd (String code ) throws WxErrorException ;
305
306
@@ -308,94 +309,108 @@ public interface WxCpTpService {
308
309
* 获取访问用户敏感信息
309
310
* </pre>
310
311
*
311
- * @param userTicket
312
- * @return
312
+ * @param userTicket the user ticket
313
+ * @return user detail 3 rd
314
+ * @throws WxErrorException the wx error exception
313
315
*/
314
316
WxCpTpUserDetail getUserDetail3rd (String userTicket ) throws WxErrorException ;
315
317
316
318
/**
317
- * 企业用户登录信息
318
- * @param authCode
319
- * @return
320
- * @throws WxErrorException
319
+ * 获取登录用户信息
320
+ *
321
+ * 文档地址:https://work.weixin.qq.com/api/doc/90001/90143/91125
322
+ * @param authCode the auth code
323
+ * @return login info
324
+ * @throws WxErrorException the wx error exception
321
325
*/
322
326
WxTpLoginInfo getLoginInfo (String authCode ) throws WxErrorException ;
323
327
324
328
/**
325
329
* 获取服务商providerToken
326
- * @return
327
- * @throws WxErrorException
330
+ *
331
+ * @return the wx cp provider token
332
+ * @throws WxErrorException the wx error exception
328
333
*/
329
334
String getWxCpProviderToken () throws WxErrorException ;
330
335
331
336
/**
332
337
* get contact service
333
- * @return WxCpTpContactService
338
+ *
339
+ * @return WxCpTpContactService wx cp tp contact service
334
340
*/
335
341
WxCpTpContactService getWxCpTpContactService ();
336
342
337
- /**
338
- * get department service
339
- * @return WxCpTpDepartmentService
340
- */
341
- WxCpTpDepartmentService getWxCpTpDepartmentService ();
342
-
343
- /**
344
- * get media service
345
- * @return WxCpTpMediaService
346
- */
347
- WxCpTpMediaService getWxCpTpMediaService ();
348
-
349
- /**
350
- * get oa service
351
- * @return WxCpTpOAService
352
- */
353
- WxCpTpOAService getWxCpTpOAService ();
354
-
355
- /**
356
- * get user service
357
- * @return WxCpTpUserService
358
- */
359
- WxCpTpUserService getWxCpTpUserService ();
360
-
361
343
/**
362
344
* set contact service
345
+ *
363
346
* @param wxCpTpContactService the contact service
364
347
*/
365
348
void setWxCpTpContactService (WxCpTpContactService wxCpTpContactService );
366
349
350
+ /**
351
+ * get department service
352
+ *
353
+ * @return WxCpTpDepartmentService wx cp tp department service
354
+ */
355
+ WxCpTpDepartmentService getWxCpTpDepartmentService ();
356
+
367
357
/**
368
358
* set department service
359
+ *
369
360
* @param wxCpTpDepartmentService the department service
370
361
*/
371
362
void setWxCpTpDepartmentService (WxCpTpDepartmentService wxCpTpDepartmentService );
372
363
364
+ /**
365
+ * get media service
366
+ *
367
+ * @return WxCpTpMediaService wx cp tp media service
368
+ */
369
+ WxCpTpMediaService getWxCpTpMediaService ();
370
+
373
371
/**
374
372
* set media service
373
+ *
375
374
* @param wxCpTpMediaService the media service
376
375
*/
377
376
void setWxCpTpMediaService (WxCpTpMediaService wxCpTpMediaService );
378
377
378
+ /**
379
+ * get oa service
380
+ *
381
+ * @return WxCpTpOAService wx cp tp oa service
382
+ */
383
+ WxCpTpOAService getWxCpTpOAService ();
384
+
379
385
/**
380
386
* set oa service
387
+ *
381
388
* @param wxCpTpOAService the oa service
382
389
*/
383
390
void setWxCpTpOAService (WxCpTpOAService wxCpTpOAService );
384
391
392
+ /**
393
+ * get user service
394
+ *
395
+ * @return WxCpTpUserService wx cp tp user service
396
+ */
397
+ WxCpTpUserService getWxCpTpUserService ();
398
+
385
399
/**
386
400
* set user service
401
+ *
387
402
* @param wxCpTpUserService the set user service
388
403
*/
389
404
void setWxCpTpUserService (WxCpTpUserService wxCpTpUserService );
390
405
391
406
/**
392
407
* 获取应用的管理员列表
393
- * @param authCorpId
394
- * @param agentId
395
- * @return
408
+ *
409
+ * @param authCorpId the auth corp id
410
+ * @param agentId the agent id
411
+ * @return admin list
412
+ * @throws WxErrorException the wx error exception
396
413
*/
397
- WxCpTpAdmin getAdminList (String authCorpId ,Integer agentId ) throws WxErrorException ;
398
-
399
-
414
+ WxCpTpAdmin getAdminList (String authCorpId , Integer agentId ) throws WxErrorException ;
400
415
401
416
}
0 commit comments