Inherits IDisposable.

Public Member Functions
	RtmClient (string appId, RtmClientEventHandler eventHandler)

int	Login (string token, string userId)

int	Logout ()

int	RenewToken (string token)

int	SendMessageToPeer (string peerId, IMessage message, SendMessageOptions options)

int	SendMessageToPeer (string peerId, IMessage message)

int	DownloadMediaToMemory (string mediaId, Int64 requestId)

int	DownloadMediaToFile (string mediaId, string filePath, Int64 requestId)

int	CancelMediaDownload (Int64 requestId)

int	CancelMediaUpload (Int64 requestId)

RtmChannel	CreateChannel (string channelId, RtmChannelEventHandler rtmChannelEventHandler)

TextMessage	CreateMessage ()

TextMessage	CreateMessage (string text)

TextMessage	CreateMessage (byte[] rawData)

TextMessage	CreateMessage (byte[] rawData, string description)

ImageMessage	CreateImageMessageByMediaId (string mediaId)

int	CreateImageMessageByUploading (string filePath, Int64 requestId)

FileMessage	CreateFileMessageByMediaId (string mediaId)

int	CreateFileMessageByUploading (string filePath, Int64 requestId)

RtmChannelAttribute	CreateChannelAttribute ()

int	SetParameters (string parameters)

int	QueryPeersOnlineStatus (string[] peerIds, Int64 requestId)

int	SubscribePeersOnlineStatus (string[] peerIds, Int64 requestId)

int	UnsubscribePeersOnlineStatus (string[] peerIds, Int64 requestId)

int	QueryPeersBySubscriptionOption (PEER_SUBSCRIPTION_OPTION option, Int64 requestId)

int	SetLogFileSize (int fileSizeInKBytes)

int	SetLogFilter (int fileter)

int	SetLogFile (string logFilePath)

int	GetChannelMemberCount (string[] channelIds, Int64 requestId)

int	GetChannelAttributesByKeys (string channelId, string[] attributeKeys, Int64 requestId)

int	GetChannelAttributes (string channelId, Int64 requestId)

int	ClearChannelAttributes (string channelId, bool enableNotificationToChannelMembers, Int64 requestId)

int	DeleteChannelAttributesByKeys (string channelId, string[] attributeKeys, bool enableNotificationToChannelMembers, Int64 requestId)

int	GetUserAttributesByKeys (string userId, string[] attributeKeys, Int64 requestId)

int	GetUserAttributes (string userId, Int64 requestId)

int	ClearLocalUserAttributes (Int64 requestId)

int	DeleteLocalUserAttributesByKeys (string[] attributeKeys, Int64 requestId)

int	SetChannelAttributes (string channelId, RtmChannelAttribute[] attributes, ChannelAttributeOptions options, Int64 requestId)

RtmCallManager	GetRtmCallManager (RtmCallEventHandler eventHandler)

void	Dispose ()

Static Public Member Functions
static string	GetSdkVersion ()

Constructor & Destructor Documentation

◆ RtmClient()

agora_rtm.RtmClient.RtmClient	(	string	appId,
		RtmClientEventHandler	eventHandler
	)

inline

create an RtmClient instance.

The Agora RTM SDK supports creating multiple RtmClient instances.
All methods in the RtmClient class are executed asynchronously.

Parameters

appId	The App ID issued to you from the Agora Console. Apply for a new App ID from Agora if it is missing from your kit.
eventHandler	An RtmClientListener object that reports to the app on RTM SDK runtime events.

Member Function Documentation

◆ CancelMediaDownload()

int agora_rtm.RtmClient.CancelMediaDownload ( Int64 requestId )

inline

Cancels an ongoing file or image download task by request ID.

Deprecated:: This method is deprecated. Agora recommends that you do not use it.

The SDK returns the result of this method call with the OnMediaCancelResultHandler callback.

Note: You can only cancel an ongoing download task. After a download task completes, the corresponding request ID is no longer valid and hence you cannot cancel it.

Parameters

requestId	The unique ID of the download request to cancel.
requestId	The unique ID of this download request.

Returns

0: Success.
≠0: Failure. See CANCEL_MEDIA_ERR_CODE for the error codes.

◆ CancelMediaUpload()

int agora_rtm.RtmClient.CancelMediaUpload ( Int64 requestId )

inline

