Index

A B C D E F G H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values

A

ACQUIRE_LOCK_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
ACQUIRED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLockEventType
4: Triggered when a remote user acquired lock
acquireLock(String, RtmConstants.RtmChannelType, String, boolean, ResultCallback<Void>) - Method in class io.agora.rtm.RtmLock
acquires a lock
addEventListener(RtmEventListener) - Method in class io.agora.rtm.RtmClient
Adds an event listener for receiving rtm events.
AES_128_GCM - Enum constant in enum class io.agora.rtm.RtmConstants.RtmEncryptionMode
1: 128-bit AES encryption, GCM mode.
AES_256_GCM - Enum constant in enum class io.agora.rtm.RtmConstants.RtmEncryptionMode
2: 256-bit AES encryption, GCM mode.
AffectedResources - Class in io.agora.rtm
 
AffectedResources(String[]) - Constructor for class io.agora.rtm.AffectedResources
 
areaCode(EnumSet<RtmConstants.RtmAreaCode>) - Method in class io.agora.rtm.RtmConfig.Builder
 
AS - Enum constant in enum class io.agora.rtm.RtmConstants.RtmAreaCode
0x00000008: Asia, excluding Mainland China.
AUTO_RECONNECT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
5: Auto reconnect.
AUTO_RECONNECT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
8: Auto reconnect.

B

BANNED_BY_SERVER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
3: The connection between the SDK and the server is banned by the server.
BINARY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmMessageType
0: The binary message.
build() - Method in class io.agora.rtm.RtmConfig.Builder
 
Builder(String, String) - Constructor for class io.agora.rtm.RtmConfig.Builder
 

C

CERTIFICATION_VERIFY_FAILURE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
22: The connection is failed due to certification verify failure.
CHANNEL - Enum constant in enum class io.agora.rtm.RtmConstants.RtmStorageType
2: The channel storage event.
CHANNEL_CUSTOM_TYPE_LENGTH_OVERFLOW - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11029: The custom type length exceeds the limit.
CHANNEL_ENCRYPT_MESSAGE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11023: Encrypt message failed.
CHANNEL_EXCEED_TOPIC_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11014: The topic count exceeds the limit.
CHANNEL_EXCEED_TOPIC_USER_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11003: The topic member count exceeds the limit.
CHANNEL_IN_ERROR_STATE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11006: The channel is in error state.
CHANNEL_IN_ERROR_STATE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
25: Channel in error state.
CHANNEL_IN_REUSE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11004: The channel is reused in RTC.
CHANNEL_INSTANCE_EXCEED_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11005: The channel instance count exceeds the limit.
CHANNEL_INSTANCE_EXCEED_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
23: Channel instance exceed limitation.
CHANNEL_INVALID_CUSTOM_TYPE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11030: The custom type is invalid.
CHANNEL_INVALID_MESSAGE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11009: The message is invalid.
CHANNEL_INVALID_TOPIC_META - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11018: The topic meta is invalid.
CHANNEL_INVALID_TOPIC_NAME - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11008: The topic name is invalid.
CHANNEL_INVALID_USER_LIST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11011: The user list is invalid.
CHANNEL_JOIN_CANCELED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11034: The channel join operation is canceled.
CHANNEL_JOIN_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11007: The channel join failed.
CHANNEL_JOIN_TOPIC_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11015: Join topic failed.
CHANNEL_LEAVE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11028: Leave channel failed.
CHANNEL_MESSAGE_DELIVERED_BUT_STORE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11037: The message delivered successfully but store in history failed.
CHANNEL_MESSAGE_LENGTH_EXCEED_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11010: The message length exceeds the limit.
CHANNEL_NOT_AVAILABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11012: The stream channel is not available.
CHANNEL_NOT_CONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11027: The connection state is invalid.
CHANNEL_NOT_JOINED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11001 ~ -12000 : reserved for channel error.
CHANNEL_NOT_SUBSCRIBED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11002: The user has not subscribed the channel.
CHANNEL_PRESENCE_NOT_READY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11032: The channel presence is not ready.
CHANNEL_PUBLISH_MESSAGE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11024: Publish message failed.
CHANNEL_PUBLISH_MESSAGE_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11026: Publish message timeout.
CHANNEL_PUBLISH_MESSAGE_TOO_FREQUENT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11025: Publish message too frequent.
CHANNEL_PUBLISH_PERMISSION_DENIED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11039: The publish permission is denied.
CHANNEL_RECEIVER_OFFLINE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11033: The destination user of publish message is offline.
CHANNEL_RECEIVER_OFFLINE_AND_STORE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11036: The message receiver is offline and the message store in history failed.
CHANNEL_RECEIVER_OFFLINE_BUT_STORE_SUCCEEDED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11035: The message receiver is offline but the message store in history succeeded.
CHANNEL_SUBSCRIBE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11021: Subscribe channel failed.
CHANNEL_SUBSCRIBE_PERMISSION_DENIED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11038: The subscribe permission is denied.
CHANNEL_SUBSCRIBE_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11019: Subscribe channel timeout.
CHANNEL_SUBSCRIBE_TOO_FREQUENT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11020: Subscribe channel too frequent.
CHANNEL_TOPIC_NOT_EXIST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11017: The topic does not exist.
CHANNEL_TOPIC_NOT_JOINED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11016: The topic is not joined.
CHANNEL_TOPIC_NOT_SUBSCRIBED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11013: The topic is not subscribed.
CHANNEL_UNSUBSCRIBE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11022: Unsubscribe channel failed.
CHANNEL_UNSUPPORTED_MESSAGE_TYPE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-11031: unsupported message type (in MacOS/iOS platform,message only support NSString and NSData)
ChannelInfo - Class in io.agora.rtm
The channel information.
ChannelInfo(String, int) - Constructor for class io.agora.rtm.ChannelInfo
 
CLIENT_IP_ADDRESS_CHANGED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
13: The IP Address of the app has changed.
CLIENT_IP_ADDRESS_CHANGED_BY_USER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
18: The local IP Address is changed by user.
CLOUD_TCP - Enum constant in enum class io.agora.rtm.RtmConstants.RtmProxyType
2: Link with tcp cloud proxy
CN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmAreaCode
0x00000001: Mainland China.
CONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionState
3: The SDK is connected to the server and has joined a channel.
CONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkState
2: The SDK has connected to the server.
CONNECTING - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
0: The SDK is connecting to the server.
CONNECTING - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionState
2: The SDK is connecting to the server.
CONNECTING - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkState
1: The SDK is connecting to the server.
CONNECTION_ERROR - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
30: Connection error.
create(RtmConfig) - Static method in class io.agora.rtm.RtmClient
Create rtm client instance.
createStreamChannel(String) - Method in class io.agora.rtm.RtmClient
Create a stream channel instance.

D

DISCONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionState
1: The SDK is disconnected with server.
DISCONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkState
3: The SDK is disconnected from the server.
DUPLICATE_OPERATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10017: Already call same request.

E

ECHO_TEST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
17: The change of connection state is caused by echo test.
encryptionConfig(RtmEncryptionConfig) - Method in class io.agora.rtm.RtmConfig.Builder
 
ERROR - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLogLevel
0x0004: Errors.
ERROR_OUT_OF_SERVICE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
7: Triggered when user joined channel without presence service
ErrorInfo - Class in io.agora.rtm
The warning or error code and description.
ErrorInfo(RtmConstants.RtmErrorCode) - Constructor for class io.agora.rtm.ErrorInfo
Constructs a new instance of RtmErrorCode with the specified errorCode.
ErrorInfo(RtmConstants.RtmErrorCode, String) - Constructor for class io.agora.rtm.ErrorInfo
Constructs a new instance of RtmErrorCode with the specified errorCode and specified reason detail.
ErrorInfo(RtmConstants.RtmErrorCode, String, String) - Constructor for class io.agora.rtm.ErrorInfo
Constructs a new instance of RtmErrorCode with the specified errorCode, specified reason detail and specified operation.
EU - Enum constant in enum class io.agora.rtm.RtmConstants.RtmAreaCode
0x00000004: Europe.
eventListener(RtmEventListener) - Method in class io.agora.rtm.RtmConfig.Builder
 
EXPIRED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLockEventType
6: Triggered when user reconnect to rtm service, detect the lock has been acquired and released by others.

F

FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionState
5: The SDK fails to connect to the server or join the channel.
FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkState
5: The SDK is failed to connect to the server.
FATAL - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLogLevel
0x0008: Critical errors that may lead to program termination.

G

GET_CHANNEL_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
GET_LOCKS_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
GET_MESSAGES_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
GET_ONLINE_USERS_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
GET_STATE_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
GET_SUBSCRIBED_USER_LIST_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
GET_USER_CHANNELS_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
GET_USER_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
getAccessPointHosts() - Method in class io.agora.rtm.RtmPrivateConfig
 
