文档中心 > 店铺动态卡片-开发指引

API概览

更新时间:2022/06/30 访问次数:259242

基础

应用级事件

名称

功能说明

my.onAppShow

监听小程序切前台事件

my.offAppShow

取消监听小程序切前台事件

my.onAppHide

监听小程序切后台事件

my.offAppHide

取消监听小程序切后台事件

my.onError

监听小程序错误事件

my.offError

取消监听小程序错误事件

my.onUnhandledRejection

监听未处理的 Promise 拒绝事件

my.offUnhandledRejection

取消监听未处理的 Promise 拒绝事件

分包加载

名称

功能说明

my.loadSubPackage

分包加载

插件

名称

功能说明

my.getParentAppIdSync

在插件中获取宿主小程序AppId

my.loadPlugin

加载动态插件

更新

名称

功能说明

my.getUpdateManager

获取版本更新管理器

界面

导航栏

名称

功能说明

my.setNavigationBar

设置导航栏文字及样式。

my.hideBackHome

隐藏回首页按钮

路由

名称

功能说明

my.switchTab

跳转到指定 tabBar 页面,并关闭其他所有非 tabBar 页面

my.reLaunch

关闭当前所有页面,跳转到应用内的某个指定页面。

my.redirectTo

关闭当前页面,跳转到应用内的某个指定页面。

my.navigateTo

当前页面,跳转到应用内的某个指定页面,以使用 my.navigateBack 返回到原来页面。

my.navigateBack

关闭当前页面,返回上一级或多级页面

TabBar

名称

功能说明

my.hideTabBar

隐藏 tabBar

my.hideTabBarRedDot

隐藏 tabBar 某一项的右上角的红点

my.removeTabBarBadge

移除 tabBar 某一项右上角的文本

my.setTabBarBadge

为 tabBar 某一项的右上角添加文本

my.setTabBarItem

动态设置 tabBar 某一项的内容

my.setTabBarStyle

动态设置 tabBar 的整体样式

my.showTabBar

显示 tabBar

my.showTabBarRedDot

显示 tabBar 某一项的右上角的红点

onTabItemTap

点击 tab 时触发

交互反馈

名称

功能说明

my.alert

警告框

my.confirm

确认框

my.hideLoading

隐藏加载提示

my.hideToast

隐藏弱提示

my.prompt

弹出一个对话框,让用户在对话框内输入文本。

my.showActionSheet

显示操作菜单

my.showLoading

显示加载提示

my.showToast

显示一个弱提示,可选择多少秒之后消失。

下拉刷新

名称

功能说明

my.startPullDownRefresh

开始下拉刷新

my.stopPullDownRefresh

停止下拉刷新

选择城市

名称

功能说明

my.chooseCity

打开城市选择列表

选择日期

名称

功能说明

my.datePicker

打开日期选择列表

动画

名称

功能说明

my.createAnimation

创建动画实例

画布

名称

功能说明

my.createCanvasContext

创建 canvas 绘图上下文

地图

名称

功能说明

my.createMapContext

创建并返回一个 map 上下文对象 mapContext

键盘

名称

功能说明

my.hideKeyboard

隐藏键盘

滚动

名称

功能说明

my.pageScrollTo

滚动到页面的目标位置

节点查询

名称

功能说明

my.createSelectorQuery

获取一个节点查询对象 SelectorQuery

设置窗口背景

名称

功能说明

my.setBackgroundTextStyle

设置窗口背景样式

my.setBackgroundColor

设置窗口背景颜色

选项选择器

设置页面是否支持下拉

名称

功能说明

my.setCanPullDown

设置页面是否支持下拉

选项选择器

名称

功能说明

my.optionsSelect

选项选择器

多媒体

图片

名称

功能说明

my.chooseImage

拍照或从手机相册中选择图片

my.compressImage

压缩图片

my.saveImage

保存图片到相册

my.previewImage

预览图片

my.getImageInfo

获取图片信息

视频

名称

功能说明

my.chooseVideo

拍摄视频或从手机相册中选视频

my.saveVideoToPhotosAlbum

保存视频到相册

my.createVideoContext

