Class Index | File Index

Classes


Class IYY


Extends IYYCommon.
yy接口入口,获取到yy的其他接口和方法。
Defined in: yyapi.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
IYY()
IYY 构造函数。
Field Summary
Field Attributes Field Name and Description
<static>  
IYY.ACTIVE
应用激活事件。当应用运行时,应用图标在应用盒子或者其他应用入口被点击时产生的事件。
 
获取语音接口。
 
获取频道接口。
 
获取简单存储接口。
 
获取财务接口。
 
设置flash对象的Id,能够根据此Id获得flash对象,调用flash中的方法。设置后YY的回调事件才能转发给flash。
 
im
获取IM接口。
 
获取应用互动接口。
 
net
获取网络接口。
 
获取安全接口。
 
获取临时语音接口。
 
获取当前用户信息。
 
获取YY API的版本,是一个Object对象:
 
获取YY客户端的版本信息。返回YY的版本,是一个Object对象。
Method Summary
Method Attributes Method Name and Description
 
获取应用的展现方式。
Methods borrowed from class IYYCommon:
addEventListener, removeEventListener
Class Detail
IYY()
IYY 构造函数。
Field Detail
<static> IYY.ACTIVE
应用激活事件。当应用运行时,应用图标在应用盒子或者其他应用入口被点击时产生的事件。
侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.activeCode: Number类型,正整数,表示点击的来源,0=点击来源于应用盒子图标。
使用示例:
yy.addEventListener(IYY.ACTIVE,onActive);

function onActive(eventData)
{
   document.getElementById("txtLog").innerHTML="点击来源:"+eventData.activeCode;
}

{IYYAudio} audio
获取语音接口。
See:
IYYAudio

{IYYChannel} channel
获取频道接口。
See:
IYYChannel

{IYYCloud} cloud
获取简单存储接口。
See:
IYYCloud

{IYYFinance} finance
获取财务接口。
See:
IYYFinance

{String} flashId
设置flash对象的Id,能够根据此Id获得flash对象,调用flash中的方法。设置后YY的回调事件才能转发给flash。

{IYYIM} im
获取IM接口。
See:
IYYIM

{IYYInteraction} interaction
获取应用互动接口。
See:
IYYInteraction

{IYYNet} net
获取网络接口。
See:
IYYNet

{IYYSecurity} security
获取安全接口。
See:
IYYSecurity

{IYYTempAudioSession} tempAudioSession
获取临时语音接口。
See:
IYYTempAudioSession

{IYYUser} user
获取当前用户信息。
See:
IYYUser

{Object} version
获取YY API的版本,是一个Object对象:
版本对象包括属性如下:
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
majorVersion: Number类型 主版本号
minorVersion: Number类型 次版本号
成功的返回值示例:{ ret:0, majorVersion:1, minorVersion:13 }
失败的返回值示例:{ ret:984832}

{Object} yyVersion
获取YY客户端的版本信息。返回YY的版本,是一个Object对象。
版本对象包括属性如下:
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
version: String类型 YY客户端主版本信息。发布版本典型的版本格式为"YY 4.17.0.3",注意空格。获取失败时返回空字符串。
成功的返回值示例:{ ret:0, version:"YY 4.17.0.3" }
失败的返回值示例:{ ret:984832}
Method Detail
{Object} getWebAppShowMode()
获取应用的展现方式。
使用示例:
var result=yy.getWebAppShowMode();
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML="应用展现模式为 mode="+result.mode;
}
else
{
    document.getElementById("txtLog").innerHTML="获取出错,错误码ret="+result.ret;
}
成功的返回值示例:{ ret:0,mode:"PopWindow"}
失败的返回值示例:{ ret:984832}
Returns:
返回应用展现方式,是Object对象格式,具体属性如下:
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
mode: String类型 应用的展现方式。其中
SubWindow=公告,应用在公告区域展现。
PopWindow=弹窗,应用弹出一个窗口展现。
FullTemplate=全模板,在频道窗口右侧展现,会隐藏公屏聊天区域。
EmbedTemplate=半模板,应用在频道窗口中间位置展现,保留公屏聊天区域。
TabPage=tab页,应用在一个新Tab页中展现。


Documentation generated by JsDoc Toolkit 2.4.0