NIM Unity SDK V2.6.0
载入中...
搜索中...
未找到
Public 成员函数 | 静态 Public 成员函数 | 事件 | 所有成员列表
NIMChatRoom.ChatRoomApi类 参考

聊天室 更多...

Public 成员函数

delegate void LinkStateChangedDelegate (long roomId, NIMChatRoomLinkCondition state)
 聊天室连接状态更改委托
 
delegate void ReceiveMessageDelegate (long roomId, Message message)
 接收到聊天室消息委托
 
delegate void SendMessageDelegate (long roomId, NIM.ResponseCode code, Message message)
 发送聊天室消息委托
 
delegate void ReceiveNotificationDelegate (long roomId, Notification notification)
 接收聊天室通知委托
 

静态 Public 成员函数

static void Init (NIMChatRoomConfig config=null)
 初始化聊天实模块
 
static void RequestLinkInfoWithAnonymous (long roomId, string appKey, RequestChatRoomLinkInfoDelegate callback)
 获取匿名登录聊天室地址(仅供demo测试使用,用户需要自己的应用服务器来获取聊天室地址)
 
static void LoginWithAnonymous (long roomId, AnonymousInfo anonymityInfo, LoginData loginData=null)
 
static void Login (long roomId, string request, LoginData loginData=null)
 登陆聊天室
 
static void Exit (long roomId)
 退出聊天室
 
static void Cleanup ()
 清理聊天室模块
 
static void QueryMembersOnline (long roomId, NIMChatRoomGetMemberType memberType, long timeOffset, int limit, QueryMembersResultDelegate cb)
 在线查询聊天室成员
 
static void QueryMessageHistoryOnline (long roomId, long startTimeStamp, int count, bool reverse, List< NIMChatRoomMsgType > msgTypes, QueryMessageHistoryResultDelegate cb)
 在线查询消息历史记录
 
static void SetMemberPropertyOnline (long roomId, MemberProperty property, SetMemberPropertyDelegate cb)
 设置成员身份标识
 
static void GetRoomInfo (long roomId, GetRoomInfoDelegate cb)
 获取聊天室信息
 
static int GetLoginState (long roomId)
 获取聊天室状态;
 
static void QueryMemberInfosByIdCollection (long roomId, string[] idCollection, QueryMembersResultDelegate cb)
 根据成员ID集合查询对应的成员信息
 
static void RemoveMember (long roomId, string memberId, string notify, RemoveMemberDelegate cb)
 将指定成员移出聊天室
 
static void SendMessage (long roomId, Message msg)
 发送消息
 
static void TempMuteMember (long roomId, string accid, long duration, TempMuteMemberDelegate cb, bool notify, string notify_ext)
 临时禁言/解禁成员
 
static void UpdateRoomInfo (long roomId, ChatRoomInfo info, UpdateRoomInfoDelegate cb, bool notify, string notify_ext)
 更新聊天室信息;
 
static void UpdateMyRoleInfo (long roomId, MemberInfo info, UpdateMyRoleDelegate cb, bool notify, string notify_ext, string jsonExt=null)
 更新我的信息;
 
static void QueueListAsync (long roomId, ChatRoomQueueListDelegate cb, string json_extension="")
 排序列出所有麦序元素
 
static void QueueDropAsync (long roomId, ChatRoomQueueDropDelegate cb, string json_extension="")
 (聊天室管理员权限)删除麦序队列
 
static void QueuePollAsync (long roomId, string element_key, ChatRoomQueuePollDelegate cb, string json_extension="")
 取出麦序头元素
 
static void QueueOfferAsync (long roomId, string element_key, string elemnet_value, ChatRoomQueueOfferDelegate cb, string json_extension="")
 新加(更新)麦序队列元素,如果element_key对应的元素已经在队列中存在了,那就是更新操作,如果不存在,就放到队列尾部
 

事件

static ChatRoomLoginDelegate LoginHandler
 登录聊天室事件
 
static ExitChatRoomDelegate ExitHandler
 退出聊天室事件
 
