Agora C# API Reference for Unity

创建并返回一个 RtmClient 实例。

注解

Agora RTM SDK 支持创建多个实例。

参数

appId	如果你的开发包里没有 App ID，请向声网申请一个新的 App ID。
eventHandler	一个 RtmClientEventHandler 对象。

获取 Agora RTM SDK 的版本信息。

返回

String 格式的 Agora RTM SDK 的版本信息。比如：1.0.0。

登录 Agora RTM 系统。

• 方法调用成功：本地用户收到回调 OnLoginSuccessHandler。
• 方法调用失败：本地用户收到回调 OnLoginFailureHandler。错误码详见 LOGIN_ERR_CODE。

  注解

  • 异地登录后之前的状态（目前主要是加入的频道）不会保留。
  • 如果你在不同实例中以相同用户 ID 登录，之前的登录将会失效，你会被踢出之前加入的频道。
  • 只有在调用本方法成功加入频道后（即：当收到 OnLoginSuccessHandler 回调时）才可以调用 RTM 的核心业务逻辑。以下方法除外：
    • CreateChannel
    • CreateMessage
    • SetText
    • GetRtmCallManager
    • CreateLocalCallInvitation
    • CreateChannelAttribute

参数

token	用于登录 Agora RTM 系统的动态密钥。开启动态鉴权后可用。集成及测试阶段请将 token 设置为 null。
userId	登录 Agora RTM 系统的用户 ID。该字符串不可超过 64 字节。不可设为空、null 或 "null"。以下为支持的字符集范围: 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", "," A userId cannot be empty, null or "null".

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。错误码详见 LOGIN_ERR_CODE。

登出 Agora RTM 系统。 本地用户收到回调 OnLogoutHandler。状态信息详见 LOGIN_ERR_CODE。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 LOGOUT_ERR_CODE 。

更新 SDK 的 RTM Token。

• 在收到 OnTokenExpiredHandler 回调时你需要调用此方法更新 Token。
• OnRenewTokenResultHandler 回调会返回 Token 更新的结果。
• 该方法的调用频率为 2 次每秒。

参数

token

新的 RTM Token。你需要自行生成 RTM Token。参考《生成 RTM Token》。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 RENEW_TOKEN_ERR_CODE 。

向指定用户（接收者）发送点对点消息或点对点的离线消息。

• OnSendMessageResultHandler 向发送者返回方法调用的结果。
• 消息到达接收方后，接收者收到回调 OnMessageReceivedFromPeerHandler。
• 该方法允许你向离线用户发送点对点消息。如果指定用户在你发送离线消息时不在线，消息服务器会保存该条消息。

  注解

  • 目前我们只为每个接收端保存 200 条离线消息最长七天。当保存的离线消息超出限制时，最老的信息将会被最新的消息替换。
  • 本方法可与老信令 SDK 的 endCall 方法兼容。你只需在用本方法发送文本消息时将消息头设为 GORA_RTM_ENDCALL_PREFIX_\<channelId\>_\<your additional information\> 格式即可。请以 endCall 对应频道的 ID 替换 \<channelId\>， \<your additional information\> 为附加文本信息。附加文本信息中不可使用下划线 "_" ，附加文本信息可以设为空字符串 ""。
  • 发送消息（包括点对点消息和频道消息）的调用频率上限为每 3 秒 180 次。

参数

peerId	接收者的用户 ID。该字符串不可超过 64 字节。不可设为空、null 或 "null"。以下为支持的字符集范围: 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
message	需要发送的消息。详见 IMessage 了解如何创建消息。
options	消息发送选项。详见 SendMessageOptions。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 PEER_MESSAGE_ERR_CODE 。

注解

• 我们不推荐使用该方法发送点对点消息。请改用它的重载方法 SendMessageToPeer 发送点对点消息或点对点的离线消息。
• OnSendMessageResultHandler 向发送者返回方法调用的结果。
• 消息到达接收方后，接收者收到回调 OnMessageReceivedFromPeerHandler。

