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

---

Classes

• IYY
• IYYAudio
• IYYChannel
• IYYChannelAppMsg
• IYYChannelChat
• IYYChannelMicList
• IYYChannelTabPage
• IYYChannelUserController
• IYYChannelUserListPopMenu
• IYYCloud
• IYYCommon
• IYYFinance
• IYYIM
• IYYInteraction
• IYYNet
• IYYReceptionChannel
• IYYSecurity
• IYYTempAudioSession
• IYYUser
• IYYVideo
• YYCloudFilter

---

Class IYYChannel

Extends IYYCommon.
频道接口，提供对频道的操作和交互。
Defined in: yyapi.js.

Class Summary

Constructor Attributes	Constructor Name and Description
	IYYChannel() IYYChannel 构造函数。

Field Summary

Field Attributes	Field Name and Description
	appMsg 获取频道应用消息接口。
<static>	IYYChannel.CHANNEL_INFO_CHANGED 当前频道信息变化事件。用户当前所在的频道(子频道或者根频道)信息变化时会触发。
<static>	IYYChannel.FOCUS_CHANNEL_CHANGED 切换频道事件。用户在大频道中切换频道的时候会触发。
	micList 获取麦序接口。
	receptionChannel 获取接待频道接口。
<static>	IYYChannel.SUB_CHANNEL_ADD 子频道增加事件。子频道创建的时候会触发此事件。
<static>	IYYChannel.SUB_CHANNEL_DEL 子频道删除事件。子频道被删除时触发此事件。
	tabPage 获取频道 tab页接口。
<static>	IYYChannel.USER_ENTER_CHANNEL 用户进入当前大频道事件。当用户进入当前大频道中任一频道就会触发。
<static>	IYYChannel.USER_LEAVE_CHANNEL 用户离开当前大频道事件。当有用户离开当前大频道就会触发。
	userController 获取频道用户控制接口。
	userListPopMenu 获取用户菜单接口。

Method Summary

Method Attributes	Method Name and Description
	getChannelInfo(cid) 获取当前大频道中，指定的子频道或者根频道的频道信息。
	getChannelStyle() 获取频道风格。用来判断是普通频道风格还是精彩世界风格。
	getCurrentChannelInfo() 获取当前所在的大频道信息
	getCurrentSubChannelInfo() 获取当前所在的子频道信息
	getRootChannelId() 获取当前根频道id。
	getSubChannelIds(cid) 获取指定频道的所有子频道的id。
	getUserList(cid) 获取指定频道的用户的uid。频道超过200人时只随机获取200人

Methods borrowed from class IYYCommon:

addEventListener, removeEventListener

See:

IYYChannelAppMsg

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData: Object类型 是YYChannelInfo对象，保存频道的新信息。

使用示例：
yy.channel.addEventListener(IYYChannel.CHANNEL_INFO_CHANGED,onChannelInfoChanged);

