聊天室更多...

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

◆ Init()

static void NIMChatRoom.ChatRoomApi.Init ( NIMChatRoomConfig config = null )

inlinestatic

初始化聊天实模块

◆ 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

◆ Cleanup()

static void NIMChatRoom.ChatRoomApi.Cleanup ( )

inlinestatic

清理聊天室模块

◆ 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

事件说明

◆ LoginHandler

ChatRoomLoginDelegate NIMChatRoom.ChatRoomApi.LoginHandler

static

登录聊天室事件

◆ ExitHandler

ExitChatRoomDelegate NIMChatRoom.ChatRoomApi.ExitHandler

static

退出聊天室事件

◆ LinkStateChanged

LinkStateChangedDelegate NIMChatRoom.ChatRoomApi.LinkStateChanged

static

聊天室连接状态更改事件

◆ ReceiveMessageHandler

ReceiveMessageDelegate NIMChatRoom.ChatRoomApi.ReceiveMessageHandler

static

接收聊天室消息事件

◆ SendMessageHandler

SendMessageDelegate NIMChatRoom.ChatRoomApi.SendMessageHandler

static

发送聊天室消息事件

◆ ReceiveNotificationHandler

ReceiveNotificationDelegate NIMChatRoom.ChatRoomApi.ReceiveNotificationHandler

static

接收聊天室通知事件

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

ChatRoomApi.cs

Public 成员函数

静态 Public 成员函数

事件

详细描述

成员函数说明

◆ LinkStateChangedDelegate()

◆ ReceiveMessageDelegate()

◆ SendMessageDelegate()

◆ ReceiveNotificationDelegate()

◆ Init()

◆ RequestLinkInfoWithAnonymous()

◆ Login()

◆ Exit()

◆ Cleanup()

◆ QueryMembersOnline()

◆ QueryMessageHistoryOnline()

◆ SetMemberPropertyOnline()

◆ GetRoomInfo()

◆ GetLoginState()

◆ QueryMemberInfosByIdCollection()

◆ RemoveMember()

◆ SendMessage()

◆ TempMuteMember()

◆ UpdateRoomInfo()

◆ UpdateMyRoleInfo()

◆ QueueListAsync()

◆ QueueDropAsync()

◆ QueuePollAsync()

◆ QueueOfferAsync()

事件说明

◆ LoginHandler

◆ ExitHandler

◆ LinkStateChanged

◆ ReceiveMessageHandler

◆ SendMessageHandler

◆ ReceiveNotificationHandler