Skip to content

Commit 54d1b92

Browse files
binarywangbinarywang
committed
🎨 批量完善部分javadoc
1 parent ba72931 commit 54d1b92

35 files changed

Lines changed: 3196 additions & 2822 deletions

‎weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpAiOpenService.java‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ public interface WxMpAiOpenService {
2323
* http://api.weixin.qq.com/cgi-bin/media/voice/addvoicetorecofortext?access_token=ACCESS_TOKEN&format=&voice_id=xxxxxx&lang=zh_CN
2424
* </pre>
2525
*
26+
* @param voiceId 语音唯一标识
2627
* @param lang 语言，zh_CN 或 en_US，默认中文
2728
* @param voiceFile 语音文件
28-
* @param voiceId 语音唯一标识
29+
* @throws WxErrorException the wx error exception
2930
*/
3031
void uploadVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException;
3132

@@ -39,18 +40,22 @@ public interface WxMpAiOpenService {
3940
*
4041
* </pre>
4142
*
42-
* @param lang 语言，zh_CN 或 en_US，默认中文
4343
* @param voiceId 语音唯一标识
44+
* @param lang 语言，zh_CN 或 en_US，默认中文
45+
* @return the string
46+
* @throws WxErrorException the wx error exception
4447
*/
4548
String queryRecognitionResult(String voiceId, AiLangType lang) throws WxErrorException;
4649

4750
/**
4851
* 识别指定语音文件内容.
4952
* 此方法揉合了前两两个方法：uploadVoice 和 queryRecognitionResult
5053
*
54+
* @param voiceId 语音唯一标识
5155
* @param lang 语言，zh_CN 或 en_US，默认中文
5256
* @param voiceFile 语音文件
53-
* @param voiceId 语音唯一标识
57+
* @return the string
58+
* @throws WxErrorException the wx error exception
5459
*/
5560
String recogniseVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException;
5661

@@ -67,6 +72,8 @@ public interface WxMpAiOpenService {
6772
* @param langFrom 源语言，zh_CN 或 en_US
6873
* @param langTo 目标语言，zh_CN 或 en_US
6974
* @param content 要翻译的文本内容
75+
* @return the string
76+
* @throws WxErrorException the wx error exception
7077
*/
7178
String translate(AiLangType langFrom, AiLangType langTo, String content) throws WxErrorException;
7279
}

‎weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpCardService.java‎

Lines changed: 281 additions & 281 deletions
Large diffs are not rendered by default.

‎weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpCommentService.java‎

Lines changed: 83 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -7,97 +7,96 @@
77
* 图文消息留言管理接口.
88
* https://developers.weixin.qq.com/doc/offiaccount/Comments_management/Image_Comments_Management_Interface.html
99
*
10-
* @author <a href="https://github.com/binarywang">Binary Wang</a>
11-
* created on 2019-06-16
10+
* @author <a href="https://github.com/binarywang">Binary Wang</a> created on 2019-06-16
1211
*/
1312
public interface WxMpCommentService {
14-
/**
15-
* 打开已群发文章评论.
16-
* https://api.weixin.qq.com/cgi-bin/comment/open?access_token=ACCESS_TOKEN
17-
*
18-
* @param msgDataId 群发返回的msg_data_id
19-
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
20-
* @throws WxErrorException 异常
21-
*/
22-
void open(String msgDataId, Integer index) throws WxErrorException;
13+
/**
14+
* 打开已群发文章评论.
15+
* https://api.weixin.qq.com/cgi-bin/comment/open?access_token=ACCESS_TOKEN
16+
*
17+
* @param msgDataId 群发返回的msg_data_id
18+
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
19+
* @throws WxErrorException 异常
20+
*/
21+
void open(String msgDataId, Integer index) throws WxErrorException;
2322

24-
/**
25-
* 关闭已群发文章评论.
26-
* https://api.weixin.qq.com/cgi-bin/comment/close?access_token=ACCESS_TOKEN
27-
*
28-
* @param msgDataId 群发返回的msg_data_id
29-
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
30-
* @throws WxErrorException 异常
31-
*/
32-
void close(String msgDataId, Integer index) throws WxErrorException;
23+
/**
24+
* 关闭已群发文章评论.
25+
* https://api.weixin.qq.com/cgi-bin/comment/close?access_token=ACCESS_TOKEN
26+
*
27+
* @param msgDataId 群发返回的msg_data_id
28+
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
29+
* @throws WxErrorException 异常
30+
*/
31+
void close(String msgDataId, Integer index) throws WxErrorException;
3332

34-
/**
35-
* 查看指定文章的评论数据.
36-
* https://api.weixin.qq.com/cgi-bin/comment/list?access_token=ACCESS_TOKEN
37-
*
38-
* @param msgDataId 群发返回的msg_data_id
39-
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
40-
* @param begin 起始位置
41-
* @param count 获取数目（>=50会被拒绝）
42-
* @param type type=0 普通评论&精选评论 type=1 普通评论 type=2 精选评论
43-
* @return 评论列表数据
44-
* @throws WxErrorException 异常
45-
*/
46-
WxMpCommentListVo list(String msgDataId, Integer index, int begin, int count, int type) throws WxErrorException;
33+
/**
34+
* 查看指定文章的评论数据.
35+
* https://api.weixin.qq.com/cgi-bin/comment/list?access_token=ACCESS_TOKEN
36+
*
37+
* @param msgDataId 群发返回的msg_data_id
38+
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
39+
* @param begin 起始位置
40+
* @param count 获取数目（>=50会被拒绝）
41+
* @param type type=0 普通评论&精选评论 type=1 普通评论 type=2 精选评论
42+
* @return 评论列表数据 wx mp comment list vo
43+
* @throws WxErrorException 异常
44+
*/
45+
WxMpCommentListVo list(String msgDataId, Integer index, int begin, int count, int type) throws WxErrorException;
4746

48-
/**
49-
* 2.4 将评论标记精选.
50-
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/markelect?access_token=ACCESS_TOKEN
51-
*
52-
* @param msgDataId 群发返回的msg_data_id
53-
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
54-
* @param userCommentId 用户评论id
55-
* @throws WxErrorException 异常
56-
*/
57-
void markElect(String msgDataId, Integer index, Long userCommentId) throws WxErrorException;
47+
/**
48+
* 2.4 将评论标记精选.
49+
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/markelect?access_token=ACCESS_TOKEN
50+
*
51+
* @param msgDataId 群发返回的msg_data_id
52+
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
53+
* @param userCommentId 用户评论id
54+
* @throws WxErrorException 异常
55+
*/
56+
void markElect(String msgDataId, Integer index, Long userCommentId) throws WxErrorException;
5857

59-
/**
60-
* 2.5 将评论取消精选.
61-
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/unmarkelect?access_token=ACCESS_TOKEN
62-
*
63-
* @param msgDataId 群发返回的msg_data_id
64-
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
65-
* @param userCommentId 用户评论id
66-
* @throws WxErrorException 异常
67-
*/
68-
void unmarkElect(String msgDataId, Integer index, Long userCommentId) throws WxErrorException;
58+
/**
59+
* 2.5 将评论取消精选.
60+
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/unmarkelect?access_token=ACCESS_TOKEN
61+
*
62+
* @param msgDataId 群发返回的msg_data_id
63+
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
64+
* @param userCommentId 用户评论id
65+
* @throws WxErrorException 异常
66+
*/
67+
void unmarkElect(String msgDataId, Integer index, Long userCommentId) throws WxErrorException;
6968

70-
/**
71-
* 2.6 删除评论.
72-
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/delete?access_token=ACCESS_TOKEN
73-
*
74-
* @param msgDataId 群发返回的msg_data_id
75-
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
76-
* @param userCommentId 用户评论id
77-
* @throws WxErrorException 异常
78-
*/
79-
void delete(String msgDataId, Integer index, Long userCommentId) throws WxErrorException;
69+
/**
70+
* 2.6 删除评论.
71+
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/delete?access_token=ACCESS_TOKEN
72+
*
73+
* @param msgDataId 群发返回的msg_data_id
74+
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
75+
* @param userCommentId 用户评论id
76+
* @throws WxErrorException 异常
77+
*/
78+
void delete(String msgDataId, Integer index, Long userCommentId) throws WxErrorException;
8079

81-
/**
82-
* 2.7 回复评论.
83-
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/reply/add?access_token=ACCESS_TOKEN
84-
*
85-
* @param msgDataId 群发返回的msg_data_id
86-
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
87-
* @param userCommentId 用户评论id
88-
* @param content 回复内容
89-
* @throws WxErrorException 异常
90-
*/
91-
void replyAdd(String msgDataId, Integer index, Long userCommentId, String content) throws WxErrorException;
80+
/**
81+
* 2.7 回复评论.
82+
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/reply/add?access_token=ACCESS_TOKEN
83+
*
84+
* @param msgDataId 群发返回的msg_data_id
85+
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
86+
* @param userCommentId 用户评论id
87+
* @param content 回复内容
88+
* @throws WxErrorException 异常
89+
*/
90+
void replyAdd(String msgDataId, Integer index, Long userCommentId, String content) throws WxErrorException;
9291

93-
/**
94-
* 2.8 删除回复.
95-
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/reply/delete?access_token=ACCESS_TOKEN
96-
*
97-
* @param msgDataId 群发返回的msg_data_id
98-
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
99-
* @param userCommentId 用户评论id
100-
* @throws WxErrorException 异常
101-
*/
102-
void replyDelete(String msgDataId, Integer index, Long userCommentId) throws WxErrorException;
92+
/**
93+
* 2.8 删除回复.
94+
* 接口调用请求: POST https://api.weixin.qq.com/cgi-bin/comment/reply/delete?access_token=ACCESS_TOKEN
95+
*
96+
* @param msgDataId 群发返回的msg_data_id
97+
* @param index 多图文时，用来指定第几篇图文，从0开始，不带默认操作该msg_data_id的第一篇图文
98+
* @param userCommentId 用户评论id
99+
* @throws WxErrorException 异常
100+
*/
101+
void replyDelete(String msgDataId, Integer index, Long userCommentId) throws WxErrorException;
103102
}

0 commit comments

Comments
 (0)