function onChannelInfoChanged(eventData)
{
    document.getElementById("txtLog").innerHTML="发生变化的频道号："+eventData.longId+" 名称为："+eventData.name;
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.departedId: Number类型 离开的频道的长位id。
eventData.nowId: Number类型 进入的频道的长位id。

使用示例：
yy.channel.addEventListener(IYYChannel.FOCUS_CHANNEL_CHANGED,onFocusChanged);

function onFocusChanged(eventData)
{
    document.getElementById("txtLog").innerHTML="离开："+eventData.departedId+" 进入了"+eventData.nowId;
}

---

See:

IYYChannelMicList

---

See:

IYYReceptionChannel

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.cid: Number类型 增加的子频道的长位id。
eventData.pcid: Number类型 增加到哪个频道下，长位id。

使用示例：
yy.channel.addEventListener(IYYChannel.SUB_CHANNEL_ADD,onChannelAdd);

function onChannelAdd(eventData)
{
    document.getElementById("txtLog").innerHTML="新的频道"+eventData.cid+"位于"+eventData.pcid+"下面";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.cid: Number类型 被删除的子频道长位id。

使用示例：
yy.channel.addEventListener(IYYChannel.SUB_CHANNEL_DEL,onChannelDel);

function onChannelDel(eventData)
{
    document.getElementById("txtLog").innerHTML="被删除的子频道："+eventData.cid;
}

---

See:

IYYChannelTabPage

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.uid: Number类型 进入频道的用户uid。
eventData.cid: Number类型 进入时，所在的那个频道的长位id。

使用示例：
yy.channel.addEventListener(IYYChannel.USER_ENTER_CHANNEL,onUserEnter);

function onUserEnter(eventData)
{
    document.getElementById("txtLog").innerHTML="有新用户"+eventData.uid+"进入到"+eventData.cid+"频道";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.uid: Number类型 离开频道的用户uid。
eventData.cid: Number类型 离开大频道时所处的频道的长位id。

使用示例：
yy.channel.addEventListener(IYYChannel.USER_LEAVE_CHANNEL,onUserLeave);

function onUserLeave(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"离开了"+eventData.cid+"频道";
}

---

See:

IYYChannelUserController

---

See:

IYYChannelUserListPopMenu

Parameters:

{Number} cid

指定的频道的id 是频道的长位Id 。

Returns:

返回指定频道信息,是一个Object对象。返回信息格式同getCurrentChannelInfo一致。

See:

#getCurrentChannelInfo

---

使用示例:
var result=yy.channel.getChannelStyle();
if(result.ret==0)
{
  document.getElementById("txtLog").innerHTML="频道风格: "+ (result.style == 0 ? "普通频道" : "精彩世界");
}
成功的返回值示例:{ ret:0,cid:88995544}
失败的返回值示例:{ ret:984832}

Returns:

返回频道风格，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
style: Number类型 当前频道频道风格,0=普通频道，1=精彩世界。

---

使用示例:
var cInfo=yy.channel.getCurrentChannelInfo();
成功的返回值示例:{ ret:0,longId:88995544,shortId:1234,name:"我的测试频道",userCount:9,totalUserCount:25,channelType:0,channelPoints:4958}
失败的返回值示例:{ ret:984832}

Returns:

返回当前频道信息,是一个Object对象，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
longId: Number类型 频道的长位Id。
shortId: Number类型 频道的短位Id，如果没有，同长位Id一致。
name: String类型 频道的名称。
userCount: Number类型 所在子频道用户数量。
totalUserCount: Number类型 大频道全部用户数量。
channelType: Number类型 游戏=0 娱乐=1 其他=2 教育=3。
channelPoints: Number类型 频道的积分。

---

Returns:

返回当前子频道信息,是一个Object对象。返回信息格式同getCurrentChannelInfo一致。

See:

#getCurrentChannelInfo

---

使用示例:
var result=yy.channel.getRootChannelId();
if(result.ret==0)
{
  document.getElementById("txtLog").innerHTML="根频道Id="+result.cid;
}
成功的返回值示例:{ ret:0,cid:88995544}
失败的返回值示例:{ ret:984832}

Returns:

返回当前根频道的频道长位id，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
cid: Number类型 当前频道根频道的长位Id。

---

使用示例:
var result=yy.channel.getSubChannelIds(45467889);
if(result.ret==0)
{
  document.getElementById("txtLog").innerHTML="所有子频道Id为"+result.cids;
}
成功的返回值示例:{ ret:0,cids:[88995544,99898888,33334445]}
失败的返回值示例:{ ret:984832}

Parameters:

{Number} cid

指定频道的的长位id,必须是在当前大频道中的一个频道。

Returns:

返回所有子频道的长位id。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
cids: Array类型 回所有子频道的长位id,id保存在一个数组中

---

使用示例:
var result=yy.channel.getUserList(45467889);
if(result.ret==0)
{
  document.getElementById("txtLog").innerHTML="在45467889频道中的用户为："+result.userList;
}
成功的返回值示例:{ ret:0,userList:[1234444,2234455,3311344]}
失败的返回值示例:{ ret:984832}

Parameters:

{Number} cid

指定频道的的长位id,必须是在当前大频道中的一个频道。

Returns:

返回在该频道中前200个用户uid。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
userList: Array类型 返回在该频道中前200个用户uid,uid保存在一个数组中。

---