特性列表 | 声网文档中心

Setup

功能	API 接口
创建实例	`RtmClient create(RtmConfig config)`
销毁实例	`RtmClient.release()`
Token 设置	`login` 接口中的 `token` 参数
端侧加密	`RtmEncryptionConfig` 中的 `encryptionMode`、`encryptionKey`、`encryptionSalt` 参数
Presence 超时设置	`RtmConfig` 中的 `presenceTimeout` 参数
日志等级设置	`RtmLogConfig` 中的 `level` 参数
Proxy 设置	`RtmProxyConfig` 中的 `proxyType`、`server`、`port`、`account`、`password` 参数
消息传输协议设置	`RtmConfig` 中的 `protocolType` 参数
私有化部署设置	`RtmPrivateConfig` 中的 `serviceType`、`accessPointHosts` 参数
事件监听	`void addEventListener(RtmEventListener listener)` `void removeEventListener(RtmEventListener listener)`
登录服务	`void login(String token, ResultCallback<Void> resultCallback)`
登出服务	`void logout(ResultCallback<Void> resultCallback)`

Channel

功能	API 接口
订阅频道	`void subscribe(String channelName, SubscribeOptions options, ResultCallback<Void> resultCallback)`
取消订阅频道	`void unsubscribe(String channelName, ResultCallback<Void> resultCallback)`
创建 Stream Channel	`StreamChannel createStreamChannel(String channelName)`
加入 Stream Channel	`void join(JoinChannelOptions options, ResultCallback<Void> resultCallback)`
离开 Stream Channel	`void leave(ResultCallback<Void> resultCallback)`
销毁 Stream Channel	`streamChannel.release()`

Topic

功能	API 接口
加入 Topic	`void joinTopic(String topicName, JoinTopicOptions options, ResultCallback<Void> resultCallback)`
发送 Topic 消息	`void publishTopicMessage(String topicName, String message, TopicMessageOptions options, ResultCallback<Void> resultCallback)`
离开 Topic	`void leaveTopic(String topicName, ResultCallback<Void> resultCallback)`
订阅 Topic	`void subscribeTopic(String topicName, TopicOptions options, ResultCallback<SubscribeTopicResult> resultCallback)`
取消订阅 Topic	`void unsubscribeTopic(String topicName, TopicOptions options, ResultCallback<Void> resultCallback)`

Message

功能	API 接口
发送消息	`void publish(String channelName, String message, PublishOptions options, ResultCallback<Void> resultCallback)`

在线状态

功能	API 接口
查询频道在线用户	`void whoNow(String channelName, RtmChannelType channelType, PresenceOptions options, ResultCallback<WhoNowResult> resultCallback)`
查询用户所在频道	`void whereNow(String userId, ResultCallback<ArrayList<ChannelInfo>> resultCallback)`
设置用户临时状态	`void setState(String channelName, RtmChannelType channelType, Map<String, String> items, ResultCallback<Void> resultCallback)`
查询用户临时状态	`void getState(String channelName, RtmChannelType channelType, String userId, ResultCallback<UserState> resultCallback)`
删除用户临时状态	`void removeState(String channelName, RtmChannelType channelType, ArrayList<String> keys, ResultCallback<Void> resultCallback)`

存储

功能	API 接口
设置频道属性	`void setChannelMetadata(String channelName, RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback<Void> resultCallback)`
获取频道属性	`void getChannelMetadata(String channelName, RtmChannelType channelType, ResultCallback<Metadata> resultCallback)`
删除频道属性	`void removeChannelMetadata(String channelName, RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback<Void> resultCallback)`
更新频道属性	`void updateChannelMetadata(String channelName, RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback<Void> resultCallback)`
设置用户属性	`void setUserMetadata(String userId, Metadata data, MetadataOptions options, ResultCallback<Void> resultCallback)`
获取用户属性	`void getUserMetadata(String userId, ResultCallback<Metadata> resultCallback)`
删除用户属性	`void removeUserMetadata(String userId, Metadata data, MetadataOptions options, ResultCallback<Void> resultCallback)`
更新用户属性	`void updateUserMetadata(String userId, Metadata data, MetadataOptions options, ResultCallback<Void> resultCallback)`
订阅用户属性	`void subscribeUserMetadata(String userId, ResultCallback<Void> resultCallback)`
取消订阅用户属性	`void unsubscribeUserMetadata(String userId, ResultCallback<Void> resultCallback)`

锁