getAccount() - Method in class io.agora.rtm.RtmProxyConfig
 
getAffectedChannels() - Method in class io.agora.rtm.LinkStateEvent
 
getAffectedResources() - Method in class io.agora.rtm.TokenEvent
 
getAppId() - Method in class io.agora.rtm.RtmConfig
 
getAreaCode() - Method in class io.agora.rtm.RtmConfig
 
getAuthorUserId() - Method in class io.agora.rtm.MetadataItem
 
getChannelMetadata(String, RtmConstants.RtmChannelType, ResultCallback<Metadata>) - Method in class io.agora.rtm.RtmStorage
Get the metadata of a specified channel.
getChannelName() - Method in class io.agora.rtm.ChannelInfo
 
getChannelName() - Method in class io.agora.rtm.LockEvent
 
getChannelName() - Method in class io.agora.rtm.MessageEvent
 
getChannelName() - Method in class io.agora.rtm.PresenceEvent
 
getChannelName() - Method in class io.agora.rtm.StreamChannel
Return the channel name of this stream channel.
getChannelName() - Method in class io.agora.rtm.TopicEvent
 
getChannelType() - Method in class io.agora.rtm.ChannelInfo
 
getChannelType() - Method in class io.agora.rtm.LockEvent
 
getChannelType() - Method in class io.agora.rtm.MessageEvent
 
getChannelType() - Method in class io.agora.rtm.PresenceEvent
 
getChannelType() - Method in class io.agora.rtm.PublishOptions
 
getChannelType() - Method in class io.agora.rtm.StorageEvent
 
getCurrentState() - Method in class io.agora.rtm.LinkStateEvent
 
getCustomType() - Method in class io.agora.rtm.HistoryMessage
 
getCustomType() - Method in class io.agora.rtm.MessageEvent
 
getCustomType() - Method in class io.agora.rtm.PublishOptions
 
getCustomType() - Method in class io.agora.rtm.TopicMessageOptions
 
getData() - Method in class io.agora.rtm.RtmMessage
Retrieves the payload of the message.
getData() - Method in class io.agora.rtm.StorageEvent
 
getEncryptionConfig() - Method in class io.agora.rtm.RtmConfig
 
getEncryptionKey() - Method in class io.agora.rtm.RtmEncryptionConfig
 
getEncryptionMode() - Method in class io.agora.rtm.RtmEncryptionConfig
 
getEncryptionSalt() - Method in class io.agora.rtm.RtmEncryptionConfig
 
getEnd() - Method in class io.agora.rtm.GetHistoryMessagesOptions
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmChannelType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmConnectionState
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkState
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmLockEventType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmMessageType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmProtocolType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmServiceType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmStorageType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmTokenEventType
 
getEnum(int) - Static method in enum class io.agora.rtm.RtmConstants.RtmTopicEventType
 
getEnum(Integer) - Static method in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
 
getEnum(Integer) - Static method in enum class io.agora.rtm.RtmConstants.RtmErrorCode
 
getEnum(Integer) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
 
getErrorCode() - Method in class io.agora.rtm.ErrorInfo
Retrieves the warning or error code.
getErrorReason() - Method in class io.agora.rtm.ErrorInfo
Retrieves the warning or error reason.
getErrorReason(RtmConstants.RtmErrorCode) - Method in class io.agora.rtm.RtmClient
Convert error code to error string.
getEventListener() - Method in class io.agora.rtm.RtmConfig
 
getEventType() - Method in class io.agora.rtm.LockEvent
 
getEventType() - Method in class io.agora.rtm.PresenceEvent
 
getEventType() - Method in class io.agora.rtm.StorageEvent
 
getEventType() - Method in class io.agora.rtm.TokenEvent
 
getFailedUsers() - Method in class io.agora.rtm.SubscribeTopicResult
 
getFilePath() - Method in class io.agora.rtm.RtmLogConfig
 
getFileSize() - Method in class io.agora.rtm.RtmLogConfig
 
getHeartbeatInterval() - Method in class io.agora.rtm.RtmConfig
 
getHistory() - Method in class io.agora.rtm.RtmClient
Get the history instance.
GetHistoryMessagesOptions - Class in io.agora.rtm
This class represents options for retrieving the message history of a channel.
GetHistoryMessagesOptions() - Constructor for class io.agora.rtm.GetHistoryMessagesOptions
Constructs a new instance of GetHistoryMessagesOptions with default parameters.
GetHistoryMessagesOptions(int, long, long) - Constructor for class io.agora.rtm.GetHistoryMessagesOptions
Constructs a new instance of GetHistoryMessagesOptions with the specified options.
getIncludeState() - Method in class io.agora.rtm.GetOnlineUsersOptions
 
getIncludeState() - Method in class io.agora.rtm.PresenceOptions
 
getIncludeUserId() - Method in class io.agora.rtm.GetOnlineUsersOptions
 
getIncludeUserId() - Method in class io.agora.rtm.PresenceOptions
 
getInstance() - Static method in class io.agora.rtm.RtmClient
Get rtm client instance.
getInterval() - Method in class io.agora.rtm.PresenceEvent
 
getIsResumed() - Method in class io.agora.rtm.LinkStateEvent
 
getItemArray() - Method in class io.agora.rtm.Metadata
 
getItems() - Method in class io.agora.rtm.Metadata
 
getJoinUserList() - Method in class io.agora.rtm.IntervalInfo
 
getKey() - Method in class io.agora.rtm.MetadataItem
 
getLeaveUserList() - Method in class io.agora.rtm.IntervalInfo
 
getLevel() - Method in class io.agora.rtm.RtmLogConfig
 
getLock() - Method in class io.agora.rtm.RtmClient
Get the lock instance.
getLockDetailList() - Method in class io.agora.rtm.LockEvent
 
getLockName() - Method in class io.agora.rtm.LockDetail
 
getLockOwner() - Method in class io.agora.rtm.LockDetail
 
getLocks(String, RtmConstants.RtmChannelType, ResultCallback<ArrayList<LockDetail>>) - Method in class io.agora.rtm.RtmLock
gets locks in the channel.
getLogConfig() - Method in class io.agora.rtm.RtmConfig
 
getMajorRevision() - Method in class io.agora.rtm.Metadata
 
getMessage() - Method in class io.agora.rtm.HistoryMessage
 
getMessage() - Method in class io.agora.rtm.MessageEvent
 
getMessageChannels() - Method in class io.agora.rtm.AffectedResources
 
getMessageCount() - Method in class io.agora.rtm.GetHistoryMessagesOptions
 
getMessageList() - Method in class io.agora.rtm.GetMessagesResult
 
getMessagePriority() - Method in class io.agora.rtm.JoinTopicOptions
 
getMessageQos() - Method in class io.agora.rtm.JoinTopicOptions
 
getMessages(String, RtmConstants.RtmChannelType, GetHistoryMessagesOptions, ResultCallback<GetMessagesResult>) - Method in class io.agora.rtm.RtmHistory
gets history messages in the channel.
GetMessagesResult - Class in io.agora.rtm
 
GetMessagesResult(long, ArrayList<HistoryMessage>) - Constructor for class io.agora.rtm.GetMessagesResult
 
getNewStart() - Method in class io.agora.rtm.GetMessagesResult
 
getNextPage() - Method in class io.agora.rtm.GetOnlineUsersResult
 
getNextPage() - Method in class io.agora.rtm.WhoNowResult
 
getOnlineUsers(String, RtmConstants.RtmChannelType, GetOnlineUsersOptions, ResultCallback<GetOnlineUsersResult>) - Method in class io.agora.rtm.RtmPresence
To query who joined this channel
GetOnlineUsersOptions - Class in io.agora.rtm
This class represents options for retrieving online users.
GetOnlineUsersOptions() - Constructor for class io.agora.rtm.GetOnlineUsersOptions
Constructs an GetOnlineUsersOptions object with default parameters.
GetOnlineUsersOptions(boolean, boolean) - Constructor for class io.agora.rtm.GetOnlineUsersOptions
Constructs an GetOnlineUsersOptions object with the specified options(whether include user id and state)
GetOnlineUsersOptions(boolean, boolean, String) - Constructor for class io.agora.rtm.GetOnlineUsersOptions
Constructs a new instance of GetOnlineUsersOptions with the specified options.
GetOnlineUsersResult - Class in io.agora.rtm
 
GetOnlineUsersResult(String, ArrayList<UserState>, int) - Constructor for class io.agora.rtm.GetOnlineUsersResult
 
getOperation() - Method in class io.agora.rtm.ErrorInfo
Retrieves current operation.
getOperation() - Method in class io.agora.rtm.LinkStateEvent
 
getPage() - Method in class io.agora.rtm.GetOnlineUsersOptions
 
getPage() - Method in class io.agora.rtm.PresenceOptions
 
getPassword() - Method in class io.agora.rtm.RtmProxyConfig
 
