cn.binarywang.wx.miniapp.bean.WxMaSubscribeMessage Maven / Gradle / Ivy
package cn.binarywang.wx.miniapp.bean;
import cn.binarywang.wx.miniapp.constant.WxMaConstants;
import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
import lombok.*;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
/**
* 订阅消息.
* https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html
*
* @author S
*/
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class WxMaSubscribeMessage implements Serializable {
private static final long serialVersionUID = 6846729898251286686L;
/**
* 接收者（用户）的 openid.
*
* 参数：touser
* 是否必填： 是
* 描述： 接收者（用户）的 openid
*
*/
private String toUser;
/**
* 所需下发的模板消息的id.
*
* 参数：template_id
* 是否必填： 是
* 描述： 所需下发的模板消息的id
*
*/
private String templateId;
/**
* 点击模板卡片后的跳转页面，仅限本小程序内的页面.
*
* 参数：page
* 是否必填： 否
* 描述： 点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转。
*
*/
private String page;
/**
* 模板内容，不填则下发空模板.
*
* 参数：data
* 是否必填： 是
* 描述： 模板内容，不填则下发空模板
*
*/
private List data;
/**
* 跳转小程序类型：developer为开发版；trial为体验版；formal为正式版；默认为正式版
*/
private String miniprogramState = WxMaConstants.MiniProgramState.FORMAL;
/**
* 进入小程序查看的语言类型，支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为zh_CN
*/
private String lang = WxMaConstants.MiniProgramLang.ZH_CN;
public WxMaSubscribeMessage addData(MsgData datum) {
if (this.data == null) {
this.data = new ArrayList<>();
}
this.data.add(datum);
return this;
}
public String toJson() {
return WxMaGsonBuilder.create().toJson(this);
}
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class MsgData implements Serializable {
private static final long serialVersionUID = 1L;
private String name;
private String value;
}
}