云信 IM 消息服务观察者接口类，提供消息、会话等服务的监听接口。更多...

Public 成员函数
void	observeReceiveMessage (Observer< List< IMMessage >> observer, boolean register)
	注册/注销消息接收的观察者。更多...

void	observeMsgStatus (Observer< IMMessage > observer, boolean register)
	注册/注销消息状态的观察者。更多...

void	observeMessageReceipt (Observer< List< MessageReceipt >> observer, boolean register)
	注册/注销消息已读回执的观察者。更多...

void	observeTeamMessageReceipt (Observer< List< TeamMessageReceipt >> observer, boolean register)
	注册/注销群消息已读回执的观察者。更多...

void	observeAttachmentProgress (Observer< AttachmentProgress > observer, boolean register)
	注册/注销消息附件上传或下载进度的观察者。更多...

void	observeRecentContact (Observer< List< RecentContact >> observer, boolean register)
	注册/注销最近联系人列表的观察者。更多...

void	observeRecentContactDeleted (Observer< RecentContact > observer, boolean register)
	注册/注销最近联系人删除操作的观察者。更多...

void	observeCustomNotification (Observer< CustomNotification > observer, boolean register)
	注册/注销自定义通知接收的观察者。更多...

void	observeRevokeMessage (Observer< RevokeMsgNotification > observer, boolean register)
	注册/注销消息撤回操作的观察者。更多...

void	observeBroadcastMessage (Observer< BroadcastMessage > observer, boolean register)
	注册/注销广播消息接收的观察者。更多...

void	observeUpdateMySession (Observer< RecentSession > observer, boolean register)
	注册/注销会话更新的观察者。更多...

void	observeDeleteMsgSelf (Observer< IMMessage > observer, boolean register)
	注册/注销单向删除一条消息操作的观察者。更多...

void	observeDeleteMsgSelfBatch (Observer< List< IMMessage >> observer, boolean register)
	注册/注销单向删除多条消息操作的观察者。更多...

void	observeDeleteSessionHistoryMsgs (Observer< List< SessionMsgDeleteOption >> observer, boolean register)
	注册/注销清除在线会话消息操作的观察者。更多...

void	observeRoamMsgHasMore (Observer< List< RoamMsgHasMoreOption >> observer, boolean register)
	注册/注销漫游消息完整性的观察者。更多...

void	observeAddQuickComment (Observer< HandleQuickCommentOption > observer, boolean register)
	注册/注销快捷评论操作的观察者。更多...

void	observeRemoveQuickComment (Observer< HandleQuickCommentOption > observer, boolean register)
	注册/注销快捷评论删除操作的观察者。更多...

void	observeAddMsgPin (Observer< MsgPinSyncResponseOption > observer, boolean register)
	注册/注销消息 PIN 操作的观察者。更多...

void	observeUpdateMsgPin (Observer< MsgPinSyncResponseOption > observer, boolean register)
	注册/注销 PIN 消息更新的观察者。更多...

void	observeRemoveMsgPin (Observer< MsgPinSyncResponseOption > observer, boolean register)
	注册/注销 PIN 消息移除操作的观察者。更多...

void	observeSyncStickTopSession (Observer< List< StickTopSessionInfo >> observer, boolean register)
	注册/注销置顶会话多端同步的观察者。更多...

void	observeAddStickTopSession (Observer< StickTopSessionInfo > observer, boolean register)
	注册/注销消息置顶操作的观察者。更多...

void	observeRemoveStickTopSession (Observer< StickTopSessionInfo > observer, boolean register)
	注册/注销置顶会话移除操作的观察者。更多...

void	observeUpdateStickTopSession (Observer< StickTopSessionInfo > observer, boolean register)
	注册/注销置顶会话更新的观察者。更多...

详细描述

云信 IM 消息服务观察者接口类，提供消息、会话等服务的监听接口。

在文件 MsgServiceObserve.java 第 28 行定义.

成员函数说明

◆ observeAddMsgPin()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeAddMsgPin	(	Observer< MsgPinSyncResponseOption >	observer,
		boolean	register
	)

注册/注销消息 PIN 操作的观察者。

该方法用于监听消息 PIN 操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将响应结果作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 MsgPinSyncResponseOption 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeAddQuickComment()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeAddQuickComment	(	Observer< HandleQuickCommentOption >	observer,
		boolean	register
	)

注册/注销快捷评论操作的观察者。

该方法用于监听快捷评论操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将响应结果作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 HandleQuickCommentOption 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeAddStickTopSession()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeAddStickTopSession	(	Observer< StickTopSessionInfo >	observer,
		boolean	register
	)

注册/注销消息置顶操作的观察者。

