yixin

来自于:开发者立即使用

概述

本模块封装了易信sdk。

在集成此模块之前需要先配置config文件

  • 名称:yixin
  • 参数:appID、urlScheme
  • 配置示例:
<feature name="yixin"> 
<param name="appID" value="" /> 
<param name="urlScheme" value="wxd0d84bbf23b4a0e4"/>
</feature>
  • 字段描述:

    urlScheme:(必须配置)用于实现应用间跳转及数据交换(此时需要云编译或自定义loader才能测试本功能)。urlScheme 的 value 值由字符串 ‘yixin’ 和本应用的 widgetId 拼接而成

    appID:(必须配置)易信开放平台注册的开发者ID。

模块接口

isYXAppInstalled

检查易信客户端是否已安装

isYXAppInstalled(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true  //布尔类型;易信已安装返回true,未安装返回false

}

示例代码

var yixin = api.require('yixin');
yixin.isYXAppInstalled(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

isYXAppSupportApi

判断当前易信客户端的版本是否支持易信分享

isYXAppSupportApi(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true  //布尔类型;支持返回true,不支持返回false     
}

示例代码

var yixin = api.require('yixin');
yixin.isYXAppSupportApi(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

isYXAppSupportOAuth

判断当前易信客户端的版本是否支持OAuth授权

isYXAppSupportOAuth(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true  //布尔类型;支持返回true,不支持返回false     
}

示例代码

var yixin = api.require('yixin');
yixin.isYXAppSupportOAuth(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

isYXAppSupportFav

判断当前易信客户端的版本是否支持收藏到易信功能

isYXAppSupportFav(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true  //布尔类型;支持返回true,不支持返回false     
}

示例代码

var yixin = api.require('yixin');
yixin.isYXAppSupportFav(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

openYXApp

打开易信客户端

openYXApp(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true  //布尔类型;成功返回true,失败返回false     
}

示例代码

var yixin = api.require('yixin');
yixin.openYXApp(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

setListener

设置监听

setListener(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   eventType:"onReceiveRequest", // 字符串;返回事件类型;       
   resp:{ // JSON对象,消息内容 **note:仅 onReceiveResponseOAuth、onReceiveResponseMessage事件类型返回**
     code:0,//数字类型;0成功,其他失败  
     errDescription:'',//字符串类型;失败信息
     oauth:{ //json对象;onReceiveResponseOAuth返回
         authCode:'',//字符串类型;code
         authToken:'',//字符串类型;token
         state:'',//字符串类型;state
         exprieSeonds:6//数字类型;exprieSeonds
     }
   }       
}

eventType:

  • 类型:字符串
  • 取值范围:
    • onReceiveRequest // 收到一个来自易信客户端的请求消息
    • onReceiveResponseMessage //易信客户端向第三方App返回的处理结果
    • onReceiveResponseOAuth // 易信客户端向第三方App返回的OAuth认证结果

示例代码

var yixin = api.require('yixin');
yixin.setListener(function(ret) {
    alert(JSON.stringify(ret));
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

sendOauthCodeReq

发送oauthcode请求

sendOauthCodeReq(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true  //布尔类型;成功返回true,失败返回false     
}

示例代码

var yixin = api.require('yixin');
yixin.sendOauthCodeReq(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本