fusion2.dialog.addClientPanel

目录

1 接口使用权限

开发者的星级为1星及以上,可申请本接口的使用权限。
调用本接口前,请按照模版提交API接口权限申请(申请方式详见这里),以获取接口调用权限。


2 功能说明

1. 接口类型:前端JS接口。
2. 接口功能:将应用图标添加到QQ主面板。
3. 功能描述:
(1)要实现将应用图标添加到QQ主面板的功能,只需在应用的前端页面代码中调用本接口,并在应用的界面上放置类似“添加到QQ主面板”的按钮。
(2)用户在应用中点击“添加到QQ主面板”按钮后,弹出“应用管理器”弹框,用户在弹框的“应用中心”页签,可以看到应用图标。
(3)用户点击“添加”,确认设置成功后,即可将应用图标添加到QQ主面板。


3 场景说明

3.1 入口说明

建议应用通过任务或者活动的形式,引导用户将应用的快捷方式设置在QQ主面板上。
示例如下:
addClientPanel_1.png

3.2 效果展示

(1)用户点击“添加到QQ主面板”按钮或链接后,弹出“应用管理器”弹框,用户在弹框的“应用中心”页签,可以看到应用图标,如下图所示:
addClientPanel_2.png

(2)点击应用下的“+添加”,在下面的“主面板上的应用”模块,即会展示添加的应用图标。

(3)关闭“应用管理器”弹框时,会弹出确认弹框,点击“设置成功”,即可将应用图标添加到QQ主面板。
addClientPanel_3.png


4 接口调用说明

调用本前端接口前,应用中应该部署Fusion2的跨域文件以及引用脚本,请参阅:Fusion2文档

4.1 参数说明

参数名称 是否必须 类型 描述
context string 参数描述:透传参数,用于onSuccess和onCancel回调,以识别请求。

透传方式:调用本接口时传入该参数,onSuccess或onCancel回调时,在JS中使用opt.context即可获取该透传参数(opt为本接口的回调函数形参)。
例如用户操作成功后,会回调onSuccess时获取该参数的值:

onSuccess : function (opt) 
  {       
      alert("Succeeded: " + opt.context);  
  }
onSuccess 参数描述:用户操作成功后的回调方法。

方法要求: 回调函数的定义符合标准JS函数定义方式,即:function (opt)。
触发条件:用户点击弹出框中的“设置成功”按钮,弹出框关闭。

onCancel 参数描述:用户取消操作后的回调方法。

方法要求: 回调函数的定义符合标准JS函数定义方式,即:function (opt)。
触发条件:用户点击取消或弹出框右上角的×按钮,弹出框关闭。用户取消时将同时关闭对话框,因此将先触发onCancel回调再触发onClose回调。

onClose 参数描述:对话框关闭时的回调方法。主要用于对话框关闭后进行UI方面的调整,onSuccess和onCancel则用于应用逻辑的处理,避免过度耦合。

方法要求: 回调函数的定义符合标准JS函数定义方式,即:function (opt)。
触发条件:用户点击取消或弹出框右上角的×按钮,弹出框关闭。用户取消时将同时关闭对话框,因此将先触发onCancel回调再触发onClose回调。

4.2 调用示例

fusion2.dialog.addClientPanel

({

  context : "add_Client_Panel_1",


  onSuccess : function (opt) 
  {  
      // opt.context:可选。opt.context为调用该接口时的context透传参数,以识别请求
      alert("Succeeded: " + opt.context);  
  },


  onCancel : function (opt) 
  {  
      // opt.context:可选。opt.context为调用该接口时的context透传参数,以识别请求
      alert("Cancelled: " + opt.context);  
  },


  onClose : function (opt) 
  {  
      alert("Closed"); 
  }

});

4.3 返回码说明

返回码 含义说明
1000 没有登录。
1001 无效的appid。
-1 系统错误。

5 使用建议

5.1 添加按钮

1. 对用户的限制越少越好,最后所有用户都可以看到该添加按钮。
2. 按钮未点击时,最好有动态效果,容易吸引用户注意。
3. 按钮第一次出现时可以直接弹框。

5.2 弹框设计

1. 弹框设计清晰、明确,可适当设置奖励。
2. 显示如果将应用图标添加到QQ主面板的操作流程,指引用户操作,并强调如下三点信息:
(1)增加安装QQ最新版本(QQ2013 beta3及之后版本)的指引,下载地址:http://im.qq.com/qq/2013/
(2)强调需要点击“添加”按钮才可以添加到主面板,而非点击应用图标;
(3)强调关闭应用管理器才生效。 3. 在弹框中设置“立即添加”,点击后后弹出“应用管理器”弹框。

弹框示意图如下:
addClientPanel_4.png

用户添加应用图标到主面板成功后,弹框示意图如下:
addClientPanel_5.png

6 接口违规使用处罚

以下情况属于违规行为,将按照应用违规处罚#3. 对技术违规及运营违规的处罚规则的三级违规进行处罚。
(1)不能在用户进入应用后的第一步,未看到任何内容即弹出窗口引导用户添加。
(2)添加按钮旁无等同的明确关闭按钮。
(3)不能在应用的主流程中强制用户添加。

7 相关文档

v3/spread/is_app_onpanel

FAQ

详见:FusionAPI调用相关问题

以上信息是否解决您的问题?

Copyright © 1998 - 2018 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部