- 模块接口
- 示例代码
setForceH5
setSyncForTaoke
setTaokeParams
setChannel
setISVCode
setISVVersion
show

alibcthb

initSDK logout setForceH5 setTaokeParams setISVCode show

概述

本模块封装了阿里百川所有方法，android与ios通用

initSDK

初始化百川SDK

initSDK(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

err：

类型：JSON 对象
内部字段：


    code: 0,     //数字类型；错误码，请查找百川SDK错误code
    msg: ""      //字符串类型：错误原因
}

示例代码

var alibcthb = api.require('alibcthb');
alibcthb.initSDK(function(ret, err) {
    if(err){
        alert("初始化失败 code = " + err.code + "; msg = " + err.msg);
    } else {
        alert("初始化成功");
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

login

登录淘宝或者天猫，如果手机装了淘宝或天猫APP则会打开淘宝或天猫，如果没装会打开H5登录页面

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    nick: "往事最为梦幻",                               //String；用户昵称
    avatarUrl: "https://wwc.alicdn.com/avatar/getAvatar.do?userIdStr=XHgbMHRhM0lzP8QuMCxGPGHLMkx0MHZIMkgbv8kbXmgT&width=160&height=160&type=sns",   //String：用户头像地址
    openId":"AAETTbMGAFaT-2JKLWWbVnWf",                 //String: 
    openSid:"62b39aca5e0e7bd4559257a28a9e3a76f0d71a7d5f831a3bd28e84161b68d595ca85ab68681bccfa4f8b14a740f0c111",   //String:
    userid:"2618653117",    //String
    topAccessToken:"6300c1163f32580fefdb7de031c84d8a20699b43a76c7452618653117",   //String
    topAuthCode:"x2YDvq854ezT9LfMp8AkpIoA12614355"     //String
}

err：

类型：JSON 对象
内部字段：

{
    code: 0,     //Number；错误码
    msg: ""      //String：错误信息
}

示例代码

var alibcthb = api.require('alibcthb');
alibcthb.login(function(ret, err) {
    if(err){
        alert("登录失败 code = " + err.code + "; msg = " + err.msg);
    } else {
        alert("登录成功：" + JSON.stringify(ret));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

logout

退出登录

logout(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
}

err：

类型：JSON 对象
内部字段：

示例代码

var alibcthb = api.require('alibcthb');
alibcthb.logout(function(ret, err) {
    if(err){
        alert("登录失败 code = " + err.code + "; msg = " + err.msg);
    } else {
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getUserInfo

获取登录用户的信息，此方法为同步方法，调用后会立即返回数据

getUserInfo()

成功返回：

{
    nick: "往事最为梦幻",                               //String；用户昵称
    avatarUrl: "https://wwc.alicdn.com/avatar/getAvatar.do?userIdStr=XHgbMHRhM0lzP8QuMCxGPGHLMkx0MHZIMkgbv8kbXmgT&width=160&height=160&type=sns",   //String：用户头像地址
    openId":"AAETTbMGAFaT-2JKLWWbVnWf",                 //String: 
    openSid:"62b39aca5e0e7bd4559257a28a9e3a76f0d71a7d5f831a3bd28e84161b68d595ca85ab68681bccfa4f8b14a740f0c111",   //String:
    userid:"2618653117",    //String
    topAccessToken:"6300c1163f32580fefdb7de031c84d8a20699b43a76c7452618653117",   //String
    topAuthCode:"x2YDvq854ezT9LfMp8AkpIoA12614355"     //String
}

失败返回：

{
    code: 9000,        //Number : 错误码
    msg: "用户未登录"  //String : 错误信息
}

示例代码

var alibcthb = api.require('alibcthb');
var userInfo = alibcthb.getUserInfo();
if(typeof userInfo.code === 'undefined'){
    alert("获取用户信息成功:" + JSON.stringify(userInfo));
} else {
    alert("获取用户信息失败: code = " + userInfo.code + "; msg = " + userInfo.msg);
}

iOS系统，Android系统

可提供的1.0.0及更高版本

setForceH5

setForceH5({params})

params

status：

类型：Boolean
描述：true：全部页面均为H5打开

示例代码

var alibcthb = api.require('alibcthb');
var status = alibcthb.setForceH5({status: true});
alert("设置强制H5"+ status ? "成功" : "失败");

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setSyncForTaoke

设置是否使用同步淘客打点

setSyncForTaoke({params})

params

status：

类型：Boolean
描述：true:使用淘客同步打点

示例代码

var alibcthb = api.require('alibcthb');
var status = alibcthb.setSyncForTaoke({status: true});
alert("设置同步淘客打点" + status ? "成功" : "失败");

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setTaokeParams

设置全局淘客参数，方便开发者用同一个淘客参数，不需要在show接口重复传入注意：初始化完成后调用才能生效如果是组合参数，则只需要传pid就可例：mm_44749042_46692263_1407390175

setTaokeParams({params})

params

pid：

类型：字符串
描述：pid

unionId：

类型：字符串
描述：unionId, 可不传
默认值：空字符串

subPid：

类型：字符串
描述：subPid 可不传
默认值：空字符串

示例代码

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setChannel

设置渠道信息（如果有渠道专享价，需要设置）注意：初始化完成后调用才能生效

setChannel({params})

params

typeName：

类型：字符串
描述：渠道类型
默认：””

channelName：

类型：字符串
描述：渠道名
默认：””

var alibcthb = api.require('alibcthb');
alibcthb.setChannel({
    typeName:"channelType",
    channelName: "c_name"
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setISVCode

设置App标识字段，和isvcode同义，可用于区分使用本SDK的具体三方App

setISVCode({params})

params

isvCode：

类型：字符串
描述：isv code 字段
默认：””

示例代码

var alibcthb = api.require('alibcthb');
var status = alibcthb.setISVCode({isvCode: '123456'});
alert("设置ISV Code " + status ? "成功" : "失败");

可用性

iOS系统，Android系统

setISVVersion

设置三方App版本，可用于标识App版本

setISVVersion({params})

params

isvVersion：

类型：字符串
描述：版本号
默认：1.0.0

示例代码

var alibcthb = api.require('alibcthb');
var status = alibcthb.setISVVersion({isvVersion:'1.0.0'});
alert("设置ISV Version " + status ? "成功" : "失败");

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

show

打开指定页面注意：x,y,w,h四个参数只要其中一个不为0就会使用自定义的webView来打开页面，如果不需要使用自定义webView打开页面，可以不传这四个参数和fremeName、fixed参数

页面类型分类：

打开商品详情
打开店铺
增加到购物车
订单页面
购物车页面
打开指定Url地址

show({params}, callback(ret, err))

params

x：

类型：整数
描述：打开的webView窗口X位置
默认：0

y：

类型：整数
描述：打开的webView窗口Y位置
默认：0

w：

类型：整数
描述：打开的webView窗口宽度
默认：0

h：

类型：整数
描述：打开的webView窗口高度
默认：0

frameName：

类型：字符串

fixed：

类型：Boolean
描述：webView是否跟随frameName移动, true:webView会跟随fremeName一起移动
默认：false

openType：

类型：整数
描述：打开页面的方式
默认：0
取值范围：
- 0 自动选择
- 1 手淘，天猫打开
- 2 H5打开

ISVCode：

类型：字符串
描述：开发者代码，如果已经使用setISVCode设置过，则无需重复传入
默认：””

mmPID：

类型：字符串
描述：妈妈ID,如果已经使用setTaokeParams设置过，则无需重复传入
默认：””

page：

类型：对象,底下为此对象中的属性
描述：需要打开的页面参数

page.type:

类型：字符串
描述：打开页面类型
取值范围：
- detail: 商品详情页
- shop: 店铺页面
- addCart: 增加商品到物车
- myOrders: 订单面
- myCarts: 购物车页面
- url: 打开Url地址

page.itemId:

类型：字符串
描述：商品itemId，（注意：只有type为detail、addCart时才需要传入）

page.shopId:

类型：字符串
描述：店铺id (注意：只有type为shop时才需要传入)

page.status:

类型：整型
描述：打开指定状态的订单（注意：只有type为myOrders才需要传入）
默认值：0
取值范围：
- 0 ：全部订单
- 1 : 待付款订单
- 2 : 待发货订单
- 3 : 待收货订单
- 4 : 待评价订单

page.allOrder:

类型：Boolean
描述：是否显示全部订单
默认值：false
取值范围：
- true : 显示全部订单
- false: 显示开发者自己创建的订单

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    paySuccessOrders: ["658921463579862"],        //字符串数组，支付成功的订单号
    payFailedOrders:["45689765143249687"]         //字符串数组，支付失败的订单号
}

err：

类型：JSON 对象
内部字段：

{
    code: 0,     //数字类型；
    msg:""       //错误原因
}

示例代码

var alibcthb = api.require('alibcthb');
alibcthb.show({
    openType:2,
    page: { //打开url
        type:"url",
        url:"https://www.baidu.com"
    },
    // page:{
    //     type:"detail",
    //     itemId: "587113182991",
    // },
    // page:{
    //     type:"shop",
    //     shopId:"588254576353"
    // },
    // page:{
    //     type:"addCart",
    //     itemId: "587113182991",
    // },
    // page:{
    //     type:"myOrders",
    //     status: 0,
    //     allOrder: false,
    // },
    // page:{
    //     type:"myCarts"
    // }
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));

此接口需要访问网络，异步调用 callback 需要一段时间才能返回用户信息

可用性

可提供的1.0.0及更高版本