cn.tee3.avd_SDK-C++  2.1.0
| Public 成员函数 | 静态 Public 成员函数 | Protected 成员函数 | 所有成员列表
tee3::avd::IMChat类 参考abstract

房间中聊天模块接口. 更多...

类 tee3::avd::IMChat 继承关系图:
tee3::avd::IModule

class  IListener
 房间中聊天模块回调接口. 更多...
 

Public 成员函数

virtual Result setListener (IListener *listener)=0
 设置房间聊天模块回调接口 更多...
 
virtual Result sendPublicMessage (const String &message)=0
 发送公聊消息 更多...
 
virtual Result sendPrivateMessage (const String &message, const UserId &toId)=0
 发送私聊消息 更多...
 
virtual Result getPublicHistoryMessage (bool latest, uint32 begindex, uint32 &ncount, MessagesType &msgs)=0
 获取公聊历史消息记录 更多...
 
virtual Result getPrivateHistoryMessage (const UserId &userId, bool latest, uint32 begindex, uint32 &ncount, MessagesType &msgs)=0
 获取私聊历史消息记录 更多...
 
- Public 成员函数 继承自 tee3::avd::IModule
virtual IRoomgetRoom ()=0
 获取房间接口指针 更多...
 
virtual IMUserManagergetUserManager ()=0
 获取房间用户管理模块指针 更多...
 
virtual bool isSelfUser (const UserId &userId) const =0
 判断是否是自己的用户Id 更多...
 
virtual bool isSelfDevice (const DeviceId &deviceId) const =0
 判断设备Id是否是属于自己的 更多...
 
virtual const UserId getOwnerId (const DeviceId &deviceId) const =0
 获取设备Id的关联用户Id 更多...
 
virtual const StringgetOwnerName (const DeviceId &deviceId) const =0
 获取设备Id的关联用户名称 更多...
 

静态 Public 成员函数

static IMChatgetChat (IRoom *room)
 获取房间内聊天模块接口 更多...
 

Protected 成员函数

virtual ~IMChat ()
 
- Protected 成员函数 继承自 tee3::avd::IModule
virtual ~IModule ()
 

详细描述

房间中聊天模块接口.

房间聊天模块定义房间中公聊和私聊等聊天功能接口。

构造及析构函数说明

◆ ~IMChat()

virtual tee3::avd::IMChat::~IMChat ( )
protectedvirtual

成员函数说明

◆ getChat()

static IMChat* tee3::avd::IMChat::getChat ( IRoom room)
static

获取房间内聊天模块接口

参数
[in]room房间对象。
返回
聊天模块接口。
参见
IRoom

◆ getPrivateHistoryMessage()

virtual Result tee3::avd::IMChat::getPrivateHistoryMessage ( const UserId userId,
bool  latest,
uint32  begindex,
uint32 ncount,
MessagesType msgs 
)
pure virtual

获取私聊历史消息记录

参数
[in]userId聊天对方的用户Id。
[in]latest是否是最新记录(即反序)。
[in]begindex消息起始索引。
[in,out]ncount请求消息数量;实际消息返回数量。
[out]msgs保存消息列表。
返回
返回错误代码。

◆ getPublicHistoryMessage()

virtual Result tee3::avd::IMChat::getPublicHistoryMessage ( bool  latest,
uint32  begindex,
uint32 ncount,
MessagesType msgs 
)
pure virtual

获取公聊历史消息记录

参数
[in]latest是否是最新记录(即反序)。
[in]begindex消息起始索引。
[in,out]ncount请求消息数量;实际消息返回数量。
[out]msgs保存消息列表。
返回
返回错误代码。

◆ sendPrivateMessage()

virtual Result tee3::avd::IMChat::sendPrivateMessage ( const String message,
const UserId toId 
)
pure virtual

发送私聊消息

参数
[in]message消息内容。
[in]toId私聊消息目的用户Id。
返回
返回错误代码。

◆ sendPublicMessage()

virtual Result tee3::avd::IMChat::sendPublicMessage ( const String message)
pure virtual

发送公聊消息

参数
[in]message消息内容。
返回
返回错误代码。

◆ setListener()

virtual Result tee3::avd::IMChat::setListener ( IListener listener)
pure virtual

设置房间聊天模块回调接口

参数
[in]*listener聊天模块回调接口指针。
返回
返回错误代码。
参见
IListener

该类的文档由以下文件生成: