com.dingtalk.api.response.OapiMessageCorpconversationGetsendresultResponse Maven / Gradle / Ivy

Go to download
package com.dingtalk.api.response;

import java.util.List;
import com.taobao.api.internal.mapping.ApiField;
import com.taobao.api.internal.mapping.ApiListField;
import com.taobao.api.TaobaoObject;

import com.taobao.api.TaobaoResponse;

/**
 * TOP DingTalk-API: dingtalk.oapi.message.corpconversation.getsendresult response.
 * 
 * @author top auto create
 * @since 1.0, null
 */
public class OapiMessageCorpconversationGetsendresultResponse extends TaobaoResponse {

	private static final long serialVersionUID = 7852821874333276324L;

	/** 
	 * errcode
	 */
	@ApiField("errcode")
	private Long errcode;

	/** 
	 * errmsg
	 */
	@ApiField("errmsg")
	private String errmsg;

	/** 
	 * result
	 */
	@ApiField("send_result")
	private AsyncSendResult sendResult;


	public void setErrcode(Long errcode) {
		this.errcode = errcode;
	}
	public Long getErrcode( ) {
		return this.errcode;
	}

	public void setErrmsg(String errmsg) {
		this.errmsg = errmsg;
	}
	public String getErrmsg( ) {
		return this.errmsg;
	}

	public void setSendResult(AsyncSendResult sendResult) {
		this.sendResult = sendResult;
	}
	public AsyncSendResult getSendResult( ) {
		return this.sendResult;
	}

	public boolean isSuccess() {
        return getErrcode() == null || getErrcode().equals(0L);
    }
	
	/**
	 * 推送被禁止的具体原因
	 *
	 * @author top auto create
	 * @since 1.0, null
	 */
	public static class SendForbiddenModel extends TaobaoObject {
		private static final long serialVersionUID = 4385247835977816477L;
		/**
		 * 流控code
		 */
		@ApiField("code")
		private String code;
		/**
		 * 流控阀值
		 */
		@ApiField("count")
		private Long count;
		/**
		 * 员工userId
		 */
		@ApiField("userid")
		private String userid;
	
		public String getCode() {
			return this.code;
		}
		public void setCode(String code) {
			this.code = code;
		}
		public Long getCount() {
			return this.count;
		}
		public void setCount(Long count) {
			this.count = count;
		}
		public String getUserid() {
			return this.userid;
		}
		public void setUserid(String userid) {
			this.userid = userid;
		}
	}
	
	/**
	 * result
	 *
	 * @author top auto create
	 * @since 1.0, null
	 */
	public static class AsyncSendResult extends TaobaoObject {
		private static final long serialVersionUID = 4426649788524566881L;
		/**
		 * 发送失败的用户id
		 */
		@ApiListField("failed_user_id_list")
		@ApiField("string")
		private List failedUserIdList;
		/**
		 * 推送被禁止的具体原因
		 */
		@ApiListField("forbidden_list")
		@ApiField("send_forbidden_model")
		private List forbiddenList;
		/**
		 * 因发送消息过于频繁或超量而被流控过滤后实际未发送的userid。未被限流的接收者仍会被成功发送。限流规则包括：1、给同一用户发相同内容消息一天仅允许一次；2、如果是ISV接入方式，给同一用户发消息一天不得超过100次；如果是企业接入方式，此上限为500。
		 */
		@ApiListField("forbidden_user_id_list")
		@ApiField("string")
		private List forbiddenUserIdList;
		/**
		 * 无效的部门id
		 */
		@ApiListField("invalid_dept_id_list")
		@ApiField("number")
		private List invalidDeptIdList;
		/**
		 * 无效的用户id
		 */
		@ApiListField("invalid_user_id_list")
		@ApiField("string")
		private List invalidUserIdList;
		/**
		 * 已读消息的用户id
		 */
		@ApiListField("read_user_id_list")
		@ApiField("string")
		private List readUserIdList;
		/**
		 * 未读消息的用户id
		 */
		@ApiListField("unread_user_id_list")
		@ApiField("string")
		private List unreadUserIdList;
	
		public List getFailedUserIdList() {
			return this.failedUserIdList;
		}
		public void setFailedUserIdList(List failedUserIdList) {
			this.failedUserIdList = failedUserIdList;
		}
		public List getForbiddenList() {
			return this.forbiddenList;
		}
		public void setForbiddenList(List forbiddenList) {
			this.forbiddenList = forbiddenList;
		}
		public List getForbiddenUserIdList() {
			return this.forbiddenUserIdList;
		}
		public void setForbiddenUserIdList(List forbiddenUserIdList) {
			this.forbiddenUserIdList = forbiddenUserIdList;
		}
		public List getInvalidDeptIdList() {
			return this.invalidDeptIdList;
		}
		public void setInvalidDeptIdList(List invalidDeptIdList) {
			this.invalidDeptIdList = invalidDeptIdList;
		}
		public List getInvalidUserIdList() {
			return this.invalidUserIdList;
		}
		public void setInvalidUserIdList(List invalidUserIdList) {
			this.invalidUserIdList = invalidUserIdList;
		}
		public List getReadUserIdList() {
			return this.readUserIdList;
		}
		public void setReadUserIdList(List readUserIdList) {
			this.readUserIdList = readUserIdList;
		}
		public List getUnreadUserIdList() {
			return this.unreadUserIdList;
		}
		public void setUnreadUserIdList(List unreadUserIdList) {
			this.unreadUserIdList = unreadUserIdList;
		}
	}
	


}