MUserManager

cn.tee3.avd

## 类 MUserManager

- java.lang.Object
- - cn.tee3.avd.Module
  - - cn.tee3.avd.MUserManager

-     public class MUserManager
      extends Module

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

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static interface` | `MUserManager.Listener` 用户管理回调接口类 用户管理回调接口定义了房间用户和用户列表操作的异步返回，房间用户通知。

  - ### 方法概要

    所有方法 静态方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `User` | `getHost()` 获取主持人信息
    `java.util.List<User>` | `getParticipants(int begindex, int ncount)` 获取房间中的用户列表
    `int` | `getParticipantsCount()` 获取房间中的用户数量
    `User` | `getSelfUser()` 获取本用户信息
    `java.lang.String` | `getSelfUserData()` 获取本用户应用层数据
    `java.lang.String` | `getSelfUserId()` 获取本用户Id
    `User` | `getUser(java.lang.String userId)` 获取关联Id的用户信息
    `static MUserManager` | `getUserManager(Room room)` 获取房间内用户管理模块接口
    `boolean` | `hasUser(java.lang.String userId)` 判断用户是否存在
    `boolean` | `setListener(MUserManager.Listener listener)` 设置用户管理回调接口
    `int` | `updateSelfUserData(java.lang.String userData)` 更改本用户的应用层数据
    `int` | `updateSelfUserStatus(int status)` 更改本用户的用户状态
    `int` | `updateUser(User user)` 更新本用户信息
    `int` | `updateUserName(java.lang.String userId, java.lang.String newUserName)` 更新某一用户名

    - ### 从类继承的方法 cn.tee3.avd.Module

      `getOwnerId, getOwnerName, getRoom, getUserManager, getUserName, isSelfDevice, isSelfUser`

    - ### 从类继承的方法 java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 方法详细资料

    - #### getUserManager

          @Nullable
          public static MUserManager getUserManager(Room room)

      获取房间内用户管理模块接口
      返回:
        返回用户管理模块接口指针。

    - #### setListener

          public boolean setListener(MUserManager.Listener listener)

      设置用户管理回调接口
      返回:
        返回错误代码。
      另请参阅:
        `MUserManager.Listener`

    - #### updateUser

          public int updateUser(User user)

      更新本用户信息
      返回:
        返回错误代码。

    - #### hasUser

          public boolean hasUser(java.lang.String userId)

      判断用户是否存在
      返回:
        是否存在用户。

    - #### getUser

          public User getUser(java.lang.String userId)

      获取关联Id的用户信息
      返回:
        返回关联Id的用户信息。

    - #### getHost

          public User getHost()

      获取主持人信息
      返回:
        返回主持人信息。

    - #### getSelfUser

          public User getSelfUser()

      获取本用户信息
      返回:
        返回本用户信息。

    - #### getSelfUserId

          public java.lang.String getSelfUserId()

      获取本用户Id
      返回:
        返回本用户Id。

    - #### getSelfUserData

          public java.lang.String getSelfUserData()

      获取本用户应用层数据
      返回:
        返回本用户应用层数据。

    - #### updateSelfUserData

          public int updateSelfUserData(java.lang.String userData)

      更改本用户的应用层数据
      返回:
        返回错误代码。

    - #### updateUserName

          public int updateUserName(java.lang.String userId,
                                    java.lang.String newUserName)

      更新某一用户名
      返回:
        返回错误代码。

    - #### updateSelfUserStatus

          public int updateSelfUserStatus(int status)

      更改本用户的用户状态
      返回:
        返回错误代码。

    - #### getParticipantsCount

          public int getParticipantsCount()

      获取房间中的用户数量
      返回:
        返回本用户数量。

    - #### getParticipants

          public java.util.List<User> getParticipants(int begindex,
                                                      int ncount)

      获取房间中的用户列表
      返回:
        返回用户列表。