InviteParamBuilder.java

浏览该文件的文档.

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

import android.text.TextUtils;

import com.netease.nimlib.avsignalling.model.InviteParam;
import com.netease.nimlib.sdk.avsignalling.event.CanceledInviteEvent;
import com.netease.nimlib.sdk.avsignalling.event.InvitedEvent;
import com.netease.nimlib.sdk.avsignalling.model.SignallingPushConfig;

/**
 * 构造邀请相关操作的参数 ，其中channelId、accountId、requestId 这3个参数必须设置
 */
public class InviteParamBuilder {

    private String channelId;
    private String accountId;
    private String requestId;
    private String customInfo;
    private SignallingPushConfig pushConfig;
    private boolean offlineEnabled;

    /**
     * @param channelId 频道id
     * @param accountId 对方帐号id。
     *                  eg : 邀请与取消邀请时填被邀请人id ，拒绝邀请与接受邀请时填邀请人id
     * @param requestId 对本次邀请的唯一标识。<br/>
     *                  发起邀请者需要自行生成(要保证唯一性，不同的邀不能用同一个id)，取消邀请时需要传入同一个requestId。<br/>
     *                  对于接收方 ， requestId可以在收到相应通知时获取，参考{@link InvitedEvent#getRequestId()}和{@link CanceledInviteEvent#getRequestId()}
     */
    public InviteParamBuilder(String channelId, String accountId, String requestId) {
        this.channelId = channelId;
        this.accountId = accountId;
        this.requestId = requestId;
    }

    /**
     * @param customInfo 自定义扩展字段，透传给接收方
     * @return InviteParamBuilder
     */
    public InviteParamBuilder customInfo(String customInfo) {
        this.customInfo = customInfo;
        return this;
    }

    /**
     * @param signallingPushConfig 推送配置 ，仅在发出邀请时有效
     * @return InviteParamBuilder
     */
    public InviteParamBuilder pushConfig(SignallingPushConfig signallingPushConfig) {
        this.pushConfig = signallingPushConfig;
        return this;
    }

    /**
     * @param offlineEnabled 相应的通知事件是否存离线 ， 默认不离线
     * @return InviteParamBuilder
     */
    public InviteParamBuilder offlineEnabled(boolean offlineEnabled) {
        this.offlineEnabled = offlineEnabled;
        return this;
    }

    public InviteParam build() {
        if (TextUtils.isEmpty(channelId) || TextUtils.isEmpty(accountId) || TextUtils.isEmpty(requestId)) {
            throw new IllegalArgumentException("InviteParamBuilder  illegal , (channelId , accountId , requestId) parameters must not null");
        }
        return new InviteParam(channelId, accountId, requestId, customInfo, offlineEnabled, pushConfig);
    }


}