功能	API 接口
设置锁	`void setLock(String channelName, RtmChannelType channelType, String lockName, long ttl, ResultCallback<Void> resultCallback)`
获取锁	`void acquireLock(String channelName, RtmChannelType channelType, String lockName, boolean retry, ResultCallback<Void> resultCallback)`
释放锁	`void releaseLock(String channelName, RtmChannelType channelType, String lockName, ResultCallback<Void> resultCallback)`
收回锁	`void revokeLock(String channelName, RtmChannelType channelType, String lockName, String owner, ResultCallback<Void> resultCallback)`
查询锁	`void getLocks(String channelName, RtmChannelType channelType, ResultCallback<ArrayList<LockDetail>> resultCallback)`
删除锁	`void removeLock(String channelName, RtmChannelType channelType, String lockName, ResultCallback<Void> resultCallback)`

本文提供 RTM 所具备的功能特性及对应 API 接口。

Setup

功能	API 接口
创建实例	`initWithConfig:delegate:error`
销毁实例	`[rtm destroy]`
Token 设置	`AgoraRtmClientConfig` 中的 `token` 参数
端侧加密	`AgoraRtmClientConfig` 中的 `encryptionConfig` 参数
Presence 超时设置	`AgoraRtmClientConfig` 中的 `presenceTimeout` 参数
日志等级设置	`AgoraRtmLogConfig` 中的 `level` 参数
Proxy 设置	`AgoraRtmProxyConfig` 中的 `proxyType`、`server`、`port`、`account`、`password` 参数
消息传输协议设置	`AgoraRtmClientConfig` 中的 `protocolType` 参数
私有化部署设置	`AgoraRtmPrivateConfig` 中的 `serviceType`、`accessPointHosts` 参数
事件监听	`[rtm addDelegate:delegate]` `[rtm removeDelegate:delegate]`
登录服务	`[rtm loginByToken:completion:]`
登出服务	`[rtm logout:completion]`

Channel

功能	API 接口
订阅频道	`[rtm subscribeWithChannel:option:completion]`
取消订阅频道	`[rtm unsubscribeWithChannel:completion]`
创建 Stream Channel	`[rtm createStreamChannel:error]`
加入 Stream Channel	`[streamChannel joinWithOption:completion]`
离开 Stream Channel	`[streamChannel leave]`
销毁 Stream Channel	`[streamChannel destroy]`

Topic

功能	API 接口
加入 Topic	`[streamChannel joinTopic:withOption:completion]`
发送 Topic 消息	`[streamChannel publishTopicMessage:data:option:completion]`
离开 Topic	`[streamChannel leaveTopic:completion]`
订阅 Topic	`[streamChannel subscribeTopic:withOption:completion]`
取消订阅 Topic	`[streamChannel unsubscribeTopic:withOption:completion]`

Message

功能	API 接口
发送消息	`[rtm publish:message:option:completion]`

在线状态

功能	API 接口
查询频道在线用户	`[[rtm getPresence] whoNow:channelType:options:completion]`
查询用户所在频道	`[[rtm getPresence] whereNow:completion]`
设置用户临时状态	`[[rtm getPresence] setState:channelType:items:completion]`
查询用户临时状态	`[[rtm getPresence] getState:channelType:userId:completion]`
删除用户临时状态	`[[rtm getPresence] removeState:channelType:keys:completion]`

存储

功能	API 接口
设置频道属性	`[[rtm getStorage] setChannelMetadata:channelType:data:options:lock:completion]`
获取频道属性	`[[rtm getStorage] getChannelMetadata:channelType:completion]`
删除频道属性	`[[rtm getStorage] removeChannelMetadata:channelType:data:options:lock:completion]`
更新频道属性	`[[rtm getStorage] updateChannelMetadata:channelType:data:options:lock:completion]`
设置用户属性	`[[rtm getStorage] setUserMetadata:data:options:completion]`
获取用户属性	`[[rtm getStorage] getUserMetadata:completion]`
删除用户属性	`[[rtm getStorage] removeUserMetadata:data:options:completion]`
更新用户属性	`[[rtm getStorage] updateChannelMetadata:data:options:completion]`
订阅用户属性	`[[rtm getStorage] subscribeUserMetadata:completion]`
取消订阅用户属性	`[[rtm getStorage] unsubscribeUserMetadata:completion]`

锁

功能	API 接口
设置锁	`[[rtm getLock] setLock:channelType:lockName:ttl:completion]`
获取锁	`[[rtm getLock] acquireLock:channelType:lockName:retry:completion]`
释放锁	`[[rtm getLock] releaseLock:channelType:lockName:completion]`
收回锁	`[[rtm getLock] revokeLock:channelType:lockName:userId:completion]`
查询锁	`[[rtm getLock] getLocks:channelType:completion]`
删除锁	`[[rtm getLock] removeLock:channelType:lockName:completion]`

本文提供 RTM 所具备的功能特性及对应 API 接口。

Setup

