特性列表

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

Presence

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

Storage

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

Lock

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