Cancels an ongoing file or image upload task by request ID.

Deprecated:: This method is deprecated. Agora recommends that you do not use it.

The SDK returns the result of this method call with the OnMediaCancelResultHandler callback.

Note: You can only cancel an ongoing upload task. After an upload task completes, you cannot cancel it and the corresponding request ID is no longer valid.

Parameters

requestId The unique ID of the upload request to cancel.

Returns

0: Success.
≠0: Failure. See CANCEL_MEDIA_ERR_CODE for the error codes.

◆ ClearChannelAttributes()

int agora_rtm.RtmClient.ClearChannelAttributes	(	string	channelId,
		bool	enableNotificationToChannelMembers,
		Int64	requestId
	)

inline

Clears all attributes of a specified channel. The SDK returns the result by the OnClearChannelAttributesResultHandler callback.

Note

You do not have to join the specified channel to clear its attributes.
The attributes of a channel will be cleared if the channel remains empty (has no members) for a couple of minutes.
For SetChannelAttributes, DeleteChannelAttributesByKeys and ClearChannelAttributes taken together: the maximum call frequency is 10 calls every five seconds.

Parameters

channelId	The channel ID of the specified channel.
enableNotificationToChannelMembers	Indicates whether or not to notify all channel members of a channel attribute change.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ ClearLocalUserAttributes()

int agora_rtm.RtmClient.ClearLocalUserAttributes ( Int64 requestId )

inline

Clears all attributes of the local user. The SDK returns the result by the OnClearLocalUserAttributesResultHandler callback.

Note: For DeleteLocalUserAttributesByKeys and ClearLocalUserAttributes taken together: the maximum call frequency is 10 calls every five seconds.

Parameters

requestId The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ CreateChannel()

RtmChannel agora_rtm.RtmClient.CreateChannel	(	string	channelId,
		RtmChannelEventHandler	rtmChannelEventHandler
	)

inline

Creates an Agora RTM channel.

If the method call succeeds, the SDK returns an RtmChannel instance.
If this method call fails, the SDK returns null.
Note
You can create multiple channels in an RtmClient instance. But you can only join a maximum of 20 channels at the same time. As a good practice, Agora recommends calling the Dispose method to release all resources of an RTM channel that you no longer use.

Parameters

channelId

The unique channel name. A channelId cannot be empty, null, or "null". Must be less than 64 bytes in length. Supported characters:

All lowercase English letters: a to z
All uppercase English letters: A to Z
All numeric characters: 0 to 9
The space character.
Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","

rtmChannelEventHandler See RtmChannelEventHandler.

Returns

An RtmChannel object: Success. If a channel with the same channelId does not exist, the method returns the created channel instance. If a channel with the same channelId already exists, the method returns the existing channel instance.
null: Failure. Possible reasons: The channelId is invalid or you have joined the maximum number of channels.

◆ CreateChannelAttribute()

RtmChannelAttribute agora_rtm.RtmClient.CreateChannelAttribute ( )

inline

Creates an RtmChannelAttribute instance.

Returns: An RtmChannelAttribute instance.

◆ CreateFileMessageByMediaId()

FileMessage agora_rtm.RtmClient.CreateFileMessageByMediaId ( string mediaId )

inline

Creates an FileMessage instance by media ID.

Deprecated:: This method is deprecated. Agora recommends that you do not use it.

If you have at hand the media ID of a file on the Agora server, you can call this method to create an FileMessage instance.
If you do not have a media ID, then you must call CreateFileMessageByUploading to get a corresponding FileMessage instance by uploading a file to the Agora RTM server.

Parameters

mediaId The media ID of an uploaded file on the Agora server.

Returns: An FileMessage instance.

◆ CreateFileMessageByUploading()

int agora_rtm.RtmClient.CreateFileMessageByUploading	(	string	filePath,
		Int64	requestId
	)

inline

Gets an FileMessage instance by uploading a file to the Agora server.

Deprecated:: This method is deprecated. Agora recommends that you do not use it.

The SDK returns the result with the OnFileMediaUploadResultHandler callback. If success, this callback returns a corresponding FileMessage instance.

Parameters

filePath	The full path to the local file to upload. Must be in UTF-8.
requestId	The unique ID of this upload request.

Returns

0: Success.
≠0: Failure. See UPLOAD_MEDIA_ERR_CODE for the error codes.

◆ CreateImageMessageByMediaId()

ImageMessage agora_rtm.RtmClient.CreateImageMessageByMediaId ( string mediaId )

inline

Creates an ImageMessage instance by media ID.

Deprecated:: This method is deprecated. Agora recommends that you do not use it.

If you have at hand the media ID of an image on the Agora server, you can call this method to create an ImageMessage instance.
If you do not have a media ID, then you must call CreateImageMessageByUploading to get a corresponding ImageMessage instance by uploading an image to the Agora RTM server.

Parameters

mediaId The media ID of an uploaded image on the Agora server.

Returns: An ImageMessage instance.

◆ CreateImageMessageByUploading()

int agora_rtm.RtmClient.CreateImageMessageByUploading	(	string	filePath,
		Int64	requestId
	)

inline

Gets an ImageMessage instance by uploading an image to the Agora server.

Deprecated:: This method is deprecated. Agora recommends that you do not use it.

The SDK returns the result by the OnImageMediaUploadResultHandler callback. If success, this callback returns a corresponding ImageMessage instance.

If the uploaded image is in JPEG, JPG, BMP, or PNG format, the SDK calculates the width and height of the image. You can call GetWidth to get the calculated width.
Otherwise, you need to call SetWidth and SetHeight to set the width and height of the uploaded image by yourself.
Note
- If you have at hand the media ID of an image on the Agora server, you can call CreateImageMessageByMediaId to create an ImageMessage instance.
- To cancel an ongoing image upload task, call CancelMediaUpload.

Parameters

filePath	The full path to the local image to upload. Must be in UTF-8.
requestId	The unique ID of the upload request.

Returns

0: Success.
≠0: Failure. See UPLOAD_MEDIA_ERR_CODE for the error codes.

◆ CreateMessage() [1/4]

TextMessage agora_rtm.RtmClient.CreateMessage ( )

inline

Creates an empty TextMessage instance.

Note

An TextMessage instance can be used either for a channel message or for a peer-to-peer message.
When you no longer need an TextMessage instance, please call the Dispose method to release all resources that it is using.
You can set the content of the text message at a later point using the SetText method, but please ensure that the size of the text message does not exceed 32 KB.

Returns: An empty text TextMessage instance.

◆ CreateMessage() [2/4]

TextMessage agora_rtm.RtmClient.CreateMessage ( byte[] rawData )

inline

Creates a raw TextMessage instance.

Note

An TextMessage instance can be used either for a channel message or for a peer-to-peer message.
When you no longer need an TextMessage instance, please call the Dispose method to release all resources that it is using.
You can set a brief text description of the raw message at a later point using the SetText method, but please ensure that the size of the raw message and the description combined does not exceed 32 KB.

Parameters

rawData The starting address of the raw message.

Returns: An raw TextMessage instance.

◆ CreateMessage() [3/4]

TextMessage agora_rtm.RtmClient.CreateMessage	(	byte[]	rawData,
		string	description
	)

inline

Creates a raw TextMessage instance and sets its description.

An TextMessage instance can be used either for a channel message or for a peer-to-peer message.
When you no longer need an TextMessage instance, please call the Dispose method to release all resources that it is using.
You can set description as "" and add a brief text description of the raw message at a later point using the SetText method, but please ensure that the size of the raw message and the description combined does not exceed 32 KB.

Parameters

rawData	The starting address of the raw message.
description	A brief text description of the raw message. If you set a text description, ensure that the size of the raw message and the description combined does not exceed 32 KB.

Returns: An raw TextMessage instance with a brief text description.

◆ CreateMessage() [4/4]

TextMessage agora_rtm.RtmClient.CreateMessage ( string text )

inline

Creates a text TextMessage instance.

Note

An TextMessage instance can be used either for a channel message or for a peer-to-peer message.
When you no longer need an TextMessage instance, please call the Dispose method to release all resources that it is using.

Parameters

text	The text content of the message.

Returns: An text TextMessage instance.

◆ DeleteChannelAttributesByKeys()

int agora_rtm.RtmClient.DeleteChannelAttributesByKeys	(	string	channelId,
		string[]	attributeKeys,
		bool	enableNotificationToChannelMembers,
		Int64	requestId
	)

inline

Deletes the attributes of a specified channel by attribute keys. The SDK returns the result by the OnDeleteChannelAttributesResultHandler callback.