功能	API 接口
创建实例	`new RTM()`
Token 设置	`login` 中的 `token` 参数
端侧加密	`RTMConfig` 中的 `encryptionMode`、`cipherKey`、`salt` 参数
Presence 超时设置	`RTMConfig` 中的 `presenceTimeout` 参数
日志上传	`RTMConfig` 中的 `logUpload` 参数
日志等级设置	`RTMConfig` 中的 `logLevel` 参数
Cloud Proxy 设置	`RTMConfig` 中的 `cloudProxy` 参数
私有化部署设置	`RTMConfig` 中的 `privateConfig` 参数
事件监听	`rtm.addEventListener("event", event => {});` `rtm.removeEventListener("event", statusHandler);`
登录服务	`rtm.login(...): Promise<LoginResponse>;`
登出服务	`rtm.logout(): Promise<LogoutResponse>;`

Channel

功能	API 接口
订阅频道	`rtm.subscribe(...): Promise<SubscribeResponse>;`
取消订阅频道	`rtm.unsubscribe(...): Promise<UnsubscribeResponse>;`
创建 Stream Channel	`rtm.createStreamChannel(...): RTMStreamChannel;`
加入 Stream Channel	`streamChannel.join(...): Promise<JoinChannelResponse>;`
离开 Stream Channel	`streamChannel.leave(...): Promise<LeaveChannelResponse>;`

Topic

功能	API 接口
加入 Topic	`streamChannel.joinTopic(...): Promise<JoinTopicResponse>;`
发送 Topic 消息	`streamChannel.publishTopicMessage(...): Promise<PublishTopicMessageResponse>;`
离开 Topic	`streamChannel.leaveTopic(...): Promise<LeaveTopicResponse>;`
订阅 Topic	`streamChannel.subscribeTopic(...): Promise<SubscribeTopicResponse>;`
取消订阅 Topic	`streamChannel.unsubscribeTopic(...): Promise<UnsubscribeTopicResponse>;`

Message

功能	API 接口
发送消息	`rtm.publish(...): Promise<PublishResponse>;`

在线状态

功能	API 接口
查询频道在线用户	`rtm.presence.whoNow(...): Promise<WhoNowResponse>;`
查询用户所在频道	`rtm.presence.whereNow(...): Promise<WhereNowResponse>;`
设置用户临时状态	`rtm.presence.setState(...): Promise<SetStateResponse>;`
查询用户临时状态	`rtm.presence.getState(...): Promise<GetStateResponse>;`
删除用户临时状态	`rtm.presence.removeState(...): Promise<RemoveStateResponse>;`

存储

功能	API 接口
设置频道属性	`rtm.storage.setChannelMetadata(...): Promise<SetChannelMetadataResponse>;`
获取频道属性	`rtm.storage.getChannelMetadata(...): Promise<GetChannelMetadataResponse>;`
删除频道属性	`rtm.storage.removeChannelMetadata(...): Promise<RemoveChannelMetadataResponse>;`
更新频道属性	`rtm.storage.updateChannelMetadata(...): Promise<UpdateChannelMetadataResponse>;`
设置用户属性	`rtm.storage.setUserMetadata(...): Promise<SetUserMetadataResponse>;`
获取用户属性	`rtm.storage.getUserMetadata(...): Promise<GetUserMetadataResponse>;`
删除用户属性	`rtm.storage.removeUserMetadata(...): Promise<RemoveUserMetadataResponse>;`
更新用户属性	`rtm.storage.updateUserMetadata(...): Promise<UpdateUserMetadataResponse>;`
订阅用户属性	`rtm.storage.subscribeUserMetadata(...): Promise<SubscribeUserMetaResponse>;`
取消订阅用户属性	`rtm.storage.unsubscribeUserMetadata(...): Promise<UnsubscribeUserMetaResponse>;`

锁

功能	API 接口
设置锁	`rtm.lock.setLock(...): Promise<SetLockResponse>;`
获取锁	`rtm.lock.acquireLock(...): Promise<AcquireLockResponse>;`
释放锁	`rtm.lock.releaseLock(...): Promise<ReleaseLockResponse>;`
收回锁	`rtm.lock.revokeLock(...): Promise<RevokeLockResponse>;`
查询锁	`rtm.lock.getLock(...): Promise<GetLockResponse>;`
删除锁	`rtm.lock.removeLock(...): Promise<RemoveLockResponse>;`

本文提供 RTM 所具备的功能特性及对应 API 接口。

Setup

功能	API 接口
创建实例	`new RtmClient()`
销毁实例	`rtmClient.release()`
Token 设置	`login` 中的 `token` 参数
端侧加密	`RtmConfig` 中的 `encryptionMode`、`cipherKey`、`salt` 参数
Presence 超时设置	`RtmConfig` 中的 `presenceTimeout` 参数
日志等级设置	`RtmConfig` 中的 `logLevel` 参数
Cloud Proxy 设置	`RtmConfig` 中的 `cloudProxy` 参数
私有化部署设置	`RtmConfig` 中的 `privateConfig` 参数
事件监听	`rtmClient.addEventListener("event", event => {});` `rtmClient.removeEventListener("event", statusHandler);`
登录服务	`rtmClient.login(...): Promise<LoginResponse>;`
登出服务	`rtmClient.logout(): Promise<LogoutResponse>;`

