特性列表

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

Presence

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

Storage

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

Lock

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