com.qiniu.rtc

类 RtcRoomManager

java.lang.Object

com.qiniu.rtc.RtcRoomManager

public class RtcRoomManager
extends java.lang.Object

构造器概要

构造器

构造器和说明
RtcRoomManager(Auth auth)
RtcRoomManager(Auth auth, java.lang.String host)

方法概要

限定符和类型	方法和说明
java.lang.String	getRoomToken(java.lang.String appId, java.lang.String roomName, java.lang.String userId, long expireAt, java.lang.String permission)
Response	kickUser(java.lang.String appId, java.lang.String roomName, java.lang.String userId)
Response	listActiveRooms(java.lang.String appId, java.lang.String prefix, int offset, int limit)
Response	listUser(java.lang.String appId, java.lang.String roomName)

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RtcRoomManager

public RtcRoomManager(Auth auth)

RtcRoomManager

public RtcRoomManager(Auth auth,
                      java.lang.String host)

方法详细资料

listUser

public Response listUser(java.lang.String appId,
                         java.lang.String roomName)
                  throws QiniuException

参数:

appId - 房间所属帐号的 app

roomName - 操作所查询的连麦房间

返回:

Response 如果不读取Response的数据，请注意调用Close方法关闭

抛出:

QiniuException

kickUser

public Response kickUser(java.lang.String appId,
                         java.lang.String roomName,
                         java.lang.String userId)
                  throws QiniuException

参数:

appId - 房间所属帐号的 app

roomName - 操作房间名

userId - 被踢人员

返回:

Response 如果不读取Response的数据，请注意调用Close方法关闭

抛出:

QiniuException

listActiveRooms

public Response listActiveRooms(java.lang.String appId,
                                java.lang.String prefix,
                                int offset,
                                int limit)
                         throws QiniuException

参数:

appId - 连麦房间所属的 app

prefix - 所查询房间名的前缀索引，可以为空。

offset - 分页查询的位移标记

limit - 此次查询的最大长度

返回:

Response 如果不读取Response的数据，请注意调用Close方法关闭

抛出:

QiniuException

getRoomToken

public java.lang.String getRoomToken(java.lang.String appId,
                                     java.lang.String roomName,
                                     java.lang.String userId,
                                     long expireAt,
                                     java.lang.String permission)
                              throws java.lang.Exception

参数:

appId - 房间所属帐号的 app

roomName - 房间名称，需满足规格 ^[a-zA-Z0-9_-]{3,64}$

userId - 请求加入房间的用户 ID，需满足规格 ^[a-zA-Z0-9_-]{3,50}$

expireAt - int64 类型，鉴权的有效时间，传入以秒为单位的64位Unix绝对时间，token 将在该时间后失效

permission - 该用户的房间管理权限，"admin" 或 "user"，默认为 "user" 。当权限角色为 "admin" 时，拥有将其他用户移除出房 间等特权.

返回:

roomToken

抛出:

java.lang.Exception