频道

频道是 RTM 实时网络中一种数据传输的管理机制，任何订阅或加入频道的用户都可以在 100 毫秒内接收到频道中传输的消息和事件，RTM 允许客户端订阅数百甚至数千个频道。大多数 RTM API 都将以频道为基础进行发送、接收、加密等行为。

基于声网的能力，RTM 的频道分成两种类型以匹配不同的应用场景：

• Message Channel：遵循行业标准的 Pub/Sub （发布/订阅）模式，频道无需提前创建，订阅频道即可在频道内收发消息。频道内的发布者和订阅者数量没有上限。
• Stream Channel：遵循行业类似观察者模式的 Room （房间）概念，用户需要创建并加入频道才能在频道内收发消息。频道中允许创建不同的 Topic，消息通过 Topic 进行组织和管理。

想要了解 Message 和 Stream 频道的更多用法及适用场景，可以查看：

• 频道

SubscribeAsyncCopy Anchor Link

接口描述Copy Anchor Link

RTM 提供消息、状态等事件通知能力。通过设置事件监听，你可以接收已订阅频道中的消息和事件。关于如何添加和设置事件监听，详见事件监听章节。

通过调用 SubscribeAsync 方法，客户端可以订阅 Message Channel 并开始接收频道中的消息和事件通知。成功调用该方法后，订阅该频道且开启 Presence 事件监听的用户会收到 REMOTE_JOIN 类型的 OnPresenceEvent 事件，详见事件监听。

接口方法Copy Anchor Link

你可以通过以下方式调用 SubscribeAsync 方法：

RtmResult<SubscribeResult> SubscribeAsync(string channelName, SubscribeOptions options);

SubscribeOptions 包含以下属性：

基本用法Copy Anchor Link

var options = new SubscribeOptions();
options.withMessage = true;
options.withPresence = true;
var (status,response) = await rtmClient.SubscribeAsync("Chat_room", options);
if (status.Error)
{
    Debug.Log(string.Format("{0} is failed, ErrorCode:{1}, due to: {2}", status.Operation, status.ErrorCode, status.Reason));
}
else
{
    Debug.Log(string.Format("Subscribe channel success! at Channel:{0}", response.ChannelName));
}

返回值Copy Anchor Link

SubscribeAsync 操作返回一个 RtmResult<SubscribeResult> 类型数据结构的返回值，其中包含：

RtmStatus 包含以下属性：

你可以通过检索 errorCode 字段的错误码了解错误原因，并找到对应的解决方法。

SubscribeResult 包含以下属性：

UnsubscribeAsyncCopy Anchor Link

接口描述Copy Anchor Link

如果你不再需要关注某个频道，可调用 UnsubscribeAsync 方法取消订阅该频道。成功取消订阅该频道后，其他订阅该频道并开启事件监听的用户会收到 REMOTE_LEAVE 类型的 OnPresenceEvent 事件通知，详见事件监听。

接口方法Copy Anchor Link

你可以通过以下方式调用 UnsubscribeAsync 方法：

RtmResult<UnsubscribeResult> UnsubscribeAsync(string channelName);

基本用法Copy Anchor Link

var (status,response) = await rtmClient.UnsubscribeAsync(channelName);
if (status.Error)
{
    Debug.Log(string.Format("{0} is failed, ErrorCode: {1}, due to: {2}", status.Operation, status.ErrorCode, status.Reason));
}

返回值Copy Anchor Link

UnsubscribeAsync 操作返回一个 RtmResult<UnsubscribeResult> 类型数据结构的返回值，其中包含：

RtmStatus 包含以下属性：

你可以通过检索 errorCode 字段的错误码了解错误原因，并找到对应的解决方法。

CreateStreamChannelCopy Anchor Link

接口描述Copy Anchor Link

在使用 Stream Channel 之前，你需要先调用 CreateStreamChannel 方法创建 IStreamChannel 实例。成功创建实例后，你可以调用其相关方法，例如：加入频道、离开频道、发送 Topic 消息、订阅 Topic 消息等。

接口方法Copy Anchor Link

你可以通过以下方式调用 CreateStreamChannel 方法：

IStreamChannel CreateStreamChannel(string channelName);

基本用法Copy Anchor Link

try
{
    IStreamChannel streamChannel = rtmClient.CreateStreamChannel("Chat_room");
}
catch(RTMException e)
{
    Debug.Log(string.Format("{0} is failed, ErrorCode : {1}, due to: {2}", e.Status.Operation, e.Status.ErrorCode, e.Status.Reason));
}

