QChatServiceObserver.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.invocation.ObserverInterface;
import com.netease.nimlib.sdk.Observer;
import com.netease.nimlib.sdk.msg.model.AttachmentProgress;
import com.netease.nimlib.sdk.qchat.event.QChatKickedOutEvent;
import com.netease.nimlib.sdk.qchat.event.QChatMessageDeleteEvent;
import com.netease.nimlib.sdk.qchat.event.QChatMessageRevokeEvent;
import com.netease.nimlib.sdk.qchat.event.QChatMessageUpdateEvent;
import com.netease.nimlib.sdk.qchat.event.QChatMultiSpotLoginEvent;
import com.netease.nimlib.sdk.qchat.event.QChatServerUnreadInfoChangedEvent;
import com.netease.nimlib.sdk.qchat.event.QChatStatusChangeEvent;
import com.netease.nimlib.sdk.qchat.event.QChatSystemNotificationUpdateEvent;
import com.netease.nimlib.sdk.qchat.event.QChatUnreadInfoChangedEvent;
import com.netease.nimlib.sdk.qchat.model.QChatMessage;
import com.netease.nimlib.sdk.qchat.model.QChatPushConfig;
import com.netease.nimlib.sdk.qchat.model.QChatSystemNotification;
import com.netease.nimlib.sdk.qchat.model.QChatTypingEvent;
import java.util.List;

@NIMService("圈组观察者")
@ObserverInterface
public interface QChatServiceObserver {
    /**
     * 注册/注销圈组在线状态/登录状态观察者
     *
     * @param observer 观察者, 参数为圈组当前状态
     * @param register true为注册，false为注销
     */
    void observeStatusChange(Observer<QChatStatusChangeEvent> observer, boolean register);

    /**
     * 注册/注销多端登录状态观察者。当有其他端登录或者注销时，会通过此接口通知到UI。<br>
     * 登录成功后，如果有其他端登录着，也会发出通知。<br>
     *
     * @param observer 观察者，参数为登录或者登出的其他端信息。<br>
     * @param register true为注册，false为注销
     */
    void observeMultiSpotLogin(Observer<QChatMultiSpotLoginEvent> observer, boolean register);

    /**
     * 注册/注销被踢出圈组观察者。
     *
     * @param observer 观察者, 参数为被踢出的事件
     * @param register true为注册，false为注销
     */
    void observeKickedOut(Observer<QChatKickedOutEvent> observer, boolean register);

    /**
     * 注册/注销消息接收观察者。
     *
     * @param observer 观察者，参数为收到的消息集合
     * @param register true为注册，false为注销
     */
    void observeReceiveMessage(Observer<List<QChatMessage>> observer, boolean register);

    /**
     * 注册/注销消息更新观察者
     *
     * @param observer 观察者，参数为改变的消息事件
     * @param register true为注册，false为注销
     */
    void observeMessageUpdate(Observer<QChatMessageUpdateEvent> observer, boolean register);

    /**
     * 注册/注销消息撤回观察者
     *
     * @param observer 观察者，参数为撤回的消息事件
     * @param register true为注册，false为注销
     */
    void observeMessageRevoke(Observer<QChatMessageRevokeEvent> observer, boolean register);

    /**
     * 注册/注销消息删除观察者
     *
     * @param observer 观察者，参数为删除的消息事件
     * @param register true为注册，false为注销
     */
    void observeMessageDelete(Observer<QChatMessageDeleteEvent> observer, boolean register);

    /**
     * 注册/注销新的未读通知接收观察者。
     * 订阅、标记消息已读、收到新消息或新消息通知会触发该通知
     * 通知事件内的新未读状态可能没有实际变更，比如重复调用订阅接口触发的变更事件
     *
     * @param observer 观察者，参数为收到的消息集合
     * @param register true为注册，false为注销
     */
    void observeUnreadInfoChanged(Observer<QChatUnreadInfoChangedEvent> observer, boolean register);

    /**
     * 注册/注销服务器未读通知接收观察者。
     * 订阅、标记消息已读、收到新消息或新消息通知会触发该通知
     * 如果服务器前后未读数没有发生变化将不会触发
     *
     * @param observer 观察者，参数为收到的消息集合
     * @param register true为注册，false为注销
     */
    void observeServerUnreadInfoChanged(Observer<QChatServerUnreadInfoChangedEvent> observer, boolean register);

    /**
     * 注册/注销消息状态变化观察者
     *
     * @param observer 观察者，参数为改变的消息体，更改的状态可能包含status和attachStatus
     * @param register true为注册，false为注销
     */
    void observeMessageStatusChange(Observer<QChatMessage> observer, boolean register);

    /**
     * 注册/注销消息附件上传/下载进度观察者，以message id作为key
     *
     * @param observer 观察者， 参数为附件的传输进度
     * @param register true为注册，false为注销
     */
    void observeAttachmentProgress(Observer<AttachmentProgress> observer, boolean register);

    /**
     * 注册/注销系统通知接收事件观察者
     * @param observer 观察者， 参数为接收到的系统消息
     * @param register true为注册，false为注销
     */
    void observeReceiveSystemNotification(Observer<List<QChatSystemNotification>> observer, boolean register);

    /**
     * 注册/注销系统通知更新观察者
     *
     * @param observer 观察者，参数为改变的系统通知事件
     * @param register true为注册，false为注销
     */
    void observeSystemNotificationUpdate(Observer<QChatSystemNotificationUpdateEvent> observer, boolean register);

    /**
     * 注册/注销推送免打扰配置更新观察者
     * @param observer 观察者，参数为推送免打扰配置更新的通知事件
     * @param register true为注册，false为注销
     */
    void observePushNoDisturbConfigUpdate(Observer<QChatPushConfig> observer, boolean register);

    /**
     * 注册/注销正在输入事件观察者
     * @param observer 观察者， 参数为接收到的消息正在输入事件
     * @param register true为注册，false为注销
     */
    void observeReceiveTypingEvent(Observer<QChatTypingEvent> observer, boolean register);
}