特性列表

本文提供 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(...)

Presence

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

Storage

功能	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(...)

Lock

功能	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(...)