AVDUserManager Class Reference

Inherits from	NSObject
Declared in	AVDUserManager.h AVDUserManager.mm

Overview

用户管理接口类

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

Other Methods

`participants`

< 用户管理回调代理

@property (nonatomic, retain, readonly) NSMutableArray *participants

Discussion

< 用户管理回调代理

Declared In

AVDUserManager.h

`selfUser`

< 参会者列表用户信息，数组中存放AVDUser对象

@property (nonatomic, retain, readonly) AVDUser *selfUser

Discussion

< 参会者列表用户信息，数组中存放AVDUser对象

Declared In

AVDUserManager.h

`+ getUserManager:`

获取用户管理功能模块对象

+ (AVDUserManager *)getUserManager:(AVDRoom *)room

Return Value

返回用户管理模块对象。

Discussion

获取用户管理功能模块对象

@param[in] *room 房间对象指针

Declared In

AVDUserManager.h

`– updateUser:`

更新本用户信息

- (AVDResult)updateUser:(AVDUser *)user

Return Value

返回错误代码。

Discussion

更新本用户信息

@param[in] *user 用户信息。

Declared In

AVDUserManager.h

`– hasUser:`

判断用户是否存在

- (BOOL)hasUser:(AVDUserId)userId

Return Value

是否存在用户。

Discussion

判断用户是否存在

@param[in] userId 用户Id。

Declared In

AVDUserManager.h

`– getUser:`

获取关联Id的用户信息

- (AVDUser *)getUser:(AVDUserId)userId

Return Value

返回关联Id的用户信息。

Discussion

获取关联Id的用户信息

@param[in] userId 用户Id。

Declared In

AVDUserManager.h

`– getSelfUser`

获取自己的用户信息

- (AVDUser *)getSelfUser

Return Value

返回用户信息。

Discussion

获取自己的用户信息

@param[in] user 用户。

Declared In

AVDUserManager.h

`– getSelfUserId`

获取本用户Id

- (AVDUserId)getSelfUserId

Return Value

返回本用户Id。

Discussion

获取本用户Id

Declared In

AVDUserManager.h

`– getSelfUserName`

获取本用户名

- (NSString *)getSelfUserName

Return Value

返回本用户名。

Discussion

获取本用户名

Declared In

AVDUserManager.h

`– getSelfUserData`

获取本用户应用层数据

- (NSString *)getSelfUserData

Return Value

返回本用户应用层数据。

Discussion

获取本用户应用层数据

Declared In

AVDUserManager.h

`– updateSelfUserData:`

更改本用户的应用层数据

- (AVDResult)updateSelfUserData:(NSString *)userData

Return Value

返回错误代码。

Discussion

更改本用户的应用层数据

@param[in] userData 本用户应用层数据。

Declared In

AVDUserManager.h

`– updateSelfUserStatus:`

更改本用户的用户状态

- (AVDResult)updateSelfUserStatus:(AVDUserStatus *)status

Return Value

返回错误代码。

Discussion

更改本用户的用户状态

@param[in] *status 用户状态。

Declared In

AVDUserManager.h

`– getParticipantsCount`

获取房间中的用户数量

- (NSUInteger)getParticipantsCount

Return Value

返回本用户数量。

Discussion

获取房间中的用户数量

Declared In

AVDUserManager.h

Other Methods

`– internal_getUserList`

获取房间中的用户列表

- (NSMutableArray *)internal_getUserList

Return Value

返回错误代码。

Discussion

获取房间中的用户列表

@param[in] begindex 起始索引。 @param[in,out] ncount 请求数量；实际返回数量。 @param[out] users 用户列表集合。

Note: 用户列表不包含本用户。

Declared In

AVDUserManager.mm