Channel

功能	API 接口
订阅频道	`rtmClient.subscribe(...): Promise<SubscribeResponse>;`
取消订阅频道	`rtmClient.unsubscribe(...): Promise<UnsubscribeResponse>;`
创建 Stream Channel	`rtmClient.createStreamChannel(...): StreamChannel;`
加入 Stream Channel	`streamChannel.join(...): Promise<JoinChannelResponse>;`
离开 Stream Channel	`streamChannel.leave(...): Promise<LeaveChannelResponse>;`
销毁 Stream Channel	`streamChannel.release()`

Topic

功能	API 接口
加入 Topic	`streamChannel.joinTopic(...): Promise<JoinTopicResponse>;`
发送 Topic 消息	`streamChannel.publishTopicMessage(...): Promise<PublishTopicMessageResponse>;`
离开 Topic	`streamChannel.leaveTopic(...): Promise<LeaveTopicResponse>;`
订阅 Topic	`streamChannel.subscribeTopic(...): Promise<SubscribeTopicResponse>;`
取消订阅 Topic	`streamChannel.unsubscribeTopic(...): Promise<UnsubscribeTopicResponse>;`

Message

功能	API 接口
发送消息	`rtmClient.publish(...): Promise<PublishResponse>;`

在线状态

功能	API 接口
查询频道在线用户	`rtmClient.presence.whoNow(...): Promise<WhoNowResponse>;`
查询用户所在频道	`rtmClient.presence.whereNow(...): Promise<WhereNowResponse>;`
设置用户临时状态	`rtmClient.presence.setState(...): Promise<SetStateResponse>;`
查询用户临时状态	`rtmClient.presence.getState(...): Promise<GetStateResponse>;`
删除用户临时状态	`rtmClient.presence.removeState(...): Promise<RemoveStateResponse>;`

存储

功能	API 接口
设置频道属性	`rtmClient.storage.setChannelMetadata(...): Promise<SetChannelMetadataResponse>;`
获取频道属性	`rtmClient.storage.getChannelMetadata(...): Promise<GetChannelMetadataResponse>;`
删除频道属性	`rtmClient.storage.removeChannelMetadata(...): Promise<RemoveChannelMetadataResponse>;`
更新频道属性	`rtmClient.storage.updateChannelMetadata(...): Promise<UpdateChannelMetadataResponse>;`
设置用户属性	`rtmClient.storage.setUserMetadata(...): Promise<SetUserMetadataResponse>;`
获取用户属性	`rtmClient.storage.getUserMetadata(...): Promise<GetUserMetadataResponse>;`
删除用户属性	`rtmClient.storage.removeUserMetadata(...): Promise<RemoveUserMetadataResponse>;`
更新用户属性	`rtmClient.storage.updateUserMetadata(...): Promise<UpdateUserMetadataResponse>;`
订阅用户属性	`rtmClient.storage.subscribeUserMetadata(...): Promise<SubscribeUserMetaResponse>;`
取消订阅用户属性	`rtmClient.storage.unsubscribeUserMetadata(...): Promise<UnsubscribeUserMetaResponse>;`

锁

功能	API 接口
设置锁	`rtmClient.lock.setLock(...): Promise<SetLockResponse>;`
获取锁	`rtmClient.lock.acquireLock(...): Promise<AcquireLockResponse>;`
释放锁	`rtmClient.lock.releaseLock(...): Promise<ReleaseLockResponse>;`
收回锁	`rtmClient.lock.revokeLock(...): Promise<RevokeLockResponse>;`
查询锁	`rtmClient.lock.getLock(...): Promise<GetLockResponse>;`
删除锁	`rtmClient.lock.removeLock(...): Promise<RemoveLockResponse>;`

本文提供 RTM 所具备的功能特性及对应 API 接口。

Setup

功能	API 接口
创建实例	`Future<(RtmStatus, RtmClient)> RTM(...)`
销毁实例	`Future<RtmStatus> release()`
Token 设置	`Future<(RtmStatus, LoginResult?)> login(String token)` 接口中的 `token` 参数
端侧加密	`RtmEncryptionConfig` 中的 `encryptionMode`、`encryptionKey`、`encryptionSalt` 参数
Presence 超时设置	`RtmConfig` 中的 `presenceTimeout` 参数
日志等级设置	`RtmLogConfig` 中的 `level` 参数
Proxy 设置	`RtmProxyConfig` 中的 `proxyType`、`server`、`port`、`account`、`password` 参数
消息传输协议设置	`RtmConfig` 中的 `protocolType` 参数
私有化部署设置	`RtmPrivateConfig` 中的 `serviceType`、`accessPointHosts` 参数
事件监听	`rtmClient.addListener({...})` `rtmClient.removeListener({...})`
登录服务	`Future<(RtmStatus, LoginResult?)> login(String token)`
登出服务	`Future<(RtmStatus, LogoutResult?)> logout()`