static LinkStateChangedDelegate LinkStateChanged
 聊天室连接状态更改事件
 
static ReceiveMessageDelegate ReceiveMessageHandler
 接收聊天室消息事件
 
static SendMessageDelegate SendMessageHandler
 发送聊天室消息事件
 
static ReceiveNotificationDelegate ReceiveNotificationHandler
 接收聊天室通知事件
 

详细描述

聊天室

成员函数说明

◆ LinkStateChangedDelegate()

delegate void NIMChatRoom.ChatRoomApi.LinkStateChangedDelegate ( long  roomId,
NIMChatRoomLinkCondition  state 
)

聊天室连接状态更改委托

参数
roomId房间ID
state连接状态

◆ ReceiveMessageDelegate()

delegate void NIMChatRoom.ChatRoomApi.ReceiveMessageDelegate ( long  roomId,
Message  message 
)

接收到聊天室消息委托

参数
roomId
message

◆ SendMessageDelegate()

delegate void NIMChatRoom.ChatRoomApi.SendMessageDelegate ( long  roomId,
NIM.ResponseCode  code,
Message  message 
)

发送聊天室消息委托

参数
roomId
code
message

◆ ReceiveNotificationDelegate()

delegate void NIMChatRoom.ChatRoomApi.ReceiveNotificationDelegate ( long  roomId,
Notification  notification 
)

接收聊天室通知委托

参数
roomId
notification

◆ RequestLinkInfoWithAnonymous()

static void NIMChatRoom.ChatRoomApi.RequestLinkInfoWithAnonymous ( long  roomId,
string  appKey,
RequestChatRoomLinkInfoDelegate  callback 
)
inlinestatic

获取匿名登录聊天室地址(仅供demo测试使用,用户需要自己的应用服务器来获取聊天室地址)

参数
roomId
appKey
callback

◆ Login()

static void NIMChatRoom.ChatRoomApi.Login ( long  roomId,
string  request,
LoginData  loginData = null 
)
inlinestatic

登陆聊天室

参数
roomId聊天室ID
request聊天室登录信息(NIM SDK请求聊天室返回的数据)
loginData聊天室可选信息

◆ Exit()

static void NIMChatRoom.ChatRoomApi.Exit ( long  roomId)
inlinestatic

退出聊天室

参数
roomId聊天室ID

◆ QueryMembersOnline()

static void NIMChatRoom.ChatRoomApi.QueryMembersOnline ( long  roomId,
NIMChatRoomGetMemberType  memberType,
long  timeOffset,
int  limit,
QueryMembersResultDelegate  cb 
)
inlinestatic

在线查询聊天室成员

参数
roomId聊天室ID
memberType成员类型
timeOffset距离当前时间的时间戳
limit查询数量
cb查询结果委托

◆ QueryMessageHistoryOnline()

static void NIMChatRoom.ChatRoomApi.QueryMessageHistoryOnline ( long  roomId,
long  startTimeStamp,
int  count,
bool  reverse,
List< NIMChatRoomMsgType msgTypes,
QueryMessageHistoryResultDelegate  cb 
)
inlinestatic

在线查询消息历史记录

参数
roomId聊天室ID
startTimeStamp起始时间戳
count查询数量
cb查询结果委托

◆ SetMemberPropertyOnline()

static void NIMChatRoom.ChatRoomApi.SetMemberPropertyOnline ( long  roomId,
MemberProperty  property,
SetMemberPropertyDelegate  cb 
)
inlinestatic

设置成员身份标识

参数
roomId聊天室ID
property成员属性
cb操作结果委托

◆ GetRoomInfo()

static void NIMChatRoom.ChatRoomApi.GetRoomInfo ( long  roomId,
GetRoomInfoDelegate  cb 
)
inlinestatic

获取聊天室信息

参数
roomId聊天室ID
cb查询结果委托

◆ GetLoginState()

static int NIMChatRoom.ChatRoomApi.GetLoginState ( long  roomId)
inlinestatic

获取聊天室状态;

参数
roomId聊天室ID
返回

◆ QueryMemberInfosByIdCollection()

