Agora RTM Java API Reference for Android

Creates an RtmClient instance.

The Agora RTM SDK supports creating multiple RtmClient instances.

All methods in the RtmClient class are executed asynchronously.

Parameters

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

Returns

An RtmClient object.

Exceptions

Exception

Returns an exception if appId is invalid (for example, its length is not 32 characters), or context or eventListener is null.

Releases all resources used by the RtmClient instance.

Note: Do not call this method in any of your callbacks.

Allows a user to log in the Agora RTM system.

Note: If you log in with the same user ID from a different instance, you will be kicked out of your previous login and removed from previously joined channels.

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: The 26 lowercase English letters: a to z The 26 uppercase English letters: A to Z The 10 numbers: 0 to 9 Space "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","

Note: userId cannot be empty or set as null.

Parameters

resultCallback

A ResultCallback object. Success: The local user receives the onSuccess callback. Failure: The local user receives the onFailure callback. See LoginError for the error codes.

Allows a user to log out of the Agora RTM system.

Parameters

resultCallback

A ResultCallback object. Success: The local user receives the onSuccess callback. Failure: The local user receives the onFailure callback. See LogoutError for the error codes.

Creates an RtmMessage instance.

Note: The RtmMessage instance can be either for a channel message or for a peer-to-peer message.

Returns

The RtmMessage instance.

Allows the local user to send a peer-to-peer message to a specific remote user.

You can send messages, including peer-to-peer and channel messages, at a maximum speed of 60 queries per second.

Success:

• The local user receives the onSuccess callback.
• The specified remote user receives the onMessageReceived callback.

Failure: The local user receives the onFailure callback with an error. See PeerMessageError for the error codes.

Parameters

peerId	The user ID of the remote user.
message	The message to be sent. For information about creating a message, see RtmMessage.
resultCallback	A ResultCallback object. Success: The local user receives the onSuccess callback. Failure: The local user receives the onFailure callback. See PeerMessageError for the error codes.

Creates an Agora RTM channel.

Note: You can create a maximum of 20 RtmChannel instances in an RtmClient instance at the same time. You must call the RtmChannel.release() method to release the resources of some existing RtmChannel instances when the number of channels is over 20, otherwise the sytem will crash and throw runtime exceptions. You can of course call the RtmClient.release() method to relase all resources used by the RtmClient, but we recommend that you not rely on the SDK to release an RtmChannel.

Parameters

channelId

The unique channel name for the Agora RTM session. The string length must be less than 64 bytes with the following character scope: The 26 lowercase English letters: a to z The 26 uppercase English letters: A to Z The 10 numbers: 0 to 9 Space "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","

Note: Do not set channelId as null.

Parameters

channelListener

An RtmChannelListener object. Success: The SDK returns an RtmChannel instance. Failure: The SDK returns null. channelId may be invalid, or an existing channel with the same channelId exists, or the number of channels is over the limit.

Exceptions

RuntimeException

in any of the cases below: The channelId is invalid. The channelId is already in use. The number of channels in use is over 20. The RtmClient instance is released.

Gets the Agora RTM call manager.

The Agora SDK has one RtmCallManager instance for each RtmClient instance. Different RtmClient instances have different RtmCallManager instances.

Returns

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

The JSON options are not public by default. Agora is working on making commonly used JSON options public in a standard way.

Parameters

parameters

The parameter to set as a JSON string in the specified format.

Returns

• 0: Success.
• < 0: Failure.

Specifies an SDK output log file.

The log file records all SDK operations during SDK runtime. Ensure that the log file exists and is writable.

Parameters

filePath

The file path of the log file. The string of the log file is in UTF-8. The default file path is /sdcard/{Package name of the App}/agorartm.log.

Returns

• 0: Success.
• < 0: Failure.

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, INFO, and DEBUG. Choose a level to see the logs preceding that level. For example, if you set the log level to WARNING, you see the logs within levels CRITICAL, ERROR, and WARNING.

Parameters

filter

Sets the log filter level: LOG_FILTER_OFF(0): Do not output any log. LOG_FILTER_DEBUG(0x80f): Output all logs. LOG_FILTER_INFO(0x0f): Output logs of the CRITICAL, ERROR, WARNING, and INFO levels. LOG_FILTER_WARNING(0x0e): Output logs of the CRITICAL, ERROR, and WARNING levels. LOG_FILTER_ERROR(0x0c): Output logs of the CRITICAL and ERROR levels. LOG_FILTER_CRITICAL(0x08): Output logs of the CRITICAL level.

Returns

• 0: Success.
• < 0: Failure.

0: Do not output any log.

0x80f: Output all API logs.

0x0f: Output logs of the CRITICAL, ERROR, WARNING, and INFO levels.

0x0e: Output logs of the CRITICAL, ERROR, and WARNING levels.

0x0c: Output logs of the CRITICAL and ERROR levels.

0x08: Output logs of the CRITICAL level.