NIMSDK-AOS  10.9.60
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService接口 参考

聊天室服务接口 更多...

类 com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService 继承关系图:
com.netease.nimlib.sdk.v2.V2NIMMultiService

Public 成员函数

void sendMessage (V2NIMChatroomMessage message, V2NIMSendChatroomMessageParams params, V2NIMSuccessCallback< V2NIMSendChatroomMessageResult > success, V2NIMFailureCallback failure, V2NIMProgressCallback progress)
 发送聊天室消息 更多...
 
void cancelMessageAttachmentUpload (V2NIMChatroomMessage message, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 取消聊天室消息附件上传 更多...
 
void getMemberListByOption (V2NIMChatroomMemberQueryOption queryOption, V2NIMSuccessCallback< V2NIMChatroomMemberListResult > success, V2NIMFailureCallback failure)
 分页获取聊天室成员列表 更多...
 
void getMessageList (V2NIMChatroomMessageListOption option, V2NIMSuccessCallback< List< V2NIMChatroomMessage >> success, V2NIMFailureCallback failure)
 查询历史消息 更多...
 
void updateMemberRole (String accountId, V2NIMChatroomMemberRoleUpdateParams updateParams, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 更新聊天室成员角色 更多...
 
void setMemberBlockedStatus (String accountId, boolean blocked, String notificationExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 设置聊天室成员黑名单状态 更多...
 
void setMemberChatBannedStatus (String accountId, boolean chatBanned, String notificationExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 设置成员禁言状态 更多...
 
void setMemberTempChatBanned (String accountId, long tempChatBannedDuration, boolean notificationEnabled, String notificationExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 设置成员临时禁言状态 更多...
 
void updateChatroomInfo (V2NIMChatroomUpdateParams updateParams, V2NIMAntispamConfig antispamConfig, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 更新聊天室信息 更多...
 
void updateSelfMemberInfo (V2NIMChatroomSelfMemberUpdateParams updateParams, V2NIMAntispamConfig antispamConfig, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 更新聊天室信息 更多...
 
void getMemberByIds (List< String > accountIds, V2NIMSuccessCallback< List< V2NIMChatroomMember >> success, V2NIMFailureCallback failure)
 根据账号列表查询成员信息 更多...
 
void kickMember (String accountId, String notificationExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 踢出聊天室成员 更多...
 
void setTempChatBannedByTag (V2NIMChatroomTagTempChatBannedParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 设置聊天室标签临时禁言 只有管理员或创建者可以操作 更多...
 
void getMemberListByTag (V2NIMChatroomTagMemberOption option, V2NIMSuccessCallback< V2NIMChatroomMemberListResult > success, V2NIMFailureCallback failure)
 根据tag查询群成员列表 更多...
 
void getMemberCountByTag (String tag, V2NIMSuccessCallback< Long > success, V2NIMFailureCallback failure)
 查询某个标签下的成员人数 更多...
 
void updateChatroomLocationInfo (V2NIMChatroomLocationConfig locationConfig, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 更新坐标信息 更多...
 
void updateChatroomTags (V2NIMChatroomTagsUpdateParams updateParams, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 更新聊天室tag信息 更多...
 
void getMessageListByTag (V2NIMChatroomTagMessageOption messageOption, V2NIMSuccessCallback< List< V2NIMChatroomMessage >> success, V2NIMFailureCallback failure)
 根据标签查询消息列表 更多...
 
void registerCustomAttachmentParser (V2NIMMessageCustomAttachmentParser parser)
 注册自定义消息附件解析器,解析自定义消息类型为100的附件 后注册的解析器优先于先注册的解析器 更多...
 
void unregisterCustomAttachmentParser (V2NIMMessageCustomAttachmentParser parser)
 取消注册自定义消息附件解析器 更多...
 
void addChatroomListener (V2NIMChatroomListener listener)
 添加聊天室监听 更多...
 
void removeChatroomListener (V2NIMChatroomListener listener)
 移除聊天室监听 更多...
 

详细描述

聊天室服务接口

在文件 V2NIMChatroomService.java29 行定义.

成员函数说明

void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.addChatroomListener ( V2NIMChatroomListener  listener)

添加聊天室监听

参数
listener聊天室监听
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.cancelMessageAttachmentUpload ( V2NIMChatroomMessage  message,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

取消聊天室消息附件上传

参数
message
success
failure
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.getMemberByIds ( List< String >  accountIds,
V2NIMSuccessCallback< List< V2NIMChatroomMember >>  success,
V2NIMFailureCallback  failure 
)

根据账号列表查询成员信息

参数
accountIds账号列表,为空或者size==0, 或者size>200 , 返回参数错误
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.getMemberCountByTag ( String  tag,
V2NIMSuccessCallback< Long >  success,
V2NIMFailureCallback  failure 
)

查询某个标签下的成员人数

参数
tag标签
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.getMemberListByOption ( V2NIMChatroomMemberQueryOption  queryOption,
V2NIMSuccessCallback< V2NIMChatroomMemberListResult success,
V2NIMFailureCallback  failure 
)

分页获取聊天室成员列表

参数
queryOption查询选项
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.getMemberListByTag ( V2NIMChatroomTagMemberOption  option,
V2NIMSuccessCallback< V2NIMChatroomMemberListResult success,
V2NIMFailureCallback  failure 
)

根据tag查询群成员列表

参数
option根据tag查询成员的参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.getMessageList ( V2NIMChatroomMessageListOption  option,
V2NIMSuccessCallback< List< V2NIMChatroomMessage >>  success,
V2NIMFailureCallback  failure 
)

查询历史消息

参数
option查询参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.getMessageListByTag ( V2NIMChatroomTagMessageOption  messageOption,
V2NIMSuccessCallback< List< V2NIMChatroomMessage >>  success,
V2NIMFailureCallback  failure 
)

根据标签查询消息列表

参数
messageOption查询参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.kickMember ( String  accountId,
String  notificationExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

踢出聊天室成员

参数
accountId被踢的成员ID
notificationExtension本次操作生成的通知中的扩展字段
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.registerCustomAttachmentParser ( V2NIMMessageCustomAttachmentParser  parser)

注册自定义消息附件解析器,解析自定义消息类型为100的附件 后注册的解析器优先于先注册的解析器

参数
parser自定义消息附件解析器
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.removeChatroomListener ( V2NIMChatroomListener  listener)

移除聊天室监听

参数
listener聊天室监听
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.sendMessage ( V2NIMChatroomMessage  message,
V2NIMSendChatroomMessageParams  params,
V2NIMSuccessCallback< V2NIMSendChatroomMessageResult success,
V2NIMFailureCallback  failure,
V2NIMProgressCallback  progress 
)

发送聊天室消息

参数
message需要发送的消息体
params发送消息相关配置参数
success发送成功回调
failure发送失败回调
progress发送进度回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.setMemberBlockedStatus ( String  accountId,
boolean  blocked,
String  notificationExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

设置聊天室成员黑名单状态

参数
accountId被操作的账号ID
blocked黑名单状态
notificationExtension本次操作生成的通知中的扩展字段
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.setMemberChatBannedStatus ( String  accountId,
boolean  chatBanned,
String  notificationExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

设置成员禁言状态

参数
accountId被操作的账号ID
chatBanned禁言状态
notificationExtension本次操作生成的通知中的扩展字段
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.setMemberTempChatBanned ( String  accountId,
long  tempChatBannedDuration,
boolean  notificationEnabled,
String  notificationExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

设置成员临时禁言状态

参数
accountId被操作的账号ID
tempChatBannedDuration设置临时禁言时长,单位:秒,单次最大:30天,取消则设置为:0
notificationEnabled是否需要发送广播通知,true:通知,false:不通知
notificationExtension本次操作生成的通知中的扩展字段
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.setTempChatBannedByTag ( V2NIMChatroomTagTempChatBannedParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

设置聊天室标签临时禁言 只有管理员或创建者可以操作

参数
params设置标签禁言的参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.unregisterCustomAttachmentParser ( V2NIMMessageCustomAttachmentParser  parser)

取消注册自定义消息附件解析器

参数
parser自定义消息附件解析器
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.updateChatroomInfo ( V2NIMChatroomUpdateParams  updateParams,
V2NIMAntispamConfig  antispamConfig,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

更新聊天室信息

参数
updateParams更新参数
antispamConfig反垃圾配置
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.updateChatroomLocationInfo ( V2NIMChatroomLocationConfig  locationConfig,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

更新坐标信息

参数
locationConfig坐标信息
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.updateChatroomTags ( V2NIMChatroomTagsUpdateParams  updateParams,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

更新聊天室tag信息

参数
updateParams更新参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.updateMemberRole ( String  accountId,
V2NIMChatroomMemberRoleUpdateParams  updateParams,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

更新聊天室成员角色

参数
accountId被操作的账号ID
updateParams更新参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.chatroom.V2NIMChatroomService.updateSelfMemberInfo ( V2NIMChatroomSelfMemberUpdateParams  updateParams,
V2NIMAntispamConfig  antispamConfig,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

更新聊天室信息

参数
updateParams更新参数
antispamConfig反垃圾配置
success成功回调
failure失败回调

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