RTM 1.x 将于近期下架，各版本退休日期和替代方案详见退休政策。





云信令（原实时消息）

Console 官网社区技术支持





Agora C# API Reference for Unity

概览 RtmClient RtmChannel LocalInvitation RemoteInvitation RtmCallManager RtmClientEventHandler RtmChannelEventHandler RtmCallEventHandler 错误码和状态码

继承自 IRtmApiNative .

Public 成员函数
delegate void	OnLoginSuccessHandler (int id)

delegate void	OnLoginFailureHandler (int id, LOGIN_ERR_CODE errorCode)

delegate void	OnRenewTokenResultHandler (int id, string token, RENEW_TOKEN_ERR_CODE errorCode)

delegate void	OnTokenExpiredHandler (int id)

delegate void	OnTokenPrivilegeWillExpireHandler (int id)

delegate void	OnLogoutHandler (int id, LOGOUT_ERR_CODE errorCode)

delegate void	OnConnectionStateChangedHandler (int id, CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)

delegate void	OnSendMessageResultHandler (int id, Int64 messageId, PEER_MESSAGE_ERR_CODE errorCode)

delegate void	OnMessageReceivedFromPeerHandler (int id, string peerId, TextMessage message)

delegate void	OnQueryPeersOnlineStatusResultHandler (int id, Int64 requestId, PeerOnlineStatus[] peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode)

delegate void	OnSubscriptionRequestResultHandler (int id, Int64 requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode)

delegate void	OnQueryPeersBySubscriptionOptionResultHandler (int id, Int64 requestId, string[] peerIds, int peerCount, QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR errorCode)

delegate void	OnDeleteLocalUserAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode)

delegate void	OnClearLocalUserAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode)

delegate void	OnGetUserAttributesResultHandler (int id, Int64 requestId, string userId, RtmAttribute[] attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)

delegate void	OnSetChannelAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode)

delegate void	OnDeleteChannelAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode)

delegate void	OnClearChannelAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode)

delegate void	OnGetChannelAttributesResultHandler (int id, Int64 requestId, RtmChannelAttribute[] attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)

delegate void	OnGetChannelMemberCountResultHandler (int id, Int64 requestId, ChannelMemberCount[] channelMemberCounts, int channelCount, GET_CHANNEL_MEMBER_COUNT_ERR_CODE errorCode)

delegate void	OnPeersOnlineStatusChangedHandler (int id, PeerOnlineStatus[] peersStatus, int peerCount)

void	Release ()

IntPtr	GetPtr ()

Public 属性
OnLoginSuccessHandler	OnLoginSuccess

OnLoginFailureHandler	OnLoginFailure

OnRenewTokenResultHandler	OnRenewTokenResult

OnTokenExpiredHandler	OnTokenExpired

OnTokenPrivilegeWillExpireHandler	OnTokenPrivilegeWillExpire

OnLogoutHandler	OnLogout

OnConnectionStateChangedHandler	OnConnectionStateChanged

OnSendMessageResultHandler	OnSendMessageResult

OnMessageReceivedFromPeerHandler	OnMessageReceivedFromPeer

OnQueryPeersOnlineStatusResultHandler	OnQueryPeersOnlineStatusResult

OnSubscriptionRequestResultHandler	OnSubscriptionRequestResult

OnQueryPeersBySubscriptionOptionResultHandler	OnQueryPeersBySubscriptionOptionResult

OnSetLocalUserAttributesResultHandler	OnSetLocalUserAttributesResult

OnAddOrUpdateLocalUserAttributesResultHandler	OnAddOrUpdateLocalUserAttributesResult

OnDeleteLocalUserAttributesResultHandler	OnDeleteLocalUserAttributesResult

OnClearLocalUserAttributesResultHandler	OnClearLocalUserAttributesResult

OnGetUserAttributesResultHandler	OnGetUserAttributesResult

OnSetChannelAttributesResultHandler	OnSetChannelAttributesResult

OnAddOrUpdateChannelAttributesResultHandler	OnAddOrUpdateChannelAttributesResult

OnDeleteChannelAttributesResultHandler	OnDeleteChannelAttributesResult

OnClearChannelAttributesResultHandler	OnClearChannelAttributesResult

OnGetChannelAttributesResultHandler	OnGetChannelAttributesResult

OnGetChannelMemberCountResultHandler	OnGetChannelMemberCountResult

OnPeersOnlineStatusChangedHandler	OnPeersOnlineStatusChanged

成员函数说明

◆ OnLoginSuccessHandler()

delegate void agora_rtm.RtmClientEventHandler.OnLoginSuccessHandler ( int id )

参数

id 引擎 ID

◆ OnLoginFailureHandler()

delegate void agora_rtm.RtmClientEventHandler.OnLoginFailureHandler	(	int	id,
		LOGIN_ERR_CODE	errorCode
	)

参数

id	引擎 ID
errorCode	错误码。详见 LOGIN_ERR_CODE。

