Skip to content

Commit 7b1e411

Browse files
committed
增加一些注释
1 parent 343ed7a commit 7b1e411

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutNewsMessage.java

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,36 @@
11
package me.chanjar.weixin.mp.bean.message;
22

3+
import java.io.Serializable;
4+
import java.util.ArrayList;
5+
import java.util.List;
6+
37
import com.thoughtworks.xstream.annotations.XStreamAlias;
48
import com.thoughtworks.xstream.annotations.XStreamConverter;
59
import lombok.Data;
610
import lombok.EqualsAndHashCode;
711
import me.chanjar.weixin.common.api.WxConsts;
812
import me.chanjar.weixin.common.util.xml.XStreamCDataConverter;
913

10-
import java.io.Serializable;
11-
import java.util.ArrayList;
12-
import java.util.List;
13-
14+
/**
15+
* 被动回复的图文消息xml.
16+
* @author chanjarster
17+
*/
1418
@XStreamAlias("xml")
1519
@Data
1620
@EqualsAndHashCode(callSuper = true)
1721
public class WxMpXmlOutNewsMessage extends WxMpXmlOutMessage {
1822
private static final long serialVersionUID = -4604402850905714772L;
1923

24+
/**
25+
* 图文消息信息.
26+
* 注意,如果图文数超过限制,则将只发限制内的条数
27+
*/
2028
@XStreamAlias("Articles")
2129
protected final List<Item> articles = new ArrayList<>();
30+
/**
31+
* 图文消息个数.
32+
* 当用户发送文本、图片、视频、图文、地理位置这五种消息时,开发者只能回复1条图文消息;其余场景最多可回复8条图文消息
33+
*/
2234
@XStreamAlias("ArticleCount")
2335
protected int articleCount;
2436

@@ -36,23 +48,35 @@ public void addArticle(Item item) {
3648
public static class Item implements Serializable {
3749
private static final long serialVersionUID = -4971456355028904754L;
3850

51+
/**
52+
* 图文消息标题.
53+
*/
3954
@XStreamAlias("Title")
4055
@XStreamConverter(value = XStreamCDataConverter.class)
4156
private String title;
4257

58+
/**
59+
* 图文消息描述.
60+
*/
4361
@XStreamAlias("Description")
4462
@XStreamConverter(value = XStreamCDataConverter.class)
4563
private String description;
4664

65+
/**
66+
* 图片链接.
67+
* 支持JPG、PNG格式,较好的效果为大图360*200,小图200*200
68+
*/
4769
@XStreamAlias("PicUrl")
4870
@XStreamConverter(value = XStreamCDataConverter.class)
4971
private String picUrl;
5072

73+
/**
74+
* 点击图文消息跳转链接.
75+
*/
5176
@XStreamAlias("Url")
5277
@XStreamConverter(value = XStreamCDataConverter.class)
5378
private String url;
5479

5580
}
5681

57-
5882
}

0 commit comments

Comments
 (0)