Class IYYInteraction

Extends IYYCommon.
应用互动接口。能够提供邀请者的信息。
Defined in: yyapi.js.

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

Method Summary
Method Attributes	Method Name and Description
	createAppTicket(subChannelId, isJump) 生成当前应用的飞机票。
	getInviter() 获取邀请者uid,只有在被邀请启动应用才能获取成功。
	getRunParams() 获取应用交互启动参数。当应用通过网页的链接或者应用消息启动时，可以获取启动时设置的参数。
	invite(inviteType) 发送邀请。可以邀请当前所在子频道的所有人或者邀请指定用户。

Methods borrowed from class IYYCommon:: addEventListener, removeEventListener

Class Detail

IYYInteraction()

IYYInteraction 构造函数。

Method Detail

{Object} createAppTicket(subChannelId, isJump)

生成当前应用的飞机票。

使用示例:
var result = yy.interaction.createAppTicket(478555775,false);
if (result.ret == 0) {
    document.getElementById("txtLog").innerHTML = "飞机票信息:"+result.appTicket;
}
成功的返回值示例:{ ret:0,appTicket:"yy://open-[sid=43671710&appid=114369&appn=SDK测试&uid=249267551&mid=0352292]/[SDK测试]"}
失败的返回值示例:{ ret:984832}

Parameters:
{Number} subChannelId: 应用所在子频道的长位id。
{Boolean} isJump: 运行飞机票时是否跳频道,如果false表示本频道有应用的话，不跳频道。

Returns:: 返回参数信息,是一个Object对象，具体属性如下。 ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
appTicket: String类型飞机票信息

{Object} getInviter()

获取邀请者uid,只有在被邀请启动应用才能获取成功。

使用示例:
var result = yy.interaction.getInviter();
if (result.inviterUid == 0) {
    document.getElementById("txtLog").innerHTML = "没有邀请者";
} else {
    document.getElementById("txtLog").innerHTML = "邀请者uid=" + result.inviterUid;
}
成功的返回值示例:{ ret:0,inviterUid:435345} ,{ ret:0,inviterUid:0}
失败的返回值示例:{ ret:984832}

Returns:: 邀请者信息，是一个Object对象，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
inviterUid: Number类型邀请者的uid,如果没有邀请者inviterUid=0

{String} getRunParams()

获取应用交互启动参数。当应用通过网页的链接或者应用消息启动时，可以获取启动时设置的参数。

使用示例：
var result=yy.interaction.getRunParams();
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML = "启动参数=" + result.runParams;
}
通过应用消息启动应用：
返回启动参数的格式为{ret:0,runParams:"{\"cookie\":8888,\"user_data\":0}"}，其中cookie的值是在发送应用消息的时候设置的token值。


通过应用飞机票或者网页链接启动应用：
典型飞机票链接格式如下yy://pd-[sid=43670710&appid=100901&userData=hellobabby] 
其中sid是频道id，appid是应用id，userData就是启动参数，是一个字符串。
示例的应用飞机票返回的启动参数为{ret:0,runParams:"hellobabby"}

通过其他方式启动应用
返回空字符串。{ret:0,runParams:""}

Returns:: 返回参数信息,是一个Object对象，具体属性如下。 ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
runParams: String类型启动参数信息

{Object} invite(inviteType)

发送邀请。可以邀请当前所在子频道的所有人或者邀请指定用户。

Parameters:
{Number} inviteType: 邀请的类型，1=邀请子频道所有人(子频道人数大于50调用无效)，2=邀请指定用户(将会打开窗口来选择用户列表)，其他值无效。

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

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

Classes

Class IYYInteraction