Skip to content

Commit f67333a

Browse files
binarywangbinarywang
committed
规范化并优化代码
1 parent 3465d53 commit f67333a

30 files changed

Lines changed: 534 additions & 535 deletions

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
* @author <a href="https://github.com/huansinho">huansinho</a>
1616
*/
1717
public interface WxCpAgentService {
18+
String GET_AGENT = "https://qyapi.weixin.qq.com/cgi-bin/agent/get?agentid=%d";
19+
String AGENT_SET = "https://qyapi.weixin.qq.com/cgi-bin/agent/set";
20+
String AGENT_LIST = "https://qyapi.weixin.qq.com/cgi-bin/agent/list";
1821

1922
/**
2023
* <pre>

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpChatService.java‎

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
package me.chanjar.weixin.cp.api;
22

3-
import java.util.List;
4-
53
import me.chanjar.weixin.common.error.WxErrorException;
64
import me.chanjar.weixin.cp.bean.WxCpAppChatMessage;
75
import me.chanjar.weixin.cp.bean.WxCpChat;
86

7+
import java.util.List;
8+
99
/**
1010
* 群聊服务.
1111
*
@@ -15,6 +15,10 @@ public interface WxCpChatService {
1515
String APPCHAT_CREATE = "https://qyapi.weixin.qq.com/cgi-bin/appchat/create";
1616
String APPCHAT_UPDATE = "https://qyapi.weixin.qq.com/cgi-bin/appchat/update";
1717
String APPCHAT_GET_CHATID = "https://qyapi.weixin.qq.com/cgi-bin/appchat/get?chatid=";
18+
String APPCHAT_SEND = "https://qyapi.weixin.qq.com/cgi-bin/appchat/send";
19+
20+
@Deprecated
21+
String chatCreate(String name, String owner, List<String> users, String chatId) throws WxErrorException;
1822

1923
/**
2024
* 创建群聊会话，注意：刚创建的群，如果没有下发消息，在企业微信不会出现该群.
@@ -24,15 +28,13 @@ public interface WxCpChatService {
2428
* @param users 群成员id列表。至少2人，至多500人
2529
* @param chatId 群聊的唯一标志，不能与已有的群重复；字符串类型，最长32个字符。只允许字符0-9及字母a-zA-Z。如果不填，系统会随机生成群id
2630
* @return 创建的群聊会话chatId
27-
* @throws WxErrorException 发生异常
28-
*/
29-
String chatCreate(String name, String owner, List<String> users, String chatId) throws WxErrorException;
30-
31-
/**
32-
* chatCreate 同名方法
31+
* @throws WxErrorException 异常
3332
*/
3433
String create(String name, String owner, List<String> users, String chatId) throws WxErrorException;
3534

35+
@Deprecated
36+
void chatUpdate(String chatId, String name, String owner, List<String> usersToAdd, List<String> usersToDelete) throws WxErrorException;
37+
3638
/**
3739
* 修改群聊会话.
3840
*
@@ -41,26 +43,19 @@ public interface WxCpChatService {
4143
* @param owner 新群主的id。若不需更新，请忽略此参数（null or empty）
4244
* @param usersToAdd 添加成员的id列表，若不需要更新，则传递空对象或者空集合
4345
* @param usersToDelete 踢出成员的id列表，若不需要更新，则传递空对象或者空集合
44-
* @throws WxErrorException 发生异常
45-
*/
46-
void chatUpdate(String chatId, String name, String owner, List<String> usersToAdd, List<String> usersToDelete) throws WxErrorException;
47-
48-
/**
49-
* chatUpdate 同名方法
46+
* @throws WxErrorException 异常
5047
*/
5148
void update(String chatId, String name, String owner, List<String> usersToAdd, List<String> usersToDelete) throws WxErrorException;
5249

50+
@Deprecated
51+
WxCpChat chatGet(String chatId) throws WxErrorException;
52+
5353
/**
5454
* 获取群聊会话.
5555
*
5656
* @param chatId 群聊编号
5757
* @return 群聊会话
58-
* @throws WxErrorException 发生异常
59-
*/
60-
WxCpChat chatGet(String chatId) throws WxErrorException;
61-
62-
/**
63-
* chatGet 同名方法
58+
* @throws WxErrorException 异常
6459
*/
6560
WxCpChat get(String chatId) throws WxErrorException;
6661

@@ -71,6 +66,7 @@ public interface WxCpChatService {
7166
* 文档地址：https://work.weixin.qq.com/api/doc#90000/90135/90248
7267
*
7368
* @param message 要发送的消息内容对象
69+
* @throws WxErrorException 异常
7470
*/
7571
void sendMsg(WxCpAppChatMessage message) throws WxErrorException;
7672

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpDepartmentService.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
* @author <a href="https://github.com/binarywang">Binary Wang</a>
1515
*/
1616
public interface WxCpDepartmentService {
17+
String DEPARTMENT_CREATE = "https://qyapi.weixin.qq.com/cgi-bin/department/create";
18+
String DEPARTMENT_UPDATE = "https://qyapi.weixin.qq.com/cgi-bin/department/update";
19+
String DEPARTMENT_DELETE = "https://qyapi.weixin.qq.com/cgi-bin/department/delete?id=%d";
20+
String DEPARTMENT_LIST = "https://qyapi.weixin.qq.com/cgi-bin/department/list";
1721

1822
/**
1923
* <pre>

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMenuService.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
* @author <a href="https://github.com/binarywang">Binary Wang</a>
1313
*/
1414
public interface WxCpMenuService {
15+
String MENU_CREATE = "https://qyapi.weixin.qq.com/cgi-bin/menu/create?agentid=%d";
16+
String MENU_DELETE = "https://qyapi.weixin.qq.com/cgi-bin/menu/delete?agentid=%d";
17+
String MENU_GET = "https://qyapi.weixin.qq.com/cgi-bin/menu/get?agentid=%d";
18+
1519
/**
1620
* <pre>
1721
* 自定义菜单创建接口

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAService.java‎

Lines changed: 0 additions & 66 deletions
This file was deleted.

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
package me.chanjar.weixin.cp.api;
2+
3+
import me.chanjar.weixin.common.error.WxErrorException;
4+
import me.chanjar.weixin.cp.bean.WxCpApprovalDataResult;
5+
import me.chanjar.weixin.cp.bean.WxCpCheckinData;
6+
import me.chanjar.weixin.cp.bean.WxCpCheckinOption;
7+
import me.chanjar.weixin.cp.bean.WxCpDialRecord;
8+
9+
import java.util.Date;
10+
import java.util.List;
11+
12+
/**
13+
* 企业微信OA相关接口.
14+
*
15+
* @author Element
16+
* @date 2019-04-06 10:52
17+
*/
18+
public interface WxCpOaService {
19+
String GET_CHECKIN_DATA = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckindata";
20+
String GET_CHECKIN_OPTION = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckinoption";
21+
String GET_APPROVAL_DATA = "https://qyapi.weixin.qq.com/cgi-bin/corp/getapprovaldata";
22+
String GET_DIAL_RECORD = "https://qyapi.weixin.qq.com/cgi-bin/dial/get_dial_record";
23+
24+
/**
25+
* <pre>
26+
* 获取打卡数据
27+
* API doc : https://work.weixin.qq.com/api/doc#90000/90135/90262
28+
* </pre>
29+
*
30+
* @param openCheckinDataType 打卡类型。1：上下班打卡；2：外出打卡；3：全部打卡
31+
* @param startTime 获取打卡记录的开始时间
32+
* @param endTime 获取打卡记录的结束时间
33+
* @param userIdList 需要获取打卡记录的用户列表
34+
* @return 打卡数据列表
35+
* @throws WxErrorException 异常
36+
*/
37+
List<WxCpCheckinData> getCheckinData(Integer openCheckinDataType, Date startTime, Date endTime, List<String> userIdList) throws WxErrorException;
38+
39+
/**
40+
* <pre>
41+
* 获取打卡规则
42+
* API doc : https://work.weixin.qq.com/api/doc#90000/90135/90263
43+
* </pre>
44+
*
45+
* @param datetime 需要获取规则的当天日期
46+
* @param userIdList 需要获取打卡规则的用户列表
47+
* @return 打卡规则列表
48+
* @throws WxErrorException 异常
49+
*/
50+
List<WxCpCheckinOption> getCheckinOption(Date datetime, List<String> userIdList) throws WxErrorException;
51+
52+
/**
53+
* <pre>
54+
* 获取审批数据
55+
* 通过本接口来获取公司一段时间内的审批记录。一次拉取调用最多拉取10000个审批记录，可以通过多次拉取的方式来满足需求，但调用频率不可超过600次/分。
56+
* API doc : https://work.weixin.qq.com/api/doc#90000/90135/91530
57+
* </pre>
58+
*
59+
* @param startTime 获取审批记录的开始时间
60+
* @param endTime 获取审批记录的结束时间
61+
* @param nextSpnum 第一个拉取的审批单号，不填从该时间段的第一个审批单拉取
62+
* @throws WxErrorException 异常
63+
*/
64+
WxCpApprovalDataResult getApprovalData(Date startTime, Date endTime, Long nextSpnum) throws WxErrorException;
65+
66+
List<WxCpDialRecord> getDialRecord(Date startTime, Date endTime, Integer offset, Integer limit) throws WxErrorException;
67+
68+
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
import me.chanjar.weixin.cp.config.WxCpConfigStorage;
1414

1515
/**
16-
* 微信API的Service
16+
* 微信API的Service.
1717
* @author chanjaster
1818
*/
1919
public interface WxCpService {
@@ -25,6 +25,7 @@ public interface WxCpService {
2525
String BATCH_REPLACE_USER = "https://qyapi.weixin.qq.com/cgi-bin/batch/replaceuser";
2626
String BATCH_GET_RESULT = "https://qyapi.weixin.qq.com/cgi-bin/batch/getresult?jobid=";
2727
String JSCODE_TO_SESSION_URL = "https://qyapi.weixin.qq.com/cgi-bin/miniprogram/jscode2session";
28+
String GET_TOKEN = "https://qyapi.weixin.qq.com/cgi-bin/gettoken?&corpid=%s&corpsecret=%s";
2829

2930
/**
3031
* <pre>
@@ -310,7 +311,7 @@ public interface WxCpService {
310311

311312
WxCpAgentService getAgentService();
312313

313-
WxCpOAService getOAService();
314+
WxCpOaService getOAService();
314315

315316
/**
316317
* http请求对象

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTagService.java‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@
1717
* @author <a href="https://github.com/binarywang">Binary Wang</a>
1818
*/
1919
public interface WxCpTagService {
20+
String TAG_CREATE = "https://qyapi.weixin.qq.com/cgi-bin/tag/create";
21+
String TAG_UPDATE = "https://qyapi.weixin.qq.com/cgi-bin/tag/update";
22+
String TAG_DELETE = "https://qyapi.weixin.qq.com/cgi-bin/tag/delete?tagid=%s";
23+
String TAG_LIST = "https://qyapi.weixin.qq.com/cgi-bin/tag/list";
24+
String TAG_GET = "https://qyapi.weixin.qq.com/cgi-bin/tag/get?tagid=%s";
25+
String TAG_ADDTAGUSERS = "https://qyapi.weixin.qq.com/cgi-bin/tag/addtagusers";
26+
String TAG_DELTAGUSERS = "https://qyapi.weixin.qq.com/cgi-bin/tag/deltagusers";
27+
2028
/**
2129
* 创建标签.
2230
*
@@ -51,6 +59,14 @@ public interface WxCpTagService {
5159
*/
5260
List<WxCpUser> listUsersByTagId(String tagId) throws WxErrorException;
5361

62+
/**
63+
* 获取标签成员.
64+
* 对应: http://qydev.weixin.qq.com/wiki/index.php?title=管理标签 中的get接口
65+
*
66+
* @param tagId 标签id
67+
*/
68+
WxCpTagGetResult get(String tagId) throws WxErrorException;
69+
5470
/**
5571
* 增加标签成员.
5672
*
@@ -69,13 +85,4 @@ public interface WxCpTagService {
6985
*/
7086
WxCpTagAddOrRemoveUsersResult removeUsersFromTag(String tagId, List<String> userIds, List<String> partyIds) throws WxErrorException;
7187

72-
73-
/**
74-
* 获取标签成员.
75-
* 对应: http://qydev.weixin.qq.com/wiki/index.php?title=管理标签 中的get接口
76-
*
77-
* @param tagId 标签id
78-
*/
79-
WxCpTagGetResult get(String tagId) throws WxErrorException;
80-
8188
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTaskCardService.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
* @date 2019-05-16
1515
*/
1616
public interface WxCpTaskCardService {
17+
String MESSAGE_UPDATE_TASKCARD = "https://qyapi.weixin.qq.com/cgi-bin/message/update_taskcard";
18+
1719
/**
1820
* <pre>
1921
* 更新任务卡片消息状态

0 commit comments

Comments
 (0)