getPort() - Method in class io.agora.rtm.RtmProxyConfig
 
getPresence() - Method in class io.agora.rtm.RtmClient
Get the presence instance.
getPresenceTimeout() - Method in class io.agora.rtm.RtmConfig
 
getPreviousState() - Method in class io.agora.rtm.LinkStateEvent
 
getPrivateConfig() - Method in class io.agora.rtm.RtmConfig
 
getProtocolType() - Method in class io.agora.rtm.RtmConfig
 
getProxyConfig() - Method in class io.agora.rtm.RtmConfig
 
getProxyType() - Method in class io.agora.rtm.RtmProxyConfig
 
getPublisher() - Method in class io.agora.rtm.HistoryMessage
 
getPublisher() - Method in class io.agora.rtm.TopicEvent
 
getPublisherId() - Method in class io.agora.rtm.MessageEvent
 
getPublisherId() - Method in class io.agora.rtm.PresenceEvent
 
getPublisherMeta() - Method in class io.agora.rtm.PublisherInfo
 
getPublishers() - Method in class io.agora.rtm.TopicInfo
 
getPublisherUserId() - Method in class io.agora.rtm.PublisherInfo
 
getReason() - Method in class io.agora.rtm.LinkStateEvent
 
getReason() - Method in class io.agora.rtm.TokenEvent
 
getReasonCode() - Method in class io.agora.rtm.LinkStateEvent
 
getReconnectTimeout() - Method in class io.agora.rtm.RtmConfig
 
getRecordTs() - Method in class io.agora.rtm.MetadataOptions
 
getRecordUserId() - Method in class io.agora.rtm.MetadataOptions
 
getRevision() - Method in class io.agora.rtm.MetadataItem
 
getSendTs() - Method in class io.agora.rtm.TopicMessageOptions
 
getServer() - Method in class io.agora.rtm.RtmProxyConfig
 
getServiceType() - Method in class io.agora.rtm.LinkStateEvent
 
getServiceType() - Method in class io.agora.rtm.RtmPrivateConfig
 
getSnapshot() - Method in class io.agora.rtm.PresenceEvent
 
getStart() - Method in class io.agora.rtm.GetHistoryMessagesOptions
 
getState(String, RtmConstants.RtmChannelType, String, ResultCallback<UserState>) - Method in class io.agora.rtm.RtmPresence
Get user state
getStateItems() - Method in class io.agora.rtm.PresenceEvent
 
getStates() - Method in class io.agora.rtm.UserState
 
getStorage() - Method in class io.agora.rtm.RtmClient
Get the storage instance.
getStorageType() - Method in class io.agora.rtm.StorageEvent
 
getStoreInHistory() - Method in class io.agora.rtm.PublishOptions
 
getSubscribedUserList(String, ResultCallback<ArrayList<String>>) - Method in class io.agora.rtm.StreamChannel
Get subscribed user list
getSucceedUsers() - Method in class io.agora.rtm.SubscribeTopicResult
 
getSyncWithMedia() - Method in class io.agora.rtm.JoinTopicOptions
 
getTarget() - Method in class io.agora.rtm.StorageEvent
 
getTimeoutUserList() - Method in class io.agora.rtm.IntervalInfo
 
getTimestamp() - Method in class io.agora.rtm.HistoryMessage
 
getTimestamp() - Method in class io.agora.rtm.LinkStateEvent
 
getTimestamp() - Method in class io.agora.rtm.LockEvent
 
getTimestamp() - Method in class io.agora.rtm.MessageEvent
 
getTimestamp() - Method in class io.agora.rtm.PresenceEvent
 
getTimestamp() - Method in class io.agora.rtm.StorageEvent
 
getTimestamp() - Method in class io.agora.rtm.TokenEvent
 
getTimestamp() - Method in class io.agora.rtm.TopicEvent
 
getToken() - Method in class io.agora.rtm.JoinChannelOptions
 
getTopicInfos() - Method in class io.agora.rtm.TopicEvent
 
getTopicMeta() - Method in class io.agora.rtm.JoinTopicOptions
 
getTopicName() - Method in class io.agora.rtm.MessageEvent
 
getTopicName() - Method in class io.agora.rtm.TopicInfo
 
getTotalOccupancy() - Method in class io.agora.rtm.GetOnlineUsersResult
 
getTotalOccupancy() - Method in class io.agora.rtm.WhoNowResult
 
getTTL() - Method in class io.agora.rtm.LockDetail
 
getType() - Method in class io.agora.rtm.RtmMessage
Retrieves the type of the message.
getType() - Method in class io.agora.rtm.TopicEvent
 
getUnrestoredChannels() - Method in class io.agora.rtm.LinkStateEvent
 
getUpdateTs() - Method in class io.agora.rtm.MetadataItem
 
getUserChannels(String, ResultCallback<ArrayList<ChannelInfo>>) - Method in class io.agora.rtm.RtmPresence
To query which channels the user joined or subscribed
getUserId() - Method in class io.agora.rtm.RtmConfig
 
getUserId() - Method in class io.agora.rtm.UserState
 
getUserMetadata(String, ResultCallback<Metadata>) - Method in class io.agora.rtm.RtmStorage
Get the metadata of a specified user.
getUsers() - Method in class io.agora.rtm.TopicOptions
 
getUserStateList() - Method in class io.agora.rtm.GetOnlineUsersResult
 
getUserStateList() - Method in class io.agora.rtm.IntervalInfo
 
getUserStateList() - Method in class io.agora.rtm.SnapshotInfo
 
getUserStateList() - Method in class io.agora.rtm.WhoNowResult
 
getValue() - Method in class io.agora.rtm.MetadataItem
 
getValue(RtmConstants.RtmAreaCode) - Static method in enum class io.agora.rtm.RtmConstants.RtmAreaCode
 
getValue(RtmConstants.RtmChannelType) - Static method in enum class io.agora.rtm.RtmConstants.RtmChannelType
 
getValue(RtmConstants.RtmConnectionChangeReason) - Static method in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
 
getValue(RtmConstants.RtmConnectionState) - Static method in enum class io.agora.rtm.RtmConstants.RtmConnectionState
 
getValue(RtmConstants.RtmEncryptionMode) - Static method in enum class io.agora.rtm.RtmConstants.RtmEncryptionMode
 
getValue(RtmConstants.RtmErrorCode) - Static method in enum class io.agora.rtm.RtmConstants.RtmErrorCode
 
getValue(RtmConstants.RtmLinkOperation) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
 
getValue(RtmConstants.RtmLinkState) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkState
 
getValue(RtmConstants.RtmLinkStateChangeReason) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
 
getValue(RtmConstants.RtmLockEventType) - Static method in enum class io.agora.rtm.RtmConstants.RtmLockEventType
 
getValue(RtmConstants.RtmLogLevel) - Static method in enum class io.agora.rtm.RtmConstants.RtmLogLevel
 
getValue(RtmConstants.RtmMessagePriority) - Static method in enum class io.agora.rtm.RtmConstants.RtmMessagePriority
 
getValue(RtmConstants.RtmMessageQos) - Static method in enum class io.agora.rtm.RtmConstants.RtmMessageQos
 
getValue(RtmConstants.RtmMessageType) - Static method in enum class io.agora.rtm.RtmConstants.RtmMessageType
 
getValue(RtmConstants.RtmPresenceEventType) - Static method in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
 
getValue(RtmConstants.RtmProtocolType) - Static method in enum class io.agora.rtm.RtmConstants.RtmProtocolType
 
getValue(RtmConstants.RtmProxyType) - Static method in enum class io.agora.rtm.RtmConstants.RtmProxyType
 
getValue(RtmConstants.RtmServiceType) - Static method in enum class io.agora.rtm.RtmConstants.RtmServiceType
 
getValue(RtmConstants.RtmStorageEventType) - Static method in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
 
getValue(RtmConstants.RtmStorageType) - Static method in enum class io.agora.rtm.RtmConstants.RtmStorageType
 
getValue(RtmConstants.RtmTokenEventType) - Static method in enum class io.agora.rtm.RtmConstants.RtmTokenEventType
 
getValue(RtmConstants.RtmTopicEventType) - Static method in enum class io.agora.rtm.RtmConstants.RtmTopicEventType
 
getVersion() - Static method in class io.agora.rtm.RtmClient
Get the version info of the Agora RTM SDK.
getWithLock() - Method in class io.agora.rtm.JoinChannelOptions
 
getWithLock() - Method in class io.agora.rtm.SubscribeOptions
 
getWithMessage() - Method in class io.agora.rtm.SubscribeOptions
 
getWithMetadata() - Method in class io.agora.rtm.JoinChannelOptions
 
getWithMetadata() - Method in class io.agora.rtm.SubscribeOptions
 
getWithPresence() - Method in class io.agora.rtm.JoinChannelOptions
 
getWithPresence() - Method in class io.agora.rtm.SubscribeOptions
 
