Agora RTM Web API Reference

Index AgoraRTM RtmClient RtmMessage RtmChannel LocalInvitation RemoteInvitation RtmEvents RtmErrorCode RtmStatusCode

Index

Enumeration members

JOIN_CHANNEL_ERR_ABORTED_BY_LEAVE

JOIN_CHANNEL_ERR_ABORTED_BY_LEAVE: = 201

JOIN_CHANNEL_ERR_ALREADY_JOINED

JOIN_CHANNEL_ERR_ALREADY_JOINED: = 6

The user is joining or has joined the channel.

JOIN_CHANNEL_ERR_ALREADY_JOINED_CHANNEL_OF_SAME_ID

JOIN_CHANNEL_ERR_ALREADY_JOINED_CHANNEL_OF_SAME_ID: = 202

JOIN_CHANNEL_ERR_EXCEED_LIMIT

JOIN_CHANNEL_ERR_EXCEED_LIMIT: = 5

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

JOIN_CHANNEL_ERR_FAILURE

JOIN_CHANNEL_ERR_FAILURE: = 1

Common failure. The user fails to join the channel.

JOIN_CHANNEL_ERR_INVALID_ARGUMENT

JOIN_CHANNEL_ERR_INVALID_ARGUMENT: = 3

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

JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN

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_REJECTED

JOIN_CHANNEL_ERR_REJECTED: = 2

RESERVED FOR FUTURE USE

JOIN_CHANNEL_ERR_TOO_OFTEN

JOIN_CHANNEL_ERR_TOO_OFTEN: = 7

The method call frequency exceeds 50 queries every three seconds.

JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN

JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN: = 102

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

JOIN_CHANNEL_TIMEOUT

JOIN_CHANNEL_TIMEOUT: = 4

A timeout occurs when joining the channel. The current timeout is set as five seconds. The current login timeout is set as six seconds. Possible reasons: The user is in the ABORTED or RECONNECTING state.