该方法用于监听消息置顶操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将响应结果作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 StickTopSessionInfo 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeAttachmentProgress()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeAttachmentProgress	(	Observer< AttachmentProgress >	observer,
		boolean	register
	)

注册/注销消息附件上传或下载进度的观察者。

该方法用于监听消息附件上传或下载的进度。当 SDK 接收到附件上传或下载进度更新时，会通知所有注册的观察者对象，并将进度信息作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 AttachmentProgress 列表信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeBroadcastMessage()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeBroadcastMessage	(	Observer< BroadcastMessage >	observer,
		boolean	register
	)

注册/注销广播消息接收的观察者。

该方法用于监听广播消息的接收。当 SDK 接收到一条广播消息时，会通知所有注册的观察者对象，并将该广播消息作为参数传递给观察者对象的回调方法中。

使用前提：

已开通广播消息功能
集成 SDK 为 4.3.0 及以上版本

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 BroadcastMessage 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeCustomNotification()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeCustomNotification	(	Observer< CustomNotification >	observer,
		boolean	register
	)

注册/注销自定义通知接收的观察者。

该方法用于监听自定义通知的接收。当 SDK 接收到一条自定义通知时，会通知所有注册的观察者对象，并将该自定义通知作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 CustomNotification 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeDeleteMsgSelf()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeDeleteMsgSelf	(	Observer< IMMessage >	observer,
		boolean	register
	)

注册/注销单向删除一条消息操作的观察者。

该方法用于监听单向删除消息操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将消息体作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告被删除消息的 IMMessage 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeDeleteMsgSelfBatch()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeDeleteMsgSelfBatch	(	Observer< List< IMMessage >>	observer,
		boolean	register
	)

注册/注销单向删除多条消息操作的观察者。

该方法用于监听单向删除消息操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将消息体作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告被删除消息的 IMMessage 信息列表。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeDeleteSessionHistoryMsgs()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeDeleteSessionHistoryMsgs	(	Observer< List< SessionMsgDeleteOption >>	observer,
		boolean	register
	)

注册/注销清除在线会话消息操作的观察者。

该方法用于监听清除在线会话消息操作的同步响应结果。当 SDK 接收到同步响应结果时，会通知所有注册的观察者对象，并将响应结果作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 SessionMsgDeleteOption 列表信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeMessageReceipt()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeMessageReceipt	(	Observer< List< MessageReceipt >>	observer,
		boolean	register
	)

注册/注销消息已读回执的观察者。

该方法用于监听消息已读回执。当 SDK 接收到消息已读回执时，会通知所有注册的观察者对象，并将消息已读回执作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 MessageReceipt 列表信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeMsgStatus()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeMsgStatus	(	Observer< IMMessage >	observer,
		boolean	register
	)

注册/注销消息状态的观察者。

该方法用于监听消息状态变化。当 SDK 接收到消息状态变化时，会通知所有注册的观察者对象，并将消息体为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 IMMessage 列表信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeReceiveMessage()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeReceiveMessage	(	Observer< List< IMMessage >>	observer,
		boolean	register
	)

注册/注销消息接收的观察者。

该方法用于监听消息接收的通知。当 SDK 接收到消息接收通知时，会通知所有注册的观察者对象，并将消息体作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

注意事项：: 消息列表中除接收的消息，还包括其他端同步的消息，及调用 MsgService#saveMessageToLocal 通知的消息。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 IMMessage 列表信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeRecentContact()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeRecentContact	(	Observer< List< RecentContact >>	observer,
		boolean	register
	)

注册/注销最近联系人列表的观察者。

该方法用于监听最近联系人列表变化。当 SDK 接收到最近联系人列表变化时，会通知所有注册的观察者对象，并将最近联系人列表作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 RecentContact 列表信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeRecentContactDeleted()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeRecentContactDeleted	(	Observer< RecentContact >	observer,
		boolean	register
	)

注册/注销最近联系人删除操作的观察者。

该方法用于监听最近联系人删除操作。当 SDK 接收到最近联系人删除操作通知时，会通知所有注册的观察者对象，并将最近联系人作信息为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

注意事项：

除主动调用 MsgService#deleteRecentContact，其他最近联系人的删除事件同样会触发该回调。
如果整个联系人列表被删除，observer 为 null。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告被删除的 RecentContact 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeRemoveMsgPin()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeRemoveMsgPin	(	Observer< MsgPinSyncResponseOption >	observer,
		boolean	register
	)

注册/注销 PIN 消息移除操作的观察者。

该方法用于监听 PIN 消息移除操作的同步响应。当 SDK 接收到 PIN 消息移除操作的同步响应时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告移除的 MsgPinSyncResponseOption 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeRemoveQuickComment()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeRemoveQuickComment	(	Observer< HandleQuickCommentOption >	observer,
		boolean	register
	)

注册/注销快捷评论删除操作的观察者。

