V2NIMLoginService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.auth;

import androidx.annotation.Nullable;

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.auth.enums.V2NIMConnectStatus;
import com.netease.nimlib.sdk.v2.auth.enums.V2NIMLoginStatus;
import com.netease.nimlib.sdk.v2.auth.model.V2NIMDataSyncDetail;
import com.netease.nimlib.sdk.v2.auth.model.V2NIMKickedOfflineDetail;
import com.netease.nimlib.sdk.v2.auth.model.V2NIMLoginClient;
import com.netease.nimlib.sdk.v2.auth.option.V2NIMLoginOption;

import java.util.List;

/**
 *  V2登录服务类 负责登录，注销和相关状态的获取
 */
public interface V2NIMLoginService {

    /**
     *  登录
     *
     *  @param accountId
     *  @param token
     *  @param option
     *  @param success 成功回调
     *  @param failure 失败回调
     */
    void login(String accountId, String token, V2NIMLoginOption option, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 登出
     *
     * @param success 成功回调
     * @param failure 失败回调
     */
    void logout(V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  获取当前登录用户
     *
     *  @return 返回当前登录用户账号
     *
     *  @note
     */
    @Nullable
    String getLoginUser();

    /**
     *  获取登录状态
     *
     *  @return 返回当前登录状态
     */
    V2NIMLoginStatus getLoginStatus();

    /**
     * 获取当前登录终端相关信息， 在登录成功后才能获取，否则内容为空
     * @return
     */
    V2NIMLoginClient getCurrentLoginClient();

    /**
     *  获取登录客户端列表（不包含当前端）
     *
     *  @return 返回当前登录客户端列表（不包含当前端）
     */
    List<V2NIMLoginClient> getLoginClients();

    /**
     *  踢掉登录客户端下线
     *
     *  @param client
     *  @param success 成功回调
     *  @param failure 失败回调
     */
    void kickOffline(V2NIMLoginClient client, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  获取被踢下线原因
     *
     *  @return 返回被踢下线原因
     */
    @Nullable
    V2NIMKickedOfflineDetail getKickedOfflineDetail();

    /**
     *  获取连接状态
     *
     *  @return 返回当前连接状态
     */
    V2NIMConnectStatus getConnectStatus();

    /**
     *  获取当前数据同步项
     *
     *  @return 返回当前数据同步项
     */
    List<V2NIMDataSyncDetail> getDataSync();

    /**
     *  获取聊天室link地址
     *  需要IM处于登录状态
     *
     *  @param roomId 聊天室ID
     *  @param success 成功回调
     *  @param failure 失败回调
     */
    void getChatroomLinkAddress(String roomId, V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);

    /**
     *  设置获取重连延时回调
     *
     *  @param provider
     */
    void setReconnectDelayProvider(V2NIMReconnectDelayProvider provider);

    /**
     *  添加登录监听
     *
     *  @param listener
     */
    void addLoginListener(V2NIMLoginListener listener);

    /**
     *  移除登录监听
     *
     *  @param listener
     */
    void removeLoginListener(V2NIMLoginListener listener);

    /**
     *  添加登录详情监听
     *
     *  @param listener
     */
    void addLoginDetailListener(V2NIMLoginDetailListener listener);

    /**
     *  移除登录详情监听
     *
     *  @param listener
     */
    void removeLoginDetailListener(V2NIMLoginDetailListener listener);
}