V2NIMSignallingCallParams.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.V2NIMSignallingConfig;
import com.netease.nimlib.sdk.v2.avsignalling.config.V2NIMSignallingPushConfig;
import com.netease.nimlib.sdk.v2.avsignalling.config.V2NIMSignallingRtcConfig;
import com.netease.nimlib.sdk.v2.avsignalling.enums.V2NIMSignallingChannelType;
 
/**
 * 直接呼叫请求参数
 */
public class V2NIMSignallingCallParams {
 
    private static final String TAG = "V2NIMSignallingCallParams";
 
    /**
     * 被呼叫者账号ID，参数为空，或者为空串，返回参数错误
     */
    private final String calleeAccountId;
 
    /**
     * 请求ID，可以用UUID实现，主要为了便于业务实现请求响应绑定，参数为空，或者为空串，返回参数错误
     */
    private final String requestId;
 
    /**
     * 频道类型，房间创建后跟频道类型绑定，必须为枚举类型之一，否则返回参数错误
     */
    private final V2NIMSignallingChannelType channelType;
 
    /**
     * 频道名称，建议使用与业务有相关场景的名称，便于页面显示
     */
    private String channelName;
 
    /**
     * 频道相关扩展字段，跟频道绑定，json格式，长度限制4096
     */
    private String channelExtension;
 
    /**
     * 服务器扩展字段，json格式，长度限制4096
     */
    private String serverExtension;
 
    /**
     * 信令相关配置
     */
    private V2NIMSignallingConfig signallingConfig;
 
    /**
     * 推送相关配置
     */
    private V2NIMSignallingPushConfig pushConfig;
 
    /**
     * 音视频相关参数配置
     */
    private V2NIMSignallingRtcConfig rtcConfig;
 
    private V2NIMSignallingCallParams() {
        this(null, null, null);
    }
 
    public V2NIMSignallingCallParams(String calleeAccountId, String requestId, V2NIMSignallingChannelType channelType) {
        this.calleeAccountId = calleeAccountId;
        this.requestId = requestId;
        this.channelType = channelType;
    }
 
    /**
     * 获取被呼叫者账号ID
     *
     * @return 被呼叫者账号ID
     */
    public String getCalleeAccountId() {
        return calleeAccountId;
    }
 
 
    /**
     * 获取请求ID
     *
     * @return 请求ID
     */
    public String getRequestId() {
        return requestId;
    }
 
 
    /**
     * 获取频道类型
     *
     * @return 频道类型
     */
    public V2NIMSignallingChannelType getChannelType() {
        return channelType;
    }
 
 
    /**
     * 获取频道名称
     *
     * @return 频道名称
     */
    public String getChannelName() {
        return channelName;
    }
 
    /**
     * 设置频道名称
     *
     * @param channelName 频道名称
     */
    public void setChannelName(String channelName) {
        this.channelName = channelName;
    }
 
    /**
     * 获取频道相关扩展字段
     *
     * @return 频道相关扩展字段
     */
    public String getChannelExtension() {
        return channelExtension;
    }
 
    /**
     * 设置频道相关扩展字段
     *
     * @param channelExtension 频道相关扩展字段
     */
    public void setChannelExtension(String channelExtension) {
        this.channelExtension = channelExtension;
    }
 
    /**
     * 获取服务器扩展字段
     *
     * @return 服务器扩展字段
     */
    public String getServerExtension() {
        return serverExtension;
    }
 
    /**
     * 设置服务器扩展字段
     *
     * @param serverExtension 服务器扩展字段
     */
    public void setServerExtension(String serverExtension) {
        this.serverExtension = serverExtension;
    }
 
    /**
     * 获取信令相关配置
     *
     * @return 信令相关配置
     */
    public V2NIMSignallingConfig getSignallingConfig() {
        return signallingConfig;
    }
 
    /**
     * 设置信令相关配置
     *
     * @param signallingConfig 信令相关配置
     */
    public void setSignallingConfig(V2NIMSignallingConfig signallingConfig) {
        this.signallingConfig = signallingConfig;
    }
 
