AgoraRtmProcessAttributeErrorCode Constants Reference

Declared in AgoraRtmKit.h

AgoraRtmProcessAttributeErrorCode

属性操作相关错误码。

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: 方法调用成功。

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorNotReady

1: DEPRECATED

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorFailure

2: 方法调用失败。

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorInvalidArgument

3: 无效的输入参数。

Declared In AgoraRtmKit.h.

AgoraRtmAttributeOperationErrorSizeOverflow

4: 本次操作后，用户属性或频道属性超过上限。

  • 用户属性操作：在本次属性操作后，用户属性总大小超过 16 KB 长度限制，或单条用户属性超过 8 KB 长度限制，或用户属性个数超过 32 个的条目上限。
  • 频道属性操作：在本次属性操作后，频道属性总大小超过 32 KB 长度限制，或单条频道属性超过 8 KB 长度限制，或频道属性个数超过 32 个的条目上限。

    Declared In AgoraRtmKit.h.

    • AgoraRtmAttributeOperationErrorTooOften

    5: 方法调用频率超过限制。

  • setLocalUserAttributes 、 addOrUpdateLocalUserAttributes 、 deleteLocalUserAttributesByKeys ，和 clearLocalUserAttributes 一并计算在内：调用频率上限为每 5 秒 10 次。
  • getUserAttributes 和 getUserAttributesByKeys 一并计算在内：调用频率上限为每 5 秒 40 次。
  • setChannelAttributes 、 addOrUpdateChannelAttributes 、 deleteChannelAttributesByKeys ，和 clearChannelAttributes 一并计算在内：调用频率上限为每 5 秒 10 次。
  • getChannelAllAttributes 和 getChannelAttributesByKeys 一并计算在内：调用频率上限为每 5 秒 10 次。

    Declared In AgoraRtmKit.h.

    • AgoraRtmAttributeOperationErrorUserNotFound

    6: 未找到指定用户。该用户或者处于离线状态或者并不存在。

    Declared In AgoraRtmKit.h.

    AgoraRtmAttributeOperationErrorTimeout

    7: 属性操作超时。当前的超时设定为 5 秒。可能原因：用户正处于 AgoraRtmConnectionStateAborted 状态或 AgoraRtmConnectionStateReconnecting 状态。

    Declared In AgoraRtmKit.h.

    AgoraRtmAttributeOperationErrorNotInitialized

    101: SDK 未完成初始化。

    Declared In AgoraRtmKit.h.

    AgoraRtmAttributeOperationErrorNotLoggedIn

    102: 执行用户属性操作前未调用 loginByToken 方法或者 loginByToken 方法调用未成功。

    Declared In AgoraRtmKit.h.

    Declared In

    AgoraRtmKit.h