创建视频

音频

名称

功能说明

my.createInnerAudioContext

创建音频

录音

名称

功能说明

my.getRecorderManager

获取录音管理器

文件

名称

功能说明

my.getFileInfo

获取文件信息

my.saveFile

保存文件到本地

my.getSavedFileInfo

获取保存的文件信息

my.getSavedFileList

获取保存的所有文件信息

my.removeSavedFile

删除某个保存的文件

my.getFileSystemManager

获取全局唯一的文件管理器

缓存

名称

功能说明

my.clearStorage

清除本地数据缓存的异步接口

my.clearStorageSync

清除本地数据缓存的同步接口

my.getStorage

获取缓存数据的异步接口

my.getStorageInfo

获取当前 storage 的相关信息的异步接口

my.getStorageInfoSync

获取当前 storage 相关信息的同步接口

my.getStorageSync

获取缓存数据的同步接口

my.removeStorage

删除缓存数据的异步接口

my.removeStorageSync

删除缓存数据的同步接口

my.setStorage

将数据存储在本地缓存中指定的 key 中的异步接口

my.setStorageSync

同步将数据存储在本地缓存中指定的 key 中的同步接口

位置

名称

功能说明

my.getLocation

获取用户当前的地理位置信息

my.chooseLocation

使用高德地图选择地理位置

my.openLocation

小程序使用淘宝内置地图查看位置

网络

上传

名称

功能说明

my.uploadFile

上传本地资源到开发者服务器,注意该接口仅支持上传到官方域名,若需要上传其他环境,需要申请白名单

下载

名称

名称

my.downloadFile

下载网络资源到本地,注意该接口仅支持从官方域名下载资源,若需要其他环境,需要申请白名单

发起请求

名称

名称

my.tb.request

发起http请求(仅限轻应用小程序使用)

Websocket通信

名称

名称

my.connectSocket

创建一个Websocket连接

设备

canIUse

名称

功能说明

my.canIUse

判断当前小程序的 API、入参或返回值、组件、属性等在当前版本是否支持

获取基础库版本号

名称

功能说明

my.SDKVersion

获取基础库版本号

系统信息

名称

功能说明

my.getSystemInfoSync

获取手机系统信息的同步接口

my.getSystemInfo

获取手机系统信息

网络状态

名称

功能说明

my.getNetworkType

获取当前网络状态

my.onNetworkStatusChange

开始网络状态变化的监听

my.offNetworkStatusChange

取消网络状态变化的监听

设备方向

名称

功能说明

my.offDeviceMotionChange

解除设备方向监听

my.onDeviceMotionChange

监听设备方向

剪贴板

名称

功能说明

my.setClipboard

设置剪贴板数据

my.getClipboard

获取剪贴板数据

摇一摇

名称

功能说明

my.watchShake

摇一摇功能

振动

名称

功能说明

my.vibrate

调用振动功能

my.vibrateShort

较短时间的振动 (40ms)

my.vibrateLong

较长时间的振动 (400ms)

加速度计

名称

功能说明

my.onAccelerometerChange

监听加速度数据

my.offAccelerometerChange

停止监听加速度数据

加速度计

名称

功能说明

my.onAccelerometerChange

监听加速度数据

my.offAccelerometerChange

停止监听加速度数据

计步

名称

功能说明

my.tb.getStepsHistory

获取历史步数

my.tb.getDailySteps

获取当天步数

my.tb.supportStepCount

判断手机是否支持计步

my.tb.stepsAuthorizeStatus

判断手机健康权限是否申请

my.tb.requestStepsAuthorization

申请步数权限

my.tb.setStepCountStatus

设置步数自动上传状态

my.tb.getStepsStatus

获取步数自动上传状态

my.tb.requestManufacturerPermission

申请厂商权限

my.tb.checkManufacturerPermission

检查厂商健康授权状态

my.tb.requestSensorPermission

申请sensors权限

my.tb.checkSensorPermission

检查sensors权限

陀螺仪

名称

功能说明

my.onGyroscopeChange

监听陀螺仪数据变化事件

my.offGyroscopeChange