GLOB - Enum constant in enum class io.agora.rtm.RtmConstants.RtmAreaCode
0xFFFFFFFF: (Default) Global.

H

HEARTBEAT_LOST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
7: Heartbeat lost.
heartbeatInterval(int) - Method in class io.agora.rtm.RtmConfig.Builder
 
HIGH - Enum constant in enum class io.agora.rtm.RtmConstants.RtmMessagePriority
1: The high priority.
HIGHEST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmMessagePriority
0: The highest priority.
HISTORY_INVALID_TIMESTAMP - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-15002: The timestamp is invalid.
HISTORY_NOT_AVAILABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-15005: The history service not available.
HISTORY_OPERATION_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-15001 ~ -16000 : reserved for history error.
HISTORY_OPERATION_NOT_PERMITTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-15004: The history operation is not permitted.
HISTORY_OPERATION_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-15003: The history operation timeout.
HISTORY_PERMISSION_DENIED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-15006: The history permission is denied.
HistoryMessage - Class in io.agora.rtm
 
HistoryMessage(RtmMessage, String, String, long) - Constructor for class io.agora.rtm.HistoryMessage
 
HTTP - Enum constant in enum class io.agora.rtm.RtmConstants.RtmProxyType
1: Link with http proxy

I

IDLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkState
0: The initial state.
IN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmAreaCode
0x00000020: India.
INCONSISTENT_APP_ID - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
18: Inconsistent app ID.
INCONSISTENT_APPID - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
24: The connection is failed due to token and appid inconsistent.
INCONSISTENT_APPID - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10016: Try to login or join with inconsistent app ID.
INFO - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLogLevel
0x0001: Informational messages.
INIT_SERVICE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10007: The service is not initialized.
INSTANCE_ALREADY_RELEASED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10018: Already call destroy or release, this instance is forbidden to call any api, please create new instance.
INTERRUPTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
2: The connection between the SDK and the server is interrupted.
INTERVAL - Enum constant in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
2: The presence event triggered in interval mode
IntervalInfo - Class in io.agora.rtm
The interval information of presence event.
IntervalInfo(String[], String[], String[], UserState[]) - Constructor for class io.agora.rtm.IntervalInfo
 
INVALID_APP_ID - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
6: The connection fails because the App ID is not valid.
INVALID_APP_ID - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10003: The app ID is invalid.
INVALID_CHANNEL_NAME - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
7: The connection fails because the channel name is not valid.
INVALID_CHANNEL_NAME - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10008: The channel name is invalid.
INVALID_CHANNEL_NAME - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
19: Invalid channel name.
INVALID_CHANNEL_TYPE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10019: Invalid channel type
INVALID_ENCRYPTION_PARAMETER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10020: The encryption parameter is invalid.
INVALID_EVENT_HANDLER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10004: The event handler is invalid.
INVALID_PARAMETER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10014: The parameter is invalid.
INVALID_PRIVATE_CONFIG - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10024: The private config is invalid, set private config should both set serviceType and accessPointHosts.
INVALID_TOKEN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
8: The connection fails because the token is not valid.
INVALID_TOKEN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10005: The token is invalid.
INVALID_TOKEN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
16: Invalid token.
INVALID_USER_ID - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10006: The user ID is invalid.
INVALID_USER_ID - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
20: Invalid user ID.
io.agora.rtm - package io.agora.rtm
 
isBeQuiet() - Method in class io.agora.rtm.JoinChannelOptions
 
isBeQuiet() - Method in class io.agora.rtm.SubscribeOptions
 
isIspPolicyEnabled() - Method in class io.agora.rtm.RtmConfig
 
isMultipath() - Method in class io.agora.rtm.RtmConfig
 
ispPolicyEnabled(boolean) - Method in class io.agora.rtm.RtmConfig.Builder
 
isUseStringUserId() - Method in class io.agora.rtm.RtmConfig
 

J

join(JoinChannelOptions, ResultCallback<Void>) - Method in class io.agora.rtm.StreamChannel
Join the channel.
JOIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
2: Join.
JOIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
11: Join.
JOIN_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
JOIN_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.
JOIN_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
13: Join failed.
JOIN_SUCCESS - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
1: The SDK has joined the channel successfully.
JOIN_SUCCESS - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
12: Join success.
JOIN_TOPIC_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
JoinChannelOptions - Class in io.agora.rtm
Join channel options.
JoinChannelOptions() - Constructor for class io.agora.rtm.JoinChannelOptions
Creates a new instance of JoinChannelOptions with default options.
JoinChannelOptions(String, boolean, boolean, boolean, boolean) - Constructor for class io.agora.rtm.JoinChannelOptions
Creates a new instance of JoinChannelOptions with specifies options.
joinTopic(String, JoinTopicOptions, ResultCallback<Void>) - Method in class io.agora.rtm.StreamChannel
Join a topic.
JoinTopicOptions - Class in io.agora.rtm
Join topic options.
JoinTopicOptions() - Constructor for class io.agora.rtm.JoinTopicOptions
The default Constructor of JoinTopicOptions.
JoinTopicOptions(RtmConstants.RtmMessageQos, RtmConstants.RtmMessagePriority) - Constructor for class io.agora.rtm.JoinTopicOptions
Constructs a new JoinTopicOptions object with message qos and priority.
JoinTopicOptions(RtmConstants.RtmMessageQos, RtmConstants.RtmMessagePriority, boolean) - Constructor for class io.agora.rtm.JoinTopicOptions
Constructs a new JoinTopicOptions object with the specified parameters.
JoinTopicOptions(RtmConstants.RtmMessageQos, RtmConstants.RtmMessagePriority, boolean, String) - Constructor for class io.agora.rtm.JoinTopicOptions
Create a new JoinTopicOptions object with the specified parameters
JP - Enum constant in enum class io.agora.rtm.RtmConstants.RtmAreaCode
0x00000010: Japan.

K

KEEP_ALIVE_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
14: A timeout occurs for the keep-alive of the connection between the SDK and the server.
KEEP_ALIVE_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
29: Keep alive timeout.
KICKED_OUT_BY_SERVER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
28: Kicked out by server.

L

leave(ResultCallback<Void>) - Method in class io.agora.rtm.StreamChannel
Leave the channel.
LEAVE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
3: Leave.
LEAVE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
15: Leave.
LEAVE_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
LEAVE_CHANNEL - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
5: The SDK has left the channel.
LEAVE_TOPIC_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
leaveTopic(String, ResultCallback<Void>) - Method in class io.agora.rtm.StreamChannel
Leave the topic.
LICENSE_VALIDATION_FAILURE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
21: The connection is failed due to license validation failure.
LinkStateEvent - Class in io.agora.rtm
 
LinkStateEvent(int, int, int, int, int, String, String[], String[], boolean, long) - Constructor for class io.agora.rtm.LinkStateEvent
 
LOCK_ACQUIRE_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14007: Acquire lock failed.
LOCK_ALREADY_EXIST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14004: The lock already exists.
LOCK_INVALID_NAME - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14005: The lock name is invalid.
LOCK_NOT_ACQUIRED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14006: The lock is not acquired.
LOCK_NOT_AVAILABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14009: The lock service is not available.
LOCK_NOT_AVAILABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
36: Lock not available.
LOCK_NOT_EXIST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14008: The lock is not exist.
LOCK_OPERATION_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14001 ~ -15000 : reserved for lock error.
LOCK_OPERATION_PERFORMING - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14003: The lock operation is performing.
LOCK_OPERATION_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14002: The lock operation timeout.
LOCK_PERMISSION_DENIED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-14010: The lock permission is denied.
LockDetail - Class in io.agora.rtm
The information of a Lock.
LockDetail(String, String, int) - Constructor for class io.agora.rtm.LockDetail
 
LockEvent - Class in io.agora.rtm
 
LockEvent(String, int, int, LockDetail[], long) - Constructor for class io.agora.rtm.LockEvent
 
logConfig(RtmLogConfig) - Method in class io.agora.rtm.RtmConfig.Builder
 
