• Welcome to Journal web site.
首页 关于 博客 留言 联系
首页 关于 博客 留言 联系

我是 PHP 程序员

- 开发无止境 -

没有了
Prev

百度小程序-API

Data: 2018-12-01 19:14:54Form: JournalClick: 2

# API

  • 小程序开发框架提供丰富的原生 API
  • 多数 API 的回调都是异步，你需要处理好代码逻辑的异步问题
一级分类二级分类API描述
基础应用级事件swan.onPageNotFound监听小程序要打开的页面不存在事件。该事件与 App.onPageNotFound 的回调时机一致
swan.onError监听小程序错误事件。如脚本错误或API调用报错等
swan.onAppShow监听小程序错误事件。如脚本错误或API调用报错等。该事件与 App.onError 的回调时机与参数一致
swan.onAppHide监听小程序切后台事件。该事件与 App.onHide 的回调时机一致
swan.offPageNotFound取消监听小程序要打开的页面不存在事件
swan.offError取消监听小程序错误事件
swan.offAppShow取消监听小程序切前台事件
swan.offAppHide取消监听小程序切后台事件
网络请求swan.request发起网络请求
上传、下载swan.uploadFile将本地资源上传到开发者服务器
swan.downloadFile下载文件资源到本地
WebSocketswan.connectSocket创建一个 WebSocket 连接
swan.onSocketOpen监听 WebSocket 连接打开事件
swan.onSocketError监听 WebSocket 错误
swan.sendSocketMessage通过 WebSocket 连接发送数据
swan.onSocketMessage监听 WebSocket 接受到服务器的消息事件
swan.closeSocket关闭 WebSocket 连接
swan.onSocketClose监听 WebSocket 关闭
AI文字识别swan.ai.ocrIdCard用户向服务请求识别身份证，身份证识别包括正面和背面
swan.ai.ocrBankCard识别银行卡并返回卡号、发卡行和卡片类型
swan.ai.ocrDrivingLicense对机动车驾驶证所有关键字段进行识别
swan.ai.ocrVehicleLicense对机动车行驶证正本所有关键字段进行识别
文本审核swan.ai.textReview运用业界领先的深度学习技术，判断一段文本内容是否符合网络发文规范，实现自动化、智能化的文本审核
语音合成swan.ai.textToAudio将文本转换为可以播放的 mp3 文件
图像审核swan.ai.imageAudit自定义图像审核
图像识别swan.ai.advancedGeneralIdentify通用物体及场景识别，即对于输入的一张图片（可正常解码，且长宽比适宜），输出图片中的多个物体及场景标签
swan.ai.objectDetectIdentify用户向服务请求检测图像中的主体位置
swan.ai.carClassify用于检测一张车辆图片的具体车型，即对于输入的一张图片（可正常解码，且长宽比适宜），输出图片的车辆品牌及型号、颜色及年份、位置信息
swan.ai.dishClassify用于菜品识别，即对于输入的一张图片（可正常解码，且长宽比适宜），输出图片的菜品名称、卡路里信息、置信度
swan.ai.logoClassify用于检测和识别图片中的品牌 LOGO 信息
swan.ai.animalClassify该请求用于识别一张图片，即对于输入的一张图片（可正常解码，且长宽比较合适），输出动物识别结果
swan.ai.plantClassify该请求用于识别一张图片，即对于输入的一张图片（可正常解码，且长宽比较合适），输出植物识别结果
语音识别swan.ai.getVoiceRecognizer获取全局唯一的语音识别器 voiceRecognizer
人脸识别swan.ai.faceDetect人脸检测，检测图片中的人脸并标记出相应的信息位置，同时可以展示出人脸的关键信息和属性信息，比如年龄，性别等
swan.ai.faceMatch人脸对比，支持两张人脸图片的相似度对比，图片类型可以为：生活照，证件照，身份证芯片照或者带网纹照
swan.ai.faceSearch人脸搜索，传入人脸图片，支持在指定人脸图片集合中，找到与传入图片中人脸最为相似的图片
swan.ai.facePersonVerify公安验证，基于姓名和身份证号，调取公民身份证小图（源自公安系统），将当前获取的人脸图片，与此证件小图进行对比，得出比对分数
swan.ai.facePersonIdmatch身份证和名字对比，验证用户输入的身份证号码和姓名是否匹配，用于判断用户信息是否真实
swan.ai.faceVerify在线活体检测，基于单张图片，判断图片中的人脸是否为二次翻拍
swan.ai.faceLivenessSessioncodeH5活体检测-语音校验码，为防止用户提交非当前操作的视频，在录制视频时，随机分配一个数字，用户需要读出这个数字，在后续识别时校验，以判断视频是否为现场录制
swan.ai.faceLivenessVerifyH5活体检测-视频活体检测，录制并上传的视频，会在云端进行随机抽帧分析，并得出最终的活体检测分数
词法分析swan.ai.nlpLexerCustom词法分析，提供分词、词性标注、专名识别三大功能
媒体图片swan.chooseImage从本地相册选择图片或使用相机拍照
swan.previewImage预览图片
swan.getImageInfo获取图片信息
swan.saveImageToPhotosAlbum保存图片到系统相册，需要用户授权
swan.chooseAlbum打开本地相册，相册内可以同时包含图片和视频
录音管理swan.getRecorderManager获取全局唯一的录音管理器 recorderManager
背景音频swan.getBackgroundAudioManager获取全局唯一的背景音频管理器 backgroundAudioManager
音频组件swan.createInnerAudioContext创建并返回内部 audio 上下文 innerAudioContext 对象
swan.setInnerAudioOption对innerAudioContext进行小程序内部的全局设置
视频swan.chooseVideo拍摄视频或从手机相册中选视频，返回视频的临时文件路径
swan.saveVideoToPhotosAlbum保存视频到系统相册。需要用户授权
视频组件swan.createVideoContext创建并返回 video 上下文 videoContext 对象
直播组件swan.createLivePlayerContext操作对应的 < live-player/> 组件
相机组件swan.createCameraContext创建并返回 camera 上下文 cameraContext对象
AR相机swan.createARCameraContext创建并返回 ar-camera 上下文 ARCameraContext对象
文件保存、获取文件swan.saveFile保存文件到本地
swan.getFileInfo获取文件信息
swan.getSavedFileList获取本地已保存的文件列表
swan.getSavedFileInfo获取本地文件的文件信息
删除文件swan.removeSavedFile删除本地存储的文件
新文件swan.openDocument新开页面打开文档，支持格式：doc, xls, ppt, pdf, docx, xlsx, pptx
数据存储存储数据swan.setStorage将数据存储在本地缓存中指定的 key 中
swan.setStorageSync将数据存储在本地缓存中指定的 key 中
swan.getStorage从本地缓存中异步获取指定 key 对应的内容
swan.getStorageSync从本地缓存中同步获取指定 key 对应的内容
swan.getStorageInfo异步获取当前 storage 的相关信息
swan.getStorageInfoSync同步获取当前 storage 的相关信息
存储清理swan.removeStorage从本地缓存中异步移除指定 key
swan.removeStorageSync从本地缓存中同步移除指定 key
swan.clearStorage清理本地数据缓存
swan.clearStorageSync同步清理本地数据缓存
位置获取位置swan.getLocation获取当前的地理位置、速度
swan.chooseLocation打开地图选择位置
查看位置swan.openLocation使用宿主 App 内置地图查看位置
地图组件swan.createMapContext创建并返回 map 上下文 mapContext 对象
界面绘图swan.createCanvasContext绘图上下文的创建
swan.canvasGetImageData用来描述 canvas 区域隐含的像素数据
swan.canvasPutImageData将像素数据绘制到画布的方法
swan.canvasToTempFilePath把当前画布指定区域的内容导出生成指定大小的图片，并返回文件路径
交互反馈swan.showToast显示消息提示框
swan.showLoading显示 loading 提示框, 需主动调用 hideLoading 才能关闭提示框
swan.hideToast隐藏消息提示框
swan.hideLoading隐藏 loading 提示框
swan.showModal显示模态弹窗
swan.showActionSheet显示操作菜单
导航栏swan.setNavigationBarTitle动态设置当前页面的标题
swan.showNavigationBarLoading该方法在当前页面显示导航条加载动画
swan.hideNavigationBarLoading隐藏导航条加载动画
swan.setNavigationBarColor动态设置当前页面导航条的颜色
设置tabBarswan.setTabBarBadge为 tabBar 某一项的右上角添加文本
swan.removeTabBarBadge移除tabBar某一项右上角的文本
swan.showTabBarRedDot显示 tabBar 某一项的右上角的红点
swan.hideTabBarRedDot隐藏 tabBar 某一项的右上角的红点
swan.setTabBarStyle动态设置 tabBar 的整体样式
swan.setTabBarItem动态设置 tabBar 某一项的内容
swan.showTabBar显示 tabBar
swan.hideTabBar隐藏 tabBar
导航swan.navigateTo保留当前页面，跳转到应用内的某个页面
swan.redirectTo关闭当前页面，跳转到应用内的某个页面
swan.switchTab跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
swan.navigateBack关闭当前页面，跳转到应用内的某个页面
swan.reLaunch关闭所有页面，打开到应用内的某个页面
动画swan.createAnimation创建一个动画实例 animation
位置swan.pageScrollTo将页面滚动到目标位置
背景swan.setBackgroundColor设置窗口的背景颜色
swan.setBackgroundTextStyle设置窗口下拉背景loading样式
下拉刷新swan.startPullDownRefresh开始下拉刷新，调用后触发下拉刷新动画
swan.stopPullDownRefresh停止当前页面下拉刷新
自定义组件swan.nextTick延迟一部分操作到下一个时间片再执行
菜单swan.getMenuButtonBoundingClientRect获取菜单按钮（右上角胶囊按钮）的布局位置信息
节点信息swan.createIntersectionObserver创建并返回一个 IntersectionObserver 对象实例
swan.createSelectorQuery返回一个 SelectorQuery 对象实例
小程序引导swan.showFavoriteGuide支持在小程序内调起添加到我的小程序引导组件，引导用户添加到我的小程序
设备系统信息swan.getSystemInfo获取系统信息
swan.getSystemInfoSync获取系统信息同步接口
swan.getEnvInfoSync获取运行环境信息同步接口
swan.canIUse判断智能小程序的API，回调，参数，组件等是否在当前版本可用
内存swan.onMemoryWarning监听内存不足的告警事件
内存swan.getNetworkType获取网络类型
swan.onNetworkStatusChange监听网络状态变化
加速度计swan.onAccelerometerChange监听加速度数据
swan.startAccelerometer开始监听加速度数据
swan.stopAccelerometer停止监听加速度数据
罗盘swan.onCompassChange监听罗盘数据
swan.startCompass开始监听罗盘数据
swan.stopCompass停止监听罗盘数据
设备方向swan.onDeviceMotionChange监听设备方向变化事件
swan.startDeviceMotionListening开始监听设备方向的变化
swan.stopDeviceMotionListening停止监听设备方向的变化
获取电量swan.getBatteryInfo支持在小程序内获取当前设备电量
swan.getBatteryInfoSync获取当前设备电量同步接口，ios系统不可用
扫码swan.scanCode调起客户端扫码界面，扫码成功后返回对应的结果
屏幕亮度swan.setScreenBrightness设置屏幕亮度
swan.getScreenBrightness获取屏幕亮度
swan.setKeepScreenOn设置是否保持常亮状态
用户截屏swan.onUserCaptureScreen监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件
振动swan.vibrateLong使手机发生较长时间的振动
swan.vibrateShort使手机发生较短时间的振动
手机联系人swan.addPhoneContact写入手机系统通讯录
拨打电话swan.makePhoneCall拨打电话
剪贴板swan.setClipboardData设置系统剪贴板的内容
swan.getClipboardData获取系统剪贴板内容
第三方平台第三方数据swan.getExtConfig获取第三方平台自定义的数据字段
swan.getExtConfigSyncswan.getExtConfig的同步版本
开放接口登陆swan.login获取用户登录凭证
swan.checkSession检测当前用户登录态是否有效
swan.isLoginSync获取宿主 App登录状态
授权swan.authorize提前向用户发起授权请求
授权swan.getSwanId获取 swanid
swan.getUserInfo获取用户信息
设置swan.openSetting调起客户端智能小程序设置界面，返回用户设置的操作结果
swan.getSetting获取用户的当前设置
分享swan.openShare调起分享面板
swan.shareFile支持调起系统分享面板将文件分享到其他App
收货地址swan.chooseAddress调起用户编辑收货地址原生界面
百度支付swan.requestPolymerPayment百度收银台，聚合了主流的百度钱包、微信、支付宝、网银等多种支付方式
获取发票swan.chooseInvoiceTitle选择用户的发票抬头
打开小程序swan.navigateToSmartProgram打开另一个小程序
swan.navigateBackSmartProgram返回到上一个小程序
页面基础信息swan.setPageInfo设置各类页面基础信息
swan.setMetaDescription设置 web 版小程序 description meta 信息
swan.setMetaKeywords设置 web 版小程序 keywords meta 信息
swan.setDocumentTitle动态设置当前页面的标题
分包预下载swan.loadSubPackage提前下载好子包的资源
更新swan.getUpdateManager获取全局唯一的版本更新管理器，用于管理小程序更新
调试swan.setEnableDebug设置是否打开调试开关，此开关对正式版也能生效
数据分析swan.reportAnalytics自定义分析数据上报接口
定时器setInterval设定一个定时器
clearInterval取消由 setInterval 设置的定时器
setTimeout设定一个定时器
clearTimeout取消由 setTimeout 设置的定时器
风控swan.getSystemRiskInfo获取用于得到风控信息的加密信息对象

