V2NIMSignallingAcceptInviteParams.java

浏览该文件的文档.

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

import android.text.TextUtils;
import com.netease.nimlib.SDKCacheUI;
import com.netease.nimlib.log.NimLog;
import java.util.Objects;

/**
 * 接受别人邀请加入信令房间请求参数
 */
public class V2NIMSignallingAcceptInviteParams {

    private static final String TAG = "V2NIMSignallingAcceptInviteParams";

    /**
     * 信令频道ID，唯一标识了该频道房间
     */
    private final String  channelId;
    /**
     * 邀请者账号ID
     */
    private final String  inviterAccountId;
    /**
     * 请求ID，可以用UUID实现，主要为了便于业务实现请求响应绑定
     */
    private final String  requestId;
    /**
     * 服务器扩展字段，长度限制4096，json格式
     */
    private String  serverExtension;
    /**
     * 是否需要存离线消息。true：需要。false：不需要
     */
    private boolean offlineEnabled = true;

    private V2NIMSignallingAcceptInviteParams() {
        this(null, null, null);
    }

    /**
     * 构造函数
     *
     * @param channelId 信令频道ID
     * @param inviterAccountId 邀请者账号ID
     * @param requestId 请求ID
     */
    public V2NIMSignallingAcceptInviteParams(String channelId, String inviterAccountId, String requestId) {
        this.channelId = channelId;
        this.inviterAccountId = inviterAccountId;
        this.requestId = requestId;
    }

    /**
     * 获取信令频道ID
     *
     * @return 信令频道ID
     */
    public String getChannelId() {
        return channelId;
    }


    /**
     * 获取邀请者账号ID
     *
     * @return 邀请者账号ID
     */
    public String getInviterAccountId() {
        return inviterAccountId;
    }

    /**
     * 获取请求ID
     *
     * @return 请求ID
     */
    public String getRequestId() {
        return requestId;
    }

    /**
     * 获取服务器扩展字段
     *
     * @return 服务器扩展字段
     */
    public String getServerExtension() {
        return serverExtension;
    }

    /**
     * 设置服务器扩展字段
     *
     * @param serverExtension 服务器扩展字段
     */
    public void setServerExtension(String serverExtension) {
        this.serverExtension = serverExtension;
    }

    /**
     * 是否需要存离线消息
     *
     * @return 是否需要存离线消息
     */
    public boolean isOfflineEnabled() {
        return offlineEnabled;
    }

    /**
     * 设置是否需要存离线消息
     *
     * @param offlineEnabled 是否需要存离线消息
     */
    public void setOfflineEnabled(boolean offlineEnabled) {
        this.offlineEnabled = offlineEnabled;
    }

    /**
     * 参数是否合法
     * @return 是否合法
     */
    public boolean isValid(){
        if(TextUtils.isEmpty(channelId)){
            NimLog.e(TAG,"channelId is invalid");
            return false;
        }
        if(TextUtils.isEmpty(inviterAccountId)){
            NimLog.e(TAG,"inviterAccountId is invalid");
            return false;
        }
        if(Objects.equals(inviterAccountId, SDKCacheUI.getAccount())){
            NimLog.e(TAG,"inviterAccountId can not be self account");
            return false;
        }
        if(TextUtils.isEmpty(requestId)){
            NimLog.e(TAG,"requestId is invalid");
            return false;
        }
        return true;
    }

    /**
     * 接受别人邀请加入信令房间请求参数构造器
     */
    public static class Builder {

        private final V2NIMSignallingAcceptInviteParams params;

        /**
         * 构造接受别人邀请加入信令房间请求参数构造器
         *
         * @param channelId 信令频道ID
         * @param inviterAccountId 邀请者账号ID
         * @param requestId 请求ID
         */
        public Builder(String channelId, String inviterAccountId, String requestId) {
            params = new V2NIMSignallingAcceptInviteParams(channelId, inviterAccountId, requestId);
        }

        /**
         * 设置服务器扩展字段
         *
         * @param serverExtension 服务器扩展字段
         * @return Builder
         */
        public Builder serverExtension(String serverExtension) {
            params.setServerExtension(serverExtension);
            return this;
        }

        /**
         * 设置是否需要存离线消息
         *
         * @param offlineEnabled 是否需要存离线消息
         * @return Builder
         */
        public Builder offlineEnabled(boolean offlineEnabled) {
            params.setOfflineEnabled(offlineEnabled);
            return this;
        }

        /**
         * 构建接受别人邀请加入信令房间请求参数
         *
         * @return 接受别人邀请加入信令房间请求参数
         */
        public V2NIMSignallingAcceptInviteParams build() {
            return params;
        }
    }
}