AgoraRtmProcessAttributeErrorCode Constants Reference

Declared in	AgoraRtmKit.h

Error codes related to attrubute operations.

Definition

typedef NS_ENUM(NSInteger, AgoraRtmProcessAttributeErrorCode ) {


                   AgoraRtmAttributeOperationErrorOk = 0,


                   AgoraRtmAttributeOperationErrorNotReady = 1,


                   AgoraRtmAttributeOperationErrorFailure = 2,


                   AgoraRtmAttributeOperationErrorInvalidArgument = 3,


                   AgoraRtmAttributeOperationErrorSizeOverflow = 4,


                   AgoraRtmAttributeOperationErrorTooOften = 5,


                   AgoraRtmAttributeOperationErrorUserNotFound = 6,


                   AgoraRtmAttributeOperationErrorTimeout = 7,


                   AgoraRtmAttributeOperationErrorNotInitialized = 101,


                   AgoraRtmAttributeOperationErrorNotLoggedIn = 102,


                };

Constants

AgoraRtmAttributeOperationErrorOk

0: The attribute operation succeeds.

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorNotReady

1: DEPRECATED

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorFailure

2: The attribute operation fails.

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorInvalidArgument

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

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorSizeOverflow

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.

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorTooOften

5: The method call frequency exceeds the limit.

For setLocalUserAttributes, addOrUpdateLocalUserAttributes, deleteLocalUserAttributesByKeys and clearLocalUserAttributes taken together: the limit is 10 queries every five seconds.

For getUserAttributes and getUserAttributesByKeys taken together, the limit is 40 queries every five seconds.

For setChannelAttributes, addOrUpdateChannelAttributes, deleteChannelAttributesByKeys and clearChannelAttributes taken together: the limit is 10 queries every five seconds.

For getChannelAllAttributes and getChannelAttributesByKeys taken together, the limit is 10 queries every five seconds.

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorUserNotFound

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

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorTimeout

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

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorNotInitialized

101: The SDK is not initialized.

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorNotLoggedIn

102: The user does not call the loginByToken method, or the method call of loginByToken does not succeed before the attribute operation.

Declared In AgoraRtmKit.h.