返回值Copy Anchor Link

一个 IStreamChannel 实例。

JoinAsyncCopy Anchor Link

接口描述Copy Anchor Link

成功创建 Stream Channel 后，你可以调用 JoinAsync 方法加入 Stream Channel。

加入频道后，你才能进行频道相关操作。此时，订阅该频道并添加事件监听的用户会收到如下事件通知：

• 本地用户：
  • SNAPSHOT 类型的 OnPresenceEvent 事件通知。
  • SNAPSHOT 类型的 OnTopicEvent 事件通知。
• 远端用户：REMOTE_JOIN 类型的 OnPresenceEvent 事件通知。

接口方法Copy Anchor Link

你可以通过以下方式调用 JoinAsync 方法：

RtmResult<JoinResult> JoinAsync(JoinChannelOptions options);

JoinChannelOptions 中包含以下属性：

基本用法Copy Anchor Link

var (status,response) = await streamChannel.JoinAsync(options);
if (status.Error)
{
    Debug.Log(string.Format("{0} is failed, ErrrorCode: {1}, due to: {2}", status.Operation, status.ErrorCode, status.Reason));
}
else
{
    Debug.Log(string.Format("User:{0} Join stream channel success! at Channel:{1}", response.UserId, response.ChannelName));
}

返回值Copy Anchor Link

JoinAsync 操作返回一个 RtmResult<JoinResult> 类型数据结构的返回值，其中包含：

RtmStatus 包含以下属性：

你可以通过检索 errorCode 字段的错误码了解错误原因，并找到对应的解决方法。

JoinResult 包含以下属性：

LeaveAsyncCopy Anchor Link

接口描述Copy Anchor Link

如果你不再需要待在某个频道中，你可以调用 LeaveAsync 方法离开该频道。离开后你将不再会接收到此频道中的任何消息、状态及事件通知，你在该频道中创建的 Topic 发布者的角色及你与所有 Topic 的订阅关系都将自动解除。如果想再次恢复之前的发布者角色和订阅关系，你需要调用 JoinAsync 方法再次进入该频道并自行调用 JoinTopicAsync 和 SubscribeTopicAsync 方法进行设置。

成功离开频道后，频道中的远端用户会收到 REMOTE_LEAVE 类型的 OnPresenceEvent 事件通知，详见事件监听。

接口方法Copy Anchor Link

你可以通过以下方式调用 LeaveAsync 方法：

RtmResult<LeaveResult> LeaveAsync();

基本用法Copy Anchor Link

var (status,response) = await streamChannel.LeaveAsync();
if (status.Error)
{
    Debug.Log(string.Format("{0} is failed, ErrorCode:{1}, due to: {2}", status.Operation, status.ErrorCode, status.Reason));
}
else
{
    Debug.Log(string.Format("User:{0} Join stream channel success! at Channel:{1}", response.UserId, response.ChannelName));
}

返回值Copy Anchor Link

LeaveAsync 操作返回一个 RtmResult<LeaveResult> 类型数据结构的返回值，其中包含：

RtmStatus 包含以下属性：

你可以通过检索 errorCode 字段的错误码了解错误原因，并找到对应的解决方法。

LeaveResult 包含以下属性：

DisposeCopy Anchor Link

接口描述Copy Anchor Link

如果你不再需要某个频道，你可以调用 Dispose 方法销毁对应的 Stream Channel 实例以释放资源。调用 Dispose 方法销毁 Stream Channel 实例不会销毁该频道，后续可通过再次调用 CreateStreamChannel 和 JoinAsync 重新加入该频道。

接口方法Copy Anchor Link

你可以通过以下方式调用 Dispose 方法：

RtmStatus Dispose();

基本用法Copy Anchor Link

var status = streamChannel.Dispose();
if (status.Error)
{
    Debug.Log(string.Format("{0} is failed, ErrorCode:{1}, due to: {2}", status.Operation, status.ErrorCode, status.Reason));
}
else
{
    Debug.Log("Dispose Channel Success!");
}

返回值Copy Anchor Link

本次操作将返回一个 RtmStatus 数据结构的返回值。

RtmStatus 包含以下属性：

你可以通过检索 errorCode 字段的错误码了解错误原因，并找到对应的解决方法。