Packageyy
Interfacepublic interface IInteraction extends flash.events.IEventDispatcher

应用互动接口。能够提供邀请者的信息。



Public Methods
 MethodDefined By
  
createAppTicket(subChannelId:uint, isJump:Boolean):Object
生成当前应用的飞机票。
IInteraction
  
getInviter():Object
获取邀请者uid,只有在被邀请启动应用才能获取成功。
IInteraction
  
getRunParams():Object
获取应用交互启动参数。当应用通过网页的链接或者应用消息启动时,可以获取启动时设置的参数。
IInteraction
  
invite(inviteType:int):Object
发送邀请。可以邀请当前所在子频道的所有人或者邀请指定用户。
IInteraction
Method Detail
createAppTicket()method
public function createAppTicket(subChannelId:uint, isJump:Boolean):Object

生成当前应用的飞机票。

Parameters

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

Returns
Object — 返回飞机票信息,是一个Object对象,具体属性如下。

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

appTicket:String类型 飞机票信息


Example
         使用示例:
         var result = yy.interaction.createAppTicket(45875558,true);
         if (result.ret == 0) {
             trace("当前应用飞机票:"+result.appTicket);
         }
         成功的返回值示例:{ ret:0,appTicket:"yy://open-[sid=43671710&appid=114369&appn=SDK测试&uid=249267551&mid=0352292]/[SDK测试]"}
         失败的返回值示例:{ ret:984832}
         
getInviter()method 
public function getInviter():Object

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

Returns
Object — 邀请者信息,是一个Object对象,具体属性如下。

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

inviterUid: Number类型 邀请者的uid,如果没有邀请者inviterUid=0,


Example
         使用示例:
         var result = yy.interaction.getInviter();
         if (result.inviterUid == 0) {
             trace("没有邀请者");
         } else {
             trace("邀请者uid=" + result.inviterUid);
         }
         成功的返回值示例:{ ret:0,inviterUid:435345}
         失败的返回值示例:{ ret:984832}
         
getRunParams()method 
public function getRunParams():Object

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

Returns
Object — 返回参数信息,是一个Object对象,具体属性如下。

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

runParams: String类型 启动参数信息


Example
         使用示例:
         var result:Object=YY.instance.interaction.getRunParams();
         if(result.ret==0)
         {
             trace("启动参数=" + 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:""}
         
invite()method 
public function invite(inviteType:int):Object

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

Parameters

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

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

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