Agora RTC Objective-C API Reference
Refactor
|
Data Structures | |
class | IChannel |
class | IChannelAttributes |
class | IChannelEventHandler |
class | IChannelMember |
class | IMessage |
class | IRtmService |
class | IRtmServiceEventHandler |
enum PEER_MESSAGE_STATE |
enum LOGIN_ERR_CODE |
The login error code.
enum LOGOUT_ERR_CODE |
enum CONNECTION_STATE |
The connection state.
enum JOIN_CHANNEL_ERR |
The join channel error.
Enumerator | |
---|---|
JOIN_CHANNEL_ERR_OK | 0: The method call succeeds, or the user joins the channel successfully. |
JOIN_CHANNEL_ERR_FAILURE | 1: Common failure. The user fails to join the channel. |
JOIN_CHANNEL_ERR_REJECTED | 2: RESERVED FOR FUTURE USE |
JOIN_CHANNEL_ERR_INVALID_ARGUMENT | 3: The user fails to join the channel because the argument is invalid. |
JOIN_CHANNEL_TIMEOUT | 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 state. |
JOIN_CHANNEL_ERR_EXCEED_LIMIT | 5: The number of the RTM channels you are in exceeds the limit of 20. |
JOIN_CHANNEL_ERR_ALREADY_JOINED | 6: The user is joining or has joined the channel. |
JOIN_CHANNEL_ERR_TOO_OFTEN | 7: The method call frequency exceeds 50 queries every three seconds. |
JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN | 8: The frequency of joining the same channel exceeds two times every five seconds. |
JOIN_CHANNEL_ERR_NOT_INITIALIZED | 101: IRtmService is not initialized. |
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. |
enum LEAVE_CHANNEL_ERR |
Error codes related to leaving a channel.
Enumerator | |
---|---|
LEAVE_CHANNEL_ERR_OK | 0: The method call succeeds, or the user leaves the channel successfully. |
LEAVE_CHANNEL_ERR_FAILURE | 1: Common failure. The user fails to leave the channel. |
LEAVE_CHANNEL_ERR_REJECTED | 2: RESERVED FOR FUTURE USE |
LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL | 3: The user is not in the channel. |
LEAVE_CHANNEL_ERR_NOT_INITIALIZED | 101: IRtmService is not initialized. |
LEAVE_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 calling the leave method. |
enum LEAVE_CHANNEL_REASON |
Error codes related to sending a channel message.
Enumerator | |
---|---|
CHANNEL_MESSAGE_ERR_OK | 0: The method call succeeds, or the server receives the channel message. |
CHANNEL_MESSAGE_ERR_FAILURE | 1: Common failure. The user fails to send the channel message. |
CHANNEL_MESSAGE_ERR_SENT_TIMEOUT | 2: The SDK does not receive a response from the server in 10 seconds. The current timeout is set as 10 seconds. Possible reasons: The user is in the CONNECTION_STATE_ABORTED state. |
CHANNEL_MESSAGE_ERR_TOO_OFTEN | 3: The method call frequency exceeds the limit of (RTM SDK for Windows C++) 180 calls every three seconds or (RTM SDK for Linux C++) 1500 calls every three seconds, with channel and peer messages taken together.. |
CHANNEL_MESSAGE_ERR_INVALID_MESSAGE | 4: The message is null or exceeds 32 KB in length. |
CHANNEL_MESSAGE_ERR_NOT_INITIALIZED | 101: IRtmService is not initialized. |
CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN | 102: The user does not call the login method, or the method call of login does not succeed before sending out a channel message. |
enum RESPONSE_CODE |
enum MESSAGE_TYPE |