static void NIMChatRoom.ChatRoomApi.QueryMemberInfosByIdCollection ( long  roomId,
string[]  idCollection,
QueryMembersResultDelegate  cb 
)
inlinestatic

根据成员ID集合查询对应的成员信息

参数
roomId聊天室ID
idCollection聊天室成员ID集合
cb查询结果委托

◆ RemoveMember()

static void NIMChatRoom.ChatRoomApi.RemoveMember ( long  roomId,
string  memberId,
string  notify,
RemoveMemberDelegate  cb 
)
inlinestatic

将指定成员移出聊天室

参数
roomId聊天室ID
memberId成员ID
notify放到事件通知中的扩展字段
cb操作结果委托

◆ SendMessage()

static void NIMChatRoom.ChatRoomApi.SendMessage ( long  roomId,
Message  msg 
)
inlinestatic

发送消息

参数
roomId房间ID
msg消息内容

◆ TempMuteMember()

static void NIMChatRoom.ChatRoomApi.TempMuteMember ( long  roomId,
string  accid,
long  duration,
TempMuteMemberDelegate  cb,
bool  notify,
string  notify_ext 
)
inlinestatic

临时禁言/解禁成员

参数
roomId聊天室ID
accid成员ID
duration临时禁言时长(秒),解禁填0
cb操作结果回调
notify是否聊天室内广播通知
notify_ext通知中的自定义字段,长度限制2048

◆ UpdateRoomInfo()

static void NIMChatRoom.ChatRoomApi.UpdateRoomInfo ( long  roomId,
ChatRoomInfo  info,
UpdateRoomInfoDelegate  cb,
bool  notify,
string  notify_ext 
)
inlinestatic

更新聊天室信息;

参数
roomId聊天室ID
info只支持修改name,announcement,broadcast_url,ext字段修改
cb操作结果回调
notify是否聊天室内广播通知
notify_ext通知中的自定义字段,长度限制2048

◆ UpdateMyRoleInfo()

static void NIMChatRoom.ChatRoomApi.UpdateMyRoleInfo ( long  roomId,
MemberInfo  info,
UpdateMyRoleDelegate  cb,
bool  notify,
string  notify_ext,
string  jsonExt = null 
)
inlinestatic

更新我的信息;

参数
roomId聊天室ID
info只支持修改nick,avatar,ext字段修改
cb操作结果回调
notify是否聊天室内广播通知
notify_ext通知中的自定义字段,长度限制2048

◆ QueueListAsync()

static void NIMChatRoom.ChatRoomApi.QueueListAsync ( long  roomId,
ChatRoomQueueListDelegate  cb,
string  json_extension = "" 
)
inlinestatic

排序列出所有麦序元素

参数
roomId房间号
cb
json_extension

◆ QueueDropAsync()

static void NIMChatRoom.ChatRoomApi.QueueDropAsync ( long  roomId,
ChatRoomQueueDropDelegate  cb,
string  json_extension = "" 
)
inlinestatic

(聊天室管理员权限)删除麦序队列

参数
roomId
cb
json_extension

◆ QueuePollAsync()

static void NIMChatRoom.ChatRoomApi.QueuePollAsync ( long  roomId,
string  element_key,
ChatRoomQueuePollDelegate  cb,
string  json_extension = "" 
)
inlinestatic

取出麦序头元素

参数
roomId聊天室ID
element_key需要取出的元素的UniqKey,长度限制128字节,传空传表示取出第一个元素
cb
json_extension

◆ QueueOfferAsync()

static void NIMChatRoom.ChatRoomApi.QueueOfferAsync ( long  roomId,
string  element_key,
string  elemnet_value,
ChatRoomQueueOfferDelegate  cb,
string  json_extension = "" 
)
inlinestatic

新加(更新)麦序队列元素,如果element_key对应的元素已经在队列中存在了,那就是更新操作,如果不存在,就放到队列尾部

参数
roomId聊天室ID
element_key新元素的UniqKey,长度限制128字节
elemnet_value新元素内容,长度限制4096字节
cb
json_extension

该类的文档由以下文件生成: