Class IYYChannelUserController

Extends IYYCommon.
频道用户控制接口。
Defined in: yyapi.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	IYYChannelUserController() IYYChannelUserController 构造函数。

Method Summary
Method Attributes	Method Name and Description
	disableMsg(uid) 禁止频道用户文字聊天。权限规则如下 OW:可以允许和禁止频道内任何其他成员语音，文字。包括（VP MA CA CA2 R VIP G U)。 VP：可以允许和禁止频道内任何其他成员语音，文字。除了（OW，VP）。 MA：可以允许和禁止频道内任何其他成员语音，文字。除了（OW，VP,MA）。 CA：可以允许和禁止相对应有管理权限的子频道内的语音，文字。包括（ CA2 R VIP G U）。 CA2：可以允许和禁止相对应有管理权限的子频道内的语音，文字。包括（ R VIP G U）。 R VIP G U 均无任何权限操作。字母代表的意义如下：游客(U),临时嘉宾(G),嘉宾(VIP),会员(R),二级子频道管理员(CA2),子频道管理员(CA),全频道管理员(MA),频道总管理(VP),频道所有者(OW)
	disableSpeak(uid) 禁止频道用户语音聊天。权限规则和disableMsg方法相同。
	enableMsg(uid) 允许频道用户文字聊天。权限规则和disableMsg方法相同。
	enableSpeak(uid) 允许频道用户语音聊天。权限规则和disableMsg方法相同。
	getUserSubChannelId(uid) 获取用户所在子频道ID。该用户必须在当前大频道中。
	isMsgEnabled(uid) 查询指定用户是否允许文字聊天。
	isSpeakEnabled(uid) 查询指定用户是否允许语音聊天。
	jumpToSubChannel(cid) 进子频道。
	pullToSubChannel(uid, cid) 拉人进子频道。权限规则如下 OW：可以调度频道内任何成员,包括（VP MA CA CA2 R VIP G U)。 VP：可以调度频道内除OW以外的任何成员，包括（VP MA CA1 CA2 R VIP G U)。 MA：可以调度频道内除了OW，VP以外的任何成员，包括（MA CA CA2 R VIP G U)。 CA:可以调度相对应有管理权限的1级子频道内的成员，（OW，VP,MA）除外。 CA2：可以调度相对应有管理权限的2级子频道内的成员，（OW，VP,MA，CA1）除外。 R VIP G U 均无任何权限操作。字母代表的意义如下：游客(U),临时嘉宾(G),嘉宾(VIP),会员(R),二级子频道管理员(CA2),子频道管理员(CA),全频道管理员(MA),频道总管理(VP),频道所有者(OW)
	setUserRole(cid, uid, role) 设置马甲。发起设置用户和被设置用户必须同时在线且在同一个大频道，发起者需要有管理员马甲，具体规则和权限同YY客户端一致。

Methods borrowed from class IYYCommon:: addEventListener, removeEventListener

Class Detail

IYYChannelUserController()

IYYChannelUserController 构造函数。

Method Detail

{Object} disableMsg(uid)

禁止频道用户文字聊天。权限规则如下
OW:可以允许和禁止频道内任何其他成员语音，文字。包括（VP MA CA CA2 R VIP G U)。
VP：可以允许和禁止频道内任何其他成员语音，文字。除了（OW，VP）。
MA：可以允许和禁止频道内任何其他成员语音，文字。除了（OW，VP,MA）。
CA：可以允许和禁止相对应有管理权限的子频道内的语音，文字。包括（ CA2 R VIP G U）。
CA2：可以允许和禁止相对应有管理权限的子频道内的语音，文字。包括（ R VIP G U）。
R VIP G U 均无任何权限操作。
字母代表的意义如下：
游客(U),临时嘉宾(G),嘉宾(VIP),会员(R),二级子频道管理员(CA2),子频道管理员(CA),全频道管理员(MA),频道总管理(VP),频道所有者(OW)

Parameters:
{Number} uid: 用户的唯一标识id，即uid，不是YY号 。

Returns:: 返回调用是否成功，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。

See:: #enableMsg

{Object} disableSpeak(uid)

禁止频道用户语音聊天。权限规则和disableMsg方法相同。

Parameters:
{Number} uid: 用户的唯一标识id，即uid，不是YY号 。

Returns:: 返回调用是否成功，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。

See:: #disableMsg

{Object} enableMsg(uid)

