IChannel

Public 成员函数
virtual int	join ()=0
virtual int	leave ()=0
virtual int	sendMessage (const IMessage *message, const SendMessageOptions &options)=0
virtual const char *	getId () const =0
virtual int	getMembers ()=0
virtual void	release ()=0

Protected 成员函数
virtual	~IChannel ()

构造及析构函数说明

~IChannel

virtual ~IChannel()

成员函数说明

getId

virtual const char *getId() const

获取当前频道 ID。

返回

当前频道 ID。

getMembers

virtual int getMembers()

获取当前频道成员列表。

SDK 通过 onGetMembers 回调返回该方法的调用结果（频道成员列表）。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。错误码详见 GET_MEMBERS_ERR 。

join

virtual int join()

加入频道

• 方法调用成功：
  • 本地用户收到回调 onJoinSuccess。
  • 所有远端用户收到回调 onMemberJoined。
• 方法调用失败：本地用户收到回调 onJoinFailure。 错误代码信息详见 JOIN_CHANNEL_ERR。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。错误码详见 GET_MEMBERS_ERR 。

注意事项：

• 同一用户只能同时加入最多 20 个频道。加入频道超限时用户会收到错误码 JOIN_CHANNEL_ERR_FAILURE。

leave

virtual int leave()

离开频道

• 方法调用成功：
  • 本地用户收到回调 onLeave 的 LEAVE_CHANNEL_ERR_OK 状态。
  • 所有远端用户收到回调 onMemberLeft。
• 方法调用失败：本地用户收到回调 onLeave的错误代码。错误代码信息详见 LEAVE_CHANNEL_ERR。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。错误码详见 LEAVE_CHANNEL_ERR 。

release

virtual void release()

释放当前 IChannel 实例使用的所有资源。

sendMessage

virtual int sendMessage(const IMessage *message, const SendMessageOptions &options)

供频道成员向所在频道发送频道消息

方法调用成功：

• 本地用户收到回调 onSendMessageResult。
• 所有远端用户收到回调 onMessageReceived。

参数

参数	说明
message	发送的消息。 详见 IMessage。
options	消息发送选项。详见 SendMessageOptions。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。错误码详见 CHANNEL_MESSAGE_ERR_CODE 。