Agora C# API Reference for Unity

Agora Real-time Messaging (RTM) SDK 提供了稳定可靠、低延时、高并发的全球消息云服务，帮助你快速构建实时场景。

‍如无特别说明，本页列出的大多数 RTM 核心业务方法都应在调用 login 方法成功收到 OnLoginSuccessHandler 回调后调用。

Agora RTM SDK 提供以下功能：

• 登录登出
• 点对点消息
• 查询单个或多个用户的在线状态
• 订阅或退订单个或多个指定用户的在线状态
• 用户属性增删改查
• 频道属性增删改查
• 查询单个或多个频道的成员人数
• 加入离开频道相关
• 频道消息
• 获取频道成员列表
• 呼叫邀请管理
• 更新当前的 RTM Token
• 日志设置与版本查询
• 定制方法

登录登出相关

‍SDK 与 RTM 服务器的连接状态是 RTM 开发过程需要理解的核心概念，详见连接状态管理.

方法	描述
RtmClient	创建并返回一个 RtmClient 实例。
Login	登录 Agora RTM 系统。
Logout	登出 Agora RTM 系统。
Dispose	释放当前 RtmClient 实例使用的所有资源。

事件	描述
OnLoginSuccessHandler	登录 Agora RTM 系统成功回调。
OnLoginFailureHandler	登录 Agora RTM 系统失败回调。
OnLogoutHandler	登出 Agora RTM 系统回调。
OnConnectionStateChangedHandler	SDK 与 Agora RTM 系统连接状态发生改变回调。

点对点消息

方法	描述
CreateMessage	创建并返回一个空文本 TextMessage 消息实例。
CreateMessage	创建并返回一个文本 TextMessage 消息实例。
CreateMessage	创建并返回一个自定义二进制 TextMessage 消息实例。
CreateMessage	创建并返回一个包含文字描述的自定义二进制 TextMessage 消息实例。
SendMessageToPeer	向指定用户发送点对点消息或点对点的离线消息。当带有前缀时，该方法类似于 Agora 信令 SDK 中的 endCall 方法.
Dispose	释放当前 TextMessage 实例使用的所有资源。

事件	描述
OnSendMessageResultHandler	报告 SendMessageToPeer(string peerId, IMessage message, SendMessageOptions options) 或 SendMessageToPeer(string peerId, IMessage message) 方法的调用结果。
OnMessageReceivedFromPeerHandler	收到来自对端的点对点消息回调。

查询单个或多个用户的在线状态

方法	描述
QueryPeersOnlineStatus	查询单个或多个指定用户的在线状态。

事件	描述
OnQueryPeersOnlineStatusResultHandler	报告 QueryPeersOnlineStatus 方法的调用结果。

订阅或取消订阅单个或多个指定用户的在线状态

方法	描述
SubscribePeersOnlineStatus	订阅指定单个或多个用户的在线状态。
UnsubscribePeersOnlineStatus	取消订阅指定单个或多个用户的在线状态。
QueryPeersBySubscriptionOption	获取某特定内容被订阅的用户列表。

事件	描述
OnSubscriptionRequestResultHandler	报告 SubscribePeersOnlineStatus 或 UnsubscribePeersOnlineStatus 方法的调用结果。
OnPeersOnlineStatusChangedHandler	被订阅用户在线状态改变回调。查看指定用户的在线状态，详见 PeerOnlineStatus。
OnQueryPeersBySubscriptionOptionResultHandler	报告 QueryPeersBySubscriptionOption 方法的调用结果。

用户属性增删改查

事件	描述
DeleteLocalUserAttributesByKeys	删除本地用户的指定属性。
ClearLocalUserAttributes	清空本地用户的属性。
GetUserAttributes	查询指定用户的全部属性。
GetUserAttributesByKeys	查询指定用户指定属性名的属性。

事件	描述
OnDeleteLocalUserAttributesResultHandler	报告 DeleteLocalUserAttributesByKeys 方法的调用结果。
OnClearLocalUserAttributesResultHandler	报告 ClearLocalUserAttributes 方法的调用结果。
OnGetUserAttributesResultHandler	报告 GetUserAttributes 方法或 GetUserAttributesByKeys 方法的调用结果。

频道属性增删改查

方法	描述
CreateChannelAttribute	创建并返回一个 RtmChannelAttribute 实例。
SetChannelAttributes	全量设置某指定频道的属性。
DeleteChannelAttributesByKeys	删除某指定频道的指定属性。
ClearChannelAttributes	清空某指定频道的属性。
GetChannelAttributes	查询某指定频道的全部属性。
GetChannelAttributesByKeys	查询某指定频道指定属性名的属性。

事件	描述
OnSetChannelAttributesResultHandler	报告 SetChannelAttributes 方法的调用结果。
OnDeleteChannelAttributesResultHandler	报告 DeleteChannelAttributesByKeys 方法的调用结果。
OnClearChannelAttributesResultHandler	报告 ClearChannelAttributes 方法的调用结果。
OnGetChannelAttributesResultHandler	报告 GetChannelAttributes or GetChannelAttributesByKeys 方法的调用结果。