Note

You do not have to join the specified channel to update its attributes.
The attributes of a channel will be cleared if the channel remains empty (has no members) for a couple of minutes.
If more than one user can update the channel attributes, then Agora recommends calling GetChannelAttributes to update the cache before calling this method.
For SetChannelAttributes, DeleteChannelAttributesByKeys and ClearChannelAttributes taken together: the maximum call frequency is 10 calls every five seconds.

Parameters

channelId	The channel ID of the specified channel.
attributeKeys	An array of channel attribute keys.
enableNotificationToChannelMembers	Indicates whether or not to notify all channel members of a channel attribute change.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ DeleteLocalUserAttributesByKeys()

int agora_rtm.RtmClient.DeleteLocalUserAttributesByKeys	(	string[]	attributeKeys,
		Int64	requestId
	)

inline

Deletes the local user's attributes by attribute keys. The SDK returns the result by the OnDeleteLocalUserAttributesResultHandler callback.

Note: For DeleteLocalUserAttributesByKeys and ClearLocalUserAttributes taken together: the maximum call frequency is 10 calls every five seconds.

Parameters

attributeKeys	An array of the attribute keys to be deleted.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ Dispose()

void agora_rtm.RtmClient.Dispose ( )

inline

◆ DownloadMediaToFile()

int agora_rtm.RtmClient.DownloadMediaToFile	(	string	mediaId,
		string	filePath,
		Int64	requestId
	)

inline

Downloads a file or image from the Agora server to a specified local directory by media ID.

Deprecated:: This method is deprecated. Agora recommends that you do not use it.

The SDK returns the result of this method call by the OnMediaDownloadToFileResultHandler callback.

Parameters

mediaId	The media ID of the file or image on the Agora server.
filePath	The full path to the downloaded file or image. Must be in UTF-8.
requestId	The unique ID of this download request.

Returns

0: Success.
≠0: Failure.See DOWNLOAD_MEDIA_ERR_CODE for the error codes.

◆ DownloadMediaToMemory()

int agora_rtm.RtmClient.DownloadMediaToMemory	(	string	mediaId,
		Int64	requestId
	)

inline

Downloads a file or image from the Agora server to the local memory by media ID.

Deprecated:: This method is deprecated. Agora recommends that you do not use it.

The SDK returns the result of this method call by the OnMediaDownloadToMemoryResultHandler callback.

Note

This method applies to scenarios requiring quick access to the downloaded file or image.
The SDK releases the downloaded file or image immediately after returning the OnMediaDownloadToMemoryResultHandler callback.

Parameters

mediaId	The media ID of the file or image on the Agora server.
requestId	The unique ID of this download request.

Returns

0: Success.
≠0: Failure.See DOWNLOAD_MEDIA_ERR_CODE for the error codes.

◆ GetChannelAttributes()

int agora_rtm.RtmClient.GetChannelAttributes	(	string	channelId,
		Int64	requestId
	)

inline

Gets all attributes of a specified channel. The SDK returns the result by the OnGetChannelAttributesResultHandler callback.

Parameters

channelId	The channel ID of the specified channel.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ GetChannelAttributesByKeys()

int agora_rtm.RtmClient.GetChannelAttributesByKeys	(	string	channelId,
		string[]	attributeKeys,
		Int64	requestId
	)

inline

Gets the attributes of a specified channel by attribute keys. The SDK returns the result by the OnGetChannelAttributesResultHandler callback.

Note

You do not have to join the specified channel to get its attributes.
For GetChannelAttributes and GetChannelAttributesByKeys taken together, the maximum call frequency is 10 calls every five seconds.

Parameters

channelId	The channel ID of the specified channel.
attributeKeys	An array of attribute keys.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ GetChannelMemberCount()

int agora_rtm.RtmClient.GetChannelMemberCount	(	string[]	channelIds,
		Int64	requestId
	)

inline

Gets the member count of specified channels. The SDK returns the result by the OnGetChannelMemberCountResultHandler callback.

Note

The call frequency limit for this method is one query per second.
We do not support getting the member counts of more than 32 channels in one method call.
You do not have to join the specified channels to call this method.

Parameters

channelIds	An array of the specified channel IDs.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See GET_CHANNEL_MEMBER_COUNT_ERR_CODE for the error codes.

