Public Attributes

int ATTRIBUTE_OPERATION_ERR_OK = 0
 
int ATTRIBUTE_OPERATION_ERR_NOT_READY = 1
 
int ATTRIBUTE_OPERATION_ERR_FAILURE = 2
 
int ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT = 3
 
int ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW = 4
 
int ATTRIBUTE_OPERATION_ERR_TOO_OFTEN = 5
 
int ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND = 6
 
int ATTRIBUTE_OPERATION_ERR_TIMEOUT = 7
 
int ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED = 101
 
int ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN = 102
 

Member Data Documentation

◆ ATTRIBUTE_OPERATION_ERR_OK

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_OK = 0

0: The attribute operation succeeds.

◆ ATTRIBUTE_OPERATION_ERR_NOT_READY

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_NOT_READY = 1

1: The SDK is not ready for this attribute operation. Only after the login method call succeeds can you call the attribute-related methods.

◆ ATTRIBUTE_OPERATION_ERR_FAILURE

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_FAILURE = 2

2: The attribute operation fails.

◆ ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT = 3

3: The argument you put for this attribute operation is invalid.

◆ ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW = 4

4: The attribute size exceeds the limit.

  • For user attribute operations: The user's overall attribute size would exceed the limit of 16 KB, one of the user's attributes would exceeds 8 KB in size, or the number of this user's attributes would exceed 32 after this attribute operation.
  • For channel attribute operations: The channel's overall attribute size would exceed the limit of 32 KB, one of the channel attributes would exceed 8 KB in size, or the number of this channel's attributes would exceed 32 after this attribute operation.

◆ ATTRIBUTE_OPERATION_ERR_TOO_OFTEN

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_TOO_OFTEN = 5

5: The method call frequency exceeds the limit.

◆ ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND = 6

6: The specified user is not found, either because the user is offline or because the user does not exist.

◆ ATTRIBUTE_OPERATION_ERR_TIMEOUT

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_TIMEOUT = 7

7: A timeout occurs in the attribute-related operation. The current timeout is set as five seconds. Possible reasons: The user is in the CONNECTION_STATE_ABORTED or CONNECTION_STATE_RECONNECTING state.

◆ ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED = 101

101: The SDK is not initialized.

◆ ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN

int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_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 the attribute operation.