Signaling (previously RTM) SDK v1.5.0 API Reference for Android
Public Attributes | List of all members
io.agora.rtm.RtmStatusCode.JoinChannelError Interface Reference

Public Attributes

int  JOIN_CHANNEL_ERR_OK = 0
 
int  JOIN_CHANNEL_ERR_FAILURE = 1
 
int  JOIN_CHANNEL_ERR_REJECTED = 2
 
int  JOIN_CHANNEL_ERR_INVALID_ARGUMENT = 3
 
int  JOIN_CHANNEL_TIMEOUT = 4
 
int  JOIN_CHANNEL_ERR_EXCEED_LIMIT = 5
 
int  JOIN_CHANNEL_ERR_ALREADY_JOINED = 6
 
int  JOIN_CHANNEL_ERR_TOO_OFTEN = 7
 
int  JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN = 8
 
int  JOIN_CHANNEL_ERR_NOT_INITIALIZED = 101
 
int  JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102
 

Member Data Documentation

◆ JOIN_CHANNEL_ERR_OK

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_OK = 0

0: The user joins the channel successfully.

◆ JOIN_CHANNEL_ERR_FAILURE

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_FAILURE = 1

1: The user fails to join the channel.

◆ JOIN_CHANNEL_ERR_REJECTED

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_REJECTED = 2

2: For v1.0.0 and earlier, the SDK returns this error when you try to join a channel that you have already joined. The SDK does not return this error code after v1.0.0.

◆ JOIN_CHANNEL_ERR_INVALID_ARGUMENT

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_INVALID_ARGUMENT = 3

3: The user fails to join the channel because the argument is invalid.

◆ JOIN_CHANNEL_TIMEOUT

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_TIMEOUT = 4

4: A timeout occurs when joining the channel. The current timeout is set as five seconds. Possible reasons: The user is in the CONNECTION_STATE_ABORTED or CONNECTION_STATE_RECONNECTING state.

◆ JOIN_CHANNEL_ERR_EXCEED_LIMIT

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_EXCEED_LIMIT = 5

5: The number of the RTM channels you are in exceeds the limit of 20.

◆ JOIN_CHANNEL_ERR_ALREADY_JOINED

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_ALREADY_JOINED = 6

6: The user is joining or has joined the channel.

◆ JOIN_CHANNEL_ERR_TOO_OFTEN

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_TOO_OFTEN = 7

7: The method call frequency exceeds the limit of 50 queries every three seconds.

◆ JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN = 8

8: The frequency of joining the same channel exceeds two times every five seconds.

◆ JOIN_CHANNEL_ERR_NOT_INITIALIZED

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_NOT_INITIALIZED = 101

101: The SDK is not initialized.

◆ JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN

int io.agora.rtm.RtmStatusCode.JoinChannelError.JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102

102: The user does not call the login method, or the method call of login does not succeed before joining the channel.