枚举类
- Android
更新时间不可用
RtmAreaCode
访问区域，即 SDK 连接的服务器所在的区域。
| 枚举值 | 描述 |
|---|---|
CN | 0x00000001: 中国大陆。 |
NA | 0x00000002: 北美区域。 |
EU | 0x00000004: 欧洲区域。 |
AS | 0x00000008: 除中国大陆以外的亚洲区域。 |
JP | 0x00000010: 日本。 |
IN | 0x00000020: 印度。 |
GLOB | 0xFFFFFFFF: 全球。 |
RtmChannelType
频道类型。
| 枚举值 | 描述 |
|---|---|
MESSAGE | 1: Message Channel |
STREAM | 2: Stream Channel |
USER | 3: User Channel |
RtmEncryptionMode
加密方式。
| 枚举值 | 描述 |
|---|---|
NONE | 0: 不加密。 |
AES_128_GCM | 1: 128 位 AES 加密，GCM 模式。 |
AES_256_GCM | 2: 256 位 AES 加密，GCM 模式。 |
RtmLockEventType
Lock 事件类型。
| 枚举值 | 描述 |
|---|---|
SNAPSHOT | 1: 加入频道时 Lock 的快照信息。 |
SET | 2: 已设置 Lock。 |
REMOVED | 3: 已删除 Lock。 |
ACQUIRED | 4: 已获取 Lock。 |
RELEASED | 5: 已释放 Lock。 |
EXPIRED | 6: Lock 已过期。 |
RtmLogLevel
日志信息的输出等级。
| 枚举值 | 描述 |
|---|---|
NONE | 0x0000: 不输出任何日志。 |
INFO | 0x0001: 输出 FATAL、ERROR、WARN、INFO 级别的日志。我们推荐你将日志级别设为该等级。 |
WARN | 0x0002: 仅输出 FATAL、ERROR、WARN 级别的日志。 |
ERROR | 0x0004: 仅输出 FATAL、ERROR 级别的日志。 |
FATAL | 0x0008: 仅输出 FATAL 级别的日志。 |
RtmMessagePriority
消息优先级。
| 枚举值 | 描述 |
|---|---|
HIGHEST | 0: 优先级最高。 |
HIGH | 1: 优先级高。 |
NORMAL | 4: 优先级正常。 |
LOW | 8: 优先级低。 |
RtmMessageQos
发送 Topic 消息时的 QoS 保障。
| 枚举值 | 描述 |
|---|---|
UNORDERED | 0: 消息数据到达时不保序。 |
ORDERED | 1: 消息数据到达时保序。 |
RtmMessageType
消息类型。
| 枚举值 | 描述 |
|---|---|
BINARY | 0：二进制类型。 |
STRING | 1：字符串类型。 |
RtmPresenceEventType
Presence 事件类型。
| 枚举值 | 描述 |
|---|---|
SNAPSHOT | 1: 加入频道时 Presence 的快照信息。 |
INTERVAL | 2: 当频道内人数达到设定值后，频道内的事件通知将由实时通知转为定时通知。 |
REMOTE_JOIN | 3: 远端用户加入频道。 |
REMOTE_LEAVE | 4: 远端用户离开频道。 |
REMOTE_TIMEOUT | 5: 远端用户连接超时。 |
REMOTE_STATE_CHANGED | 6: 远端用户的临时用户状态改变。 |
ERROR_OUT_OF_SERVICE | 7: 用户加入频道时未启用 Presence。 |
RtmLinkOperation
操作类型。
| 枚举值 | 描述 |
|---|---|
LOGIN | 0: 登录。 |
LOGOUT | 1: 登出。 |
JOIN | 2: 加入 Stream Channel。 |
LEAVE | 3: 离开 Stream Channel。 |
SERVER_REJECT | 4: 服务器拒绝。 |
AUTO_RECONNECT | 5: 自动重连。 |
RECONNECTED | 6: 已重连。 |
HEARTBEAT_TIMEOUT | 7: 超时未收到心跳包。 |
SERVER_TIMEOUT | 8: 服务器超时。 |
NETWORK_CHANGE | 9: 网络发生变化。 |
RtmLinkState
连接状态类型。
| 枚举值 | 描述 |
|---|---|
IDLE | 0: 初始状态。 |
CONNECTING | 1: 正在连接。 |
CONNECTED | 2: 已连接。 |
DISCONNECTED | 3: 已断开连接。 |
SUSPENDED | 4: 挂起状态。 |
FAILED | 5: 连接失败。 |
RtmLinkStateChangeReason
连接状态改变的原因。
| 枚举值 | 描述 |
|---|---|
UNKNOWN | 0: 未知原因。 |
LOGIN | 1: 正在登录。 |
LOGIN_SUCCESS | 2: 登录成功。 |
LOGIN_TIMEOUT | 3: 登录超时。 |
LOGIN_NOT_AUTHORIZED | 4: 登录未授权。 |
LOGIN_REJECTED | 5: 登录被拒绝。 |
RELOGIN | 6: 重新登录。 |
LOGOUT | 7: 登出。 |
AUTO_RECONNECT | 8: 自动重连。 |
RECONNECT_TIMEOUT | 9: 重连超时。 |
RECONNECT_SUCCESS | 10: 重连成功。 |
JOIN | 11: 正在加入频道。 |
JOIN_SUCCESS | 12: 加入频道成功。 |
JOIN_FAILED | 13: 加入频道失败。 |
REJOIN | 14: 重新加入频道。 |
LEAVE | 15: 离开频道。 |
INVALID_TOKEN | 16: Token 无效。 |
TOKEN_EXPIRED | 17: Token 过期。 |
INCONSISTENT_APP_ID | 18: App ID 不一致。 |
INVALID_CHANNEL_NAME | 19: 频道名无效。 |
INVALID_USER_ID | 20: 用户 ID 无效。 |
NOT_INITIALIZED | 21: SDK 未初始化。 |
RTM_SERVICE_NOT_CONNECTED | 22: RTM 服务未连接。 |
CHANNEL_INSTANCE_EXCEED_LIMITATION | 23: 频道实例超出限制。 |
OPERATION_RATE_EXCEED_LIMITATION | 24: 操作频率超出限制。 |
CHANNEL_IN_ERROR_STATE | 25: 频道处于错误状态。 |
PRESENCE_NOT_CONNECTED | 26: Presence 服务未连接。 |
SAME_UID_LOGIN | 27: 使用相同用户 ID 登录。 |
KICKED_OUT_BY_SERVER | 28: 被服务器踢出。 |
KEEP_ALIVE_TIMEOUT | 29: 心跳超时。 |
CONNECTION_ERROR | 30: 连接错误。 |
PRESENCE_NOT_READY | 31: Presence 服务未就绪。 |
NETWORK_CHANGE | 32: 网络发生变化。 |
SERVICE_NOT_SUPPORTED | 33: 服务不支持。 |
STREAM_CHANNEL_NOT_AVAILABLE | 34: Stream Channel 不存在。 |
STORAGE_NOT_AVAILABLE | 35: Storage 服务不可用。 |
LOCK_NOT_AVAILABLE | 36: Lock 服务不可用。 |
LOGIN_TOO_FREQUENT | 37: 登录操作太频繁。 |
RtmProtocolType
消息传输协议类型。
| 枚举值 | 描述 |
|---|---|
TCP_UDP | 0: TCP 和 UDP 协议。 |
TCP_ONLY | 1: 仅 TCP 协议，即双环境都是 TCP 协议。 |
RtmServiceType
服务类型。
| 枚举值 | 描述 |
|---|---|
MESSAGE | 基础服务，包含 Message Channel、User Channel、Presence、Storage 和 Lock 服务。 |
STREAM | Stream Channel 服务。 |
信息
如需使用 RTM 的全部服务，你可以使用位操作同时设置两种服务类型。
RtmProxyType
代理类型。
| 枚举值 | 描述 |
|---|---|
NONE | 0: 不开启 Proxy。 |
HTTP | 1: 开启 HTTP 协议的 Proxy。 |
CLOUD_TCP | 2: 开启 TCP 协议的 Cloud Proxy。 |
RtmStorageEventType
Storage 事件类型。
| 枚举值 | 描述 |
|---|---|
SNAPSHOT | 1: 用户第一次订阅 Channl Metadata 或 User Metadata，或加入频道时触发，本地用户会收到此类事件通知。 |
SET | 2: 当调用 setChannelMetadata 或者 setUserMetadata 时触发。该事件仅在增量数据更新模式下返回。 |
UPDATE | 3: 当调用设置、更新或删除 Channel Metadata 或 User Metadata 的方法时会返回该类型事件。 |
REMOVE | 4: 当调用 removeChannelMetadata 或者 removeUserMetadata 时触发。该事件仅在增量数据更新模式下返回。 |
RtmStorageType
Storage 类型。
| 枚举值 | 描述 |
|---|---|
USER | 1: User Metadata 事件。 |
CHANNEL | 2: Channel Metadata 事件。 |
RtmTopicEventType
Topic 事件类型。
| 枚举值 | 描述 |
|---|---|
SNAPSHOT | 1: 加入频道时 Topic 的快照信息。 |
REMOTE_JOIN | 2: 远端用户加入 Topic。 |
REMOTE_LEAVE | 3: 远端用户离开 Topic。 |