发送消息（包括点对点消息和频道消息）的调用频率上限为每 3 秒 180 次。

参数

peerId	接收者的用户 ID。
message	需要发送的消息。详见 IMessage了解如何创建消息。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 PEER_MESSAGE_ERR_CODE 。

创建一个 Agora RTM 频道。

注解

一个 RtmClient 实例中可以创建多个频道。但是同一个用户只能同时加入最多 20 个频道。请在不使用某个频道时，调用 Dispose 方法销毁频道实例。

参数

channelId	Agora RTM 频道名称。该字符串长度在 64 字节以内，不能设为空、null，或 "null"。以下为支持的字符集范围: 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
rtmChannelEventHandler	See RtmChannelEventHandler.

返回

• 一个 RtmChannel 频道实例: 方法调用成功。如果具有相同 channelId 的频道不存在，此方法会返回已创建的频道实例。如果已经存在具有相同 channelId 的频道，此方法会返回已存在的频道实例。
• 方法调用失败。原因可能是 channelId 无效或频道数量超过限制。

创建并返回一个空文本 TextMessage 消息实例。

注解

• TextMessage 实例可用于频道和点对点消息消息。
• 请在不需要 TextMessage 时调用 Dispose 方法销毁其占用的资源。
• 你可以在创建文本消息实例之后调用 SetText 方法设置消息内容。不过请确保文本消息长度不超过 32 KB。

返回

一个空文本 TextMessage 消息实例。

创建并返回一个文本 "TextMessage" 消息实例。

注解

• TextMessage 实例可用于频道和点对点消息消息。
• 请在不需要 TextMessage 时调用 Dispose 方法销毁其占用的资源。

参数

text	文本消息内容。长度不得超过 32 KB。

返回

一个文本 TextMessage 消息实例。

创建并返回一个自定义二进制 TextMessage 消息实例。

注解

• TextMessage 实例可用于频道和点对点消息消息。
• 请在不需要 TextMessage 时调用 Dispose 方法销毁其占用的资源。
• 你可以在调用本方法后通过 SetText 方法设置自定义二进制消息的文字描述。但是请确保二进制消息和文字描述加起来的大小不超过 32 KB。

参数

rawData

二进制消息在内存中的首地址。

返回

一个自定义二进制 TextMessage 消息实例。

创建并返回一个包含文字描述的自定义二进制 TextMessage 消息实例。

• TextMessage 实例可用于频道和点对点消息消息。
• 请在不需要 TextMessage 时调用 Dispose 方法销毁其占用的资源。
• 你也可以先将 description 设为 "" ，消息创建成功后可以通过调用 SetText 方法设置自定义二进制消息的文字描述。但是请确保自定义二进制消息内容和文字描述加起来的大小不超过 32 KB。

参数

rawData	自定义二进制消息在内存中的首地址。
description	自定义二进制消息的简短文字描述。设置文字描述时，请确保自定义二进制消息内容和文字描述加起来的大小不超过 32 KB。

返回

一个二进制 TextMessage 消息实例。

创建一个 RtmChannelAttribute 实例。

返回

一个 RtmChannelAttribute 实例。

通过 JSON 配置 SDK 提供技术预览或特别定制功能。

注解

JSON 选项默认不公开。声网工程师正在努力寻求以标准化方式公开 JSON 选项。详情请联系 suppo.nosp@m.rt@a.nosp@m.gora..nosp@m.io。

参数

parameters

JSON 格式的 SDK 选项。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败

查询指定用户的在线状态。

• 在线：用户已登录到 Agora RTM 系统。
• 不在线：用户已登出 Agora RTM 系统或因其他原因与 Agora RTM 系统断开连接。

  注解

  调用频率上限为每 5 秒 10 次. SDK 将通过 OnQueryPeersOnlineStatusResultHandler 回调返回方法调用结果。

