MsgServiceObserve.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg;

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.msg.model.BroadcastMessage;
import com.netease.nimlib.sdk.msg.model.CustomNotification;
import com.netease.nimlib.sdk.msg.model.HandleQuickCommentOption;
import com.netease.nimlib.sdk.msg.model.IMMessage;
import com.netease.nimlib.sdk.msg.model.MessageReceipt;
import com.netease.nimlib.sdk.msg.model.MsgPinSyncResponseOption;
import com.netease.nimlib.sdk.msg.model.RecentContact;
import com.netease.nimlib.sdk.msg.model.RecentSession;
import com.netease.nimlib.sdk.msg.model.RevokeMsgNotification;
import com.netease.nimlib.sdk.msg.model.RoamMsgHasMoreOption;
import com.netease.nimlib.sdk.msg.model.SessionMsgDeleteOption;
import com.netease.nimlib.sdk.msg.model.StickTopSessionInfo;
import com.netease.nimlib.sdk.msg.model.TeamMessageReceipt;
import java.util.List;

/**
 * 云信 IM 消息服务观察者接口类，提供消息、会话等服务的监听接口。
 */
@NIMService("消息服务观察者")
@ObserverInterface
public interface MsgServiceObserve {
    /**
     * 注册/注销消息接收的观察者。
     *
     * 该方法用于监听消息接收的通知。当 SDK 接收到消息接收通知时，会通知所有注册的观察者对象，并将消息体作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 注意事项：
     * 消息列表中除接收的消息，还包括其他端同步的消息，及调用 {@link MsgService#saveMessageToLocal} 通知的消息。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 {@link IMMessage} 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeReceiveMessage(Observer<List<IMMessage>> observer, boolean register);

    /**
     * 注册/注销消息状态的观察者。
     *
     * 该方法用于监听消息状态变化。当 SDK 接收到消息状态变化时，会通知所有注册的观察者对象，并将消息体为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 {@link IMMessage} 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeMsgStatus(Observer<IMMessage> observer, boolean register);

    /**
     * 注册/注销消息已读回执的观察者。
     *
     * 该方法用于监听消息已读回执。当 SDK 接收到消息已读回执时，会通知所有注册的观察者对象，并将消息已读回执作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 MessageReceipt 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeMessageReceipt(Observer<List<MessageReceipt>> observer, boolean register);

    /**
     * 注册/注销群消息已读回执的观察者。
     *
     * 该方法用于监听群消息已读回执。当 SDK 接收到群消息已读回执通知时，会通知所有注册的观察者对象，并将回执信息作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 TeamMessageReceipt 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeTeamMessageReceipt(Observer<List<TeamMessageReceipt>> observer, boolean register);

    /**
     * 注册/注销消息附件上传或下载进度的观察者。
     *
     * 该方法用于监听消息附件上传或下载的进度。当 SDK 接收到附件上传或下载进度更新时，会通知所有注册的观察者对象，并将进度信息作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 AttachmentProgress 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeAttachmentProgress(Observer<AttachmentProgress> observer, boolean register);

    /**
     * 注册/注销最近联系人列表的观察者。
     *
     * 该方法用于监听最近联系人列表变化。当 SDK 接收到最近联系人列表变化时，会通知所有注册的观察者对象，并将最近联系人列表作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 RecentContact 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeRecentContact(Observer<List<RecentContact>> observer, boolean register);

    /**
     * 注册/注销最近联系人删除操作的观察者。
     *
     * 该方法用于监听最近联系人删除操作。当 SDK 接收到最近联系人删除操作通知时，会通知所有注册的观察者对象，并将最近联系人作信息为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 注意事项：
     * <ul><li>除主动调用 {@link MsgService#deleteRecentContact}，其他最近联系人的删除事件同样会触发该回调。</li><li>如果整个联系人列表被删除，observer 为 null。</li></ul>
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告被删除的 RecentContact 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeRecentContactDeleted(Observer<RecentContact> observer, boolean register);

    /**
     * 注册/注销自定义通知接收的观察者。
     *
     * 该方法用于监听自定义通知的接收。当 SDK 接收到一条自定义通知时，会通知所有注册的观察者对象，并将该自定义通知作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 CustomNotification 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeCustomNotification(Observer<CustomNotification> observer, boolean register);

    /**
     * 注册/注销消息撤回操作的观察者。
     *
     * 该方法用于监听消息撤回操作的同步响应。当 SDK 接收到消息撤回操作的同步响应时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 RevokeMsgNotification 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeRevokeMessage(Observer<RevokeMsgNotification> observer, boolean register);

    /**
     * 注册/注销广播消息接收的观察者。
     *
     * 该方法用于监听广播消息的接收。当 SDK 接收到一条广播消息时，会通知所有注册的观察者对象，并将该广播消息作为参数传递给观察者对象的回调方法中。
     *
     * @par 使用前提：
     * <ul><li>已开通广播消息功能</li><li>集成 SDK 为 4.3.0 及以上版本</li></ul>
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 BroadcastMessage 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeBroadcastMessage(Observer<BroadcastMessage> observer, boolean register);

    /**
     * 注册/注销会话更新的观察者。
     *
     * 该方法用于监听会话更新。当 SDK 接收到会话更新时，会通知所有注册的观察者对象，并将最近会话作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 RecentSession 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeUpdateMySession(Observer<RecentSession> observer, boolean register);

    /**
     * 注册/注销单向删除一条消息操作的观察者。
     *
     * 该方法用于监听单向删除消息操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将消息体作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告被删除消息的 {@link IMMessage} 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeDeleteMsgSelf(Observer<IMMessage> observer, boolean register);

    /**
     * 注册/注销单向删除多条消息操作的观察者。
     *
     * 该方法用于监听单向删除消息操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将消息体作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告被删除消息的 {@link IMMessage} 信息列表。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeDeleteMsgSelfBatch(Observer<List<IMMessage>> observer, boolean register);

    /**
     * 注册/注销清除在线会话消息操作的观察者。
     *
     * 该方法用于监听清除在线会话消息操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将响应结果作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 SessionMsgDeleteOption 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeDeleteSessionHistoryMsgs(Observer<List<SessionMsgDeleteOption>> observer, boolean register);

    /**
     * 注册/注销漫游消息完整性的观察者。
     *
     * 该方法用于监听漫游消息完整性的同步响应结果。当 SDK 接收到漫游消息不完整的同步响应结果时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 RoamMsgHasMoreOption 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeRoamMsgHasMore(Observer<List<RoamMsgHasMoreOption>> observer, boolean register);

    /**
     * 注册/注销快捷评论操作的观察者。
     *
     * 该方法用于监听快捷评论操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将响应结果作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 HandleQuickCommentOption 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeAddQuickComment(Observer<HandleQuickCommentOption> observer, boolean register);

    /**
     * 注册/注销快捷评论删除操作的观察者。
     *
     * 该方法用于监听快捷评论删除操作的同步响应结果。当 SDK 接收到快捷评论删除操作的同步响应结果时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 HandleQuickCommentOption 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeRemoveQuickComment(Observer<HandleQuickCommentOption> observer, boolean register);

    /**
     * 注册/注销消息 PIN 操作的观察者。
     *
     * 该方法用于监听消息 PIN 操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将响应结果作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 MsgPinSyncResponseOption 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeAddMsgPin(Observer<MsgPinSyncResponseOption> observer, boolean register);

    /**
     * 注册/注销 PIN 消息更新的观察者。
     *
     * 该方法用于监听 PIN 消息更新的同步响应结果。当 SDK 接收到 PIN 消息更新的同步响应结果时，会通知所有注册的观察者对象，并将同步响应结果作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告更新的 MsgPinSyncResponseOption 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeUpdateMsgPin(Observer<MsgPinSyncResponseOption> observer, boolean register);

    /**
     * 注册/注销 PIN 消息移除操作的观察者。
     *
     * 该方法用于监听 PIN 消息移除操作的同步响应。当 SDK 接收到 PIN 消息移除操作的同步响应时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告移除的 MsgPinSyncResponseOption 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeRemoveMsgPin(Observer<MsgPinSyncResponseOption> observer, boolean register);

    /**
     * 注册/注销置顶会话多端同步的观察者。
     *
     * 该方法用于监听置顶会话多端同步的同步响应结果。当 SDK 接收到置顶会话多端同步的同步响应结果时，会通知所有注册的观察者对象，并将同步响应结果作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告同步的 StickTopSessionInfo 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeSyncStickTopSession(Observer<List<StickTopSessionInfo>> observer, boolean register);

    /**
     * 注册/注销消息置顶操作的观察者。
     *
     * 该方法用于监听消息置顶操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将响应结果作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 StickTopSessionInfo 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeAddStickTopSession(Observer<StickTopSessionInfo> observer, boolean register);

    /**
     * 注册/注销置顶会话移除操作的观察者。
     *
     * 该方法用于监听置顶会话移除操作的同步响应。当 SDK 接收到置顶会话移除操作的同步响应时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告移除的 StickTopSessionInfo 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeRemoveStickTopSession(Observer<StickTopSessionInfo> observer, boolean register);

    /**
     * 注册/注销置顶会话更新的观察者。
     *
     * 该方法用于监听置顶会话更新。当 SDK 接收到置顶会话更新通知时，会通知所有注册的观察者对象，并将置顶会话信息作为参数传递给观察者对象的回调方法中。
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告更新的的 StickTopSessionInfo 信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    void observeUpdateStickTopSession(Observer<StickTopSessionInfo> observer, boolean register);

    /**
     * 注册/注销消息更新的观察者。
     *
     * 该方法用于监听消息更新的通知。当 SDK 接收到消息更新通知时，会通知所有注册的观察者对象，并将消息体作为参数传递给观察者对象的回调方法中。
     *
     * @par 调用时机：
     * 在初始化 SDK 后，登录 IM 前调用。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>observer</td>
     * <td>观察者对象，通过 {@link Observer} 中的回调事件报告 {@link IMMessage} 列表信息。</td>
     * </tr>
     * <tr>
     * <td>register</td>
     * <td>是否注册观察者对象：<ul><li>true：（默认）注册观察者对象</li><li>false：注销观察者对象</li></ul></td>
     * </tr>
     * </table>
     * @return
     * 无返回值
     *
     */
    public void observeReceiveMessagesModified(Observer<List<IMMessage>> observer, boolean register);
}