◆ GetRtmCallManager()

RtmCallManager agora_rtm.RtmClient.GetRtmCallManager ( RtmCallEventHandler eventHandler )

inline

Gets an RtmCallManager object. Each RtmClient object corresponds to a unique RtmCallManager object. That said, the RtmCallManager object is RtmClient-specific.

Note: When you do no use RtmCallManager, call the Dispose method to release all of its resources.

Parameters

eventHandler An RtmCallEventHandler object.

Returns: An RtmCallManager object.

◆ GetSdkVersion()

static string agora_rtm.RtmClient.GetSdkVersion ( )

inlinestatic

Gets the SDK version.

Returns: The current version of the Agora RTM SDK in the string format. For example, 1.0.0.

◆ GetUserAttributes()

int agora_rtm.RtmClient.GetUserAttributes	(	string	userId,
		Int64	requestId
	)

inline

Gets all attributes of a specified user. The SDK returns the result by the OnGetUserAttributesResultHandler callback.

Parameters

userId	The user ID of the specified user.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ GetUserAttributesByKeys()

int agora_rtm.RtmClient.GetUserAttributesByKeys	(	string	userId,
		string[]	attributeKeys,
		Int64	requestId
	)

inline

Gets the attributes of a specified user by attribute keys. The SDK returns the result by the OnGetUserAttributesResultHandler callback.

Note: For GetUserAttributes and GetUserAttributesByKeys taken together, the maximum call frequency is 40 calls every five seconds.

Parameters

userId	The user ID of the specified user.
attributeKeys	An array of the attribute keys.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ Login()

int agora_rtm.RtmClient.Login	(	string	token,
		string	userId
	)

inline

Logs in the Agora RTM system.

If this method call succeeds, the local user receives the OnLoginSuccessHandler callback.
If this method call fails, the local user receives the OnLoginFailureHandler callback. See LOGIN_ERR_CODE for the error codes.
Note
- If you login with the same user ID from a different instance, your previous login will be kicked and you will be removed from the previously joined channels.
- The call frequency limit for this method is 2 queries per second.
- Only after you successfully call this method and when the SDK is in the <CONNECTION_STATE_CONNECTED> state, can you call the key RTM methods except:

Parameters

token The token used to log in the Agora RTM system and used when dynamic authentication is enabled. Set token as null in the integration and test stages.

userId

The user ID of the user logging in the Agora RTM system. The string length must be less than 64 bytes with the following character scope:

All lowercase English letters: a to z
All uppercase English letters: A to Z
All numeric characters: 0 to 9
The space character.
Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", "," A userId cannot be empty, null or "null".

Returns

0: Success.
≠0: Failure. See LOGIN_ERR_CODE for the error codes.

◆ Logout()

int agora_rtm.RtmClient.Logout ( )

inline

Logs out of the Agora RTM system. The local user receives the OnLogoutHandler callback.

Returns

0: Success.
≠0: Failure. See LOGOUT_ERR_CODE for the error codes.

◆ QueryPeersBySubscriptionOption()

int agora_rtm.RtmClient.QueryPeersBySubscriptionOption	(	PEER_SUBSCRIPTION_OPTION	option,
		Int64	requestId
	)

inline

Gets a list of the peers, to whose specific status you have subscribed. The SDK returns the result by the OnQueryPeersBySubscriptionOptionResultHandler callback.

Parameters

option	The status type, to which you have subscribed.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR for the error codes.

◆ QueryPeersOnlineStatus()

int agora_rtm.RtmClient.QueryPeersOnlineStatus	(	string[]	peerIds,
		Int64	requestId
	)

inline

Queries the online status of the specified users.

Online: The user has logged in the Agora RTM system.
Offline: The user has logged out of the Agora RTM system.
Note
The frequency of calls is capped at 10 times every 5 seconds. The SDK returns the result by the OnQueryPeersOnlineStatusResultHandler callback.

Parameters

peerIds	An array of the specified user IDs. The maximum number of `peerIds` is 256.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See QUERY_PEERS_ONLINE_STATUS_ERR for the error codes.

◆ RenewToken()

int agora_rtm.RtmClient.RenewToken ( string token )

inline

Renews the RTM Token of the SDK. You are required to renew your RTM Token when receiving the OnTokenExpiredHandler callback, and the OnRenewTokenResultHandler callback returns the result of this method call. The call frequency limit for this method is 2 calls per second.