# 一、界面--交互反馈api

# 1、swan.showToast 显示消息提示框

属性类型必填描述
titlestring是提示的内容
iconstring否图标
imagestring否自定义图标的本地路径，image 的优先级高于 icon
durationnumber否提示的延迟时间
maskboolean否是否显示透明蒙层，防止触摸穿透
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

icon合法值：

属性描述
success显示成功图标，此时 title 文本最多显示 7 个汉字长度
loading显示加载图标，此时 title 文本最多显示 7 个汉字长度
none不显示图标，此时 title 文本最多可显示两行

js示例：

Page({
    onLoad: function (options) {
        swan.showToast({
            title: '成功',
            icon: 'success',
            image: 'img/1.png', // 放在小程序根目录，icon就不会显示了
            duration : 1000,
            mask : true,
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

# 2、swan.hideToast 隐藏消息提示框

属性类型必填描述
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

Page({
    onLoad: function (options) {
        swan.hideToast({
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

# 3、swan.showLoading 显示 loading 提示框

  • 需主动调用 swan.hideLoading 才能关闭提示框
属性类型必填描述
titlestring是提示的内容
maskboolean否是否显示透明蒙层，防止触摸穿透
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

Page({
    onLoad: function (options) {
        swan.showLoading({
            title: '加载中',
            mask : true,
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

# 4、swan.hideLoading 隐藏 loading 提示框

属性类型必填描述
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

Page({
    onLoad: function (options) {
        swan.hideLoading({
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

# 5、swan.showModal 显示模态对话框

属性类型必填描述
titlestring是提示的标题
contentstring是提示的内容
showCancelboolean否是否显示取消按钮
cancelTextstring否取消按钮的文字，最多 4 个字符
cancelColorstring否取消按钮的文字颜色，必须是 16 进制格式的颜色字符串
confirmTextstring否确认按钮的文字，最多 4 个字符
confirmColorstring否确认按钮的文字颜色，必须是 16 进制格式的颜色字符串
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

Page({
    onLoad: function (options) {
        swan.showModal({
            title: '提示',
            content: '这是一个模态弹窗',
            showCancel : true,
            cancelText : '取消按钮',
            cancelColor : '#333',
            confirmText : '确定按钮',
            confirmColor : 'red',
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

# 6、swan.showActionSheet 显示模态对话框

属性类型必填描述
itemListArray是按钮的文字数组，数组长度最大为 6
itemColorstring否按钮的文字颜色
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

Page({
    onLoad: function (options) {
        swan.showActionSheet({
            itemList: [
                '欧阳克',
                '黄蓉',
                '郭靖',
                '杨康',
                '穆念慈'
            ],
            itemColor: '#333',
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

# 二、界面--导航api

# 1、swan.switchTab 跳转到 tabBar 页面 并关闭其他所有非 tabBar 页面

属性类型必填描述
urlstring是需要跳转的 tabBar 页面的路径，路径后不能带参数。
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

Page({
    onLoad: function (options) {
        swan.switchTab({
            url: 'a',
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

app.json示例：

{
    "tabBar": {
        "list": [
            {
                "pagePath": "index",
                "text": "首页"
            },
            {
                "pagePath": "a",
                "text": "A页面"
            }
        ]
    }
}

# 2、swan.reLaunch 关闭所有页面，打开到应用内的某个页面

属性类型必填描述
urlstring是需要跳转的应用内页面路径，路径后可以带参数。
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

Page({
    onLoad: function (options) {
        swan.reLaunch({
            url: 'a?id=1',
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

# 3、swan.redirectTo 关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面

属性类型必填描述
urlstring是需要跳转的应用内非 tabBar 的页面的路径, 路径后可以带参数。
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

Page({
    onLoad: function (options) {
        swan.redirectTo({
            url: 'a?id=1',
            success(){
                console.log('成功');
            },
            fail(){
                console.log('失败');
            },
            complete(){
                console.log('成功或失败');
            }
        })
    }
})

# 4、swan.navigateTo 保留当前页面，跳转到应用内的某个页面。但是不能跳到 tabbar 页面

属性类型必填描述
urlstring是需要跳转的应用内非 tabBar 的页面的路径, 路径后可以带参数。
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

js示例：

journal I'm Developers.
Copyright © 2014-2024 Guojunjie.com.
All screenshots © 郭俊杰(Journal).
I have been in Xiamen,China.
Website Establishment by Journal.
闽ICP备12018326号-2
Name:
<提交>