文档中心
云信令(原实时消息)
API 参考
Agora RTM C++ API Reference for Linux & Windows
Agora RTM C++ API Reference for Linux & Windows
◆ ~IChannelEventHandler()
virtual agora::rtm::IChannelEventHandler::~IChannelEventHandler |
( |
| ) |
|
|
inlinevirtual |
◆ onJoinSuccess()
virtual void agora::rtm::IChannelEventHandler::onJoinSuccess |
( |
| ) |
|
|
inlinevirtual |
加入频道成功回调。
本地用户调用 join 方法成功加入频道后:
◆ onJoinFailure()
virtual void agora::rtm::IChannelEventHandler::onJoinFailure |
( |
JOIN_CHANNEL_ERR |
errorCode | ) |
|
|
inlinevirtual |
◆ onLeave()
virtual void agora::rtm::IChannelEventHandler::onLeave |
( |
LEAVE_CHANNEL_ERR |
errorCode | ) |
|
|
inlinevirtual |
◆ onMessageReceived()
virtual void agora::rtm::IChannelEventHandler::onMessageReceived |
( |
const char * |
userId, |
|
|
const IMessage * |
message |
|
) |
| |
|
inlinevirtual |
收到频道消息回调。
当远端用户调用 sendMessage 方法成功发送频道消息后,在相同频道的本地用户会收到此回调。
- 参数
-
userId | 消息发送者的用户 ID。 |
message | 接收到的频道消息内容。详见 IMessage。 |
◆ onImageMessageReceived()
virtual void agora::rtm::IChannelEventHandler::onImageMessageReceived |
( |
const char * |
userId, |
|
|
const IImageMessage * |
message |
|
) |
| |
|
inlinevirtual |
◆ onFileMessageReceived()
virtual void agora::rtm::IChannelEventHandler::onFileMessageReceived |
( |
const char * |
userId, |
|
|
const IFileMessage * |
message |
|
) |
| |
|
inlinevirtual |
◆ onSendMessageResult()
virtual void agora::rtm::IChannelEventHandler::onSendMessageResult |
( |
long long |
messageId, |
|
|
CHANNEL_MESSAGE_ERR_CODE |
state |
|
) |
| |
|
inlinevirtual |
◆ onMemberJoined()
virtual void agora::rtm::IChannelEventHandler::onMemberJoined |
( |
IChannelMember * |
member | ) |
|
|
inlinevirtual |
远端用户加入频道回调。
当有远端用户调用 join 方法加入频道并收到 onJoinSuccess 回调时,在相同频道的本地用户会收到此回调。
- 注解
- 频道人数超过 512 人时后台会关闭上下线通知。
- 参数
-
member | 加入频道的远端用户。详见 IChannelMember。 |
◆ onMemberLeft()
virtual void agora::rtm::IChannelEventHandler::onMemberLeft |
( |
IChannelMember * |
member | ) |
|
|
inlinevirtual |
◆ onGetMembers()
◆ onAttributesUpdated()
virtual void agora::rtm::IChannelEventHandler::onAttributesUpdated |
( |
const IRtmChannelAttribute * |
attributes[], |
|
|
int |
numberOfAttributes |
|
) |
| |
|
inlinevirtual |
频道属性更新回调。报告所在频道的所有属性。
- 注解
- 只有当频道属性更新者将 enableNotificationToChannelMembers 设为
true
后,该回调才会被触发。请注意:该标志位为一次性标志位,仅对当前频道属性操作有效。
- 参数
-
attributes | 当前频道的所有属性。 |
numberOfAttributes | 频道属性的条数。 |
◆ onMemberCountUpdated()
virtual void agora::rtm::IChannelEventHandler::onMemberCountUpdated |
( |
int |
memberCount | ) |
|
|
inlinevirtual |
频道成员人数更新回调。报告最新频道成员人数。
- 注解
- SDK 会在频道成员人数更新时返回该回调:
- 频道成员人数 ≤ 512 时,回调触发频率为每秒 1 次。
- 频道成员人数超过 512 时,回调触发频率为每 3 秒 1 次。
- 用户在成功加入频道时会收到该回调。你可以通过监听该回调获取加入频道时的频道成员人数和后继人数更新。
- 参数
-