Packageyy
Interfacepublic interface IChannel extends flash.events.IEventDispatcher

频道接口，提供对频道的操作和交互


Public Properties
 PropertyDefined By
  appMsg : IChannelAppMsg
[read-only] 获取频道应用消息接口。
IChannel
  chat : IChannelChat
[read-only] 获取公屏聊天和私聊接口。
IChannel
  micList : IChannelMicList
[read-only] 获取麦序接口。
IChannel
  receptionChannel : IReceptionChannel
[read-only] 获取接待频道接口。
IChannel
  tabPage : IChannelTabPage
[read-only] 获取频道 tab页接口。
IChannel
  userController : IChannelUserController
[read-only] 获取频道用户控制接口。
IChannel
  userListPopMenu : IChannelUserListPopMenu
[read-only] 获取用户菜单接口。
IChannel
Public Methods
 MethodDefined By
  
getChannelInfo(cid:uint):Object
获取当前大频道中，指定的子频道或者根频道的频道信息。
IChannel
  
getChannelStyle():Object
获取频道风格。用来判断是普通频道风格还是精彩世界风格。
IChannel
  
getCurrentChannelInfo():Object
获取当前所在的大频道信息。
IChannel
  
getCurrentSubChannelInfo():Object
获取当前所在的子频道信息。
IChannel
  
getRootChannelId():Object
获取当前根频道id。
IChannel
  
getSubChannelIds(cid:uint):Object
获取指定频道的所有子频道的id
IChannel
  
getUserList(cid:uint):Object
获取指定频道的用户的uid。频道超过200人时只随机获取200人
IChannel
Events
 Event Summary Defined By
  
CHANNEL_INFO_CHANGED
 当前频道信息变化事件。用户当前所在频道信息变化时会触发。 事件信息格式说明: eventData: ChannelInfo类型 是ChannelInfo对象，保存频道的新信息。 IChannel
  
FOCUS_CHANNEL_CHANGED
 触发切换频道事件。用户在大频道中切换频道的时候会触发。 事件信息格式说明: eventData.departedId: int类型 离开的频道的长位id。 eventData.nowId: int类型 进入的频道的长位id。 IChannel
  
SUB_CHANNEL_ADD
 子频道增加事件。子频道创建的时候会触发此事件。 事件信息格式说明: eventData.cid: int类型 增加的子频道的长位id。 eventData.pcid: int类型 增加到哪个频道下，长位id。 IChannel
  
SUB_CHANNEL_DEL
 子频道删除事件。子频道被删除时触发此事件。 事件信息格式说明: eventData.cid: int类型 被删除的子频道长位id。 IChannel
  
USER_ENTER_CHANNEL
 用户进入当前大频道事件。当用户进入当前大频道中任一频道就会触发。 事件信息格式说明: eventData.uid: int类型 进入频道的用户uid。 eventData.cid: int类型 进入时，所在的那个频道的长位id。 IChannel
  
USER_LEAVE_CHANNEL
 用户离开当前大频道事件。当有用户离开当前大频道就会触发。 事件信息格式说明: eventData.uid: int类型 离开频道的用户uid。 eventData.cid: int类型 离开大频道时所处的频道的长位id。 IChannel
Property Detail
appMsgproperty
appMsg:IChannelAppMsg  [read-only]

获取频道应用消息接口。


Implementation
    public function get appMsg():IChannelAppMsg

See also

IChannelAppMsg
chatproperty 
chat:IChannelChat  [read-only]

获取公屏聊天和私聊接口。


Implementation
    public function get chat():IChannelChat

See also

IChannelChat
micListproperty 
micList:IChannelMicList  [read-only]

获取麦序接口。


Implementation
    public function get micList():IChannelMicList

See also

IChannelMicList
receptionChannelproperty 
receptionChannel:IReceptionChannel  [read-only]

获取接待频道接口。


Implementation
    public function get receptionChannel():IReceptionChannel

See also

IReceptionChannel
tabPageproperty 
tabPage:IChannelTabPage  [read-only]

获取频道 tab页接口。


Implementation
    public function get tabPage():IChannelTabPage

See also

IChannelTabPage
userControllerproperty 
userController:IChannelUserController  [read-only]

获取频道用户控制接口。


Implementation
    public function get userController():IChannelUserController

See also

IChannelUserController
userListPopMenuproperty 
userListPopMenu:IChannelUserListPopMenu  [read-only]

获取用户菜单接口。


Implementation
    public function get userListPopMenu():IChannelUserListPopMenu

See also

IChannelUserListPopMenu
Method Detail
getChannelInfo()method
public function getChannelInfo(cid:uint):Object

获取当前大频道中，指定的子频道或者根频道的频道信息。

Parameters

cid:uint — 频道的id号 ,是频道的长位ID

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

See also

getCurrentChannelInfo()
getChannelStyle()method 
public function getChannelStyle():Object

获取频道风格。用来判断是普通频道风格还是精彩世界风格。

Returns
Object — 返回频道风格，具体属性如下。

ret: int类型 返回码 0=成功，非0值失败，具体请参考错误代码。

style: int类型 当前频道频道风格,0=普通频道，1=精彩世界。


Example 
         使用示例:
         var result:Object=YY.instance.channel.getChannelStyle();
         if(result.ret==0)
         {
           trace("频道风格: "+ (result.style == 0 ? "普通频道" : "精彩世界"));
         }
         成功的返回值示例:{ ret:0,style:1}
         失败的返回值示例:{ ret:984832}
