特性列表

  • Swift

更新时间

查看实时消息 RTM 的特性列表,了解关键概念、参数说明、使用限制和接入注意事项。

本文提供 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.login(_ token: String?, completion completionBlock: AgoraRtmOperationBlock? = nil)
登出服务rtm.logout(_ completionBlock: AgoraRtmOperationBlock? = nil)
表格内容超出当前宽度,可横向滚动查看更多列。

Channel

Topic

Message

功能API 接口
发送消息[rtm publish:message:option:completion]
表格内容超出当前宽度,可横向滚动查看更多列。

在线状态

存储

功能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)
表格内容超出当前宽度,可横向滚动查看更多列。

锁