参数

peerIds	用户 ID 列表。支持 ID 数量上限为 256 。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 QUERY_PEERS_ONLINE_STATUS_ERR。

订阅指定单个或多个用户的在线状态。 SDK 将通过 OnSubscriptionRequestResultHandler 回调返回方法调用结果。

• 首次订阅成功后，SDK 会通过 OnPeersOnlineStatusChangedHandler 回调返回被订阅用户在线状态。
• 每当被订阅用户在线状态发生变化时，SDK 都会通过 OnPeersOnlineStatusChangedHandler 回调通知订阅方。
• 如果 SDK 在断线重连过程中有被订阅用户的在线状态发生改变，SDK 会在重连成功时通过 OnPeersOnlineStatusChangedHandler 回调通知订阅方。

  注解

  • 用户登出 Agora RTM 系统后，所有之前的订阅内容都会被清空；重新登录后，如需保留之前订阅内容则需重新订阅。
  • SDK 会在网络连接中断时进入断线重连状态。重连成功时 SDK 会自动重新订阅之前订阅用户，无需人为干预。

参数

peerIds	用户 ID 列表。最多不超过 512 个用户 ID。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 PEER_SUBSCRIPTION_STATUS_ERR 。

退订指定单个或多个用户的在线状态。 SDK 将通过 OnSubscriptionRequestResultHandler 回调返回方法调用结果。

参数

peerIds	用户 ID 列表。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 PEER_SUBSCRIPTION_STATUS_ERR 。

获取某特定内容被订阅的用户列表。 SDK 将通过 OnQueryPeersBySubscriptionOptionResultHandler 回调返回方法调用结果。

参数

option	被订阅的类型。详见 PEER_SUBSCRIPTION_OPTION。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR 。

设置 SDK 输出的单个日志文件的大小，单位为 KB。 SDK 设有 2 个大小相同的日志文件。

参数

fileSizeInKBytes

SDK 输出的单个日志文件的大小，单位为 KB。默认值为 10240 (KB)。取值范围为 [512 KB, 1 GB]。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

设置日志输出等级。 设置 SDK 的输出日志输出等级。不同的输出等级可以单独或组合使用。日志级别顺序依次为 OFF、CRITICAL、ERROR、WARNING 和 INFO。选择一个级别，你就可以看到在该级别之前所有级别的日志信息。例如，你选择 WARNING 级别，就可以看到在 CRITICAL、ERROR 和 WARNING 级别上的所有日志信息。

参数

fileter

日志输出等级。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

设定日志文件的默认地址。

注解

• 请确保指定的路径可写。
• 如需调用本方法，请在调用 RtmClient 方法创建 RtmClient 实例后立即调用，否则会造成输出日志不完整。

参数

logFilePath

日志文件的绝对路径。编码格式为 UTF-8。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

查询单个或多个频道的成员人数。 SDK 将通过 OnGetChannelMemberCountResultHandler 回调返回方法调用结果。

注解

• 该方法的调用频率上限为每秒 1 次。
• 不支持一次查询超过 32 个频道的成员人数。

参数

channelIds	指定频道名数组。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 GET_CHANNEL_MEMBER_COUNT_ERR_CODE 。

查询某指定频道指定属性名的属性。 SDK 将通过 OnGetChannelAttributesResultHandler 回调返回方法调用结果。

注解

• 你无需加入指定频道即可查询该频道的频道属性。
• GetChannelAttributes 和 GetChannelAttributesByKeys 一并计算在内：调用频率上限为每 5 秒 10 次。

参数

channelId	该指定频道的频道 ID。
attributeKeys	频道属性名数组。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

查询某指定频道的全部属性。 SDK 将通过 OnGetChannelAttributesResultHandler 回调返回方法调用结果。

参数

channelId	该指定频道的频道 ID。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