停止监听陀螺仪数据

打电话

名称

功能说明

my.makePhoneCall

拨打电话

发短信

名称

功能说明

my.sendSMS

发送短信

获取服务器时间

名称

功能说明

my.getServerTime

获取当前服务器时间的毫秒数

用户截屏

名称

功能说明

my.offUserCaptureScreen

取消监听截屏事件

my.onUserCaptureScreen

监听用户发起的主动截屏事件

屏幕亮度

名称

功能说明

my.getScreenBrightness

获取屏幕亮度

my.setScreenBrightness

设置屏幕亮度

my.setKeepScreenOn

设置屏幕常亮

设置

名称

功能说明

my.getSetting

获取用户的当前设置

my.openSetting

打开小程序设置界面,返回用户权限设置的结果

添加手机联系人

名称

功能说明

my.addPhoneContact

添加手机联系人

权限引导

名称

功能说明

my.showAuthGuide

显示系统权限引导界面

扫码

名称

功能说明

my.scan

调用扫一扫功能

内存不足告警

名称

功能说明

my.onMemoryWarning

开始监听内存不足的告警事件

my.offMemoryWarning

停止监听内存不足的告警事件

获取设备电量

名称

功能说明

my.getBatteryInfo

获取电量的异步接口

my.getBatteryInfoSync

获取电量的同步接口

传统蓝牙

名称

功能说明

my.openBluetoothAdapter

初始化小程序蓝牙模块

my.closeBluetoothAdapter

关闭本机蓝牙模块

my.getBluetoothAdapterState

获取本机蓝牙模块状态

my.getBluetoothDevices

获取所有已发现的蓝牙设备

my.getConnectedBluetoothDevices

获取处于已连接状态的设备

my.onBluetoothDeviceFound

搜索到新的蓝牙设备时触发此事件

my.offBluetoothDeviceFound

移除寻找到新的蓝牙设备事件的监听

my.startBluetoothDevicesDiscovery

开始搜寻附近的蓝牙外围设备

my.stopBluetoothDevicesDiscovery

停止搜寻附近的蓝牙外围设备

my.onBluetoothAdapterStateChange

监听本机蓝牙状态变化的事件

my.offBluetoothAdapterStateChange

取消监听本机蓝牙状态变化的事件

低功耗蓝牙

名称

功能说明

my.connectBLEDevice

连接低功耗蓝牙设备

my.disconnectBLEDevice

断开与低功耗蓝牙设备的连接

my.getBLEDeviceCharacteristics

获取蓝牙设备所有特征值

my.getBLEDeviceServices

获取蓝牙设备所有服务

my.notifyBLECharacteristicValueChange

启用低功耗蓝牙设备特征值变化时的 notify 功能

my.offBLECharacteristicValueChange

取消监听低功耗蓝牙设备的特征值变化的事件

my.offBLEConnectionStateChanged

取消监听低功耗蓝牙连接的错误事件,包括设备丢失,连接异常断开等

my.onBLECharacteristicValueChange

监听低功耗蓝牙设备的特征值变化的事件

my.onBLEConnectionStateChanged

监听低功耗蓝牙连接的错误事件,包括设备丢失,连接异常断开等

my.readBLECharacteristicValue

读取低功耗蓝牙设备特征值中的数据

my.writeBLECharacteristicValue

向低功耗蓝牙设备特征值中写入数据

my.setBLEMTU

设置蓝牙最大传输单元

iBeacons

名称

功能说明

my.getBeacons

获取已经搜索到的iBeacon设备

my.onBeaconUpdate

监听 iBeacon 设备的更新事件

my.offBeaconUpdate

取消监听 iBeacon 设备的更新事件

my.startBeaconDiscovery

开始搜索iBeacon设备

my.stopBeaconDiscovery

停止搜索iBeacon设备

my.offBeaconServiceChange

取消监听 iBeacon 服务的状态变化

my.onBeaconServiceChange

监听 iBeacon 服务的状态变化

Wi-Fi

名称

功能说明

my.connectWifi

连接Wifi

分享

名称

功能说明

my.hideShareMenu

隐藏分享按钮

