AgoraRtmChannelDelegate Protocol Reference

Conforms to NSObject
Declared in AgoraRtmKit.h

Overview

AgoraRtmChannelDelegate 接口类向 App 发送回调通知，上报运行时的频道相关事件。

– channel:memberJoined:

远端用户加入频道回调。

- (void)channel:(AgoraRtmChannel *_Nonnull)channel memberJoined:(AgoraRtmMember *_Nonnull)member

Parameters

channel

所在频道。详见 AgoraRtmChannel。
member

加入频道的远端用户。详见 AgoraRtmMember。

Discussion

当有远端用户调用 joinWithCompletion 方法成功加入频道时，在相同频道的本地用户会收到此回调。

NOTE

频道人数超过 512 人时后台会关闭上下线通知。

Declared In

AgoraRtmKit.h

– channel:memberLeft:

频道成员离开频道回调。

- (void)channel:(AgoraRtmChannel *_Nonnull)channel memberLeft:(AgoraRtmMember *_Nonnull)member

Parameters

channel

所在频道。详见 AgoraRtmChannel。
member

离开频道的频道成员。详见 AgoraRtmMember。

Discussion

当有频道成员调用 leaveWithCompletion 方法成功离开频道时，在相同频道的本地用户会收到此回调。

NOTE

频道人数超过 512 人时后台会关闭上下线通知。

Declared In

AgoraRtmKit.h

– channel:messageReceived:fromMember:

收到频道消息回调。

- (void)channel:(AgoraRtmChannel *_Nonnull)channel messageReceived:(AgoraRtmMessage *_Nonnull)message fromMember:(AgoraRtmMember *_Nonnull)member

Parameters

channel

所在频道。详见 AgoraRtmChannel。
message

消息内容。详见 AgoraRtmMessage。
member

频道消息发送者。详见 AgoraRtmMember。

Discussion

当远端用户调用 sendMessage 方法成功发送频道消息后，在相同频道的本地用户会收到此回调。

Declared In

AgoraRtmKit.h

– channel:fileMessageReceived:fromMember:

DEPRECATED 该回调自 1.5.0 版本开始正式下线，Agora 建议你不要使用。

- (void)channel:(AgoraRtmChannel *_Nonnull)channel fileMessageReceived:(AgoraRtmFileMessage *_Nonnull)message fromMember:(AgoraRtmMember *_Nonnull)member

Parameters

channel

用户所属频道。详见 AgoraRtmChannel。
message

接收到的频道文件消息内容。详见 AgoraRtmFileMessage。
member

消息发送者。详见 AgoraRtmMember。

Discussion

收到频道文件消息回调。

Declared In

AgoraRtmKit.h

– channel:imageMessageReceived:fromMember:

DEPRECATED 该回调自 1.5.0 版本开始正式下线，Agora 建议你不要使用。

- (void)channel:(AgoraRtmChannel *_Nonnull)channel imageMessageReceived:(AgoraRtmImageMessage *_Nonnull)message fromMember:(AgoraRtmMember *_Nonnull)member

Parameters

channel

用户所属频道。详见 AgoraRtmChannel。
message

接收到的频道图片消息内容。详见 AgoraRtmImageMessage。
member

消息发送者。详见 AgoraRtmMember。

Discussion

收到频道图片消息回调。

Declared In

AgoraRtmKit.h

– channel:attributeUpdate:

频道属性更新回调。返回所在频道的所有属性。

- (void)channel:(AgoraRtmChannel *_Nonnull)channel attributeUpdate:(NSArray<AgoraRtmChannelAttribute*> *_Nonnull)attributes

Parameters

channel

所在频道。详见 AgoraRtmChannel。
attributes

频道属性列表。详见 AgoraRtmChannelAttribute。

Discussion

NOTE

只有当频道属性更新者将 enableNotificationToChannelMembers 设为 YES 后，该回调才会被触发。请注意：该标志位为一次性标志位，仅对当前频道属性操作有效。

Declared In

AgoraRtmKit.h

– channel:memberCount:

频道成员人数更新回调。返回最新频道成员人数。

- (void)channel:(AgoraRtmChannel *_Nonnull)channel memberCount:(int)count

Parameters

channel

所在频道。详见 AgoraRtmChannel。
count

最新频道成员人数。

Discussion

NOTE SDK 会在频道成员人数更新时返回该回调：

  • 频道成员人数 ≤ 512 时，回调触发频率为每秒 1 次。
  • 频道成员人数超过 512 时，回调触发频率为每 3 秒 1 次。
  • 用户在成功加入频道时会收到该回调。你可以通过监听该回调获取加入频道时的频道成员人数和后继人数更新。

Declared In

AgoraRtmKit.h