Parameters

token Your new RTM Token. You need to generate the RTM Token yourself. See Generate an RTM Token.

Returns

0: Success.
≠0: Failure. See RENEW_TOKEN_ERR_CODE for the error codes.

◆ SendMessageToPeer() [1/2]

int agora_rtm.RtmClient.SendMessageToPeer	(	string	peerId,
		IMessage	message
	)

inline

Note

We do not recommend using this method to send a peer-to-peer message. Use SendMessageToPeer instead.
You can send messages, including peer-to-peer and channel messages, at a maximum frequency of 180 calls every three seconds.

Parameters

peerId	User ID of the receiver.
message	The message to be sent. For information about creating a message, see IMessage.

Returns

0: Success.
≠0: Failure. See PEER_MESSAGE_ERR_CODE for the error codes.

◆ SendMessageToPeer() [2/2]

int agora_rtm.RtmClient.SendMessageToPeer	(	string	peerId,
		IMessage	message,
		SendMessageOptions	options
	)

inline

Sends a peer-to-peer message to a specified user (receiver).

The OnSendMessageResultHandler callback returns the result of this method call.
When the message arrives at the receiver, the receiver receives the OnMessageReceivedFromPeerHandler callback.
Note
- If you use this method to send off a text message that starts off with AGORA_RTM_ENDCALL_PREFIX_<channelId>_<your additional information>, then this method is compatible with the endCall method of the legacy Agora Signaling SDK. Replace <channelId> with the channel ID from which you want to leave (end call), and replace <your additional information> with any additional information.
- You must not put any "_" (underscore" in your additional information but you can set \<your additional information\> as empty "".

Parameters

peerId	User ID of the receiver. The string must not exceed 64 bytes in length. It cannot be empty, null, or "null". Supported characters: The 26 lowercase English letters: a to z The 26 uppercase English letters: A to Z The 10 numbers: 0 to 9 "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "\|", "~", ","
message	The message to be sent. For information about creating a message, see IMessage.
options	Options when sending the message to a peer. See SendMessageOptions.

Returns

0: Success.
≠0: Failure. See PEER_MESSAGE_ERR_CODE for the error codes.

◆ SetChannelAttributes()

int agora_rtm.RtmClient.SetChannelAttributes	(	string	channelId,
		RtmChannelAttribute[]	attributes,
		ChannelAttributeOptions	options,
		Int64	requestId
	)

inline

Resets the attributes of a specified channel. The SDK returns the result by the OnSetChannelAttributesResultHandler callback.

Note

You do not have to join the specified channel to update its attributes.
The attributes of a channel will be cleared if the channel remains empty (has no members) for a couple of minutes.
If more than one user can update the channel attributes, then Agora recommends calling GetChannelAttributes to update the cache before calling this method.
For DeleteLocalUserAttributesByKeys and ClearLocalUserAttributes taken together: the maximum call frequency is 10 calls every five seconds.

Parameters

channelId	The channel ID of the specified channel.
attributes	An array of channel attributes. See RtmChannelAttribute.
options	Options for this attribute operation. See ChannelAttributeOptions.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See ATTRIBUTE_OPERATION_ERR for the error codes.

◆ SetLogFile()

int agora_rtm.RtmClient.SetLogFile ( string logFilePath )

inline

Specifies the default path to the SDK log file.

Note

Ensure that the directory holding the log file exists and is writable.
Ensure that you call this method immediately after calling the RtmClient method to create a RtmClient instance, otherwise the output log may be incomplete.
This method is called globally. If multiple instances call this method, the last called method takes effect.

Parameters

logFilePath The absolute file path to the log file. The string of logFilePath is in UTF-8.

Returns

0: Success.
≠0: Failure.

◆ SetLogFileSize()

int agora_rtm.RtmClient.SetLogFileSize ( int fileSizeInKBytes )

inline

Sets the size of a single log file. The SDK has two log files with the same size.

Note: This method is called globally. If multiple instances call this method, the last called method takes effect.

Parameters

fileSizeInKBytes The size of a single log file (KB).The default is 10240 (KB). The value range is [512 KB, 1 GB].

Returns

0: Success.
≠0: Failure.

◆ SetLogFilter()

int agora_rtm.RtmClient.SetLogFilter ( int fileter )

inline

Sets the output log level of the SDK. You can use one or a combination of the filters. The log level follows the sequence of OFF, CRITICAL, ERROR, WARNING, and INFO. Choose a level to see the logs preceding that level. If, for example, you set the log level to WARNING, you see the logs within levels CRITICAL, ERROR, and WARNING.

Note: This method is called globally. If multiple instances call this method, the last called method takes effect.

Parameters

fileter The log filter level.

Returns

0: Success.
≠0: Failure.

◆ SetParameters()

int agora_rtm.RtmClient.SetParameters ( string parameters )

inline

Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options.

Note: The JSON options are not public by default. Agora is working on making commonly used JSON options public in a standard way. Contact suppo.nosp@m.rt@a.nosp@m.gora..nosp@m.io for more information.

Parameters

parameters SDK options in the JSON format.

Returns

0: Success.
≠0: Failure.

◆ SubscribePeersOnlineStatus()

int agora_rtm.RtmClient.SubscribePeersOnlineStatus	(	string[]	peerIds,
		Int64	requestId
	)

inline

Subscribes to the online status of the specified users. The SDK returns the result by the OnSubscriptionRequestResultHandler callback.

When the method call succeeds, the SDK returns the OnPeersOnlineStatusChangedHandler callback to report the online status of peers, to whom you subscribe.
When the online status of the peers, to whom you subscribe, changes, the SDK returns the OnPeersOnlineStatusChangedHandler callback to report whose online status has changed.
If the online status of the peers, to whom you subscribe, changes when the SDK is reconnecting to the server, the SDK returns the OnPeersOnlineStatusChangedHandler callback to report whose online status has changed when successfully reconnecting to the server.
Note
- When you log out of the Agora RTM system, all the status that you subscribe to will be cleared. To keep the original subscription after you re-log in the system, you need to redo the whole subscription process.
- When the SDK reconnects to the server from the state of being interupted, the SDK automatically subscribes to the peers and states before the interruption without human intervention.

Parameters

peerIds	An array of the specified user IDs.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See PEER_SUBSCRIPTION_STATUS_ERR for the error codes.

◆ UnsubscribePeersOnlineStatus()

int agora_rtm.RtmClient.UnsubscribePeersOnlineStatus	(	string[]	peerIds,
		Int64	requestId
	)

inline

Unsubscribes from the online status of the specified users. The SDK returns the result by the OnSubscriptionRequestResultHandler callback.

Parameters

peerIds	An array of the specified user IDs.
requestId	The unique ID of this request.

Returns

0: Success.
≠0: Failure. See PEER_SUBSCRIPTION_STATUS_ERR for the error codes.

The documentation for this class was generated from the following file:

RtmClient.cs

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ RtmClient()

Member Function Documentation

◆ CancelMediaDownload()

◆ CancelMediaUpload()

◆ ClearChannelAttributes()

◆ ClearLocalUserAttributes()

◆ CreateChannel()

◆ CreateChannelAttribute()

◆ CreateFileMessageByMediaId()

◆ CreateFileMessageByUploading()

◆ CreateImageMessageByMediaId()

◆ CreateImageMessageByUploading()

◆ CreateMessage() [1/4]

◆ CreateMessage() [2/4]

◆ CreateMessage() [3/4]

◆ CreateMessage() [4/4]

◆ DeleteChannelAttributesByKeys()

◆ DeleteLocalUserAttributesByKeys()

◆ Dispose()

◆ DownloadMediaToFile()

◆ DownloadMediaToMemory()

◆ GetChannelAttributes()

◆ GetChannelAttributesByKeys()

◆ GetChannelMemberCount()

◆ GetRtmCallManager()

◆ GetSdkVersion()

◆ GetUserAttributes()

◆ GetUserAttributesByKeys()

◆ Login()

◆ Logout()

◆ QueryPeersBySubscriptionOption()

◆ QueryPeersOnlineStatus()

◆ RenewToken()

◆ SendMessageToPeer() [1/2]

◆ SendMessageToPeer() [2/2]

◆ SetChannelAttributes()

◆ SetLogFile()

◆ SetLogFileSize()

◆ SetLogFilter()

◆ SetParameters()

◆ SubscribePeersOnlineStatus()

◆ UnsubscribePeersOnlineStatus()