my.showSharePanel

唤起分享面板

onShareAppMessage

在 Page 中定义 onShareAppMessage 函数,设置该页面的分享信息

开放能力 API

用户授权

名称

功能说明

my.authorize

获取用户授权

获取授权用户信息

名称

功能说明

my.getAuthUserInfo

获取授权用户信息

小程序跳转

名称

功能说明

my.navigateBackMiniProgram

跳转回上一个小程序,只有当另一个小程序跳转到当前小程序时才能调用成功。

my.navigateToMiniProgram

跳转到其他小程序

跳转淘宝官方页面

名称

功能说明

my.tb.navigateToTaobaoPage

打开淘宝官方页面

添加轻应用

名称

功能说明

my.tb.checkAddedStatus

查询轻应用是否被添加

获取用户设备ID

名称

功能说明

my.tb.getDeviceId

获取用户设备ID

自定义【更多】菜单

名称

功能说明

my.tb.setActionSheet

自定义更多菜单项

配置导航栏扩展能力

名称

功能说明

my.tb.addMenu

定制导航栏右侧按钮

日历提醒

名称

功能说明

my.tb.addCalendarPlan

添加日历提醒

my.tb.checkCalendarPlanIsExist

查询设置过的日历提醒

my.tb.cancelCalendarPlan

取消日历提醒异步接口

添加到桌面

名称

功能说明

my.tb.addToDesktop

添加小程序到桌面快捷方式

退出当前小程序

名称

功能说明

my.exit

退出当前小程序

错误页

名称

功能说明

my.tb.showErrorView

显示错误页

my.tb.hideErrorView

隐藏错误页

安全

名称

功能说明

my.tb.textRiskIdentification

文本风险识别

my.tb.imgRisk

图片内容安全

my.tb.preventCheat

业务风控营销反作弊

电商能力API

SKU

名称

功能说明

my.tb.showSku

显示指定商品 SKU 选择器

my.tb.hideSku

隐藏正在展示的商品 SKU 选择

商品

名称

功能说明

my.tb.collectGoods

收藏商品

my.tb.unCollectGoods

取消收藏商品

my.tb.checkGoodsCollectedStatus

检查商品是否被收藏

my.tb.openDetail

打开商品详情页

店铺

名称

功能说明

my.tb.favorShop

关注店铺

my.tb.checkShopFavoredStatus

查询店铺关注状态

my.tb.unFavorShop

取消关注店铺

购物车

名称

功能说明

my.tb.openCart

打开购物车

my.tb.addToCart

加入购物车

收货地址

名称

功能说明

my.tb.chooseAddress

打开收货地址选择器

消息

名称

功能说明

my.tb.openMessage

打开BC客服聊天

my.tb.subscribe

调起客户端小程序订阅消息界面,返回用户订阅消息的操作结果

订单

名称

功能说明

my.tb.confirmCustomOrder

跳转订单页

千牛端扩展API

请前往【API-千牛端扩展API】查看

webview组件控制

名称

功能说明

my.createWebViewContext

通过创建webviewContext提供从小程序向web-view发送消息的能力。创建并返回 web-view 上下文 webViewContext 对象。

数据安全

名称

功能说明

my.rsa

非对称加密

小程序当前运行版本类型

名称

功能说明

my.getRunScene

用于获取当前小程序的运行版本

自定义分析

名称

功能说明

my.reportAnalytics

自定义分析数据的上报接口

模板实例化

名称

功能说明

my.getExtConfig

获取模板ext.json中的ext配置

my.getExtConfigSync

同步获取模板ext.json中的ext配置

小部件

名称

功能说明

my.getRelationAppId

获取小部件关联的小程序AppID

my.getRelationAppInfo

获取小部件关联的小程序信息

my.tb.openScuCombination

打开组合购

my.setGestureMode

设置小部件手势交互模式

my.navigateToRelationMiniProgram

小部件跳转到关联的小程序

my.widgetDowngrade

小部件降级API

my.getSceneInfo

获取小部件场景信息

my.getBizData

获取商家配置的表单数据

FAQ

关于此文档暂时还没有FAQ
返回
顶部