Skip to content

Commit 8fb0573

Browse files
committed
📝 部分java类属性增加javadoc,方便开发者随时查看
1 parent 829ca6f commit 8fb0573

File tree

4 files changed

+70
-5
lines changed

4 files changed

+70
-5
lines changed

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAppChatMessage.java

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
import lombok.Builder;
77
import lombok.Data;
88
import lombok.NoArgsConstructor;
9-
import me.chanjar.weixin.cp.constant.WxCpConsts.AppChatMsgType;
109
import me.chanjar.weixin.cp.bean.article.MpnewsArticle;
1110
import me.chanjar.weixin.cp.bean.article.NewArticle;
11+
import me.chanjar.weixin.cp.constant.WxCpConsts.AppChatMsgType;
1212

1313
import java.io.Serializable;
1414
import java.util.List;
@@ -28,16 +28,49 @@
2828
public class WxCpAppChatMessage implements Serializable {
2929
private static final long serialVersionUID = -5469013416372240229L;
3030

31+
/**
32+
* 消息类型
33+
*/
3134
private String msgType;
35+
/**
36+
* 消息内容
37+
*/
3238
private String content;
39+
/**
40+
* 群聊id
41+
*/
3342
private String chatId;
43+
/**
44+
* 图片媒体文件id,可以调用上传临时素材接口获取
45+
*/
3446
private String mediaId;
47+
/**
48+
* 视频消息的标题,不超过128个字节,超过会自动截断
49+
*/
3550
private String title;
51+
/**
52+
* 视频消息的描述,不超过512个字节,超过会自动截断
53+
*/
3654
private String description;
55+
/**
56+
* 表示是否是保密消息
57+
*/
3758
private Boolean safe;
59+
/**
60+
* 点击后跳转的链接。
61+
*/
3862
private String url;
63+
/**
64+
* 按钮文字。 默认为“详情”, 不超过4个文字,超过自动截断。
65+
*/
3966
private String btnTxt;
67+
/**
68+
* 图文消息,一个图文消息支持1到8条图文
69+
*/
4070
private List<NewArticle> articles;
71+
/**
72+
* Mpnews图文消息,一个图文消息支持1到8条图文
73+
*/
4174
private List<MpnewsArticle> mpnewsArticles;
4275

4376
/**

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpMessage.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
import me.chanjar.weixin.cp.bean.article.NewArticle;
99
import me.chanjar.weixin.cp.bean.messagebuilder.*;
1010
import me.chanjar.weixin.cp.bean.taskcard.TaskCardButton;
11-
import me.chanjar.weixin.cp.constant.WxCpConsts;
1211
import org.apache.commons.lang3.StringUtils;
1312

1413
import java.io.Serializable;

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/article/MpnewsArticle.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,34 @@
1717
public class MpnewsArticle implements Serializable {
1818
private static final long serialVersionUID = 6985871812170756481L;
1919

20+
/**
21+
* 标题,不超过128个字节,超过会自动截断
22+
*/
2023
private String title;
24+
/**
25+
* 图文消息缩略图的media_id, 可以通过素材管理接口获得。此处thumb_media_id即上传接口返回的media_id
26+
*/
2127
private String thumbMediaId;
28+
/**
29+
* 图文消息的作者,不超过64个字节
30+
*/
2231
private String author;
32+
/**
33+
* 图文消息点击“阅读原文”之后的页面链接
34+
*/
2335
private String contentSourceUrl;
36+
/**
37+
* 图文消息的内容,支持html标签,不超过666 K个字节
38+
*/
2439
private String content;
40+
/**
41+
* 图文消息的描述,不超过512个字节,超过会自动截断
42+
*/
2543
private String digest;
44+
/**
45+
* 可能已经废弃了,官方文档里已经看不到了
46+
*/
47+
@Deprecated
2648
private String showCoverPic;
2749

2850
}

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/article/NewArticle.java

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
package me.chanjar.weixin.cp.bean.article;
22

3-
import java.io.Serializable;
4-
53
import lombok.AllArgsConstructor;
64
import lombok.Builder;
75
import lombok.Data;
86
import lombok.NoArgsConstructor;
97

8+
import java.io.Serializable;
9+
1010
/**
1111
* <pre>
1212
* Created by BinaryWang on 2017/3/27.
@@ -20,10 +20,21 @@
2020
@NoArgsConstructor
2121
public class NewArticle implements Serializable {
2222
private static final long serialVersionUID = 4087852055781140659L;
23-
23+
/**
24+
* 标题,不超过128个字节,超过会自动截断
25+
*/
2426
private String title;
27+
/**
28+
* 描述,不超过512个字节,超过会自动截断
29+
*/
2530
private String description;
31+
/**
32+
* 点击后跳转的链接。
33+
*/
2634
private String url;
35+
/**
36+
* 图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图1068*455,小图150*150。
37+
*/
2738
private String picUrl;
2839

2940
}

0 commit comments

Comments
 (0)