Channel

功能	API 接口
订阅频道	`Future<(RtmStatus, SubscribeResult?)> subscribe(...)`
取消订阅频道	`Future<(RtmStatus, UnsubscribeResult?)> unsubscribe(...)`
创建 Stream Channel	`Future<(RtmStatus, StreamChannel?)> createStreamChannel(...)`
加入 Stream Channel	`Future<(RtmStatus, JoinResult?)> join(...)`
离开 Stream Channel	`Future<(RtmStatus, LeaveResult?)> leave()`
销毁 Stream Channel	`Future<RtmStatus> release()`

Topic

功能	API 接口
加入 Topic	`Future<(RtmStatus, JoinTopicResult?)> joinTopic(...)`
发送 Topic 消息	`Future<(RtmStatus, PublishTopicMessageResult?)> publishTextMessage(...)` `Future<(RtmStatus, PublishTopicMessageResult?)> publishBinaryMessage(...)`
离开 Topic	`Future<(RtmStatus, LeaveTopicResult?)> leaveTopic(...)`
订阅 Topic	`Future<(RtmStatus, SubscribeTopicResult?)> subscribeTopic(...)`
取消订阅 Topic	`Future<(RtmStatus, UnsubscribeTopicResult?)> unsubscribeTopic(...)`

Message

功能	API 接口
发送消息	`Future<(RtmStatus, PublishResult?)> publish(...)` `Future<(RtmStatus, PublishResult?)> publishBinaryMessage(...)`

在线状态

功能	API 接口
查询频道在线用户	`Future<(RtmStatus, WhoNowResult?)> whoNow(...)`
查询用户所在频道	`Future<(RtmStatus, WhereNowResult?)> whereNow(...)`
设置用户临时状态	`Future<(RtmStatus, SetStateResult?)> setState(...)`
查询用户临时状态	`Future<(RtmStatus, GetStateResult?)> getState(...)`
删除用户临时状态	`Future<(RtmStatus, RemoveStateResult?)> removeState(...)`

存储

功能	API 接口
设置频道属性	`Future<(RtmStatus, SetChannelMetadataResult?)> setChannelMetadata(...)`
获取频道属性	`Future<(RtmStatus, GetChannelMetadataResult?)> getChannelMetadata(...)`
删除频道属性	`Future<(RtmStatus, RemoveChannelMetadataResult?)> removeChannelMetadata(...)`
更新频道属性	`Future<(RtmStatus, UpdateChannelMetadataResult?)> updateChannelMetadata(...)`
设置用户属性	`Future<(RtmStatus, SetUserMetadataResult?)> setUserMetadata(...)`
获取用户属性	`Future<(RtmStatus, GetUserMetadataResult?)> getUserMetadata(...)`
删除用户属性	`Future<(RtmStatus, RemoveUserMetadataResult?)> removeUserMetadata(...)`
更新用户属性	`Future<(RtmStatus, UpdateUserMetadataResult?)> updateUserMetadata(...)`
订阅用户属性	`Future<(RtmStatus, SubscribeUserMetadataResult?)> subscribeUserMetadata(...)`
取消订阅用户属性	`Future<(RtmStatus, UnsubscribeUserMetadataResult?)> unsubscribeUserMetadata(...)`

锁

功能	API 接口
设置锁	`Future<(RtmStatus, SetLockResult?)> setLock(...)`
获取锁	`Future<(RtmStatus, AcquireLockResult?)> acquireLock(...)`
释放锁	`Future<(RtmStatus, ReleaseLockResult?)> releaseLock(...)`
收回锁	`Future<(RtmStatus, RevokeLockResult?)> revokeLock(...)`
查询锁	`Future<(RtmStatus, GetLocksResult?)> getLocks(...)`
删除锁	`Future<(RtmStatus, RemoveLockResult?)> removeLock(...)`

本文提供 RTM 所具备的功能特性及对应 API 接口。

Setup

功能	API 接口
创建实例	`IRtmClient* createAgoraRtmClient(const RtmConfig& config, int& errorCode)`
销毁实例	`rtmClient.release()`
Token 设置	`void login(const char* token)` 接口中的 `token` 参数
端侧加密	`RtmEncryptionConfig` 中的 `encryptionMode`、`encryptionKey`、`encryptionSalt` 参数
Presence 超时设置	`RtmConfig` 中的 `presenceTimeout` 参数
日志等级设置	`RtmLogConfig` 中的 `level` 参数
Proxy 设置	`RtmProxyConfig` 中的 `proxyType`、`server`、`port`、`account`、`password` 参数
消息传输协议设置	`RtmConfig` 中的 `protocolType` 参数
私有化部署设置	`RtmPrivateConfig` 中的 `serviceType`、`accessPointHosts` 参数
事件监听	`IRtmEventHandler`
登录服务	`void login(const char* token)`
登出服务	`void logout()`