允许频道用户文字聊天。权限规则和disableMsg方法相同。

Parameters:
{Number} uid: 用户的唯一标识id，即uid，不是YY号 。

Returns:: 返回调用是否成功，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。

See:: #disableMsg

{Object} enableSpeak(uid)

允许频道用户语音聊天。权限规则和disableMsg方法相同。

Parameters:
{Number} uid: 用户的唯一标识id，即uid，不是YY号 。

Returns:: 返回调用是否成功，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。

See:: #disableMsg

{Object} getUserSubChannelId(uid)

获取用户所在子频道ID。该用户必须在当前大频道中。

使用示例:
var result = yy.channel.userController.getUserSubChannelId(435345);
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML = "用户当前在" + result.cid+"频道";
}
  
成功的返回值示例:{ ret:0,cid:88548884}
失败的返回值示例:{ ret:984832}

Parameters:
uid

Returns:: 返回用户所在的频道信息，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
cid: Number类型用户所在子频道长位Id

{Object} isMsgEnabled(uid)

查询指定用户是否允许文字聊天。

使用示例:
var result = yy.channel.userController.isMsgEnabled(435345);
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML = result.enabled?"用户可以文字聊天": "用户被禁止文字聊天";
}
  
成功的返回值示例:{ ret:0,enabled:true}
失败的返回值示例:{ ret:984832}

Parameters:
{Number} uid: 被查询的用户的唯一标识id，即uid，不是YY号 。

Returns:: 返回查询结果，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
enabled: Boolean类型 true=用户允许文字聊天，false=用户已被禁止文字聊天。

{Object} isSpeakEnabled(uid)

查询指定用户是否允许语音聊天。

使用示例:
var result = yy.channel.userController.isSpeakEnabled(435345);
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML = result.enabled?"用户可以语音聊天": "用户被禁止语音聊天";
}
  
成功的返回值示例:{ ret:0,enabled:true}
失败的返回值示例:{ ret:984832}

Parameters:
{Number} uid: 被查询的用户的唯一标识id，即uid，不是YY号 。

Returns:: 返回查询结果，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
enabled: Boolean类型 true=用户允许语音聊天，false=用户已被禁止语音聊天。

{Object} jumpToSubChannel(cid)

进子频道。

Parameters:
{Number} cid: 子频道长位id,必须是在当前大频道中的一个频道。

Returns:: 返回调用是否成功，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。

{Object} pullToSubChannel(uid, cid)

拉人进子频道。
权限规则如下
OW：可以调度频道内任何成员,包括（VP MA CA CA2 R VIP G U)。
VP：可以调度频道内除OW以外的任何成员，包括（VP MA CA1 CA2 R VIP G U)。
MA：可以调度频道内除了OW，VP以外的任何成员，包括（MA CA CA2 R VIP G U)。
CA:可以调度相对应有管理权限的1级子频道内的成员，（OW，VP,MA）除外。
CA2：可以调度相对应有管理权限的2级子频道内的成员，（OW，VP,MA，CA1）除外。
R VIP G U 均无任何权限操作。
字母代表的意义如下：
游客(U),临时嘉宾(G),嘉宾(VIP),会员(R),二级子频道管理员(CA2),子频道管理员(CA),全频道管理员(MA),频道总管理(VP),频道所有者(OW)

Parameters:
{Number} uid: 被拉的用户的uid。
{Number} cid: 子频道长位id,必须是当前大频道中的一个频道。

Returns:: 返回调用是否成功，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。

{Object} setUserRole(cid, uid, role)

设置马甲。发起设置用户和被设置用户必须同时在线且在同一个大频道，发起者需要有管理员马甲，具体规则和权限同YY客户端一致。

Parameters:
{Number} cid: 用户所在的频道id。如果用户在子频道，需要传子频道id。
{Number} uid: 用户的uid。
{Number} role: 用户的角色(马甲)数值。可以设置的马甲的数值如下：
游客(U) 白马 25
临时嘉宾(G) 浅绿色马甲 66
嘉宾(VIP) 绿马 88
会员(R) 蓝马 100
二级子频道管理员(CA2) 粉马 150
子频道管理员(CA) 红马 175
全频道管理员(MA) 黄马 200
频道总管理(VP) 橙马 230

Returns:: 返回调用是否成功，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。

YY开放平台 JavaScript SDK 1.19 参考手册

Classes

Class IYYChannelUserController