◆ OnRenewTokenResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnRenewTokenResultHandler	(	int	id,
		string	token,
		RENEW_TOKEN_ERR_CODE	errorCode
	)

报告 RenewToken 方法的调用结果。

参数

id	引擎 ID
token	新的 Token。
errorCode	错误码。详见 RENEW_TOKEN_ERR_CODE。

◆ OnTokenExpiredHandler()

delegate void agora_rtm.RtmClientEventHandler.OnTokenExpiredHandler ( int id )

（SDK 断线重连时触发）当前使用的 RTM Token 已超过 24 小时的签发有效期。该回调仅会在 SDK 处于 CONNECTION_STATE_RECONNECTING 状态时因 RTM 后台监测到 Token 签发有效期过期而触发。SDK 处于 CONNECTION_STATE_CONNECTED 状态时该回调不会被触发。收到该回调时，请尽快在你的业务服务端生成新的 Token 并调用 RenewToken 方法把新的 Token 传给 Token 验证服务器。

参数

id 引擎 ID

◆ OnTokenPrivilegeWillExpireHandler()

delegate void agora_rtm.RtmClientEventHandler.OnTokenPrivilegeWillExpireHandler ( int id )

当前使用的 RTM Token 还有 30 秒过期时触发。 SDK 触发该回调提醒 App 当前 Token 即将过期，应即时获取新 Token。

收到该回调后，你需要在服务端生成新 Token 并调用 renewToken 方法将该 Token 传给 SDK。
如果调用 login 方法登录时传入的 Token 直至过期仍未更新，SDK 会断线重连，用户将下线。

参数

id 引擎 ID

◆ OnLogoutHandler()

delegate void agora_rtm.RtmClientEventHandler.OnLogoutHandler	(	int	id,
		LOGOUT_ERR_CODE	errorCode
	)

登出 Agora RTM 服务回调。

参数

id	引擎 ID
errorCode	错误码。详见 LOGOUT_ERR_CODE。

◆ OnConnectionStateChangedHandler()

delegate void agora_rtm.RtmClientEventHandler.OnConnectionStateChangedHandler	(	int	id,
		CONNECTION_STATE	state,
		CONNECTION_CHANGE_REASON	reason
	)

SDK 与 Agora RTM 系统的连接状态发生改变回调。

参数

id	引擎 ID
state	新连接状态。详见 CONNECTION_STATE。
reason	连接状态改变原因。详见 CONNECTION_CHANGE_REASON。

◆ OnSendMessageResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnSendMessageResultHandler	(	int	id,
		Int64	messageId,
		PEER_MESSAGE_ERR_CODE	errorCode
	)

报告 SendMessageToPeer 方法的调用结果。

参数

id	引擎 ID
messageId	点对点消息的 ID。
errorCode	错误码。详见 PEER_MESSAGE_ERR_CODE。

◆ OnMessageReceivedFromPeerHandler()

delegate void agora_rtm.RtmClientEventHandler.OnMessageReceivedFromPeerHandler	(	int	id,
		string	peerId,
		TextMessage	message
	)

收到点对点消息回调。

参数

id	引擎 ID
peerId	发送该消息的对端用户 ID。
message	接收到的消息。详见 IMessage。

◆ OnQueryPeersOnlineStatusResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnQueryPeersOnlineStatusResultHandler	(	int	id,
		Int64	requestId,
		PeerOnlineStatus[]	peersStatus,
		int	peerCount,
		QUERY_PEERS_ONLINE_STATUS_ERR	errorCode
	)

报告 QueryPeersOnlineStatus 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
peersStatus	用户的在线状态。详见 QUERY_PEERS_ONLINE_STATUS_ERR。
peerCount	指定用户的数量。
errorCode	错误码。详见 QUERY_PEERS_ONLINE_STATUS_ERR。

◆ OnSubscriptionRequestResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnSubscriptionRequestResultHandler	(	int	id,
		Int64	requestId,
		PEER_SUBSCRIPTION_STATUS_ERR	errorCode
	)

报告 SubscribePeersOnlineStatus 或 UnsubscribePeersOnlineStatus 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
errorCode	错误码。详见 PEER_SUBSCRIPTION_STATUS_ERR。

◆ OnQueryPeersBySubscriptionOptionResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnQueryPeersBySubscriptionOptionResultHandler	(	int	id,
		Int64	requestId,
		string[]	peerIds,
		int	peerCount,
		QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR	errorCode
	)

报告 QueryPeersBySubscriptionOption 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
peerIds	用户 ID 列表。
peerCount	某订阅类型被订阅的用户人数。
errorCode	错误码。详见 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR。

◆ OnDeleteLocalUserAttributesResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnDeleteLocalUserAttributesResultHandler	(	int	id,
		Int64	requestId,
		ATTRIBUTE_OPERATION_ERR	errorCode
	)

报告 DeleteLocalUserAttributesByKeys 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
errorCode	错误码。详见 ATTRIBUTE_OPERATION_ERR。

◆ OnClearLocalUserAttributesResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnClearLocalUserAttributesResultHandler	(	int	id,
		Int64	requestId,
		ATTRIBUTE_OPERATION_ERR	errorCode
	)

报告 ClearLocalUserAttributes 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
errorCode	错误码。详见 ATTRIBUTE_OPERATION_ERR。

◆ OnGetUserAttributesResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnGetUserAttributesResultHandler	(	int	id,
		Int64	requestId,
		string	userId,
		RtmAttribute[]	attributes,
		int	numberOfAttributes,
		ATTRIBUTE_OPERATION_ERR	errorCode
	)

报告 GetUserAttributes 或 GetUserAttributesByKeys 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
userId	指定用户的用户 ID。
attributes	返回的属性数组。详见 RtmAttribute。
numberOfAttributes	用户属性数组的长度。
errorCode	错误码。详见 ATTRIBUTE_OPERATION_ERR。

◆ OnSetChannelAttributesResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnSetChannelAttributesResultHandler	(	int	id,
		Int64	requestId,
		ATTRIBUTE_OPERATION_ERR	errorCode
	)

报告 SetChannelAttributes 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
errorCode	错误码。详见 ATTRIBUTE_OPERATION_ERR。

◆ OnDeleteChannelAttributesResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnDeleteChannelAttributesResultHandler	(	int	id,
		Int64	requestId,
		ATTRIBUTE_OPERATION_ERR	errorCode
	)

报告 DeleteChannelAttributesByKeys 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
errorCode	错误码。详见 ATTRIBUTE_OPERATION_ERR。

◆ OnClearChannelAttributesResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnClearChannelAttributesResultHandler	(	int	id,
		Int64	requestId,
		ATTRIBUTE_OPERATION_ERR	errorCode
	)

报告 ClearChannelAttributes 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
errorCode	错误码。详见 ATTRIBUTE_OPERATION_ERR。

◆ OnGetChannelAttributesResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnGetChannelAttributesResultHandler	(	int	id,
		Int64	requestId,
		RtmChannelAttribute[]	attributes,
		int	numberOfAttributes,
		ATTRIBUTE_OPERATION_ERR	errorCode
	)

报告 GetChannelAttributes 或 "GetChannelAttributesByKeys" 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
attributes	频道属性数组。
numberOfAttributes	频道属性的条数。
errorCode	错误码。详见 ATTRIBUTE_OPERATION_ERR.

◆ OnGetChannelMemberCountResultHandler()

delegate void agora_rtm.RtmClientEventHandler.OnGetChannelMemberCountResultHandler	(	int	id,
		Int64	requestId,
		ChannelMemberCount[]	channelMemberCounts,
		int	channelCount,
		GET_CHANNEL_MEMBER_COUNT_ERR_CODE	errorCode
	)

报告 GetChannelMemberCount 方法的调用结果。

参数

id	引擎 ID
requestId	标识本次请求的的唯一 ID。
channelMemberCounts	频道成员人数数组。
channelCount	频道数量。
errorCode	错误码。详见 GET_CHANNEL_MEMBER_COUNT_ERR_CODE。

◆ OnPeersOnlineStatusChangedHandler()

delegate void agora_rtm.RtmClientEventHandler.OnPeersOnlineStatusChangedHandler	(	int	id,
		PeerOnlineStatus[]	peersStatus,
		int	peerCount
	)

被订阅用户在线状态改变回调。

首次订阅在线状态成功时，SDK 也会返回本回调，显示所有被订阅用户的在线状态。
每当被订阅用户的在线状态发生改变，SDK 都会通过该回调通知订阅方。
如果 SDK 在断线重连过程中有被订阅用户的在线状态发生改变，SDK 会在重连成功时通过该回调通知订阅方。

参数

id	引擎 ID
peersStatus	用户在线状态列表。详见 PeerOnlineStatus。
peerCount	在线状态发生变化的被订阅用户人数。

Agora C# API Reference for Unity

Public 成员函数

Public 属性

成员函数说明

◆ OnLoginSuccessHandler()

◆ OnLoginFailureHandler()

◆ OnRenewTokenResultHandler()

◆ OnTokenExpiredHandler()

◆ OnTokenPrivilegeWillExpireHandler()

◆ OnLogoutHandler()

◆ OnConnectionStateChangedHandler()

◆ OnSendMessageResultHandler()

◆ OnMessageReceivedFromPeerHandler()

◆ OnQueryPeersOnlineStatusResultHandler()

◆ OnSubscriptionRequestResultHandler()

◆ OnQueryPeersBySubscriptionOptionResultHandler()

◆ OnDeleteLocalUserAttributesResultHandler()

◆ OnClearLocalUserAttributesResultHandler()

◆ OnGetUserAttributesResultHandler()

◆ OnSetChannelAttributesResultHandler()

◆ OnDeleteChannelAttributesResultHandler()

◆ OnClearChannelAttributesResultHandler()

◆ OnGetChannelAttributesResultHandler()

◆ OnGetChannelMemberCountResultHandler()

◆ OnPeersOnlineStatusChangedHandler()