V2NIMSignallingCancelInviteParams.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 com.netease.nimlib.sdk.v2.avsignalling.config.V2NIMSignallingPushConfig;
import java.util.Objects;

/**
 * 取消之前的邀请成员加入信令房间请求参数
 */
public class V2NIMSignallingCancelInviteParams {

    private static final String TAG = "V2NIMSignallingCancelInviteParams";

    /**
     * 信令频道ID，唯一标识了该频道房间
     */
    private final String channelId;

    /**
     * 被邀请者账号ID
     */
    private final String inviteeAccountId;

    /**
     * 请求ID，可以用UUID实现，主要为了便于业务实现请求响应绑定
     */
    private final String requestId;

    /**
     * 服务器扩展字段，长度限制4096，json格式
     */
    private String serverExtension;

    /**
     * 是否需要存离线消息
     */
    private boolean offlineEnabled = true;

    /**
     * 推送相关配置
     */
    private V2NIMSignallingPushConfig pushConfig;

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

    public V2NIMSignallingCancelInviteParams(String channelId, String inviteeAccountId, String requestId) {
        this.channelId = channelId;
        this.inviteeAccountId = inviteeAccountId;
        this.requestId = requestId;
    }

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

    /**
     * 获取被邀请者账号ID
     *
     * @return 被邀请者账号ID
     */
    public String getInviteeAccountId() {
        return inviteeAccountId;
    }

    /**
     * 获取请求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 V2NIMSignallingPushConfig getPushConfig() {
        return pushConfig;
    }

    /**
     * 设置推送相关配置
     *
     * @param pushConfig 推送相关配置
     */
    public void setPushConfig(V2NIMSignallingPushConfig pushConfig) {
        this.pushConfig = pushConfig;
    }

    /**
     * 参数是否合法
     * @return 是否合法
     */
    public boolean isValid(){
        if(TextUtils.isEmpty(channelId)){
            NimLog.e(TAG,"channelId is invalid");
            return false;
        }
        if(TextUtils.isEmpty(inviteeAccountId)){
            NimLog.e(TAG,"inviterAccountId is invalid");
            return false;
        }
        if(Objects.equals(inviteeAccountId, 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 V2NIMSignallingCancelInviteParams params;

        public Builder(String channelId, String inviteeAccountId, String requestId) {
            params = new V2NIMSignallingCancelInviteParams(channelId, inviteeAccountId, requestId);
        }

        /**
         * 设置服务器扩展字段
         *
         * @param serverExtension 服务器扩展字段
         * @return 取消邀请请求参数构造器
         */
        public Builder serverExtension(String serverExtension) {
            params.setServerExtension(serverExtension);
            return this;
        }

        /**
         * 设置是否需要存离线消息
         *
         * @param offlineEnabled 是否需要存离线消息
         * @return 取消邀请请求参数构造器
         */
        public Builder offlineEnabled(boolean offlineEnabled) {
            params.setOfflineEnabled(offlineEnabled);
            return this;
        }

        /**
         * 设置推送相关配置
         *
         * @param pushConfig 推送相关配置
         * @return 取消邀请请求参数构造器
         */
        public Builder pushConfig(V2NIMSignallingPushConfig pushConfig) {
            params.setPushConfig(pushConfig);
            return this;
        }

        /**
         * 构建取消邀请请求参数
         *
         * @return 取消邀请请求参数
         */
        public V2NIMSignallingCancelInviteParams build() {
            return params;
        }
    }
}