频道属性更新事件	描述
OnAttributesUpdatedHandler	当频道属性更新时返回当前频道的所有属性。

查询单个或多个频道的成员人数

方法	事件
GetChannelMemberCount	查询单个或多个频道的成员人数。用户无需加入指定频道即可调用该方法。

事件	描述
OnGetChannelMemberCountResultHandler	返回 GetChannelMemberCount 方法的调用结果。

加入离开频道相关

方法	描述
CreateChannel	创建一个 RtmChannel 对象。
Join	加入频道。
Leave	离开频道。
Dispose	释放当前 RtmChannel 频道实例的所有资源。

事件	描述
OnJoinSuccessHandler	成功加入频道回调。
OnJoinFailureHandler	加入频道失败回调。
OnLeaveHandler	报告 Leave 方法的调用结果。
OnMemberJoinedHandler	远端用户加入频道回调。
OnMemberLeftHandler	远端用户离开频道回调。
OnMemberCountUpdatedHandler	频道成员人数更新回调。返回最新频道成员人数。

频道消息

方法	描述
CreateMessage	创建并返回一个空文本 TextMessage 实例。
CreateMessage	创建并返回一个文本 IMessage 实例。
CreateMessage	创建并返回一个自定义二进制 IMessage 实例。
CreateMessage	创建并返回一个包含文字描述的自定义二进制 IMessage 消息实例。
sendMessage	供频道成员向所在频道发送频道消息。
Release	释放当前 IMessage 消息实例使用的所有资源。

事件	描述
OnSendMessageResultHandler	报告 SendMessage 方法的调用结果。
OnMessageReceivedHandler	收到频道消息回调。

获取频道成员列表

方法	描述
GetMembers	获取当前频道成员列表。

事件	描述
OnGetMembersHandler	获取频道成员列表回调。

呼叫邀请管理

呼叫管理器获取与释放方法	描述
GetRtmCallManager	获取呼叫邀请管理器。
Dispose	释放当前 RtmCallManager 实例的所有资源。

供主叫调用的方法	描述
CreateLocalCallInvitation	供主叫创建、管理一个 LocalInvitation 呼叫邀请对象。
SendLocalInvitation	供主叫向指定用户发送呼叫邀请。
CancelLocalInvitation	供主叫取消一个呼叫邀请。
Dispose	释放当前 LocalInvitation 本地呼叫邀请实例的所有资源。

供被叫调用的方法	描述
AcceptRemoteInvitation	供被叫接受一个呼叫邀请。
RefuseRemoteInvitation	供被叫拒绝一个呼叫邀请。
Dispose	释放当前 RemoteInvitation 呼叫邀请实例的所有资源。

Caller Event	Description
OnLocalInvitationReceivedByPeerHandler	报告给主叫的回调：被叫已收到呼叫邀请。
OnLocalInvitationCanceledHandler	报告给主叫的回调：呼叫邀请已被成功取消。
OnLocalInvitationAcceptedHandler	报告给主叫的回调：被叫已接受呼叫邀请。
OnLocalInvitationRefusedHandler	报告给主叫的回调：被叫已拒绝呼叫邀请。
OnLocalInvitationFailureHandler	报告给主叫的回调：呼叫邀请过程失败。

被叫接收的事件	描述
OnRemoteInvitationReceivedHandler	报告给被叫的回调：收到一条呼叫邀请。SDK 会同时返回一个 RemoteInvitation 对象供被叫管理。
OnRemoteInvitationAcceptedHandler	报告给被叫的回调：已接受呼叫邀请。
OnRemoteInvitationRefusedHandler	报告给被叫的回调：已拒绝呼叫邀请。
OnRemoteInvitationCanceledHandler	报告给被叫的回调：呼叫邀请已被主叫取消。
OnRemoteInvitationFailureHandler	报告给被叫的回调：呼叫邀请进程失败。

更新 Token

方法	描述
RenewToken	更新 SDK 的 RTM Token。

事件	描述
OnTokenExpiredHandler	（SDK 断线重连时触发）当前使用的 RTM Token 已超过 24 小时的签发有效期。
OnRenewTokenResultHandler	报告 RenewToken 方法的调用结果。

日志设置与版本查询

• 日志相关操作在调用 RtmClient 方法创建 RtmClient 实例后即可进行，无需等到调用 Login 方法成功。
• 版本查询操作为全局方法，可在创建 RtmClient 实例前进行。

方法	描述
SetLogFile	设定日志文件的默认地址。
SetLogFilter	设置日志输出等级。
SetLogFileSize	设置 SDK 输出的单个日志文件的大小，单位为 KB。 SDK 设有 2 个大小相同的日志文件。
GetSdkVersion	获取 Agora RTM SDK 的版本信息。

定制方法

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