V2NIMChatroomQueueOfferParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.chatroom.params;

import android.text.TextUtils;

/**
 * 聊天室队列新增或者更新队列元素参数
 */
public class V2NIMChatroomQueueOfferParams {
    /**
     * 元素的唯一key
     * 长度限制: 128字节
     * 如果队列key不存在,则追加到队尾,否则更新相应元素
     */
    private final String elementKey;

    /**
     * 元素的值
     * 长度限制: 4096字节
     */
    private final String elementValue;

    /**
     * 元素是否瞬态的
     * true: 当前元素所属的成员退出或者掉线时,同步删除
     * false: 元素保留
     */
    private boolean isTransient = false;

    /**
     * 元素属于的账号,默认为当前操作者
     * 管理员操作,可以指定元素属于的合法账号
     */
    private String elementOwnerAccountId;

    /**
     * 构造函数
     * @param elementKey 元素的唯一key
     * @param elementValue 元素的值
     */
    public V2NIMChatroomQueueOfferParams(String elementKey, String elementValue) {
        this.elementKey = elementKey;
        this.elementValue = elementValue;
    }

    private V2NIMChatroomQueueOfferParams() {
        this.elementKey = null;
        this.elementValue = null;
    }

    /**
     * 获取元素的唯一key
     * @return 元素的唯一key
     */
    public String getElementKey() {
        return elementKey;
    }

    /**
     * 获取元素的值
     * @return 元素的值
     */
    public String getElementValue() {
        return elementValue;
    }


    /**
     * 判断元素是否为瞬态的
     * @return true表示元素是瞬态的,false表示元素是持久的
     */
    public boolean isTransient() {
        return isTransient;
    }

    /**
     * 设置元素是否为瞬态的
     * @param isTransient true表示元素是瞬态的,当前元素所属的成员退出或者掉线时会同步删除;
     *                    false表示元素是持久的,会被保留
     */
    public void setTransient(boolean isTransient) {
        this.isTransient = isTransient;
    }

    /**
     * 获取元素属于的账号
     * @return 元素属于的账号,如果未设置则返回null
     */
    public String getElementOwnerAccountId() {
        return elementOwnerAccountId;
    }

    /**
     * 设置元素属于的账号
     * @param elementOwnerAccountId 元素属于的账号,默认为当前操作者。
     *                            管理员操作时,可以指定元素属于的合法账号
     */
    public void setElementOwnerAccountId(String elementOwnerAccountId) {
        this.elementOwnerAccountId = elementOwnerAccountId;
    }

    /**
     * 判断参数是否有效
     * @return
     */
    public boolean isValid(){
        if(TextUtils.isEmpty(elementKey)){
            return false;
        }

        if(TextUtils.isEmpty(elementValue)){
            return false;
        }

        return true;
    }
}