ChatRoomServiceObserver.java

浏览该文件的文档.

package com.netease.nimlib.sdk.chatroom;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.invocation.ObserverInterface;
import com.netease.nimlib.sdk.Observer;
import com.netease.nimlib.sdk.chatroom.model.CdnRequestData;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomKickOutEvent;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomMessage;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomStatusChangeData;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomTagsUpdateEvent;
import com.netease.nimlib.sdk.msg.model.AttachmentProgress;

import java.util.List;

/**
 * 聊天室监听
 */
@NIMService("聊天室观察者")
@ObserverInterface
public interface ChatRoomServiceObserver {

    /**
     * 注册/注销聊天室在线状态/登录状态观察者
     *
     * @param observer 观察者, 参数为聊天室ID和聊天室状态（未进入、连接中、进入中、已进入）
     * @param register true为注册，false为注销
     */
    public void observeOnlineStatus(Observer<ChatRoomStatusChangeData> observer, boolean register);

    /**
     * 注册/注销被踢出聊天室观察者。
     *
     * @param observer 观察者, 参数为被踢出的事件（可以获取被踢出的聊天室ID和被踢出的原因）
     * @param register true为注册，false为注销
     */
    public void observeKickOutEvent(Observer<ChatRoomKickOutEvent> observer, boolean register);

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

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

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

    /**
     * 注册/注销SDK数据上报观察者
     *
     * @param observer 观察者
     * @param register true为注册，false为注销
     */
    public void observeCdnRequestData(Observer<CdnRequestData> observer, boolean register);

    /**
     * 注册/注销我的标签更新观察者
     *
     * @param observer 观察者
     * @param register true为注册，false为注销
     */
    public void observeTagsUpdate(Observer<ChatRoomTagsUpdateEvent> observer, boolean register);
}