alibcthb

来自于：开发者立即使用

initSDK login logout getUserInfo setForceH5 setSyncForTaoke setTaokeParams setChannel setISVCode setISVVersion show

概述

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

模块接口

initSDK

初始化百川SDK

initSDK(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，初始化成功与失败
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0,     //数字类型；错误码，请查找百川SDK错误code
  3.     msg: ""      //字符串类型：错误原因
  4. }

示例代码

  1. var alibcthb = api.require('alibcthb');
  2. alibcthb.initSDK(function(ret, err) {
  3.     if(err){
  4.         alert("初始化失败 code = " + err.code + "; msg = " + err.msg);
  5.     } else {
  6.         alert("初始化成功");
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

login

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

login(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     nick: "往事最为梦幻",                               //String；用户昵称
  3.     avatarUrl: "https://wwc.alicdn.com/avatar/getAvatar.do?userIdStr=XHgbMHRhM0lzP8QuMCxGPGHLMkx0MHZIMkgbv8kbXmgT&width=160&height=160&type=sns",   //String：用户头像地址
  4.     openId":"AAETTbMGAFaT-2JKLWWbVnWf",                 //String: 
  5.     openSid:"62b39aca5e0e7bd4559257a28a9e3a76f0d71a7d5f831a3bd28e84161b68d595ca85ab68681bccfa4f8b14a740f0c111",   //String:
  6.     userid:"2618653117",    //String
  7.     topAccessToken:"6300c1163f32580fefdb7de031c84d8a20699b43a76c7452618653117",   //String
  8.     topAuthCode:"x2YDvq854ezT9LfMp8AkpIoA12614355"     //String
  9. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0,     //Number；错误码
  3.     msg: ""      //String：错误信息
  4. }

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

logout

退出登录

logout(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false  退出成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0,     //数字类型；错误码
  3.     msg: ""      //退出失败信息
  4. }

示例代码

  1. var alibcthb = api.require('alibcthb');
  2. alibcthb.logout(function(ret, err) {
  3.     if(err){
  4.         alert("登录失败 code = " + err.code + "; msg = " + err.msg);
  5.     } else {
  6.         alert("退出登录" + ret.status ? "成功" : "失败");
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getUserInfo

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

getUserInfo()

成功返回：

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

失败返回：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setForceH5

是否走强制H5逻辑

setForceH5({params})

params

status：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setSyncForTaoke

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

setSyncForTaoke({params})

params

status：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setTaokeParams

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

setTaokeParams({params})

params

pid：

  • 类型：字符串
  • 描述：pid

unionId：

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

subPid：

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

示例代码

  1. var alibcthb = api.require('alibcthb');
  2. alibcthb.setTaokeParams({pid: 'mm_44749042_46692263_1407390175'});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setChannel

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

setChannel({params})

params

typeName：

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

channelName：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setISVCode

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

setISVCode({params})

params

isvCode：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setISVVersion

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

setISVVersion({params})

params

isvVersion：

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

示例代码

  1. var alibcthb = api.require('alibcthb');
  2. var status = alibcthb.setISVVersion({isvVersion:'1.0.0'});
  3. 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：

  • 类型：字符串
  • 描述：在指定的frameName中打开webView, 如果不传就会在当前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 对象
  • 内部字段：
  1. {
  2.     resultType: 1,      //整型；0||1 0:增加到购物车 1:购买成功
  3.     paySuccessOrders: ["658921463579862"],        //字符串数组，支付成功的订单号
  4.     payFailedOrders:["45689765143249687"]         //字符串数组，支付失败的订单号
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0,     //数字类型；
  3.     msg:""       //错误原因
  4. }

示例代码

  1. var alibcthb = api.require('alibcthb');
  2. alibcthb.show({
  3.     openType:2,
  4.     page: { //打开url
  5.         type:"url",
  6.         url:"https://www.baidu.com"
  7.     },
  8.     // page:{
  9.     //     type:"detail",
  10.     //     itemId: "587113182991",
  11.     // },
  12.     // page:{
  13.     //     type:"shop",
  14.     //     shopId:"588254576353"
  15.     // },
  16.     // page:{
  17.     //     type:"addCart",
  18.     //     itemId: "587113182991",
  19.     // },
  20.     // page:{
  21.     //     type:"myOrders",
  22.     //     status: 0,
  23.     //     allOrder: false,
  24.     // },
  25.     // page:{
  26.     //     type:"myCarts"
  27.     // }
  28. }, function(ret, err) {
  29.     if (ret.status) {
  30.         alert(JSON.stringify(ret));
  31.     } else {
  32.         alert(JSON.stringify(err));
  33.     }
  34. });

补充说明

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本