getCurrentChannelInfo()method 
public function getCurrentChannelInfo():Object

获取当前所在的大频道信息。

Returns
Object — 返回当前频道信息,是一个Object对象，具体属性如下。

ret: int类型 返回码 0=成功，非0值失败，具体请参考错误代码。

longId: Number类型 频道的长位Id。

shortId: Number类型 频道的短位Id，如果没有，同长位Id一致。

name: String类型 频道的名称。

userCount: Number类型 所在子频道用户数量。

totalUserCount: Number类型 大频道全部用户数量。

channelType: Number类型 游戏=0 娱乐=1 其他=2 教育=3。

channelPoints: Number类型 频道的积分。


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

获取当前所在的子频道信息。

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

See also

getCurrentChannelInfo()
getRootChannelId()method 
public function getRootChannelId():Object

获取当前根频道id。

Returns
Object — 返回当前根频道的频道长位id，具体属性如下。

ret: int类型 返回码 0=成功，非0值失败，具体请参考错误代码。

cid: Number类型 当前频道根频道的长位Id。


Example 
         使用示例:
         var result:Object=YY.instance.channel.getRootChannelId();
         if(result.ret==0)
         {
           trace("根频道Id="+result.cid);
         }
         成功的返回值示例:{ ret:0,cid:88995544}
         失败的返回值示例:{ ret:984832}
getSubChannelIds()method 
public function getSubChannelIds(cid:uint):Object

获取指定频道的所有子频道的id

Parameters

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

Returns
Object — 返回所有子频道的长位id。

ret: int类型 返回码 0=成功，非0值失败，具体请参考错误代码。

cids: Array类型 回所有子频道的长位id,id保存在一个数组中


Example 
         使用示例:
         var result:Object=YY.instance.channel.getSubChannelIds(45467889);
         if(result.ret==0)
         {
           trace("所有子频道Id为"+result.cids);
         }
         成功的返回值示例:{ ret:0,cids:[88995544,99898888,33334445]}
         失败的返回值示例:{ ret:984832}
getUserList()method 
public function getUserList(cid:uint):Object

获取指定频道的用户的uid。频道超过200人时只随机获取200人

Parameters

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

Returns
Object — 返回在该频道中前200个用户uid。

ret: int类型 返回码 0=成功，非0值失败，具体请参考错误代码。

userList: Array类型 返回在该频道中前200个用户uid,uid保存在一个数组中。


Example 
         使用示例:
         var result:Object=YY.instance.channel.getUserList(45467889);
         if(result.ret==0)
         {
           trace("在45467889频道中的用户为："+result.userList);
         }
         成功的返回值示例:{ ret:0,userList:[1234444,2234455,3311344]}
         失败的返回值示例:{ ret:984832}
Event Detail
CHANNEL_INFO_CHANGED Event
Event Object Type: yy.events.ChannelEvent
ChannelEvent.type property = yy.events.ChannelEvent.CHANNEL_INFO_CHANGED

当前频道信息变化事件。用户当前所在频道信息变化时会触发。

事件信息格式说明:

eventData: ChannelInfo类型 是ChannelInfo对象，保存频道的新信息。

FOCUS_CHANNEL_CHANGED Event  
Event Object Type: yy.events.ChannelEvent
ChannelEvent.type property = yy.events.ChannelEvent.FOCUS_CHANNEL_CHANGED

触发切换频道事件。用户在大频道中切换频道的时候会触发。

事件信息格式说明:

eventData.departedId: int类型 离开的频道的长位id。

eventData.nowId: int类型 进入的频道的长位id。

SUB_CHANNEL_ADD Event  
Event Object Type: yy.events.ChannelEvent
ChannelEvent.type property = yy.events.ChannelEvent.SUB_CHANNEL_ADD

子频道增加事件。子频道创建的时候会触发此事件。

事件信息格式说明:

eventData.cid: int类型 增加的子频道的长位id。

eventData.pcid: int类型 增加到哪个频道下，长位id。

SUB_CHANNEL_DEL Event  
Event Object Type: yy.events.ChannelEvent
ChannelEvent.type property = yy.events.ChannelEvent.SUB_CHANNEL_DEL

子频道删除事件。子频道被删除时触发此事件。

事件信息格式说明:

eventData.cid: int类型 被删除的子频道长位id。

USER_ENTER_CHANNEL Event  
Event Object Type: yy.events.ChannelEvent
ChannelEvent.type property = yy.events.ChannelEvent.USER_ENTER_CHANNEL

用户进入当前大频道事件。当用户进入当前大频道中任一频道就会触发。

事件信息格式说明:

eventData.uid: int类型 进入频道的用户uid。

eventData.cid: int类型 进入时，所在的那个频道的长位id。

USER_LEAVE_CHANNEL Event  
Event Object Type: yy.events.ChannelEvent
ChannelEvent.type property = yy.events.ChannelEvent.USER_LEAVE_CHANNEL

用户离开当前大频道事件。当有用户离开当前大频道就会触发。

事件信息格式说明:

eventData.uid: int类型 离开频道的用户uid。

eventData.cid: int类型 离开大频道时所处的频道的长位id。





Mon Dec 16 2013, 04:44 PM +08:00