特性列表

本文提供 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>;

Presence

功能	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>;

Storage

功能	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>;

Lock

功能	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>;