Channel

功能	API 接口
订阅频道	`void subscribe(const char* channelName, const SubscribeOptions& options, uint64_t& requestId)`
取消订阅频道	`void unsubscribe(const char* channelName)`
创建 Stream Channel	`IStreamChannel* createStreamChannel(const char* channelName, int& errorCode)`
加入 Stream Channel	`void join(const JoinChannelOptions& options, uint64_t& requestId)`
离开 Stream Channel	`void leave(uint64_t& requestId)`
销毁 Stream Channel	`streamChannel.release()`

Topic

功能	API 接口
加入 Topic	`void joinTopic(const char* topic, const JoinTopicOptions& options, uint64_t& requestId)`
发送 Topic 消息	`void publishTopicMessage(const char* topic, const char* message, size_t length, const TopicMessageOptions& option)`
离开 Topic	`void leaveTopic(const char* topic, uint64_t& requestId)`
订阅 Topic	`void subscribeTopic(const char* topic, const TopicOptions& options, uint64_t& requestId)`
取消订阅 Topic	`void unsubscribeTopic(const char* topic, const TopicOptions& options)`

Message

功能	API 接口
发送消息	`void publish(const char* channelName, const char* message, const size_t length, const PublishOptions& option, uint64_t& requestId)`

在线状态

功能	API 接口
查询频道在线用户	`void whoNow(const char* channelName, RTM_CHANNEL_TYPE channelType, const PresenceOptions& options, uint64_t& requestId)`
查询用户所在频道	`void whereNow(const char* userId, uint64_t& requestId)`
设置用户临时状态	`void setState(const char* channelName, RTM_CHANNEL_TYPE channelType, const StateItem* items, size_t count, uint64_t& requestId)`
查询用户临时状态	`void getState(const char* channelName, RTM_CHANNEL_TYPE channelType, const char* userId, uint64_t& requestId)`
删除用户临时状态	`void removeState(const char* channelName, RTM_CHANNEL_TYPE channelType, const char** keys, size_t count, uint64_t& requestId)`

存储

功能	API 接口
设置频道属性	`void setChannelMetadata(const char* channelName, RTM_CHANNEL_TYPE channelType, const Metadata& data, const MetadataOptions& options, const char* lockName, uint64_t& requestId)`
获取频道属性	`void getChannelMetadata(const char* channelName, RTM_CHANNEL_TYPE channelType, uint64_t& requestId)`
删除频道属性	`void removeChannelMetadata(const char* channelName, RTM_CHANNEL_TYPE channelType, const Metadata& data, const MetadataOptions& options, const char* lockName, uint64_t& requestId)`
更新频道属性	`void updateChannelMetadata(const char* channelName, RTM_CHANNEL_TYPE channelType, const Metadata& data, const MetadataOptions& options, const char* lockName, uint64_t& requestId)`
设置用户属性	`void setUserMetadata(const char* userId, const Metadata& data, const MetadataOptions& options, uint64_t& requestId)`
获取用户属性	`void getUserMetadata(const char* userId, uint64_t& requestId)`
删除用户属性	`void removeUserMetadata(const char* userId, const Metadata& data, const MetadataOptions& options, uint64_t& requestId)`
更新用户属性	`void updateUserMetadata(const char* userId, const Metadata& data, const MetadataOptions& options, uint64_t& requestId)`
订阅用户属性	`void subscribeUserMetadata(const char* userId, uint64_t& requestId)`
取消订阅用户属性	`void unsubscribeUserMetadata(const char* userId, uint64_t& requestId)`

锁

功能	API 接口
设置锁	`void setLock(const char* channelName, RTM_CHANNEL_TYPE channelType, const char* lockName, uint32_t ttl, uint64_t& requestId)`
获取锁	`void acquireLock(const char* channelName, RTM_CHANNEL_TYPE channelType, const char* lockName, bool retry, uint64_t& requestId)`
释放锁	`void releaseLock(const char* channelName, RTM_CHANNEL_TYPE channelType, const char* lockName, uint64_t& requestId)`
收回锁	`void revokeLock(const char* channelName, RTM_CHANNEL_TYPE channelType, const char* lockName, const char* owner, uint64_t& requestId)`
查询锁	`void getLocks(const char* channelName, RTM_CHANNEL_TYPE channelType, uint64_t& requestId)`
删除锁	`void removeLock(const char* channelName, RTM_CHANNEL_TYPE channelType, const char* lockName, uint64_t& requestId)`

