CallExParam.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.avsignalling.constant.ChannelType;

public class CallExParam {

    private final ChannelType channelType;
    private final String accountId;
    private final String requestId;

    private String channelName;
    private String channelExt;
    private Long selfUid;
    private Boolean offlineEnable;
    private String customInfo;
    private SignallingPushConfig pushConfig;
    private String nertcChannelName;
    private Long nertcTokenTtl;
    private String nertcJoinRoomQueryParamMap;

    private CallExParam(ChannelType channelType, String accountId, String requestId) {
        this.channelType = channelType;
        this.accountId = accountId;
        this.requestId = requestId;
    }

    /**
     * 获取频道类型
     */
    public ChannelType getChannelType() {
        return channelType;
    }

    /**
     * 获取对方的accid
     */
    public String getAccountId() {
        return accountId;
    }

    /**
     * 获取邀请id
     */
    public String getRequestId() {
        return requestId;
    }

    /**
     * 获取频道名
     */
    public String getChannelName() {
        return channelName;
    }

    /**
     * 获取频道扩展字段
     */
    public String getChannelExt() {
        return channelExt;
    }

    /**
     * 获取自己的uid
     */
    public Long getSelfUid() {
        return selfUid;
    }

    /**
     * 相应的通知是否存离线
     */
    public Boolean getOfflineEnable() {
        return offlineEnable;
    }

    /**
     * 获取邀请者附加的自定义信息，透传给被邀请者
     */
    public String getCustomInfo() {
        return customInfo;
    }

    /**
     * 获取推送配置
     */
    public SignallingPushConfig getPushConfig() {
        return pushConfig;
    }

    /**
     * 获取云信G2-RTC的房间名
     */
    public String getNertcChannelName() {
        return nertcChannelName;
    }

    /**
     * 获取云信G2-RTC的token的有效期
     */
    public Long getNertcTokenTtl() {
        return nertcTokenTtl;
    }

    /**
     * 获取云信G2-RTC加入房间的请求参数
     */
    public String getNertcJoinRoomQueryParamMap() {
        return nertcJoinRoomQueryParamMap;
    }

    public static final class CallExParamBuilder {
        private final ChannelType channelType;
        private final String accountId;
        private final String requestId;
        private String channelName;
        private String channelExt;
        private Long selfUid;
        private Boolean offlineEnable;
        private String customInfo;
        private SignallingPushConfig pushConfig;
        private String nertcChannelName;
        private Long nertcTokenTtl;
        private String nertcJoinRoomQueryParamMap;

        /***
         * @param channelType 频道类型
         * @param accountId 对方的accid
         * @param requestId 邀请id ，发起邀请者自行生成(要保证唯一性)
         */
        public CallExParamBuilder(ChannelType channelType, String accountId, String requestId) {
            this.channelType = channelType;
            this.accountId = accountId;
            this.requestId = requestId;
        }

        /**
         * 指定频道名
         */
        public CallExParamBuilder withChannelName(String channelName) {
            this.channelName = channelName;
            return this;
        }

        /**
         * 指定频道扩展字段
         */
        public CallExParamBuilder withChannelExt(String channelExt) {
            this.channelExt = channelExt;
            return this;
        }

        /**
         * 指定自己的uid，不指定的话，服务端会自动生成。如果指定请保持维一性
         */
        public CallExParamBuilder withSelfUid(Long selfUid) {
            this.selfUid = selfUid;
            return this;
        }

        /**
         * 指定相应的通知是否存离线
         */
        public CallExParamBuilder withOfflineEnable(Boolean offlineEnable) {
            this.offlineEnable = offlineEnable;
            return this;
        }

        /**
         * 指定邀请者附加的自定义信息，透传给被邀请者
         */
        public CallExParamBuilder withCustomInfo(String customInfo) {
            this.customInfo = customInfo;
            return this;
        }

        /**
         * 指定推送配置
         */
        public CallExParamBuilder withPushConfig(SignallingPushConfig pushConfig) {
            this.pushConfig = pushConfig;
            return this;
        }

        /**
         * 指定云信G2-RTC的房间名，如果填了该字段，则会返回token
         */
        public CallExParamBuilder withNertcChannelName(String nertcChannelName) {
            this.nertcChannelName = nertcChannelName;
            return this;
        }

        /**
         * 指定云信G2-RTC的token的有效期，单位秒,选填，默认10分钟
         */
        public CallExParamBuilder withNertcTokenTtl(Long nertcTokenTtl) {
            this.nertcTokenTtl = nertcTokenTtl;
            return this;
        }

        /**
         * 指定云信G2-RTC加入房间的请求参数，可转化为json的字符串
         */
        public CallExParamBuilder withNertcJoinRoomQueryParamMap(String nertcJoinRoomQueryParamMap) {
            this.nertcJoinRoomQueryParamMap = nertcJoinRoomQueryParamMap;
            return this;
        }

        public CallExParam build() {
            CallExParam callExParam = new CallExParam( this.channelType, this.accountId, this.requestId);
            callExParam.nertcChannelName = this.nertcChannelName;
            callExParam.channelExt = this.channelExt;
            callExParam.pushConfig = this.pushConfig;
            callExParam.channelName = this.channelName;
            callExParam.customInfo = this.customInfo;
            callExParam.nertcJoinRoomQueryParamMap = this.nertcJoinRoomQueryParamMap;
            callExParam.selfUid = this.selfUid;
            callExParam.offlineEnable = this.offlineEnable;
            callExParam.nertcTokenTtl = this.nertcTokenTtl;
            return callExParam;
        }
    }
}