该方法用于监听快捷评论删除操作的同步响应结果。当 SDK 接收到快捷评论删除操作的同步响应结果时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 HandleQuickCommentOption 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeRemoveStickTopSession()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeRemoveStickTopSession	(	Observer< StickTopSessionInfo >	observer,
		boolean	register
	)

注册/注销置顶会话移除操作的观察者。

该方法用于监听置顶会话移除操作的同步响应。当 SDK 接收到置顶会话移除操作的同步响应时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告移除的 StickTopSessionInfo 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeRevokeMessage()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeRevokeMessage	(	Observer< RevokeMsgNotification >	observer,
		boolean	register
	)

注册/注销消息撤回操作的观察者。

该方法用于监听消息撤回操作的同步响应。当 SDK 接收到消息撤回操作的同步响应时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 RevokeMsgNotification 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeRoamMsgHasMore()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeRoamMsgHasMore	(	Observer< List< RoamMsgHasMoreOption >>	observer,
		boolean	register
	)

注册/注销漫游消息完整性的观察者。

该方法用于监听漫游消息完整性的同步响应结果。当 SDK 接收到漫游消息不完整的同步响应结果时，会通知所有注册的观察者对象，并将同步响应信息作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 RoamMsgHasMoreOption 列表信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeSyncStickTopSession()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeSyncStickTopSession	(	Observer< List< StickTopSessionInfo >>	observer,
		boolean	register
	)

注册/注销置顶会话多端同步的观察者。

该方法用于监听置顶会话多端同步的同步响应结果。当 SDK 接收到置顶会话多端同步的同步响应结果时，会通知所有注册的观察者对象，并将同步响应结果作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告同步的 StickTopSessionInfo 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeTeamMessageReceipt()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeTeamMessageReceipt	(	Observer< List< TeamMessageReceipt >>	observer,
		boolean	register
	)

注册/注销群消息已读回执的观察者。

该方法用于监听群消息已读回执。当 SDK 接收到群消息已读回执通知时，会通知所有注册的观察者对象，并将回执信息作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 TeamMessageReceipt 列表信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeUpdateMsgPin()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeUpdateMsgPin	(	Observer< MsgPinSyncResponseOption >	observer,
		boolean	register
	)

注册/注销 PIN 消息更新的观察者。

该方法用于监听 PIN 消息更新的同步响应结果。当 SDK 接收到 PIN 消息更新的同步响应结果时，会通知所有注册的观察者对象，并将同步响应结果作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告更新的 MsgPinSyncResponseOption 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeUpdateMySession()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeUpdateMySession	(	Observer< RecentSession >	observer,
		boolean	register
	)

注册/注销会话更新的观察者。

该方法用于监听会话更新。当 SDK 接收到会话更新时，会通知所有注册的观察者对象，并将最近会话作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告 RecentSession 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

◆ observeUpdateStickTopSession()

void com.netease.nimlib.sdk.msg.MsgServiceObserve.observeUpdateStickTopSession	(	Observer< StickTopSessionInfo >	observer,
		boolean	register
	)

注册/注销置顶会话更新的观察者。

该方法用于监听置顶会话更新。当 SDK 接收到置顶会话更新通知时，会通知所有注册的观察者对象，并将置顶会话信息作为参数传递给观察者对象的回调方法中。

调用时机：: 在初始化 SDK 后，登录 IM 前调用。

参数说明：

参数名称	描述
observer	观察者对象，通过 Observer 中的回调事件报告更新的的 StickTopSessionInfo 信息。
register	是否注册观察者对象： true：（默认）注册观察者对象 false：注销观察者对象

返回: 无返回值

该接口的文档由以下文件生成:

basesdk/src/com/netease/nimlib/sdk/msg/MsgServiceObserve.java

Public 成员函数

详细描述

成员函数说明

◆ observeAddMsgPin()

◆ observeAddQuickComment()

◆ observeAddStickTopSession()

◆ observeAttachmentProgress()

◆ observeBroadcastMessage()

◆ observeCustomNotification()

◆ observeDeleteMsgSelf()

◆ observeDeleteMsgSelfBatch()

◆ observeDeleteSessionHistoryMsgs()

◆ observeMessageReceipt()

◆ observeMsgStatus()

◆ observeReceiveMessage()

◆ observeRecentContact()

◆ observeRecentContactDeleted()

◆ observeRemoveMsgPin()

◆ observeRemoveQuickComment()

◆ observeRemoveStickTopSession()

◆ observeRevokeMessage()

◆ observeRoamMsgHasMore()

◆ observeSyncStickTopSession()

◆ observeTeamMessageReceipt()

◆ observeUpdateMsgPin()

◆ observeUpdateMySession()

◆ observeUpdateStickTopSession()