Agora Java API Reference for Android
Classes | Public Member Functions | Public Attributes | List of all members
io.agora.rtm2.RtmConfig Class Reference

Classes

class  LogConfig
 

Public Member Functions

String getAppId ()
 
String getUserId ()
 
IRtmEventHandler getEventHandler ()
 
LogConfig getLogConfig ()
 

Public Attributes

String mAppId
 
String mUserId
 
IRtmEventHandler mEventHandler
 
LogConfig mLogConfig
 

Detailed Description

Configurations for the RtmClient instance.

Member Data Documentation

◆ mAppId

String io.agora.rtm2.RtmConfig.mAppId

The App ID issued to you by Agora. See How to get the App ID. Only users in apps with the same App ID can join the same channel and communicate with each other. Use an App ID to create only one RmClient instance. To change your App ID, call release to release the current RmClient instance and then call create to create an RmClient instance with the new App ID.

◆ mUserId

String io.agora.rtm2.RtmConfig.mUserId

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:

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: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", "," userId cannot be empty, null or "null".

◆ mEventHandler

IRtmEventHandler io.agora.rtm2.RtmConfig.mEventHandler

The callbacks handler IRtmEventHandler reports to the app on RTM SDK runtime events.

◆ mLogConfig

LogConfig io.agora.rtm2.RtmConfig.mLogConfig

The config for customer set log path, log size and log level.