房间信息 功能API 说明

调用方式:

在实例化,VhallSDK 之后, 用vhallSDK的实例句柄,进行调用访问。

API 名称 功能描述 参数 返回值 备注
getRoominfo 自助操作 获取当前活动状态 null promise
getUserinfo 自助操作 获取当前用户参会信息 null promise {avatar: '',dataToken: '',forbidchat: 1, is_gag : 1, is_kickout : 1, nick_name : '', role: 'user', userId : '', vss : Object} 备注:forbidchat:全体禁言(仅flash可用),1:开启,0:关闭。 is_gag:是否被禁言,1:禁言,0:未禁言。is_kickout: 是否被踢出,1:踢出,0:未踢出。role: 角色,user:观众,host:主持,guest:嘉宾,assistant:助理
updateUserInfo 自助操作 更新用户昵称 name, 类型:String promise 参数长度小于30

代码示例


    var vhallSDKInstance = new VhallSDK({
        ... // 微吼SDK 初始化参数
    })
	
    // 自助操作 获取当前活动状态
    vhallSDKInstance.getRoominfo().then(res => {}).catch(e => {})
	
    // 自助操作 获取当前用户参会信息
    vhallSDKInstance.getUserinfo().then(res => {}).catch(e => {})
	
    // 自助操作 更新用户昵称
    vhallSDKInstance.updateUserInfo(name)