AgoraRtmChannel Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | AgoraRtmKit.h |
channelDelegate
AgoraRtmChannelDelegate 接口类向 App 发送回调通知，上报运行时的频道相关事件。
@property (nonatomic, weak, nullable) id<AgoraRtmChannelDelegate> channelDelegateDeclared In
AgoraRtmKit.h
– joinWithCompletion:
加入频道。
- (void)joinWithCompletion:(AgoraRtmJoinChannelBlock _Nullable)completionBlockParameters
completionBlock |
AgoraRtmJoinChannelBlock 回调返回本方法的调用结果。错误码详见 AgoraRtmJoinChannelErrorCode。 |
|---|
Discussion
- AgoraRtmJoinChannelBlock 回调返回本方法的调用结果。
- 加入频道成功后，频道内的所有远端用户收到 memberJoined 回调。
NOTE
同一用户只能同时加入最多 20 个频道。加入频道超限时用户会收到错误码 AgoraRtmJoinChannelErrorExceedLimit。
Declared In
AgoraRtmKit.h
– leaveWithCompletion:
离开频道。
- (void)leaveWithCompletion:(AgoraRtmLeaveChannelBlock _Nullable)completionBlockParameters
completionBlock |
AgoraRtmLeaveChannelBlock 回调返回本方法的调用结果。错误码详见 AgoraRtmLeaveChannelErrorCode。 |
|---|
Discussion
- AgoraRtmLeaveChannelBlock 回调返回本方法的调用结果。
- 成功离开频道后，频道内的所有远端用户收到 memberLeft 回调。
Declared In
AgoraRtmKit.h
– sendMessage:completion:
DEPRECATED 发送频道消息。
- (void)sendMessage:(AgoraRtmMessage *_Nonnull)message completion:(AgoraRtmSendChannelMessageBlock _Nullable)completionBlockParameters
message |
发送的消息内容。详见 AgoraRtmMessage。 |
|---|---|
completionBlock |
AgoraRtmSendChannelMessageBlock 回调返回方法的调用结果。错误码详见 AgoraRtmSendChannelMessageErrorCode。 |
Discussion
该方法已废弃，请改用 sendMessage 方法发送频道消息。
- AgoraRtmSendChannelMessageBlock 回调回本方法的调用结果。
- 消息发送成功后，频道内的所有远端用户收到 messageReceived 回调。
NOTE
消息（包括频道消息和点对点消息）的最高发送频率为每 3 秒 180 次。
Declared In
AgoraRtmKit.h
– sendMessage:sendMessageOptions:completion:
发送频道消息。
- (void)sendMessage:(AgoraRtmMessage *_Nonnull)message sendMessageOptions:(AgoraRtmSendMessageOptions *_Nonnull)options completion:(AgoraRtmSendChannelMessageBlock _Nullable)completionBlockParameters
message |
发送的消息内容。详见 AgoraRtmMessage。 |
|---|---|
options |
消息发送选项。详见 AgoraRtmSendMessageOptions。 |
completionBlock |
AgoraRtmSendChannelMessageBlock 回调返回方法的调用结果。错误码详见 AgoraRtmSendChannelMessageErrorCode。 |
Discussion
- AgoraRtmSendChannelMessageBlock 回调回本方法的调用结果。
- 消息发送成功后，频道内的所有远端用户收到 messageReceived 回调。
NOTE
消息（包括频道消息和点对点消息）的最高发送频率为每 3 秒 180 次。
Declared In
AgoraRtmKit.h
– getMembersWithCompletion:
获取频道成员列表。
- (void)getMembersWithCompletion:(AgoraRtmGetMembersBlock _Nullable)completionBlockParameters
completionBlock |
AgoraRtmGetMembersBlock 回调返回本方法的调用结果（频道成员列表）。错误码详见 AgoraRtmGetMembersErrorCode。 |
|---|
Discussion
NOTE
该方法的调用频率上限为每 2 秒 5 次。该方法最多获取 512 个频道成员。如果频道成员数量超过 512，该方法会随即返回其中的 512 个成员。
Declared In
AgoraRtmKit.h
– serverBanned:
用户被服务端禁止加入这个频道
- (void)serverBanned:(AgoraRtmChannel *_Nonnull)channelDeclared In
AgoraRtmKit.h