login(String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmClient
Login the Agora RTM service.
LOGIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
0: Login.
LOGIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
1: Login.
LOGIN_ABORTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10013: The login is aborted due to unrecoverable error.
LOGIN_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
LOGIN_CANCELED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10023: This login operation stopped by a new login operation or logout operation.
LOGIN_NO_SERVER_RESOURCES - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10010: There is no server resources now.
LOGIN_NOT_AUTHORIZED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10015: The login is not authorized.
LOGIN_NOT_AUTHORIZED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
4: Login not authorized.
LOGIN_REJECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10012: The login is rejected by server.
LOGIN_REJECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
5: Login rejected.
LOGIN_SUCCESS - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
10001: The connection of rtm edge service has been successfully established.
LOGIN_SUCCESS - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
2: Login success.
LOGIN_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10011: The login timeout.
LOGIN_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
3: Login timeout.
LOGIN_TOO_FREQUENT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
37: Login too frequent.
logout(ResultCallback<Void>) - Method in class io.agora.rtm.RtmClient
Logout the Agora RTM service.
LOGOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
10002: User log out Agora RTM system.
LOGOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
1: Logout.
LOGOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
7: Logout.
LOGOUT_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
LOST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
16: The connection between the SDK and the server is lost.
LOW - Enum constant in enum class io.agora.rtm.RtmConstants.RtmMessagePriority
8: The low priority.

M

MESSAGE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmChannelType
1: Message channel.
MESSAGE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmServiceType
1: The basic functionality of rtm service.
MessageEvent - Class in io.agora.rtm
 
MessageEvent(int, String, String, RtmMessage, String, String, long) - Constructor for class io.agora.rtm.MessageEvent
 
Metadata - Class in io.agora.rtm
 
Metadata() - Constructor for class io.agora.rtm.Metadata
 
Metadata(long, MetadataItem[]) - Constructor for class io.agora.rtm.Metadata
 
MetadataItem - Class in io.agora.rtm
 
MetadataItem() - Constructor for class io.agora.rtm.MetadataItem
Creates a new instance of MetadataItem with default parameters.
MetadataItem(String, String) - Constructor for class io.agora.rtm.MetadataItem
Creates a new instance of MetadataItem with key and value.
MetadataItem(String, String, long) - Constructor for class io.agora.rtm.MetadataItem
Creates a new instance of MetadataItem with key, value and revision.
MetadataItem(String, String, String, long, long) - Constructor for class io.agora.rtm.MetadataItem
 
MetadataOptions - Class in io.agora.rtm
Metadata options.
MetadataOptions() - Constructor for class io.agora.rtm.MetadataOptions
Creates a new instance of MetadataOptions with default parameters.
MetadataOptions(boolean, boolean) - Constructor for class io.agora.rtm.MetadataOptions
Creates a new instance of MetadataOptions with spec.
multipath(boolean) - Method in class io.agora.rtm.RtmConfig.Builder
 

N

NA - Enum constant in enum class io.agora.rtm.RtmConstants.RtmAreaCode
0x00000002: North America.
NETWORK_CHANGE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
9: Network change.
NETWORK_CHANGE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
32: Network change.
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmChannelType
0: Unknown channel type.
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmEncryptionMode
0: Disable message encryption.
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLockEventType
0: Unknown event type
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLogLevel
0x0000: No logging.
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
0: Unknown event type
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmProxyType
0: Link without proxy
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmServiceType
0: The type of rtm service not specified.
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
0: Unknown event type.
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmStorageType
0: Unknown type.
NONE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmTopicEventType
0: Unknown event type
NORMAL - Enum constant in enum class io.agora.rtm.RtmConstants.RtmMessagePriority
4: The normal priority (Default).
NOT_CONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10025: Perform operation failed due to RTM service is not connected.
NOT_INITIALIZED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10001 ~ -11000 : reserved for generic error.
NOT_INITIALIZED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
21: Not initialized.
NOT_LOGIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10002: The user didn't login the RTM system.

O

OK - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
0: No error occurs.
onConnectionStateChanged(String, RtmConstants.RtmConnectionState, RtmConstants.RtmConnectionChangeReason) - Method in interface io.agora.rtm.RtmEventListener
Deprecated.
This callback is deprecated. Use LinkStateEvent instead.
onFailure(ErrorInfo) - Method in interface io.agora.rtm.ResultCallback
Occurs when a method call fails.
onLinkStateEvent(LinkStateEvent) - Method in interface io.agora.rtm.RtmEventListener
Occurs when link state change
onLockEvent(LockEvent) - Method in interface io.agora.rtm.RtmEventListener
Occurs when lock state changed
onMessageEvent(MessageEvent) - Method in interface io.agora.rtm.RtmEventListener
Occurs when receive a message.
onPresenceEvent(PresenceEvent) - Method in interface io.agora.rtm.RtmEventListener
Occurs when remote user presence changed
onStorageEvent(StorageEvent) - Method in interface io.agora.rtm.RtmEventListener
Occurs when receive storage event
onSuccess(T) - Method in interface io.agora.rtm.ResultCallback
Occurs when a method call succeeds.
onTokenEvent(TokenEvent) - Method in interface io.agora.rtm.RtmEventListener
Occurs when receive token event
onTokenPrivilegeWillExpire(String) - Method in interface io.agora.rtm.RtmEventListener
Occurs when token will expire in 30 seconds.
onTopicEvent(TopicEvent) - Method in interface io.agora.rtm.RtmEventListener
Occurs when remote user join/leave topic or when user first join this channel, got snapshot of topics in this channel
OPERATION_RATE_EXCEED_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10021: The operation is too frequent.
OPERATION_RATE_EXCEED_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
24: Operation rate exceed limitation.
ORDERED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmMessageQos
1: Will ensure that messages arrive in order.

P

PRESENCE_CACHED_TOO_MANY_STATES - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13004: The cached presence state count exceeds the limit.
PRESENCE_INVALID_ARGUMENT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13003: The argument in presence operation is invalid.
PRESENCE_INVALID_STATE_KEY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13006: The state key is invalid.
PRESENCE_INVALID_STATE_VALUE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13007: The state value is invalid.
PRESENCE_NOT_CONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13001 ~ -14000 : reserved for presence error.
PRESENCE_NOT_CONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
26: Presence not connected.
PRESENCE_NOT_READY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
10003: User log out Agora RTM system.
PRESENCE_NOT_READY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
31: Presence not ready.
PRESENCE_NOT_WRITABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13002: The presence is not writable.
PRESENCE_OPERATION_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13013: The presence operation failed.
PRESENCE_OPERATION_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13012: The presence operation timeout.
PRESENCE_STATE_COUNT_OVERFLOW - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13005: The state count exceeds the limit.
PRESENCE_STATE_DUPLICATE_KEY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13010: The state key already exists.
PRESENCE_STATE_KEY_SIZE_OVERFLOW - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13008: The state key length exceeds the limit.
PRESENCE_STATE_VALUE_SIZE_OVERFLOW - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13009: The state value length exceeds the limit.
PRESENCE_USER_NOT_EXIST - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-13011: The user is not exist.
PresenceEvent - Class in io.agora.rtm
 
PresenceEvent(int, int, String, String, HashMap<String, String>, IntervalInfo, SnapshotInfo, long) - Constructor for class io.agora.rtm.PresenceEvent
 
PresenceOptions - Class in io.agora.rtm
The option to query user presence.
PresenceOptions() - Constructor for class io.agora.rtm.PresenceOptions
Creates a new instance of PresenceOptions with default parameters.
PresenceOptions(boolean, boolean) - Constructor for class io.agora.rtm.PresenceOptions
Creates a new instance of PresenceOptions with specifies options.
PresenceOptions(boolean, boolean, String) - Constructor for class io.agora.rtm.PresenceOptions
Creates a new instance of PresenceOptions with the specified options.
presenceTimeout(int) - Method in class io.agora.rtm.RtmConfig.Builder
 
privateConfig(RtmPrivateConfig) - Method in class io.agora.rtm.RtmConfig.Builder
 
protocolType(RtmConstants.RtmProtocolType) - Method in class io.agora.rtm.RtmConfig.Builder
 
proxyConfig(RtmProxyConfig) - Method in class io.agora.rtm.RtmConfig.Builder
 
publish(String, byte[], PublishOptions, ResultCallback<Void>) - Method in class io.agora.rtm.RtmClient
Publish a binary message in the channel.
publish(String, String, PublishOptions, ResultCallback<Void>) - Method in class io.agora.rtm.RtmClient
Publish a string message in the channel.
PUBLISH_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
PUBLISH_TOPIC_MESSAGE_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
PublisherInfo - Class in io.agora.rtm
Topic publisher information
PublisherInfo(String, String) - Constructor for class io.agora.rtm.PublisherInfo
 
PublishOptions - Class in io.agora.rtm
Publish message option
PublishOptions() - Constructor for class io.agora.rtm.PublishOptions
Creates a new instance of PublishOptions with default parameters.
PublishOptions(RtmConstants.RtmChannelType, String, boolean) - Constructor for class io.agora.rtm.PublishOptions
Creates a new instance of PublishOptions with specified channelType and customType.
publishTopicMessage(String, byte[], TopicMessageOptions, ResultCallback<Void>) - Method in class io.agora.rtm.StreamChannel
Publish a binary message in the topic.
publishTopicMessage(String, String, TopicMessageOptions, ResultCallback<Void>) - Method in class io.agora.rtm.StreamChannel
Publish a string message in the topic.

R

READ_PERMISSION_REVOKED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmTokenEventType
2: The token read permission is revoked.
RECONNECT_SUCCESS - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
10: Reconnect success.
RECONNECT_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
9: Reconnect timeout.
RECONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
6: Reconnected.
RECONNECTING - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionState
4: The SDK keeps rejoining the channel after being disconnected from the channel, probably because of network issues.
reconnectTimeout(int) - Method in class io.agora.rtm.RtmConfig.Builder
 
REJECTED_BY_SERVER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
10: The connection is rejected by the server.
REJOIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
14: Rejoin.
REJOIN_SUCCESS - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
15: The SDK has rejoined the channel successfully.
release() - Static method in class io.agora.rtm.RtmClient
Release the rtm client instance.
release() - Method in class io.agora.rtm.StreamChannel
Release the stream channel instance.
RELEASE_LOCK_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
RELEASED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLockEventType
5: Triggered when a remote user released lock
releaseLock(String, RtmConstants.RtmChannelType, String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmLock
releases a lock
RELOGIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
6: Re-login.
REMOTE_JOIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
3: Triggered when remote user join channel
REMOTE_JOIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmTopicEventType
2: Triggered when remote user join a topic
REMOTE_LEAVE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
4: Triggered when remote user leave channel
REMOTE_LEAVE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmTopicEventType
3: Triggered when remote user leave a topic
REMOTE_STATE_CHANGED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
6: Triggered when user changed state
REMOTE_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
5: Triggered when remote user's connection timeout
REMOVE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
4: Triggered when a remote user remove metadata
REMOVE_CHANNEL_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
REMOVE_LOCK_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
REMOVE_STATE_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
REMOVE_USER_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
removeChannelMetadata(String, RtmConstants.RtmChannelType, Metadata, MetadataOptions, String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmStorage
Remove the metadata of a specified channel.
REMOVED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLockEventType
3: Triggered when a remote user remove lock
removeEventListener(RtmEventListener) - Method in class io.agora.rtm.RtmClient
Remove the specified event listener.
removeLock(String, RtmConstants.RtmChannelType, String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmLock
removes a lock.
removeState(String, RtmConstants.RtmChannelType, ArrayList<String>, ResultCallback<Void>) - Method in class io.agora.rtm.RtmPresence
Delete user state
removeUserMetadata(String, Metadata, MetadataOptions, ResultCallback<Void>) - Method in class io.agora.rtm.RtmStorage
Remove the metadata of a specified user.
RENEW_TOKEN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
12: When the connection state changes because the app has renewed the token.
RENEW_TOKEN_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
RENEW_TOKEN_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10026: Renew token timeout.
renewToken(String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmClient
Renews the token.
renewToken(String, ResultCallback<Void>) - Method in class io.agora.rtm.StreamChannel
Renews the token.
ResultCallback<T> - Interface in io.agora.rtm
The ResultCallback interface contains callbacks indicating the results of a method call:
REVOKE_LOCK_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
revokeLock(String, RtmConstants.RtmChannelType, String, String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmLock
disables a lock
RTM_SERVICE_NOT_CONNECTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
22: Rtm service not connected.
RtmClient - Class in io.agora.rtm
The RtmClient class.
RtmClient() - Constructor for class io.agora.rtm.RtmClient
 
RtmConfig - Class in io.agora.rtm
Configurations for RTM Client.
RtmConfig.Builder - Class in io.agora.rtm
 
RtmConstants - Class in io.agora.rtm
 
RtmConstants() - Constructor for class io.agora.rtm.RtmConstants
 
RtmConstants.RtmAreaCode - Enum Class in io.agora.rtm
IP areas.
RtmConstants.RtmChannelType - Enum Class in io.agora.rtm
RTM channel type.
RtmConstants.RtmConnectionChangeReason - Enum Class in io.agora.rtm
Reasons for connection state change.
RtmConstants.RtmConnectionState - Enum Class in io.agora.rtm
Connection states between rtm sdk and agora server.
RtmConstants.RtmEncryptionMode - Enum Class in io.agora.rtm
RTM encryption mode.
RtmConstants.RtmErrorCode - Enum Class in io.agora.rtm
The error codes of rtm client.
RtmConstants.RtmLinkOperation - Enum Class in io.agora.rtm
Rtm link operation.
RtmConstants.RtmLinkState - Enum Class in io.agora.rtm
Rtm link state.
RtmConstants.RtmLinkStateChangeReason - Enum Class in io.agora.rtm
Rtm link state change reason.
RtmConstants.RtmLockEventType - Enum Class in io.agora.rtm
RTM lock event type.
RtmConstants.RtmLogLevel - Enum Class in io.agora.rtm
The log level for rtm sdk.
RtmConstants.RtmMessagePriority - Enum Class in io.agora.rtm
The priority of rtm message.
RtmConstants.RtmMessageQos - Enum Class in io.agora.rtm
The qos of rtm message.
RtmConstants.RtmMessageType - Enum Class in io.agora.rtm
RTM message type.
RtmConstants.RtmPresenceEventType - Enum Class in io.agora.rtm
Presence event type
RtmConstants.RtmProtocolType - Enum Class in io.agora.rtm
Rtm protocol type for underlying connection.
RtmConstants.RtmProxyType - Enum Class in io.agora.rtm
RTM proxy type.
RtmConstants.RtmServiceType - Enum Class in io.agora.rtm
Rtm service type.
RtmConstants.RtmStorageEventType - Enum Class in io.agora.rtm
RTM storage event type.
RtmConstants.RtmStorageType - Enum Class in io.agora.rtm
RTM storage type.
RtmConstants.RtmTokenEventType - Enum Class in io.agora.rtm
Rtm token event type.
RtmConstants.RtmTopicEventType - Enum Class in io.agora.rtm
Topic event type
RtmEncryptionConfig - Class in io.agora.rtm
encryption configuration
RtmEncryptionConfig() - Constructor for class io.agora.rtm.RtmEncryptionConfig
Creates a new instance of RtmEncryptionConfig with default parameters.
RtmEncryptionConfig(RtmConstants.RtmEncryptionMode, String, byte[]) - Constructor for class io.agora.rtm.RtmEncryptionConfig
Creates a new instance of RtmEncryptionConfig with specifies parameters.
RtmEventListener - Interface in io.agora.rtm
The RtmEventListener class.
RtmHistory - Class in io.agora.rtm
The RtmHistory class.
RtmHistory() - Constructor for class io.agora.rtm.RtmHistory
 
RtmLock - Class in io.agora.rtm
The RtmLock class.
RtmLock() - Constructor for class io.agora.rtm.RtmLock
 
RtmLogConfig - Class in io.agora.rtm
rtm log configuration
RtmLogConfig() - Constructor for class io.agora.rtm.RtmLogConfig
Creates a new instance of RtmLogConfig with default parameters.
RtmLogConfig(String, int, RtmConstants.RtmLogLevel) - Constructor for class io.agora.rtm.RtmLogConfig
Creates a new instance of RtmLogConfig with specifies parameters.
RtmMessage - Class in io.agora.rtm
 
RtmMessage(byte[], int) - Constructor for class io.agora.rtm.RtmMessage
 
RtmPresence - Class in io.agora.rtm
The RtmPresence class.
RtmPresence() - Constructor for class io.agora.rtm.RtmPresence
 
RtmPrivateConfig - Class in io.agora.rtm
Private configuration.
RtmPrivateConfig() - Constructor for class io.agora.rtm.RtmPrivateConfig
Creates a new instance of RtmPrivateConfig with default parameters.
RtmPrivateConfig(EnumSet<RtmConstants.RtmServiceType>, ArrayList<String>) - Constructor for class io.agora.rtm.RtmPrivateConfig
Creates a new instance of RtmProxyConfig with specifies parameters.
RtmProxyConfig - Class in io.agora.rtm
Proxy configuration
RtmProxyConfig() - Constructor for class io.agora.rtm.RtmProxyConfig
Creates a new instance of RtmProxyConfig with default parameters.
RtmProxyConfig(RtmConstants.RtmProxyType, String, int) - Constructor for class io.agora.rtm.RtmProxyConfig
Creates a new instance of RtmProxyConfig with specifies parameters.
RtmProxyConfig(RtmConstants.RtmProxyType, String, int, String, String) - Constructor for class io.agora.rtm.RtmProxyConfig
Creates a new instance of RtmProxyConfig with specifies parameters.
RtmStorage - Class in io.agora.rtm
The RtmStorage class.
RtmStorage() - Constructor for class io.agora.rtm.RtmStorage
 

S

SAME_UID_LOGIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
19: The connection is failed due to join the same channel on another device with the same uid.
SAME_UID_LOGIN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
27: Same UID login.
SERVER_REJECT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
4: Server reject.
SERVER_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
8: Server timeout.
SERVICE_NOT_SUPPORTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10022: The service is not configured in private config mode.
SERVICE_NOT_SUPPORTED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
33: Service not supported.
SET - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLockEventType
2: Triggered when a remote user set lock
SET - Enum constant in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
2: Triggered when a remote user set metadata
SET_CHANNEL_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
SET_LOCK_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
SET_PARAMETERS_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
SET_STATE_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
SET_USER_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
setAccessPointHosts(ArrayList<String>) - Method in class io.agora.rtm.RtmPrivateConfig
 
setAccount(String) - Method in class io.agora.rtm.RtmProxyConfig
 
setBeQuiet(boolean) - Method in class io.agora.rtm.JoinChannelOptions
 
setBeQuiet(boolean) - Method in class io.agora.rtm.SubscribeOptions
 
setChannelMetadata(String, RtmConstants.RtmChannelType, Metadata, MetadataOptions, String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmStorage
Set the metadata of a specified channel.
setChannelType(RtmConstants.RtmChannelType) - Method in class io.agora.rtm.PublishOptions
 
setCustomType(String) - Method in class io.agora.rtm.PublishOptions
 
setCustomType(String) - Method in class io.agora.rtm.TopicMessageOptions
 
setEncryptionKey(String) - Method in class io.agora.rtm.RtmEncryptionConfig
 
setEncryptionMode(RtmConstants.RtmEncryptionMode) - Method in class io.agora.rtm.RtmEncryptionConfig
 
setEncryptionSalt(byte[]) - Method in class io.agora.rtm.RtmEncryptionConfig
 
setEnd(long) - Method in class io.agora.rtm.GetHistoryMessagesOptions
 
setFilePath(String) - Method in class io.agora.rtm.RtmLogConfig
 
setFileSize(int) - Method in class io.agora.rtm.RtmLogConfig
 
setIncludeState(boolean) - Method in class io.agora.rtm.GetOnlineUsersOptions
 
setIncludeState(boolean) - Method in class io.agora.rtm.PresenceOptions
 
setIncludeUserId(boolean) - Method in class io.agora.rtm.GetOnlineUsersOptions
 
setIncludeUserId(boolean) - Method in class io.agora.rtm.PresenceOptions
 
setItems(ArrayList<MetadataItem>) - Method in class io.agora.rtm.Metadata
 
setKey(String) - Method in class io.agora.rtm.MetadataItem
 
setLevel(RtmConstants.RtmLogLevel) - Method in class io.agora.rtm.RtmLogConfig
 
setLock(String, RtmConstants.RtmChannelType, String, long, ResultCallback<Void>) - Method in class io.agora.rtm.RtmLock
sets a lock.
setMajorRevision(long) - Method in class io.agora.rtm.Metadata
 
setMessageCount(int) - Method in class io.agora.rtm.GetHistoryMessagesOptions
 
setMessageQos(RtmConstants.RtmMessageQos) - Method in class io.agora.rtm.JoinTopicOptions
 
setPage(String) - Method in class io.agora.rtm.GetOnlineUsersOptions
 
setPage(String) - Method in class io.agora.rtm.PresenceOptions
 
setParameters(String) - Method in class io.agora.rtm.RtmClient
Set parameters of the sdk or engine
setParameters(String) - Method in class io.agora.rtm.StreamChannel
Set parameters of the stream channel
setPassword(String) - Method in class io.agora.rtm.RtmProxyConfig
 
setPort(int) - Method in class io.agora.rtm.RtmProxyConfig
 
setPriority(RtmConstants.RtmMessagePriority) - Method in class io.agora.rtm.JoinTopicOptions
 
setProxyType(RtmConstants.RtmProxyType) - Method in class io.agora.rtm.RtmProxyConfig
 
setRecordTs(boolean) - Method in class io.agora.rtm.MetadataOptions
 
setRecordUserId(boolean) - Method in class io.agora.rtm.MetadataOptions
 
setRevision(long) - Method in class io.agora.rtm.MetadataItem
 
setSendTs(long) - Method in class io.agora.rtm.TopicMessageOptions
 
setServer(String) - Method in class io.agora.rtm.RtmProxyConfig
 
setServiceType(EnumSet<RtmConstants.RtmServiceType>) - Method in class io.agora.rtm.RtmPrivateConfig
 
setStart(long) - Method in class io.agora.rtm.GetHistoryMessagesOptions
 
setState(String, RtmConstants.RtmChannelType, Map<String, String>, ResultCallback<Void>) - Method in class io.agora.rtm.RtmPresence
Set user state
setStoreInHistory(boolean) - Method in class io.agora.rtm.PublishOptions
 
setSyncWithMedia(boolean) - Method in class io.agora.rtm.JoinTopicOptions
 
SETTING_PROXY_SERVER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
11: The connection changes to reconnecting because the SDK has set a proxy server.
setToken(String) - Method in class io.agora.rtm.JoinChannelOptions
 
setTopicMeta(String) - Method in class io.agora.rtm.JoinTopicOptions
 
setUserMetadata(String, Metadata, MetadataOptions, ResultCallback<Void>) - Method in class io.agora.rtm.RtmStorage
Set the metadata of a specified user.
setUsers(String[]) - Method in class io.agora.rtm.TopicOptions
 
setUsers(ArrayList<String>) - Method in class io.agora.rtm.TopicOptions
 
setValue(String) - Method in class io.agora.rtm.MetadataItem
 
setWithLock(boolean) - Method in class io.agora.rtm.JoinChannelOptions
 
setWithLock(boolean) - Method in class io.agora.rtm.SubscribeOptions
 
setWithMessage(boolean) - Method in class io.agora.rtm.SubscribeOptions
 
setWithMetadata(boolean) - Method in class io.agora.rtm.JoinChannelOptions
 
setWithMetadata(boolean) - Method in class io.agora.rtm.SubscribeOptions
 
setWithPresence(boolean) - Method in class io.agora.rtm.JoinChannelOptions
 
setWithPresence(boolean) - Method in class io.agora.rtm.SubscribeOptions
 
SNAPSHOT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLockEventType
1: Triggered when user subscribe lock state
SNAPSHOT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
1: The presence snapshot of this channel
SNAPSHOT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
1: Triggered when user subscribe user metadata state or join channel with options.withMetadata = true.
SNAPSHOT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmTopicEventType
1: The topic snapshot of this channel
SnapshotInfo - Class in io.agora.rtm
snapshot information
SnapshotInfo(UserState[]) - Constructor for class io.agora.rtm.SnapshotInfo
 
STORAGE_DUPLICATE_KEY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12013: The metadata key already exists.
STORAGE_INVALID_ARGUMENT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12004: The argument in storage operation is invalid.
STORAGE_INVALID_KEY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12009: The metadata key is invalid.
STORAGE_INVALID_LOCK_NAME - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12007: The lock name in storage operation is invalid.
STORAGE_INVALID_METADATA_INSTANCE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12016: The metadata item is invalid.
STORAGE_INVALID_METADATA_ITEM - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12003: The metadata item is invalid.
STORAGE_INVALID_REVISION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12005: The revision in storage operation is invalid.
STORAGE_INVALID_VALUE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12010: The metadata value is invalid.
STORAGE_KEY_LENGTH_OVERFLOW - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12011: The metadata key length exceeds the limit.
STORAGE_LOCK_NOT_ACQUIRED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12008: The lock in storage operation is not acquired.
STORAGE_METADATA_ITEM_EXCEED_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12002: The metadata item count exceeds the limit.
STORAGE_METADATA_LENGTH_OVERFLOW - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12006: The metadata length exceeds the limit.
STORAGE_NOT_AVAILABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12019: The storage service not available.
STORAGE_NOT_AVAILABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
35: storage not available.
STORAGE_NOT_SUBSCRIBE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12015: The storage operation performed without subscribing.
STORAGE_OPERATION_FAILED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12001 ~ -13000 : reserved for storage error.
STORAGE_OPERATION_TIMEOUT - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12018: The storage operation timeout.
STORAGE_OUTDATED_REVISION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12014: The revision in storage operation is outdated or the key does not exist.
STORAGE_PERMISSION_DENIED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12020: The storage permission is denied.
STORAGE_SUBSCRIBE_USER_EXCEED_LIMITATION - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12017: The user count exceeds the limit when try to subscribe.
STORAGE_VALUE_LENGTH_OVERFLOW - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-12012: The metadata value length exceeds the limit.
StorageEvent - Class in io.agora.rtm
 
StorageEvent(int, int, int, String, Metadata, long) - Constructor for class io.agora.rtm.StorageEvent
 
STREAM - Enum constant in enum class io.agora.rtm.RtmConstants.RtmChannelType
2: Stream channel.
STREAM - Enum constant in enum class io.agora.rtm.RtmConstants.RtmServiceType
2: The advanced functionality of rtm service.
STREAM_CHANNEL_NOT_AVAILABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
23: The connection is failed due to user vid not support stream channel.
STREAM_CHANNEL_NOT_AVAILABLE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
34: Stream channel not available.
StreamChannel - Class in io.agora.rtm
The StreamChannel class.
StreamChannel() - Constructor for class io.agora.rtm.StreamChannel
 
STRING - Enum constant in enum class io.agora.rtm.RtmConstants.RtmMessageType
1: The ascii message.
subscribe(String, SubscribeOptions, ResultCallback<Void>) - Method in class io.agora.rtm.RtmClient
Subscribe a channel.
SUBSCRIBE_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
SUBSCRIBE_TOPIC_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
SUBSCRIBE_USER_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
SubscribeOptions - Class in io.agora.rtm
The subscribe option.
SubscribeOptions() - Constructor for class io.agora.rtm.SubscribeOptions
The default Constructor of SubscribeOptions.
SubscribeOptions(boolean, boolean, boolean, boolean, boolean) - Constructor for class io.agora.rtm.SubscribeOptions
Creates a new instance of SubscribeOptions with specifies options.
subscribeTopic(String, TopicOptions, ResultCallback<SubscribeTopicResult>) - Method in class io.agora.rtm.StreamChannel
Subscribe a topic.
SubscribeTopicResult - Class in io.agora.rtm
 
SubscribeTopicResult(ArrayList<String>, ArrayList<String>) - Constructor for class io.agora.rtm.SubscribeTopicResult
 
subscribeUserMetadata(String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmStorage
Subscribe the metadata update event of a specified user.
SUSPENDED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkState
4: The SDK link is suspended.

T

TCP_ONLY - Enum constant in enum class io.agora.rtm.RtmConstants.RtmProtocolType
1: Use TCP only.
TCP_UDP - Enum constant in enum class io.agora.rtm.RtmConstants.RtmProtocolType
0: TCP and UDP (default).
TOKEN_EXPIRED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
9: The connection fails because the token has expired.
TOKEN_EXPIRED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmErrorCode
-10009: The token has expired.
TOKEN_EXPIRED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
17: Token expired.
TokenEvent - Class in io.agora.rtm
 
TokenEvent(int, String, AffectedResources, long) - Constructor for class io.agora.rtm.TokenEvent
 
TOO_MANY_BROADCASTERS - Enum constant in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
20: The connection is failed due to too many broadcasters in the channel.
TopicEvent - Class in io.agora.rtm
 
TopicEvent(String, int, String, TopicInfo[], long) - Constructor for class io.agora.rtm.TopicEvent
 
TopicInfo - Class in io.agora.rtm
Topic information
TopicMessageOptions - Class in io.agora.rtm
topic message option
TopicMessageOptions() - Constructor for class io.agora.rtm.TopicMessageOptions
Creates a new instance of TopicMessageOptions with default parameters.
TopicMessageOptions(String) - Constructor for class io.agora.rtm.TopicMessageOptions
Creates a new instance of TopicMessageOptions with specified customType.
TopicMessageOptions(String, long) - Constructor for class io.agora.rtm.TopicMessageOptions
Creates a new instance of TopicMessageOptions with specified customType and sendTs.
TopicOptions - Class in io.agora.rtm
Topic options.
TopicOptions() - Constructor for class io.agora.rtm.TopicOptions
Constructor for TopicOptions with default parameters.
toString() - Method in class io.agora.rtm.AffectedResources
 
toString() - Method in class io.agora.rtm.ChannelInfo
 
toString() - Method in class io.agora.rtm.ErrorInfo
 
toString() - Method in class io.agora.rtm.GetHistoryMessagesOptions
 
toString() - Method in class io.agora.rtm.GetMessagesResult
 
toString() - Method in class io.agora.rtm.GetOnlineUsersOptions
 
toString() - Method in class io.agora.rtm.GetOnlineUsersResult
 
toString() - Method in class io.agora.rtm.HistoryMessage
 
toString() - Method in class io.agora.rtm.IntervalInfo
 
toString() - Method in class io.agora.rtm.JoinChannelOptions
 
toString() - Method in class io.agora.rtm.JoinTopicOptions
 
toString() - Method in class io.agora.rtm.LinkStateEvent
 
toString() - Method in class io.agora.rtm.LockDetail
 
toString() - Method in class io.agora.rtm.LockEvent
 
toString() - Method in class io.agora.rtm.MessageEvent
 
toString() - Method in class io.agora.rtm.Metadata
 
toString() - Method in class io.agora.rtm.MetadataItem
 
toString() - Method in class io.agora.rtm.MetadataOptions
 
toString() - Method in class io.agora.rtm.PresenceEvent
 
toString() - Method in class io.agora.rtm.PresenceOptions
 
toString() - Method in class io.agora.rtm.PublisherInfo
 
toString() - Method in class io.agora.rtm.PublishOptions
 
toString() - Method in class io.agora.rtm.RtmConfig
 
toString() - Method in class io.agora.rtm.RtmEncryptionConfig
 
toString() - Method in class io.agora.rtm.RtmLogConfig
 
toString() - Method in class io.agora.rtm.RtmMessage
 
toString() - Method in class io.agora.rtm.RtmPrivateConfig
 
toString() - Method in class io.agora.rtm.RtmProxyConfig
 
toString() - Method in class io.agora.rtm.SnapshotInfo
 
toString() - Method in class io.agora.rtm.StorageEvent
 
toString() - Method in class io.agora.rtm.SubscribeOptions
 
toString() - Method in class io.agora.rtm.SubscribeTopicResult
 
toString() - Method in class io.agora.rtm.TokenEvent
 
toString() - Method in class io.agora.rtm.TopicEvent
 
toString() - Method in class io.agora.rtm.TopicInfo
 
toString() - Method in class io.agora.rtm.TopicMessageOptions
 
toString() - Method in class io.agora.rtm.TopicOptions
 
toString() - Method in class io.agora.rtm.UserState
 
toString() - Method in class io.agora.rtm.WhoNowResult
 

U

UNKNOWN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
0: Unknown reason.
UNORDERED - Enum constant in enum class io.agora.rtm.RtmConstants.RtmMessageQos
0: Will not ensure that messages arrive in order.
unsubscribe(String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmClient
Unsubscribe a channel.
UNSUBSCRIBE_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
UNSUBSCRIBE_TOPIC_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
UNSUBSCRIBE_USER_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
unsubscribeTopic(String, TopicOptions, ResultCallback<Void>) - Method in class io.agora.rtm.StreamChannel
Unsubscribe a topic.
unsubscribeUserMetadata(String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmStorage
unsubscribe the metadata update event of a specified user.
UPDATE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
3: Triggered when a remote user update metadata
UPDATE_CHANNEL_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
UPDATE_USER_METADATA_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
updateChannelMetadata(String, RtmConstants.RtmChannelType, Metadata, MetadataOptions, String, ResultCallback<Void>) - Method in class io.agora.rtm.RtmStorage
Update the metadata of a specified channel.
updateUserMetadata(String, Metadata, MetadataOptions, ResultCallback<Void>) - Method in class io.agora.rtm.RtmStorage
Update the metadata of a specified user.
USER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmChannelType
3: User.
USER - Enum constant in enum class io.agora.rtm.RtmConstants.RtmStorageType
1: The user storage event.
UserState - Class in io.agora.rtm
The states of user.
UserState(String, HashMap<String, String>) - Constructor for class io.agora.rtm.UserState
 
useStringUserId(boolean) - Method in class io.agora.rtm.RtmConfig.Builder
 

V

valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmAreaCode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmChannelType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmConnectionState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmEncryptionMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmErrorCode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmLockEventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmLogLevel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmMessagePriority
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmMessageQos
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmMessageType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmProtocolType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmProxyType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmServiceType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmStorageType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmTokenEventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtm.RtmConstants.RtmTopicEventType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmAreaCode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmChannelType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmConnectionChangeReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmConnectionState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmEncryptionMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmErrorCode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkOperation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmLinkStateChangeReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmLockEventType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmLogLevel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmMessagePriority
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmMessageQos
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmMessageType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmPresenceEventType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmProtocolType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmProxyType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmServiceType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmStorageEventType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmStorageType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmTokenEventType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtm.RtmConstants.RtmTopicEventType
Returns an array containing the constants of this enum class, in the order they are declared.

W

WARN - Enum constant in enum class io.agora.rtm.RtmConstants.RtmLogLevel
0x0002: Warnings.
WHERE_NOW_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
whereNow(String, ResultCallback<ArrayList<ChannelInfo>>) - Method in class io.agora.rtm.RtmPresence
To query which channels the user joined
WHO_NOW_API_STR - Static variable in class io.agora.rtm.RtmConstants
 
whoNow(String, RtmConstants.RtmChannelType, PresenceOptions, ResultCallback<WhoNowResult>) - Method in class io.agora.rtm.RtmPresence
To query who joined this channel
WhoNowResult - Class in io.agora.rtm
 
WhoNowResult(String, ArrayList<UserState>, int) - Constructor for class io.agora.rtm.WhoNowResult
 
WILL_EXPIRE - Enum constant in enum class io.agora.rtm.RtmConstants.RtmTokenEventType
1: The token is about to expire.
A B C D E F G H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values