NIMSDK-AOS  10.9.76
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService接口 参考

Public 成员函数

void getConversationList (long offset, int limit, V2NIMSuccessCallback< V2NIMConversationResult > success, V2NIMFailureCallback failure)
 获取会话列表 更多...
 
void getConversationListByOption (long offset, int limit, V2NIMConversationOption option, V2NIMSuccessCallback< V2NIMConversationResult > success, V2NIMFailureCallback failure)
 根据查询参数获取会话列表 更多...
 
void getConversation (@NonNull String conversationId, V2NIMSuccessCallback< V2NIMConversation > success, V2NIMFailureCallback failure)
 获取会话列表,通过会话id 更多...
 
void getConversationListByIds (@NonNull List< String > conversationIds, V2NIMSuccessCallback< List< V2NIMConversation >> success, V2NIMFailureCallback failure)
 根据会话id获取会话列表 更多...
 
void getStickTopConversationList (V2NIMSuccessCallback< List< V2NIMConversation >> success, V2NIMFailureCallback failure)
 查询当前全量置顶的会话列表 排序方式:倒序 更多...
 
void createConversation (@NonNull String conversationId, V2NIMSuccessCallback< V2NIMConversation > success, V2NIMFailureCallback failure)
 创建会话 更多...
 
void deleteConversation (@NonNull String conversationId, boolean clearMessage, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 删除会话 更多...
 
void deleteConversationListByIds (@NonNull List< String > conversationIds, boolean clearMessage, V2NIMSuccessCallback< List< V2NIMConversationOperationResult >> success, V2NIMFailureCallback failure)
 删除会话列表 更多...
 
void stickTopConversation (@NonNull String conversationId, boolean stickTop, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 置顶会话 更多...
 
void updateConversation (@NonNull String conversationId, V2NIMConversationUpdate updateInfo, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 更新会话 更多...
 
void updateConversationLocalExtension (@NonNull String conversationId, String localExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 更新会话本地扩展字段 更多...
 
int getTotalUnreadCount ()
 获取会话总未读数 更多...
 
void getUnreadCountByIds (@NonNull List< String > conversationIds, V2NIMSuccessCallback< Integer > success, V2NIMFailureCallback failure)
 根据会话id获取会话未读数 更多...
 
void getUnreadCountByFilter (V2NIMConversationFilter filter, V2NIMSuccessCallback< Integer > success, V2NIMFailureCallback failure)
 根据过滤条件获取相应的未读数 更多...
 
void clearTotalUnreadCount (V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 清空会话未读数 更多...
 
void clearUnreadCountByIds (@NonNull List< String > conversationIds, V2NIMSuccessCallback< List< V2NIMConversationOperationResult >> success, V2NIMFailureCallback failure)
 根据会话id清空会话未读数 更多...
 
void clearUnreadCountByGroupId (@NonNull String groupId, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 根据会话分组清空相应会话的未读数 更多...
 
void clearUnreadCountByTypes (@NonNull List< V2NIMConversationType > conversationTypes, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 根据会话类型清空相应会话的未读数 更多...
 
V2NIMError subscribeUnreadCountByFilter (@NonNull V2NIMConversationFilter filter)
 订阅指定过滤条件的会话未读数 更多...
 
V2NIMError unsubscribeUnreadCountByFilter (@NonNull V2NIMConversationFilter filter)
 取消订阅指定过滤条件的会话未读数 更多...
 
void getConversationReadTime (String conversationId, V2NIMSuccessCallback< Long > success, V2NIMFailureCallback failure)
 获取会话已读时间戳 当前只支持P2P,高级群, 超大群 更多...
 
void markConversationRead (String conversationId, V2NIMSuccessCallback< Long > success, V2NIMFailureCallback failure)
 标记会话已读时间戳 当前只支持P2P,高级群, 超大群 更多...
 
V2NIMSyncResult< Void > setCurrentConversation (String conversationId)
 设置当前聊天账号 更多...
 
void addConversationListener (@NonNull V2NIMConversationListener listener)
 添加会话监听 更多...
 
void removeConversationListener (@NonNull V2NIMConversationListener listener)
 移除会话监听 更多...
 

详细描述

在文件 V2NIMConversationService.java17 行定义.

成员函数说明

void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.addConversationListener ( @NonNull V2NIMConversationListener  listener)

添加会话监听

参数
listener会话监听
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.clearTotalUnreadCount ( V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

清空会话未读数

参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.clearUnreadCountByGroupId ( @NonNull String  groupId,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

根据会话分组清空相应会话的未读数

参数
groupId会话分组id
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.clearUnreadCountByIds ( @NonNull List< String >  conversationIds,
V2NIMSuccessCallback< List< V2NIMConversationOperationResult >>  success,
V2NIMFailureCallback  failure 
)

根据会话id清空会话未读数

参数
conversationIds会话id列表
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.clearUnreadCountByTypes ( @NonNull List< V2NIMConversationType conversationTypes,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

根据会话类型清空相应会话的未读数

参数
conversationTypes
success
failure
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.createConversation ( @NonNull String  conversationId,
V2NIMSuccessCallback< V2NIMConversation success,
V2NIMFailureCallback  failure 
)

创建会话

参数
conversationId会话id
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.deleteConversation ( @NonNull String  conversationId,
boolean  clearMessage,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

删除会话

参数
conversationId会话id
clearMessage是否删除会话消息
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.deleteConversationListByIds ( @NonNull List< String >  conversationIds,
boolean  clearMessage,
V2NIMSuccessCallback< List< V2NIMConversationOperationResult >>  success,
V2NIMFailureCallback  failure 
)

删除会话列表

参数
conversationIds会话id列表
clearMessage是否删除会话消息
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getConversation ( @NonNull String  conversationId,
V2NIMSuccessCallback< V2NIMConversation success,
V2NIMFailureCallback  failure 
)

获取会话列表,通过会话id

参数
conversationId会话id
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getConversationList ( long  offset,
int  limit,
V2NIMSuccessCallback< V2NIMConversationResult success,
V2NIMFailureCallback  failure 
)

获取会话列表

参数
offset分页偏移,首次传0,后续拉取采用上一次返回的offset
limit分页拉取数量,不建议超过100;
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getConversationListByIds ( @NonNull List< String >  conversationIds,
V2NIMSuccessCallback< List< V2NIMConversation >>  success,
V2NIMFailureCallback  failure 
)

根据会话id获取会话列表

参数
conversationIds会话id列表
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getConversationListByOption ( long  offset,
int  limit,
V2NIMConversationOption  option,
V2NIMSuccessCallback< V2NIMConversationResult success,
V2NIMFailureCallback  failure 
)

根据查询参数获取会话列表

参数
offset分页偏移,首次传0,后续拉取采用上一次返回的offset
limit分页拉取数量,不建议超过100;
option查询选项
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getConversationReadTime ( String  conversationId,
V2NIMSuccessCallback< Long >  success,
V2NIMFailureCallback  failure 
)

获取会话已读时间戳 当前只支持P2P,高级群, 超大群

参数
conversationId会话ID
success查询成功回调
failure查询失败回调
弃用:
该方法已被废弃,建议使用 V2NIMConversation#getLastReadTime 作为替代。
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getStickTopConversationList ( V2NIMSuccessCallback< List< V2NIMConversation >>  success,
V2NIMFailureCallback  failure 
)

查询当前全量置顶的会话列表 排序方式:倒序

参数
success
failure
int com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getTotalUnreadCount ( )

获取会话总未读数

返回
会话总未读数
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getUnreadCountByFilter ( V2NIMConversationFilter  filter,
V2NIMSuccessCallback< Integer >  success,
V2NIMFailureCallback  failure 
)

根据过滤条件获取相应的未读数

参数
filter查询选项
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.getUnreadCountByIds ( @NonNull List< String >  conversationIds,
V2NIMSuccessCallback< Integer >  success,
V2NIMFailureCallback  failure 
)

根据会话id获取会话未读数

参数
conversationIds会话id列表
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.markConversationRead ( String  conversationId,
V2NIMSuccessCallback< Long >  success,
V2NIMFailureCallback  failure 
)

标记会话已读时间戳 当前只支持P2P,高级群, 超大群

参数
conversationId会话ID
success查询成功回调
failure查询失败回调
弃用:
该方法已被废弃,建议使用 V2NIMConversationService#clearUnreadCountByIds 作为替代。
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.removeConversationListener ( @NonNull V2NIMConversationListener  listener)

移除会话监听

参数
listener会话监听
V2NIMSyncResult<Void> com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.setCurrentConversation ( String  conversationId)

设置当前聊天账号

参数
conversationId当前聊天会话id 如果为空字符串, null, 均表示不设置, 不在聊天界面 否则表示为具体的聊天界面:当前账号下, 不触发未读变更, 不触发在线通知,包括:P2P, TEAM, SUPERTEAM
返回
是否设置成功,失败返回V2NIMError
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.stickTopConversation ( @NonNull String  conversationId,
boolean  stickTop,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

置顶会话

参数
conversationId会话id
stickTop是否置顶,true:置顶, false:取消置顶
success成功回调
failure失败回调
V2NIMError com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.subscribeUnreadCountByFilter ( @NonNull V2NIMConversationFilter  filter)

订阅指定过滤条件的会话未读数

参数
filter过滤条件
返回
是否订阅成功,成功返回null,失败返回V2NIMError
V2NIMError com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.unsubscribeUnreadCountByFilter ( @NonNull V2NIMConversationFilter  filter)

取消订阅指定过滤条件的会话未读数

参数
filter过滤条件
返回
是否取消订阅成功,成功返回null,失败返回V2NIMError
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.updateConversation ( @NonNull String  conversationId,
V2NIMConversationUpdate  updateInfo,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

更新会话

参数
conversationId会话id
updateInfo更新信息
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.conversation.V2NIMConversationService.updateConversationLocalExtension ( @NonNull String  conversationId,
String  localExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

更新会话本地扩展字段

参数
conversationId会话id
localExtension本地扩展字段更新信息
success成功回调
failure失败回调

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