SignallingServiceObserver.java

浏览该文件的文档.

package com.netease.nimlib.sdk.avsignalling;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.invocation.ObserverInterface;
import com.netease.nimlib.sdk.Observer;
import com.netease.nimlib.sdk.avsignalling.constant.SignallingEventType;
import com.netease.nimlib.sdk.avsignalling.event.CanceledInviteEvent;
import com.netease.nimlib.sdk.avsignalling.event.ChannelCloseEvent;
import com.netease.nimlib.sdk.avsignalling.event.ChannelCommonEvent;
import com.netease.nimlib.sdk.avsignalling.event.ControlEvent;
import com.netease.nimlib.sdk.avsignalling.event.InviteAckEvent;
import com.netease.nimlib.sdk.avsignalling.event.InvitedEvent;
import com.netease.nimlib.sdk.avsignalling.event.KickEvent;
import com.netease.nimlib.sdk.avsignalling.event.MemberUpdateEvent;
import com.netease.nimlib.sdk.avsignalling.event.SyncChannelListEvent;
import com.netease.nimlib.sdk.avsignalling.event.UserJoinEvent;
import com.netease.nimlib.sdk.avsignalling.event.UserLeaveEvent;
import java.util.ArrayList;

@NIMService("音视频信令服务观察者")
@ObserverInterface
public interface SignallingServiceObserver {

    /**
     * 注册/注销 在线通知事件观察者
     * 回调返回参数为RoomCommonEvent的子类对象 ，如果用户想获取相应子类对象中的特殊属性，可以根据事件类型{@link ChannelCommonEvent#getEventType()}进行强制类型转换。<br/>
     * <br/>
     * 事件类型{@link SignallingEventType }与 ChannelCommonEvent 子类的对应关系如下：<br/>
     * {@link SignallingEventType#CLOSE} 对应于{@link ChannelCloseEvent}<br/>
     * {@link SignallingEventType#JOIN} 对应于{@link UserJoinEvent}<br/>
     * {@link SignallingEventType#INVITE} 对应于{@link InvitedEvent}<br/>
     * {@link SignallingEventType#CANCEL_INVITE} 对应于{@link CanceledInviteEvent}<br/>
     * {@link SignallingEventType#REJECT} 对应于{@link InviteAckEvent}<br/>
     * {@link SignallingEventType#ACCEPT} 对应于{@link InviteAckEvent}<br/>
     * {@link SignallingEventType#LEAVE} 对应于{@link UserLeaveEvent}<br/>
     * {@link SignallingEventType#CONTROL} 对应于{@link ControlEvent}<br/>
     * {@link SignallingEventType#KICK} 对应于{@link KickEvent}<br/>
     *
     * @param observer 观察者 ，参数为在线通知事件
     * @param register register true为注册，false为注销
     */
    void observeOnlineNotification(Observer<ChannelCommonEvent> observer, boolean register);


    /**
     * 注册/注销 离线通知事件观察者，在用户登录后sdk 会去服务器同步用户离线期间发生的各种通知，并以列表的形式返回。列表的排序方式为时间递增排序{@link ChannelCommonEvent#getTime()}<br/><br/>
     * 注意：登录后第一次注册此回调时，如果sdk已经获取到了相应的离线通知列表，会立即回调一次（仅此一次）。<br/><br/>
     * 回调返回列表中的元素为ChannelCommonEvent的子类对象 ，如果用户想获取相应子类对象中的特殊属性，可以根据事件类型{@link ChannelCommonEvent#getEventType()}进行强制类型转换。<br/><br/>
     * 事件类型{@link SignallingEventType }与 ChannelCommonEvent 子类的对应关系如下：<br/>
     * {@link SignallingEventType#CLOSE} 对应于{@link ChannelCloseEvent}<br/>
     * {@link SignallingEventType#JOIN} 对应于{@link UserJoinEvent}<br/>
     * {@link SignallingEventType#INVITE} 对应于{@link InvitedEvent}<br/>
     * {@link SignallingEventType#CANCEL_INVITE} 对应于{@link CanceledInviteEvent}<br/>
     * {@link SignallingEventType#REJECT} 对应于{@link InviteAckEvent}<br/>
     * {@link SignallingEventType#ACCEPT} 对应于{@link InviteAckEvent}<br/>
     * {@link SignallingEventType#LEAVE} 对应于{@link UserLeaveEvent}<br/>
     * {@link SignallingEventType#KICK} 对应于{@link KickEvent}<br/>
     *
     * @param observer 观察者 ，参数为离线通知事件列表
     * @param register register true为注册，false为注销
     */
    void observeOfflineNotification(Observer<ArrayList<ChannelCommonEvent>> observer, boolean register);


    /**
     * 注册/注销 其他端响应（接收/拒绝）邀请事件观察者，当其他端响应了邀请时触发
     *
     * @param observer 观察者 ，回调参数为其他端邀请响应事件
     * @param register register true为注册，false为注销
     */
    void observeOtherClientInviteAckNotification(Observer<InviteAckEvent> observer, boolean register);

    /**
     * 注册/注销 同步未退出频道列表事件观察者 ，在用户登录后sdk会去服务器获取当前还未退出的频道列表 。<br/><br/>
     * 注意：登录后第一次注册此回调时，如果sdk已经获取到了相应的频道列表，会立即回调一次（仅此一次）。
     *
     * @param observer 观察者，回调参数为未退出的频道列表
     * @param register register true为注册，false为注销
     */
    void observeSyncChannelListNotification(Observer<ArrayList<SyncChannelListEvent>> observer, boolean register);


    /**
     * 注册/注销 频道成员更新事件观察者
     *
     * @param observer 观察者，回调参数为成员更新事件，其中包含了最新的频道的完整信息(频道信息+成员列表)<br/><br/>
     *                 注意：如果是有成员离开或加入频道，正常情况下会优先通过{@link SignallingServiceObserver#observeOnlineNotification} 的回调来通知用户。<br/>
     *                 此回调的时机如下： 如果有成员信息的变更（而不是成员数量增减）或异常情况（有成员数量变更但是sdk没有回调{@link SignallingServiceObserver#observeOnlineNotification}）<br/>
     * @param register register true为注册，false为注销
     */
    void observeMemberUpdateNotification(Observer<MemberUpdateEvent> observer, boolean register);

}