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

用户管理接口类 更多...

class  IListener
 用户管理回调接口类 更多...
 

Public 成员函数

virtual Result setListener (IListener *listener)=0
 设置用户管理回调接口 更多...
 
virtual Result updateUser (const User &user)=0
 更新本用户信息 更多...
 
virtual bool hasUser (const UserId &userId) const =0
 判断用户是否存在 更多...
 
virtual const UsergetUser (const UserId &userId) const =0
 获取关联Id的用户信息 更多...
 
virtual const UsergetHost () const =0
 获取主持人信息 更多...
 
virtual const UsergetSelfUser () const =0
 获取本用户信息 更多...
 
virtual const UserIdgetSelfUserId () const =0
 获取本用户Id 更多...
 
virtual const StringgetSelfUserData () const =0
 获取本用户应用层数据 更多...
 
virtual Result updateSelfUserData (const String &userData)=0
 更改本用户的应用层数据 更多...
 
virtual Result updateSelfUserStatus (uint32 status)=0
 更改本用户的用户状态 更多...
 
virtual uint32 getParticipantsCount () const =0
 获取房间中的用户数量 更多...
 
virtual Result getParticipants (uint32 begindex, uint32 &ncount, UsersType &users)=0
 获取房间中的用户列表 更多...
 

静态 Public 成员函数

static IMUserManagergetUserManager (IRoom *room)
 获取房间内用户管理模块接口 更多...
 

Protected 成员函数

virtual ~IMUserManager ()
 

详细描述

用户管理接口类

用户管理接口定义了房间内所有用户和用户列表相关的功能操作。

构造及析构函数说明

◆ ~IMUserManager()

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

成员函数说明

◆ getHost()

virtual const User& tee3::avd::IMUserManager::getHost ( ) const
pure virtual

获取主持人信息

返回
返回主持人信息。

◆ getParticipants()

virtual Result tee3::avd::IMUserManager::getParticipants ( uint32  begindex,
uint32 ncount,
UsersType users 
)
pure virtual

获取房间中的用户列表

参数
[in]begindex起始索引。
[in,out]ncount请求数量;实际返回数量。
[out]users用户列表集合。
注解
用户列表不包含本用户。
返回
返回错误代码。

◆ getParticipantsCount()

virtual uint32 tee3::avd::IMUserManager::getParticipantsCount ( ) const
pure virtual

获取房间中的用户数量

返回
返回本用户数量。

◆ getSelfUser()

virtual const User& tee3::avd::IMUserManager::getSelfUser ( ) const
pure virtual

获取本用户信息

返回
返回本用户信息。

◆ getSelfUserData()

virtual const String& tee3::avd::IMUserManager::getSelfUserData ( ) const
pure virtual

获取本用户应用层数据

返回
返回本用户应用层数据。

◆ getSelfUserId()

virtual const UserId& tee3::avd::IMUserManager::getSelfUserId ( ) const
pure virtual

获取本用户Id

返回
返回本用户Id。

◆ getUser()

virtual const User& tee3::avd::IMUserManager::getUser ( const UserId userId) const
pure virtual

获取关联Id的用户信息

参数
[in]userId用户Id。
返回
返回关联Id的用户信息。

◆ getUserManager()

static IMUserManager* tee3::avd::IMUserManager::getUserManager ( IRoom room)
static

获取房间内用户管理模块接口

参数
[in]room房间对象指针。
返回
返回用户管理模块接口指针。

◆ hasUser()

virtual bool tee3::avd::IMUserManager::hasUser ( const UserId userId) const
pure virtual

判断用户是否存在

参数
[in]userId用户Id。
返回
是否存在用户。

◆ setListener()

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

设置用户管理回调接口

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

◆ updateSelfUserData()

virtual Result tee3::avd::IMUserManager::updateSelfUserData ( const String userData)
pure virtual

更改本用户的应用层数据

参数
[in]userData本用户应用层数据。
返回
返回错误代码。

◆ updateSelfUserStatus()

virtual Result tee3::avd::IMUserManager::updateSelfUserStatus ( uint32  status)
pure virtual

更改本用户的用户状态

参数
[in]status用户状态。
返回
返回错误代码。

◆ updateUser()

virtual Result tee3::avd::IMUserManager::updateUser ( const User user)
pure virtual

更新本用户信息

参数
[in]user用户信息。
返回
返回错误代码。

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