清空某指定频道的属性。 SDK 将通过 OnClearChannelAttributesResultHandler 回调返回方法调用结果。

注解

• 你无需加入指定频道即可删除该频道属性。
• DeleteChannelAttributesByKeys 和 ClearChannelAttributes 一并计算在内：调用频率上限为每 5 秒 10 次。

参数

channelId	该指定频道的频道 ID。
enableNotificationToChannelMembers	指示是否将通道属性更改通知所有通道成员。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

删除某指定频道的指定属性。 SDK 将通过 OnDeleteChannelAttributesResultHandler 回调返回方法调用结果。

注解

• 你无需加入指定频道即可删除该频道属性。
• 当某频道处于空频道状态（无人状态）数分钟后，该频道的频道属性将被清空。
• 如果存在多个用户有权限修改频道属性，那么我们建议在修改频道属性前先通过调用 GetChannelAttributes 方法更新本地频道属性缓存。
• SetChannelAttributes 、 DeleteChannelAttributesByKeys 和 ClearChannelAttributes 一并计算在内：调用频率上限为每 5 秒 10 次。

参数

channelId	该指定频道的频道 ID。
attributeKeys	频道属性名数组。
enableNotificationToChannelMembers	指示是否将通道属性更改通知所有通道成员。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

查询指定用户指定属性名的属性。 SDK 将通过 OnGetUserAttributesResultHandler 回调返回方法调用结果。

注解

GetUserAttributes 和 GetUserAttributesByKeys 一并计算在内：调用频率上限为每 5 秒 40 次。

参数

userId	指定用户的用户 ID。
attributeKeys	属性名数组。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

查询指定用户的全部属性。 SDK 将通过 OnGetUserAttributesResultHandler 回调返回方法调用结果。

注解

GetUserAttributes 和 GetUserAttributesByKeys 一并计算在内：调用频率上限为每 5 秒 40 次。

参数

userId	指定用户的用户 ID。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

清空本地用户的属性。 SDK 将通过 OnClearLocalUserAttributesResultHandler 回调返回方法调用结果。

注解

DeleteLocalUserAttributesByKeys 和 ClearLocalUserAttributes 一并计算在内：调用频率上限为每 5 秒 40 次。

参数

requestId

标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

删除本地用户的指定属性。 SDK 将通过 OnDeleteLocalUserAttributesResultHandler 回调返回方法调用结果。

注解

DeleteLocalUserAttributesByKeys 和 ClearLocalUserAttributes 一并计算在内：调用频率上限为每 5 秒 10 次。

参数

attributeKeys	属性名数组。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

全量设置某指定频道的属性。 SDK 将通过 OnSetChannelAttributesResultHandler 回调返回方法调用结果。

注解

• 你无需加入指定频道即可为该频道设置频道属性。
• 当某频道处于空频道状态（无人状态）数分钟后，该频道的频道属性将被清空。
• 如果存在多个用户有权限修改频道属性，那么我们建议在修改频道属性前先通过调用 GetChannelAttributes 方法更新本地频道属性缓存。
• SetChannelAttributes， DeleteLocalUserAttributesByKeys 和 ClearLocalUserAttributes 一并计算在内：调用频率上限为每 5 秒 10 次。

参数

channelId	该指定频道的频道 ID。
attributes	频道属性数组。详见 RtmChannelAttribute。
options	频道属性操作选项。详见 ChannelAttributeOptions。
requestId	标识本次请求的的唯一 ID。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。详见 ATTRIBUTE_OPERATION_ERR 。

获取 RtmCallManager 对象。 每个 RtmClient 实例都有各自唯一的 RtmCallManager 实例。属于不同 RtmClient 实例的 RtmCallManager 实例各不相同。

注解

如果不再使用 RtmCallManager ，请调用 Dispose 方法释放其占用资源。

参数

eventHandler

一个 RtmCallEventHandler 对象。

返回

一个 RtmCallManager 对象。