AuthServiceObserver.java

浏览该文件的文档.

package com.netease.nimlib.sdk.auth;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.invocation.ObserverInterface;
import com.netease.nimlib.sdk.Observer;
import com.netease.nimlib.sdk.StatusCode;
import com.netease.nimlib.sdk.auth.constant.LoginSyncStatus;

import java.util.List;

/**
 * 用户认证服务观察者接口。
 */
@NIMService("用户认证服务观察者")
@ObserverInterface
public interface AuthServiceObserver {

    /**
     * 注册/注销在线状态变化回调，监听当前账户登录状态的变化。<br>
     * 注册后，观察者（Observer）的 onEvent 回调函数会被立即调用一次，告知观察者当前账户的登录状态。
     * @par 参考：
     * 云信账号登录状态变更逻辑请参考[登录状态转换流程](https://doc.yunxin.163.com/messaging/docs/TI1MTU1NDc?platform=android#登录状态转换流程)。
     * @par 调用时机：
     * 建议在登录前调用该方法。
     * @par 注意事项：
     * 如果通过云信 IM 服务端接口封禁 IM 账号，封禁时配置了 kickNotifyExt，则会表现在 onEvent 回调函数中。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>**参数名称**</th>
     * <th>**描述**</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者，参数为当前状态</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>注册/注销回调，true为注册，false为注销</td>
     * </tr>
     * </table>
     */
    void observeOnlineStatus(Observer<StatusCode> observer, boolean register);

    /**
     * 注册/注销多端登录状态回调，监听其他端的登录信息。
     * @par 注意事项：
     * 本端无论是已登录还是未登录状态，如有其他端使用相同的 IM 账号登录或注销，本端都会收到通知，会通过此接口通知到 UI。登录成功后，如果有其他端登录着，也会发出通知。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>**参数名称**</th>
     * <th>**描述**</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者，参数为同时登录的其他端信息<br>如果有其他端注销，参数为剩余的在线端；如果没有剩余在线端，参数为 null</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>注册/注销回调，true为注册，false为注销</td>
     * </tr>
     * </table>
     */
    void observeOtherClients(Observer<List<OnlineClient>> observer, boolean register);

    /**
     * 注册/注销登录后的数据同步回调，监听登录后的数据同步状态。
     * @par 注意事项：
     * 登录 IM 成功后，SDK 会自动同步群信息，离线消息，漫游消息，系统通知等数据。数据同步完成时，整个登录过程才算真正完成。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>**参数名称**</th>
     * <th>**描述**</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者，参数为同步数据的过程状态（开始/结束）</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>注册/注销回调，true为注册，false为注销</td>
     * </tr>
     * </table>
     */
    void observeLoginSyncDataStatus(Observer<LoginSyncStatus> observer, boolean register);


    /**
     * 注册/注销登录后的群组成员数据同步回调，监听登录后的数据同步状态。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>**参数名称**</th>
     * <th>**描述**</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者，参数为同步结果（成功/失败）</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>注册/注销回调，true为注册，false为注销</td>
     * </tr>
     * </table>
     */
    void observeLoginSyncTeamMembersCompleteResult(Observer<Boolean> observer, boolean register);

    /**
     * 注册/注销登录后的超大群成员数据同步回调，监听登录后的数据同步状态。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>**参数名称**</th>
     * <th>**描述**</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者，参数为同步结果（成功/失败）</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>注册/注销回调，true为注册，false为注销</td>
     * </tr>
     * </table>
     */
    void observeLoginSyncSuperTeamMembersCompleteResult(Observer<Boolean> observer, boolean register);

    /**
     * 注册/注销数据准备完成的通知
     *
     * @param observer 观察者
     * @param register true为注册，false为注销
     */
    void observeDataReady(Observer<Void> observer, boolean register);
}