MemberPushOption.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg.model;

import java.io.Serializable;
import java.util.List;

/**
 * 指定成员推送相关可选项
 * 配置后发送消息，如果遇到414，说明客户端提交参数(forcePushList)格式有误；811说明是强推列表中帐号数量超限，目前上限是100个帐号。
 */
public class MemberPushOption implements Serializable {

    private List<String> forcePushList = null;

    private String forcePushContent = null;

    private boolean isForcePush = true; // 注意，默认值是强推

    /**
     * 返回强制推送的账号列表
     *
     * @return 账号列表
     */
    public List<String> getForcePushList() {
        return forcePushList;
    }

    /**
     * 返回强制推送的文案
     *
     * @return 强制推送文本
     */
    public String getForcePushContent() {
        return forcePushContent;
    }

    /**
     * 返回是否强制推送
     *
     * @return 是否强制推送
     */
    public boolean isForcePush() {
        return isForcePush;
    }

    /**
     * 设置是否强推（可扩展为区别于普通推送的推送形式）,针对forcePushList里的帐号，false为不强推，true为强推，默认为true。
     * isForcePush只对forcePushList中的账号生效。
     * 若指定isForcePush为false，则不会有强推。在此情况下，对于forcePushList中的用户，推送文案为forcePushContent；对于不在forcePushList中的用户，推送文案为pushContent；
     * 针对在forcePushList中的账号：isForcePush为true时，推送文案中不会包含发送者nick，直接为forcePushContent；isForcePush为false时，推送文案中目前包含了发送者nick（暂定），即为fromNick：forcePushContent。
     *
     * @param forcePush 是否强制推送
     */
    public void setForcePush(boolean forcePush) {
        isForcePush = forcePush;
    }

    /**
     * 设置强推列表（可扩展为区别于普通推送的推送帐号列表），填null表示强推给该会话所有成员，不为null时最大上限账号为100个。
     *
     * @param forcePushList 账号列表
     */
    public void setForcePushList(List<String> forcePushList) {
        this.forcePushList = forcePushList;
    }

    /**
     * 强推文案（可扩展为区别与普通推送的推送文案），目前限制为500字以内
     *
     * @param forcePushContent 强推文本，如不指定forcePushContent，则强推文案退化为IMMessage#pushContent字段。
     */
    public void setForcePushContent(String forcePushContent) {
        this.forcePushContent = forcePushContent;
    }
}