本文提供 RTM 所具备的功能特性及对应 API 接口。

Setup

功能	API 接口
创建实例	`AgoraRtmClientKit(_ config: AgoraRtmClientConfig, delegate: (any AgoraRtmClientDelegate)?)`
销毁实例	`rtm.destroy() -> AgoraRtmErrorCode`
Token 设置	`AgoraRtmClientConfig` 中的 `token` 参数
端侧加密	`AgoraRtmClientConfig` 中的 `encryptionConfig` 参数
Presence 超时设置	`AgoraRtmClientConfig` 中的 `presenceTimeout` 参数
日志等级设置	`AgoraRtmLogConfig` 中的 `level` 参数
Proxy 设置	`AgoraRtmProxyConfig` 中的 `proxyType`、`server`、`port`、`account`、`password` 参数
消息传输协议设置	`AgoraRtmClientConfig` 中的 `protocolType` 参数
私有化部署设置	`AgoraRtmPrivateConfig` 中的 `serviceType`、`accessPointHosts` 参数
事件监听	`rtm.addDelegate(_ delegate: any AgoraRtmClientDelegate)` `rtm.removeDelegate(_ delegate: any AgoraRtmClientDelegate)`
登录服务	`rtm.login(_ token: String?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
登出服务	`rtm.logout(_ completionBlock: AgoraRtmOperationBlock? = nil)`

Channel

功能	API 接口
订阅频道	`rtm.subscribe(channelName: String, option subscribeOption: AgoraRtmSubscribeOptions?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
取消订阅频道	`rtm.unsubscribe(_ channelName: String, completion completionBlock: AgoraRtmOperationBlock? = nil)`
创建 Stream Channel	`rtm.createStreamChannel(_ channelName: String) throws -> AgoraRtmStreamChannel`
加入 Stream Channel	`streamChannel.join(_ option: AgoraRtmJoinChannelOption, completion completionBlock: AgoraRtmOperationBlock? = nil)`
离开 Stream Channel	`streamChannel.leave(_ completionBlock: AgoraRtmOperationBlock? = nil)`
销毁 Stream Channel	`streamChannel.destroy() -> AgoraRtmErrorCode`

Topic

功能	API 接口
加入 Topic	`streamChannel.joinTopic(_ topic: String, option: AgoraRtmJoinTopicOption?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
发送 Topic 消息	`streamChannel.publishTopicMessage(topic: String, message: String, option options: AgoraRtmTopicMessageOptions?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
离开 Topic	`streamChannel.leaveTopic(_ topic: String, completion completionBlock: AgoraRtmOperationBlock? = nil)`
订阅 Topic	`streamChannel.subscribeTopic(_ topic: String, option: AgoraRtmTopicOption?, completion completionBlock: AgoraRtmTopicSubscriptionBlock? = nil)`
取消订阅 Topic	`streamChannel.unsubscribeTopic(_ topic: String, option: AgoraRtmTopicOption?, completion completionBlock: AgoraRtmOperationBlock? = nil)`

Message

功能	API 接口
发送消息	`[rtm publish:message:option:completion]`

在线状态

功能	API 接口
查询频道在线用户	`rtm.getPresence()?.whoNow(channelName: String, channelType: AgoraRtmChannelType, options: AgoraRtmPresenceOptions?, completion completionBlock: AgoraRtmWhoNowBlock? = nil)`
查询用户所在频道	`rtm.getPresence()?.whereNow(userId: String, completion completionBlock: AgoraRtmWhereNowBlock? = nil)`
设置用户临时状态	`rtm.getPresence()?.setState(channelName: String, channelType: AgoraRtmChannelType, items: [String: String], completion completionBlock: AgoraRtmOperationBlock? = nil)`
查询用户临时状态	`rtm.getPresence()?.getState(channelName: String, channelType: AgoraRtmChannelType, userId: String, completion completionBlock: AgoraRtmPresenceGetStateBlock? = nil)`
删除用户临时状态	`rtm.getPresence()?.removeState(channelName: String, channelType: AgoraRtmChannelType, keys: [String], completion completionBlock: AgoraRtmOperationBlock? = nil)`

存储

功能	API 接口
设置频道属性	`rtm.getStorage()?.setChannelMetadata(channelName: String, channelType: AgoraRtmChannelType, data: AgoraRtmMetadata, options: AgoraRtmMetadataOptions?, lock: String?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
获取频道属性	`rtm.getStorage()?.getChannelMetadata(channelName: String, channelType: AgoraRtmChannelType, completion completionBlock: AgoraRtmGetMetadataBlock? = nil)`
删除频道属性	`rtm.getStorage()?.removeChannelMetadata(channelName: String, channelType: AgoraRtmChannelType, data: AgoraRtmMetadata, options: AgoraRtmMetadataOptions?, lock: String?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
更新频道属性	`rtm.getStorage()?.updateChannelMetadata(channelName: String, channelType: AgoraRtmChannelType, data: AgoraRtmMetadata, options: AgoraRtmMetadataOptions?, lock: String?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
设置用户属性	`rtm.getStorage()?.setUserMetadata(userId: String, data: AgoraRtmMetadata, options: AgoraRtmMetadataOptions?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
获取用户属性	`rtm.getStorage()?.getUserMetadata(userId: String, completion completionBlock: AgoraRtmGetMetadataBlock? = nil)`
删除用户属性	`rtm.getStorage()?.removeUserMetadata(userId: String, data: AgoraRtmMetadata, options: AgoraRtmMetadataOptions?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
更新用户属性	`rtm.getStorage()?.updateChannelMetadata(channelName: String, channelType: AgoraRtmChannelType, data: AgoraRtmMetadata, options: AgoraRtmMetadataOptions?, lock: String?, completion completionBlock: AgoraRtmOperationBlock? = nil)`
订阅用户属性	`rtm.getStorage()?.subscribeUserMetadata(userId: String, completion completionBlock: AgoraRtmOperationBlock? = nil)`
取消订阅用户属性	`rtm.getStorage()?.unsubscribeUserMetadata(userId: String, completion completionBlock: AgoraRtmOperationBlock? = nil)`

锁

功能	API 接口
设置锁	`rtm.getLock()?.setLock(channelName: String, channelType: AgoraRtmChannelType, lockName: String, ttl: Int32, completion completionBlock: AgoraRtmOperationBlock? = nil)`
获取锁	`rtm.getLock()?.acquireLock(channelName: String, channelType: AgoraRtmChannelType, lockName: String, retry: Bool, completion completionBlock: AgoraRtmOperationBlock? = nil)`
释放锁	`rtm.getLock()?.releaseLock(channelName: String, channelType: AgoraRtmChannelType, lockName: String, completion completionBlock: AgoraRtmOperationBlock? = nil)`
收回锁	`rtm.getLock()?.revokeLock(channelName: String, channelType: AgoraRtmChannelType, lockName: String, userId: String, completion completionBlock: AgoraRtmOperationBlock? = nil)`
查询锁	`rtm.getLock()?.getLocks(channelName: String, channelType: AgoraRtmChannelType, completion completionBlock: AgoraRtmGetLocksBlock? = nil)`
删除锁	`rtm.getLock()?.removeLock(channelName: String, channelType: AgoraRtmChannelType, lockName: String, completion completionBlock: AgoraRtmOperationBlock? = nil)`

本文介绍 RTM 微信小程序 SDK 支持的功能特性和当前不支持的 API 能力。

注意

微信小程序 SDK 与 Web SDK API 范围不同。当前 API 链接指向 RTM JavaScript API 参考，使用具体 API 前，请以已安装的 shengwang-rtm-miniapp 包中的类型定义为准。

支持能力

功能	说明	API 参考
创建实例	使用 App ID 和用户 ID 创建 RTM 客户端实例。	`new RTM()`
登录服务	使用 RTM Token 登录服务。	`login`
登出服务	断开当前用户与 RTM 服务的连接。	`logout`
事件监听	监听消息、Presence 和连接状态等事件。	`addEventListener`
Message Channel 订阅	订阅或取消订阅 Message Channel。	`subscribe`、`unsubscribe`
发布消息	向 Message Channel 或 User Channel 发布字符串或二进制消息。对象类型消息需要先序列化。	`publish`
Presence	查询在线用户、查询用户所在频道、设置和查询临时用户状态。	Presence
Storage	管理频道属性和用户属性。	Storage
Lock	管理分布式锁。	Lock
Token 鉴权	使用 RTM Token 鉴权，并在 Token 过期前更新 Token。	Token
日志上传	通过 `logUpload` 上传 SDK 日志，辅助问题排查。	`RTMConfig`

当前不支持能力

微信小程序 SDK 当前不支持以下 API 和能力：

RTM.createStreamChannel
RTMStreamChannel 相关 API，包括加入、离开 Stream Channel，以及 Stream Channel 上的消息发送能力
Topic 相关 API，包括加入 Topic、发送 Topic 消息、订阅 Topic、取消订阅 Topic 和离开 Topic
RTMConfig.cloudProxy
RTMConfig.privateConfig
私有化部署
私有化配置

请勿将依赖上述能力的 Web SDK 代码直接复制到微信小程序项目中。

服务开通与计费

微信小程序 SDK 复用 RTM 现有服务开通和计费规则。详见开通服务和计费策略。

支持能力Copy Anchor Link

当前不支持能力Copy Anchor Link

服务开通与计费Copy Anchor Link

咨询电话

咨询电话

支持能力

当前不支持能力

服务开通与计费