Package io.agora.rtm

Enum Class RtmConstants.RtmErrorCode

java.lang.Object
java.lang.Enum<RtmConstants.RtmErrorCode>
io.agora.rtm.RtmConstants.RtmErrorCode
All Implemented Interfaces:
Serializable, Comparable<RtmConstants.RtmErrorCode>, Constable
Enclosing class:
RtmConstants
public static enum RtmConstants.RtmErrorCode extends Enum<RtmConstants.RtmErrorCode>
The error codes of rtm client.

  • Enum Constant Details

    • OK

      public static final RtmConstants.RtmErrorCode OK
      0: No error occurs.

    • NOT_INITIALIZED

      public static final RtmConstants.RtmErrorCode NOT_INITIALIZED
      -10001 ~ -11000 : reserved for generic error. -10001: The SDK is not initialized.

    • NOT_LOGIN

      public static final RtmConstants.RtmErrorCode NOT_LOGIN
      -10002: The user didn't login the RTM system.

    • INVALID_APP_ID

      public static final RtmConstants.RtmErrorCode INVALID_APP_ID
      -10003: The app ID is invalid.

    • INVALID_EVENT_HANDLER

      public static final RtmConstants.RtmErrorCode INVALID_EVENT_HANDLER
      -10004: The event handler is invalid.

    • INVALID_TOKEN

      public static final RtmConstants.RtmErrorCode INVALID_TOKEN
      -10005: The token is invalid.

    • INVALID_USER_ID

      public static final RtmConstants.RtmErrorCode INVALID_USER_ID
      -10006: The user ID is invalid.

    • INIT_SERVICE_FAILED

      public static final RtmConstants.RtmErrorCode INIT_SERVICE_FAILED
      -10007: The service is not initialized.

    • INVALID_CHANNEL_NAME

      public static final RtmConstants.RtmErrorCode INVALID_CHANNEL_NAME
      -10008: The channel name is invalid.

    • TOKEN_EXPIRED

      public static final RtmConstants.RtmErrorCode TOKEN_EXPIRED
      -10009: The token has expired.

    • LOGIN_NO_SERVER_RESOURCES

      public static final RtmConstants.RtmErrorCode LOGIN_NO_SERVER_RESOURCES
      -10010: There is no server resources now.

    • LOGIN_TIMEOUT

      public static final RtmConstants.RtmErrorCode LOGIN_TIMEOUT
      -10011: The login timeout.

    • LOGIN_REJECTED

      public static final RtmConstants.RtmErrorCode LOGIN_REJECTED
      -10012: The login is rejected by server.

    • LOGIN_ABORTED

      public static final RtmConstants.RtmErrorCode LOGIN_ABORTED
      -10013: The login is aborted due to unrecoverable error.

    • INVALID_PARAMETER

      public static final RtmConstants.RtmErrorCode INVALID_PARAMETER
      -10014: The parameter is invalid.

    • LOGIN_NOT_AUTHORIZED

      public static final RtmConstants.RtmErrorCode LOGIN_NOT_AUTHORIZED
      -10015: The login is not authorized. Happens user login the RTM system without granted from console.

    • INCONSISTENT_APPID

      public static final RtmConstants.RtmErrorCode INCONSISTENT_APPID
      -10016: Try to login or join with inconsistent app ID.

    • DUPLICATE_OPERATION

      public static final RtmConstants.RtmErrorCode DUPLICATE_OPERATION
      -10017: Already call same request.

    • INSTANCE_ALREADY_RELEASED

      public static final RtmConstants.RtmErrorCode INSTANCE_ALREADY_RELEASED
      -10018: Already call destroy or release, this instance is forbidden to call any api, please create new instance.

    • INVALID_CHANNEL_TYPE

      public static final RtmConstants.RtmErrorCode INVALID_CHANNEL_TYPE
      -10019: Invalid channel type

    • INVALID_ENCRYPTION_PARAMETER

      public static final RtmConstants.RtmErrorCode INVALID_ENCRYPTION_PARAMETER
      -10020: The encryption parameter is invalid.

    • OPERATION_RATE_EXCEED_LIMITATION

      public static final RtmConstants.RtmErrorCode OPERATION_RATE_EXCEED_LIMITATION
      -10021: The operation is too frequent.

    • SERVICE_NOT_SUPPORTED

      public static final RtmConstants.RtmErrorCode SERVICE_NOT_SUPPORTED
      -10022: The service is not configured in private config mode.

    • LOGIN_CANCELED

      public static final RtmConstants.RtmErrorCode LOGIN_CANCELED
      -10023: This login operation stopped by a new login operation or logout operation.

    • INVALID_PRIVATE_CONFIG

      public static final RtmConstants.RtmErrorCode INVALID_PRIVATE_CONFIG
      -10024: The private config is invalid, set private config should both set serviceType and accessPointHosts.

    • NOT_CONNECTED

      public static final RtmConstants.RtmErrorCode NOT_CONNECTED
      -10025: Perform operation failed due to RTM service is not connected.

    • RENEW_TOKEN_TIMEOUT

      public static final RtmConstants.RtmErrorCode RENEW_TOKEN_TIMEOUT
      -10026: Renew token timeout.

    • CHANNEL_NOT_JOINED

      public static final RtmConstants.RtmErrorCode CHANNEL_NOT_JOINED
      -11001 ~ -12000 : reserved for channel error. -11001: The user has not joined the channel.

    • CHANNEL_NOT_SUBSCRIBED

      public static final RtmConstants.RtmErrorCode CHANNEL_NOT_SUBSCRIBED
      -11002: The user has not subscribed the channel.

    • CHANNEL_EXCEED_TOPIC_USER_LIMITATION

      public static final RtmConstants.RtmErrorCode CHANNEL_EXCEED_TOPIC_USER_LIMITATION
      -11003: The topic member count exceeds the limit.

    • CHANNEL_IN_REUSE

      public static final RtmConstants.RtmErrorCode CHANNEL_IN_REUSE
      -11004: The channel is reused in RTC.

    • CHANNEL_INSTANCE_EXCEED_LIMITATION

      public static final RtmConstants.RtmErrorCode CHANNEL_INSTANCE_EXCEED_LIMITATION
      -11005: The channel instance count exceeds the limit.

    • CHANNEL_IN_ERROR_STATE

      public static final RtmConstants.RtmErrorCode CHANNEL_IN_ERROR_STATE
      -11006: The channel is in error state.

    • CHANNEL_JOIN_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_JOIN_FAILED
      -11007: The channel join failed.

    • CHANNEL_INVALID_TOPIC_NAME

      public static final RtmConstants.RtmErrorCode CHANNEL_INVALID_TOPIC_NAME
      -11008: The topic name is invalid.

    • CHANNEL_INVALID_MESSAGE

      public static final RtmConstants.RtmErrorCode CHANNEL_INVALID_MESSAGE
      -11009: The message is invalid.

    • CHANNEL_MESSAGE_LENGTH_EXCEED_LIMITATION

      public static final RtmConstants.RtmErrorCode CHANNEL_MESSAGE_LENGTH_EXCEED_LIMITATION
      -11010: The message length exceeds the limit.

    • CHANNEL_INVALID_USER_LIST

      public static final RtmConstants.RtmErrorCode CHANNEL_INVALID_USER_LIST
      -11011: The user list is invalid.

    • CHANNEL_NOT_AVAILABLE

      public static final RtmConstants.RtmErrorCode CHANNEL_NOT_AVAILABLE
      -11012: The stream channel is not available.

    • CHANNEL_TOPIC_NOT_SUBSCRIBED

      public static final RtmConstants.RtmErrorCode CHANNEL_TOPIC_NOT_SUBSCRIBED
      -11013: The topic is not subscribed.

    • CHANNEL_EXCEED_TOPIC_LIMITATION

      public static final RtmConstants.RtmErrorCode CHANNEL_EXCEED_TOPIC_LIMITATION
      -11014: The topic count exceeds the limit.

    • CHANNEL_JOIN_TOPIC_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_JOIN_TOPIC_FAILED
      -11015: Join topic failed.

    • CHANNEL_TOPIC_NOT_JOINED

      public static final RtmConstants.RtmErrorCode CHANNEL_TOPIC_NOT_JOINED
      -11016: The topic is not joined.

    • CHANNEL_TOPIC_NOT_EXIST

      public static final RtmConstants.RtmErrorCode CHANNEL_TOPIC_NOT_EXIST
      -11017: The topic does not exist.

    • CHANNEL_INVALID_TOPIC_META

      public static final RtmConstants.RtmErrorCode CHANNEL_INVALID_TOPIC_META
      -11018: The topic meta is invalid.

    • CHANNEL_SUBSCRIBE_TIMEOUT

      public static final RtmConstants.RtmErrorCode CHANNEL_SUBSCRIBE_TIMEOUT
      -11019: Subscribe channel timeout.

    • CHANNEL_SUBSCRIBE_TOO_FREQUENT

      public static final RtmConstants.RtmErrorCode CHANNEL_SUBSCRIBE_TOO_FREQUENT
      -11020: Subscribe channel too frequent.

    • CHANNEL_SUBSCRIBE_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_SUBSCRIBE_FAILED
      -11021: Subscribe channel failed.

    • CHANNEL_UNSUBSCRIBE_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_UNSUBSCRIBE_FAILED
      -11022: Unsubscribe channel failed.

    • CHANNEL_ENCRYPT_MESSAGE_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_ENCRYPT_MESSAGE_FAILED
      -11023: Encrypt message failed.

    • CHANNEL_PUBLISH_MESSAGE_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_PUBLISH_MESSAGE_FAILED
      -11024: Publish message failed.

    • CHANNEL_PUBLISH_MESSAGE_TOO_FREQUENT

      public static final RtmConstants.RtmErrorCode CHANNEL_PUBLISH_MESSAGE_TOO_FREQUENT
      -11025: Publish message too frequent.

    • CHANNEL_PUBLISH_MESSAGE_TIMEOUT

      public static final RtmConstants.RtmErrorCode CHANNEL_PUBLISH_MESSAGE_TIMEOUT
      -11026: Publish message timeout.

    • CHANNEL_NOT_CONNECTED

      public static final RtmConstants.RtmErrorCode CHANNEL_NOT_CONNECTED
      -11027: The connection state is invalid.

    • CHANNEL_LEAVE_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_LEAVE_FAILED
      -11028: Leave channel failed.

    • CHANNEL_CUSTOM_TYPE_LENGTH_OVERFLOW

      public static final RtmConstants.RtmErrorCode CHANNEL_CUSTOM_TYPE_LENGTH_OVERFLOW
      -11029: The custom type length exceeds the limit.

    • CHANNEL_INVALID_CUSTOM_TYPE

      public static final RtmConstants.RtmErrorCode CHANNEL_INVALID_CUSTOM_TYPE
      -11030: The custom type is invalid.

    • CHANNEL_UNSUPPORTED_MESSAGE_TYPE

      public static final RtmConstants.RtmErrorCode CHANNEL_UNSUPPORTED_MESSAGE_TYPE
      -11031: unsupported message type (in MacOS/iOS platform，message only support NSString and NSData)

    • CHANNEL_PRESENCE_NOT_READY

      public static final RtmConstants.RtmErrorCode CHANNEL_PRESENCE_NOT_READY
      -11032: The channel presence is not ready.

    • CHANNEL_RECEIVER_OFFLINE

      public static final RtmConstants.RtmErrorCode CHANNEL_RECEIVER_OFFLINE
      -11033: The destination user of publish message is offline.

    • CHANNEL_JOIN_CANCELED

      public static final RtmConstants.RtmErrorCode CHANNEL_JOIN_CANCELED
      -11034: The channel join operation is canceled.

    • CHANNEL_RECEIVER_OFFLINE_BUT_STORE_SUCCEEDED

      public static final RtmConstants.RtmErrorCode CHANNEL_RECEIVER_OFFLINE_BUT_STORE_SUCCEEDED
      -11035: The message receiver is offline but the message store in history succeeded.

    • CHANNEL_RECEIVER_OFFLINE_AND_STORE_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_RECEIVER_OFFLINE_AND_STORE_FAILED
      -11036: The message receiver is offline and the message store in history failed.

    • CHANNEL_MESSAGE_DELIVERED_BUT_STORE_FAILED

      public static final RtmConstants.RtmErrorCode CHANNEL_MESSAGE_DELIVERED_BUT_STORE_FAILED
      -11037: The message delivered successfully but store in history failed.

    • CHANNEL_SUBSCRIBE_PERMISSION_DENIED

      public static final RtmConstants.RtmErrorCode CHANNEL_SUBSCRIBE_PERMISSION_DENIED
      -11038: The subscribe permission is denied.

    • CHANNEL_PUBLISH_PERMISSION_DENIED

      public static final RtmConstants.RtmErrorCode CHANNEL_PUBLISH_PERMISSION_DENIED
      -11039: The publish permission is denied.

    • STORAGE_OPERATION_FAILED

      public static final RtmConstants.RtmErrorCode STORAGE_OPERATION_FAILED
      -12001 ~ -13000 : reserved for storage error. -12001: The storage operation failed.

    • STORAGE_METADATA_ITEM_EXCEED_LIMITATION

      public static final RtmConstants.RtmErrorCode STORAGE_METADATA_ITEM_EXCEED_LIMITATION
      -12002: The metadata item count exceeds the limit.

    • STORAGE_INVALID_METADATA_ITEM

      public static final RtmConstants.RtmErrorCode STORAGE_INVALID_METADATA_ITEM
      -12003: The metadata item is invalid.

    • STORAGE_INVALID_ARGUMENT

      public static final RtmConstants.RtmErrorCode STORAGE_INVALID_ARGUMENT
      -12004: The argument in storage operation is invalid.

    • STORAGE_INVALID_REVISION

      public static final RtmConstants.RtmErrorCode STORAGE_INVALID_REVISION
      -12005: The revision in storage operation is invalid.

    • STORAGE_METADATA_LENGTH_OVERFLOW

      public static final RtmConstants.RtmErrorCode STORAGE_METADATA_LENGTH_OVERFLOW
      -12006: The metadata length exceeds the limit.

    • STORAGE_INVALID_LOCK_NAME

      public static final RtmConstants.RtmErrorCode STORAGE_INVALID_LOCK_NAME
      -12007: The lock name in storage operation is invalid.

    • STORAGE_LOCK_NOT_ACQUIRED

      public static final RtmConstants.RtmErrorCode STORAGE_LOCK_NOT_ACQUIRED
      -12008: The lock in storage operation is not acquired.

    • STORAGE_INVALID_KEY

      public static final RtmConstants.RtmErrorCode STORAGE_INVALID_KEY
      -12009: The metadata key is invalid.

    • STORAGE_INVALID_VALUE

      public static final RtmConstants.RtmErrorCode STORAGE_INVALID_VALUE
      -12010: The metadata value is invalid.

    • STORAGE_KEY_LENGTH_OVERFLOW

      public static final RtmConstants.RtmErrorCode STORAGE_KEY_LENGTH_OVERFLOW
      -12011: The metadata key length exceeds the limit.

    • STORAGE_VALUE_LENGTH_OVERFLOW

      public static final RtmConstants.RtmErrorCode STORAGE_VALUE_LENGTH_OVERFLOW
      -12012: The metadata value length exceeds the limit.

    • STORAGE_DUPLICATE_KEY

      public static final RtmConstants.RtmErrorCode STORAGE_DUPLICATE_KEY
      -12013: The metadata key already exists.

    • STORAGE_OUTDATED_REVISION

      public static final RtmConstants.RtmErrorCode STORAGE_OUTDATED_REVISION
      -12014: The revision in storage operation is outdated or the key does not exist.

    • STORAGE_NOT_SUBSCRIBE

      public static final RtmConstants.RtmErrorCode STORAGE_NOT_SUBSCRIBE
      -12015: The storage operation performed without subscribing.

    • STORAGE_INVALID_METADATA_INSTANCE

      public static final RtmConstants.RtmErrorCode STORAGE_INVALID_METADATA_INSTANCE
      -12016: The metadata item is invalid.

    • STORAGE_SUBSCRIBE_USER_EXCEED_LIMITATION

      public static final RtmConstants.RtmErrorCode STORAGE_SUBSCRIBE_USER_EXCEED_LIMITATION
      -12017: The user count exceeds the limit when try to subscribe.

    • STORAGE_OPERATION_TIMEOUT

      public static final RtmConstants.RtmErrorCode STORAGE_OPERATION_TIMEOUT
      -12018: The storage operation timeout.

    • STORAGE_NOT_AVAILABLE

      public static final RtmConstants.RtmErrorCode STORAGE_NOT_AVAILABLE
      -12019: The storage service not available.

    • STORAGE_PERMISSION_DENIED

      public static final RtmConstants.RtmErrorCode STORAGE_PERMISSION_DENIED
      -12020: The storage permission is denied.

    • PRESENCE_NOT_CONNECTED

      public static final RtmConstants.RtmErrorCode PRESENCE_NOT_CONNECTED
      -13001 ~ -14000 : reserved for presence error. -13001: The user is not connected.

    • PRESENCE_NOT_WRITABLE

      public static final RtmConstants.RtmErrorCode PRESENCE_NOT_WRITABLE
      -13002: The presence is not writable.

    • PRESENCE_INVALID_ARGUMENT

      public static final RtmConstants.RtmErrorCode PRESENCE_INVALID_ARGUMENT
      -13003: The argument in presence operation is invalid.

    • PRESENCE_CACHED_TOO_MANY_STATES

      public static final RtmConstants.RtmErrorCode PRESENCE_CACHED_TOO_MANY_STATES
      -13004: The cached presence state count exceeds the limit.

    • PRESENCE_STATE_COUNT_OVERFLOW

      public static final RtmConstants.RtmErrorCode PRESENCE_STATE_COUNT_OVERFLOW
      -13005: The state count exceeds the limit.

    • PRESENCE_INVALID_STATE_KEY

      public static final RtmConstants.RtmErrorCode PRESENCE_INVALID_STATE_KEY
      -13006: The state key is invalid.

    • PRESENCE_INVALID_STATE_VALUE

      public static final RtmConstants.RtmErrorCode PRESENCE_INVALID_STATE_VALUE
      -13007: The state value is invalid.

    • PRESENCE_STATE_KEY_SIZE_OVERFLOW

      public static final RtmConstants.RtmErrorCode PRESENCE_STATE_KEY_SIZE_OVERFLOW
      -13008: The state key length exceeds the limit.

    • PRESENCE_STATE_VALUE_SIZE_OVERFLOW

      public static final RtmConstants.RtmErrorCode PRESENCE_STATE_VALUE_SIZE_OVERFLOW
      -13009: The state value length exceeds the limit.

    • PRESENCE_STATE_DUPLICATE_KEY

      public static final RtmConstants.RtmErrorCode PRESENCE_STATE_DUPLICATE_KEY
      -13010: The state key already exists.

    • PRESENCE_USER_NOT_EXIST

      public static final RtmConstants.RtmErrorCode PRESENCE_USER_NOT_EXIST
      -13011: The user is not exist.

    • PRESENCE_OPERATION_TIMEOUT

      public static final RtmConstants.RtmErrorCode PRESENCE_OPERATION_TIMEOUT
      -13012: The presence operation timeout.

    • PRESENCE_OPERATION_FAILED

      public static final RtmConstants.RtmErrorCode PRESENCE_OPERATION_FAILED
      -13013: The presence operation failed.

    • LOCK_OPERATION_FAILED

      public static final RtmConstants.RtmErrorCode LOCK_OPERATION_FAILED
      -14001 ~ -15000 : reserved for lock error. -14001: The lock operation failed.

    • LOCK_OPERATION_TIMEOUT

      public static final RtmConstants.RtmErrorCode LOCK_OPERATION_TIMEOUT
      -14002: The lock operation timeout.

    • LOCK_OPERATION_PERFORMING

      public static final RtmConstants.RtmErrorCode LOCK_OPERATION_PERFORMING
      -14003: The lock operation is performing.

    • LOCK_ALREADY_EXIST

      public static final RtmConstants.RtmErrorCode LOCK_ALREADY_EXIST
      -14004: The lock already exists.

    • LOCK_INVALID_NAME

      public static final RtmConstants.RtmErrorCode LOCK_INVALID_NAME
      -14005: The lock name is invalid.

    • LOCK_NOT_ACQUIRED

      public static final RtmConstants.RtmErrorCode LOCK_NOT_ACQUIRED
      -14006: The lock is not acquired.

    • LOCK_ACQUIRE_FAILED

      public static final RtmConstants.RtmErrorCode LOCK_ACQUIRE_FAILED
      -14007: Acquire lock failed.

    • LOCK_NOT_EXIST

      public static final RtmConstants.RtmErrorCode LOCK_NOT_EXIST
      -14008: The lock is not exist.

    • LOCK_NOT_AVAILABLE

      public static final RtmConstants.RtmErrorCode LOCK_NOT_AVAILABLE
      -14009: The lock service is not available.

    • LOCK_PERMISSION_DENIED

      public static final RtmConstants.RtmErrorCode LOCK_PERMISSION_DENIED
      -14010: The lock permission is denied.

    • HISTORY_OPERATION_FAILED

      public static final RtmConstants.RtmErrorCode HISTORY_OPERATION_FAILED
      -15001 ~ -16000 : reserved for history error. -15001: The history operation failed.

    • HISTORY_INVALID_TIMESTAMP

      public static final RtmConstants.RtmErrorCode HISTORY_INVALID_TIMESTAMP
      -15002: The timestamp is invalid.

    • HISTORY_OPERATION_TIMEOUT

      public static final RtmConstants.RtmErrorCode HISTORY_OPERATION_TIMEOUT
      -15003: The history operation timeout.

    • HISTORY_OPERATION_NOT_PERMITTED

      public static final RtmConstants.RtmErrorCode HISTORY_OPERATION_NOT_PERMITTED
      -15004: The history operation is not permitted.

    • HISTORY_NOT_AVAILABLE

      public static final RtmConstants.RtmErrorCode HISTORY_NOT_AVAILABLE
      -15005: The history service not available.

    • HISTORY_PERMISSION_DENIED

      public static final RtmConstants.RtmErrorCode HISTORY_PERMISSION_DENIED
      -15006: The history permission is denied.

  • Method Details

    • values

      public static RtmConstants.RtmErrorCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RtmConstants.RtmErrorCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public static int getValue(RtmConstants.RtmErrorCode code)

    • getEnum

      public static RtmConstants.RtmErrorCode getEnum(Integer value)