所有通用API均收敛到common
域下,可以在所有智能硬件中使用
closeWebView
getHomePage
getImages
getInfo
getStoreMemberCode
getFlagShipMemberCode
getBAMemberCode
getVideos
openSystemConfig
openWebView
turnOffAutoRefresh
turnOnAutoRefresh
所有API的入参如果没有特殊说明,均为必选参数
所有API均返回Promise
。返回数据通过then
的successCallback
返回;错误通过then
的failCallback
返回。
注:以下API的Data
章节描述的是successCallback
返回的数据
closeWebView
关闭当前webview容器
无
无
Tida.rop.call('common.closeWebView').then(function () { console.log('call common.closeWebView success'); }, function (err) { console.log(err); });
getHomePage
获取售货机首页URL
无
string // 首页URL
Tida.rop.call('common.getHomePage').then(function (url) { console.log(url); // console output // 'https://www.xxx.com/vending-machine' }, function (err) { console.log(err); });
getImages
获取首页图片链接数组
无
[] // 图片地址数组
Tida.rop.call('common.getImages').then(function (urls) { console.log(urls); }, function (err) { console.log(err); });
getInfo
获取设备信息
无
{ "mac": string // 设备mac地址 "deviceCode": string // 设备标识符 "mainPage": string // 首页地址 "registStatus": string // 设备状态(通常开发者不用关心) }
Tida.rop.call('common.getInfo').then(function (data) { console.log(data); // console output: // { // "mac": "00:0C:29:01:98:27", // "deviceCode": "33333", // "mainPage": "https://www.taobao.com", // "registStatus": "0" // } }, function (err) { console.log(err); });
getStoreMemberCode
获取门店入会二维码。生成的二维码图片会添加到container元素中,作为元素的child
{ deviceCode: string // 设备端调用时可选,非设备端调用必传 uniCrmId: string // 会员体系ID storeId: string // 门店ID callbackUrl: string // 报告的url地址 reportCardImg: string // 报告卡片的图片地址 container: HTMLElement // 二维码的父容器,二维码生成后,会添加到父容器上 itemIds: string[] // (可选)推荐商品列表,将显示在报告页面的底部,最多4个。 }
无
Tida.rop.call('common.getStoreMemberCode', { deviceCode: 'dc_1234', uniCrmId: '2123456', storeId: '1233456', callbackUrl: 'https://foo.com/foo-report.html', reportCardImg: 'https://gw.alicdn.com/tfs/TB1FbSEobwrBKNjSZPcXXXpapXa-702-300.png', container: document.getElementById('***'), itemIds: ['3213', '12332', '1234', '4566'] }).then(function (data) { console.log(data); }, function (err) { console.log(err); });
getFlagShipMemberCode
获取旗舰店入会二维码。生成的二维码图片会添加到container元素中,作为元素的child
{ deviceCode: string // 设备端调用时可选,非设备端调用必传 uniCrmId: string // 会员体系ID callbackUrl: string // 报告的url地址 reportCardImg: string // 报告卡片的图片地址 container: HTMLElement // 二维码的父容器,二维码生成后,会添加到父容器上 itemIds: string[] // (可选)推荐商品列表,将显示在报告页面的底部,最多4个。 }
无
Tida.rop.call('common.getFlagShipMemberCode', { deviceCode: 'dc_1234', uniCrmId: '2123456', callbackUrl: 'https://foo.com/foo-report.html', reportCardImg: 'https://gw.alicdn.com/tfs/TB1FbSEobwrBKNjSZPcXXXpapXa-702-300.png', container: document.getElementById('***'), itemIds: ['3213', '12332', '1234', '4566'] }).then(function (data) { console.log(data); }, function (err) { console.log(err); });
getBAMemberCode
获取导购员入会二维码。生成的二维码图片会添加到container元素中,作为元素的child
{ deviceCode: string // 设备端调用时可选,非设备端调用必传 uniCrmId: string // 会员体系ID storeId: string // 门店ID baIphoneNum: string // 导购员手机号 container: HTMLElement // 二维码的父容器,二维码生成后,会添加到父容器上 }
无
Tida.rop.call('common.getBAMemberCode', { deviceCode: 'dc_1234', uniCrmId: '2123456', storeId: '1233456', baIphoneNum: '13333338888', container: document.getElementById('***'), }).then(function (data) { console.log(data); }, function (err) { console.log(err); });
getVideos
获取首页视频链接数组。
无
[] // 视频地址数组
Tida.rop.call('common.getVideos').then(function (urls) { console.log(urls); }, function (err) { console.log(err); });
openSystemConfig
跳转安卓系统设置
无
无
Tida.rop.call('common.openSystemConfig');
openWebView
打开新的webview容器
{ url: string // 容器打开的页面url }
无
Tida.rop.call('common.openWebView', { url: 'https://www.taobao.com' });
turnOffAutoRefresh
关闭首页变化时的自动刷新功能。
无
无
Tida.rop.call('common.turnOffAutoRefresh');
turnOnAutoRefresh
首页变化时,自动刷新。开启后,会自动和服务器同步一次首页地址。如果首页地址和当前地址不一致,则会跳转到首页。并且,之后每隔30s都会执行一次上述流程。
无
无
Tida.rop.call('common.turnOnAutoRefresh');