    /**
     * 获取推送相关配置
     *
     * @return 推送相关配置
     */
    public V2NIMSignallingPushConfig getPushConfig() {
        return pushConfig;
    }
 
    /**
     * 设置推送相关配置
     *
     * @param pushConfig 推送相关配置
     */
    public void setPushConfig(V2NIMSignallingPushConfig pushConfig) {
        this.pushConfig = pushConfig;
    }
 
    /**
     * 获取音视频相关参数配置
     *
     * @return 音视频相关参数配置
     */
    public V2NIMSignallingRtcConfig getRtcConfig() {
        return rtcConfig;
    }
 
    /**
     * 设置音视频相关参数配置
     *
     * @param rtcConfig 音视频相关参数配置
     */
    public void setRtcConfig(V2NIMSignallingRtcConfig rtcConfig) {
        this.rtcConfig = rtcConfig;
    }
 
    /**
     * 参数是否合法
     * @return 是否合法
     */
    public boolean isValid() {
        if(TextUtils.isEmpty(calleeAccountId)){
            NimLog.e(TAG, "calleeAccountId is empty");
            return false;
        }
        if(calleeAccountId.equals(SDKCacheUI.getAccount())){
            NimLog.e(TAG, "calleeAccountId is self");
            return false;
        }
        if(TextUtils.isEmpty(requestId)){
            NimLog.e(TAG, "requestId is empty");
            return false;
        }
        if(channelType == null){
            NimLog.e(TAG, "channelType is null");
            return false;
        }
 
        return true;
    }
 
    /**
     * 直接呼叫请求参数构造器
     */
    public static class Builder {
 
        private final V2NIMSignallingCallParams params;
 
        /**
         * 构造直接呼叫请求参数构造器
         *
         * @param calleeAccountId 被呼叫者账号ID
         * @param requestId       请求ID
         * @param channelType     频道类型
         */
        public Builder(String calleeAccountId, String requestId, V2NIMSignallingChannelType channelType) {
            params = new V2NIMSignallingCallParams(calleeAccountId, requestId, channelType);
        }
 
 
        /**
         * 设置频道名称
         *
         * @param channelName 频道名称
         * @return Builder
         */
        public Builder channelName(String channelName) {
            params.setChannelName(channelName);
            return this;
        }
 
        /**
         * 设置频道相关扩展字段
         *
         * @param channelExtension 频道相关扩展字段
         * @return Builder
         */
        public Builder channelExtension(String channelExtension) {
            params.setChannelExtension(channelExtension);
            return this;
        }
 
        /**
         * 设置服务器扩展字段
         *
         * @param serverExtension 服务器扩展字段
         * @return Builder
         */
        public Builder serverExtension(String serverExtension) {
            params.setServerExtension(serverExtension);
            return this;
        }
 
        /**
         * 设置信令相关配置
         *
         * @param signallingConfig 信令相关配置
         * @return Builder
         */
        public Builder signallingConfig(V2NIMSignallingConfig signallingConfig) {
            params.setSignallingConfig(signallingConfig);
            return this;
        }
 
        /**
         * 设置推送相关配置
         *
         * @param pushConfig 推送相关配置
         * @return Builder
         */
        public Builder pushConfig(V2NIMSignallingPushConfig pushConfig) {
            params.setPushConfig(pushConfig);
            return this;
        }
 
        /**
         * 设置音视频相关参数配置
         *
         * @param rtcConfig 音视频相关参数配置
         * @return Builder
         */
        public Builder rtcConfig(V2NIMSignallingRtcConfig rtcConfig) {
            params.setRtcConfig(rtcConfig);
            return this;
        }
 
        /**
         * 构建直接呼叫请求参数
         *
         * @return 直接呼叫请求参数
         */
        public V2NIMSignallingCallParams build() {
            return params;
        }
    }
 
}