Agora RTM Java API Reference for Android
概览
RtmClient
RtmMessage
RtmImageMessage
RtmFileMessage
SendMessageOptions
PeerSubscriptionOption
PeerOnlineState
RtmAttribute
RtmChannelAttribute
ChannelAttributeOptions
RtmChannelMemberCount
RtmChannel
RtmChannelMember
RtmCallManager
LocalInvitation
RemoteInvitation
ResultCallback
RtmClientListener
RtmChannelListener
RtmCallEventListener
RtmRequestId
RtmMediaOperationProgress
状态码和错误码
Public 属性 | |
| 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 |
类成员变量说明
◆ ATTRIBUTE_OPERATION_ERR_OK
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_OK = 0 |
0: 属性操作成功。
◆ ATTRIBUTE_OPERATION_ERR_NOT_READY
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_NOT_READY = 1 |
1:
◆ ATTRIBUTE_OPERATION_ERR_FAILURE
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_FAILURE = 2 |
2: 方法调用失败。
◆ ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT = 3 |
3: 无效的输入参数。比如，你不可以把用户属性或频道属性设为 ""。
◆ ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW = 4 |
4: 本次操作后，用户属性或频道属性超过上限。
- 用户属性操作：在本次属性操作后，用户属性总大小超过 16 KB 长度限制，或单条用户属性超过 8 KB 长度限制，或（RTM SDK for Android Java）用户属性个数超过 32 个的条目上限；（RTM SDK for Linux Java）用户属性个数超过 512 个的条目上限。
- 频道属性操作：在本次属性操作后，频道属性总大小超过 32 KB 长度限制，或单条频道属性超过 8 KB 长度限制，或（RTM SDK for Android Java）频道属性个数超过 32 个的条目上限；（RTM SDK for Linux Java）频道属性个数超过 512 个的条目上限。
◆ ATTRIBUTE_OPERATION_ERR_TOO_OFTEN
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_TOO_OFTEN = 5 |
5: 方法调用频率超过限制。
-
setLocalUserAttributes、addOrUpdateLocalUserAttributes、deleteLocalUserAttributesByKeys，和clearLocalUserAttributes一并计算在内：（RTM SDK for Android Java）调用频率上限为每 5 秒 10 次；（RTM SDK for Linux Java）调用频率上限为每 5 秒 100 次。 -
getUserAttributes和getUserAttributesByKeys一并计算在内：（RTM SDK for Android Java）调用频率上限为每 5 秒 40 次；（RTM SDK for Linux Java）调用频率上限为每 5 秒 400 次。 -
setChannelAttributes、addOrUpdateChannelAttributes、deleteChannelAttributesByKeys，和clearChannelAttributes一并计算在内：（RTM SDK for Android Java）调用频率上限为每 5 秒 10 次；（RTM SDK for Linux Java）调用频率上限为每 5 秒 100 次。
getChannelAttributes 和 getChannelAttributesByKeys 一并计算在内：（RTM SDK for Android Java）调用频率上限为每 5 秒 10 次；（RTM SDK for Linux Java）调用频率上限为每 5 秒 100 次。
◆ ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND = 6 |
6: 未找到指定用户。该用户或者处于离线状态或者并不存在。
◆ ATTRIBUTE_OPERATION_ERR_TIMEOUT
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_TIMEOUT = 7 |
7: 属性操作超时。当前的超时设定为 5 秒。可能原因：用户正处于 CONNECTION_STATE_ABORTED 状态或 CONNECTION_STATE_RECONNECTING 状态。
◆ ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED
| int io.agora.rtm.RtmStatusCode.AttributeOperationError.ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED = 101 |
101: SDK 未完成初始化。
