📝 部分java类属性增加javadoc,方便开发者随时查看

This commit is contained in:
Binary Wang 2019-10-16 17:13:38 +08:00
parent 829ca6f9e2
commit 8fb05730a2
4 changed files with 70 additions and 5 deletions

View File

@ -6,9 +6,9 @@ import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import me.chanjar.weixin.cp.constant.WxCpConsts.AppChatMsgType;
import me.chanjar.weixin.cp.bean.article.MpnewsArticle; import me.chanjar.weixin.cp.bean.article.MpnewsArticle;
import me.chanjar.weixin.cp.bean.article.NewArticle; import me.chanjar.weixin.cp.bean.article.NewArticle;
import me.chanjar.weixin.cp.constant.WxCpConsts.AppChatMsgType;
import java.io.Serializable; import java.io.Serializable;
import java.util.List; import java.util.List;
@ -28,16 +28,49 @@ import java.util.List;
public class WxCpAppChatMessage implements Serializable { public class WxCpAppChatMessage implements Serializable {
private static final long serialVersionUID = -5469013416372240229L; private static final long serialVersionUID = -5469013416372240229L;
/**
* 消息类型
*/
private String msgType; private String msgType;
/**
* 消息内容
*/
private String content; private String content;
/**
* 群聊id
*/
private String chatId; private String chatId;
/**
* 图片媒体文件id可以调用上传临时素材接口获取
*/
private String mediaId; private String mediaId;
/**
* 视频消息的标题不超过128个字节超过会自动截断
*/
private String title; private String title;
/**
* 视频消息的描述不超过512个字节超过会自动截断
*/
private String description; private String description;
/**
* 表示是否是保密消息
*/
private Boolean safe; private Boolean safe;
/**
* 点击后跳转的链接
*/
private String url; private String url;
/**
* 按钮文字 默认为详情 不超过4个文字超过自动截断
*/
private String btnTxt; private String btnTxt;
/**
* 图文消息一个图文消息支持1到8条图文
*/
private List<NewArticle> articles; private List<NewArticle> articles;
/**
* Mpnews图文消息一个图文消息支持1到8条图文
*/
private List<MpnewsArticle> mpnewsArticles; private List<MpnewsArticle> mpnewsArticles;
/** /**

View File

@ -8,7 +8,6 @@ import me.chanjar.weixin.cp.bean.article.MpnewsArticle;
import me.chanjar.weixin.cp.bean.article.NewArticle; import me.chanjar.weixin.cp.bean.article.NewArticle;
import me.chanjar.weixin.cp.bean.messagebuilder.*; import me.chanjar.weixin.cp.bean.messagebuilder.*;
import me.chanjar.weixin.cp.bean.taskcard.TaskCardButton; import me.chanjar.weixin.cp.bean.taskcard.TaskCardButton;
import me.chanjar.weixin.cp.constant.WxCpConsts;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import java.io.Serializable; import java.io.Serializable;

View File

@ -17,12 +17,34 @@ import java.io.Serializable;
public class MpnewsArticle implements Serializable { public class MpnewsArticle implements Serializable {
private static final long serialVersionUID = 6985871812170756481L; private static final long serialVersionUID = 6985871812170756481L;
/**
* 标题不超过128个字节超过会自动截断
*/
private String title; private String title;
/**
* 图文消息缩略图的media_id, 可以通过素材管理接口获得此处thumb_media_id即上传接口返回的media_id
*/
private String thumbMediaId; private String thumbMediaId;
/**
* 图文消息的作者不超过64个字节
*/
private String author; private String author;
/**
* 图文消息点击阅读原文之后的页面链接
*/
private String contentSourceUrl; private String contentSourceUrl;
/**
* 图文消息的内容支持html标签不超过666 K个字节
*/
private String content; private String content;
/**
* 图文消息的描述不超过512个字节超过会自动截断
*/
private String digest; private String digest;
/**
* 可能已经废弃了官方文档里已经看不到了
*/
@Deprecated
private String showCoverPic; private String showCoverPic;
} }

View File

@ -1,12 +1,12 @@
package me.chanjar.weixin.cp.bean.article; package me.chanjar.weixin.cp.bean.article;
import java.io.Serializable;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import java.io.Serializable;
/** /**
* <pre> * <pre>
* Created by BinaryWang on 2017/3/27. * Created by BinaryWang on 2017/3/27.
@ -20,10 +20,21 @@ import lombok.NoArgsConstructor;
@NoArgsConstructor @NoArgsConstructor
public class NewArticle implements Serializable { public class NewArticle implements Serializable {
private static final long serialVersionUID = 4087852055781140659L; private static final long serialVersionUID = 4087852055781140659L;
/**
* 标题不超过128个字节超过会自动截断
*/
private String title; private String title;
/**
* 描述不超过512个字节超过会自动截断
*/
private String description; private String description;
/**
* 点击后跳转的链接
*/
private String url; private String url;
/**
* 图文消息的图片链接支持JPGPNG格式较好的效果为大图1068*455小图150*150
*/
private String picUrl; private String picUrl;
} }