微信小程序开发文档 第22页
wx.setScreenBrightness(OBJECT) 基础库 1.2.0 开始支持,低版本需做兼容处理 设置屏幕亮度。 OBJECT参数说明: 参数 类型 必填 说明 value Number 是 屏幕亮度值,范围 0~1,0 最暗,1 最亮 success Function 否 接口调用成功 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) wx.getScreenBrightness(OBJECT) 基础库 1.2.0 开始支持,低版本需做兼容处理 获取屏幕亮度。 OBJECT参数说明: 参数 类型 必填 说明 success Function 否 接口调用成功 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数说明: 参数 类型 说明 value Number 屏幕亮度值,范围 0~1,0 最暗,1 最亮 wx.setKeepScreenOn(OBJECT) 基础库 1.4.0 开始支持,低版本需做兼容处理 设置是否保持常亮状态。仅在当前小程序生效,离开小程序后设置失效。 OBJECT参数说明: 参数名 类型 必填 说明 keepScreenOn Boolean 是 是否保持屏幕常亮 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数说明: 参数名 类型 说明 errMsg String 调用结果 示例代码: // 保持屏幕常亮 wx.setKeepScreenOn({ keepScreenOn: true })
wx.startBeaconDiscovery(OBJECT) 基础库 1.2.0 开始支持,低版本需做兼容处理 开始搜索附近的iBeacon设备 OBJECT参数说明: 参数名 类型 必填 说明 uuids StringArray 是 iBeacon设备广播的 uuids success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数说明: 参数名 类型 说明 errMsg String 调用结果 示例代码: wx.startBeaconDiscovery({ success(res) { } }) wx.stopBeaconDiscovery(OBJECT) 基础库 1.2.0 开始支持,低版本需做兼容处理 停止搜索附近的iBeacon设备 OBJECT参数说明: 参数名 类型 必填 说明 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数说明: 参数名 类型 说明 errMsg String 调用结果 wx.getBeacons(OBJECT) 基础库 1.2.0 开始支持,低版本需做兼容处理 获取所有已搜索到的iBeacon设备 OBJECT参数说明: 参数名 类型 必填 说明 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数说明: 参数名 类型 说明 beacons ObjectArray iBeacon 设备列表 errMsg String 调用结果 iBeacon 结构: 参数 类型 说明 uuid String iBeacon 设备广播的 uuid major String iBeacon 设备的主 id minor String iBeacon...
蓝牙适配器接口 基础库版本 1.1.0 开始支持,低版本需做兼容处理 iOS 微信客户端 6.5.6 版本开始支持,Android 客户端暂不支持 wx.openBluetoothAdapter(OBJECT) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 初始化蓝牙适配器 OBJECT参数说明: 参数 类型 必填 说明 success Function 是 成功则返回成功初始化信息 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码: wx.openBluetoothAdapter({ success: function (res) { console.log(res) } }) Bug & Tip tip: 由于系统的问题,目前仅在 mac 版的开发工具上支持蓝牙调试 tip: 基础库版本 1.1.0 开始支持,低版本需做兼容处理 wx.closeBluetoothAdapter(OBJECT) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 关闭蓝牙模块。调用该方法将断开所有已建立的链接并释放系统资源 OBJECT参数说明: 参数 类型 必填 说明 success Function 是 成功则返回成功关闭模块信息 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码: wx.closeBluetoothAdapter({ success: function (res) { console.log(res) } }) wx.getBluetoothAdapterState(OBJECT) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 获取本机蓝牙适配器状态 OBJECT参数说明: 参数 类型 必填 说明 success Function 是 成功则返回本机蓝牙适配器状态 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数: 参数 类型 说明 discovering Boolean 是否正在搜索设备 available Boolean 蓝牙适配器是否可用 errMsg String 成功:ok,错误:详细信息 示例代码: wx.getBluetoothAdapterState({ success:...
wx.setClipboardData(OBJECT) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 设置系统剪贴板的内容。 OBJECT参数说明: 参数 类型 必填 说明 data String 是 需要设置的内容 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码: wx.setClipboardData({ data: 'data', success: function(res) { wx.getClipboardData({ success: function(res) { console.log(res.data) // data } }) } }) wx.getClipboardData(OBJECT) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 获取系统剪贴板内容 OBJECT参数说明: 参数 类型 必填 说明 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数说明: 参数 类型 说明 data String 剪贴板的内容 示例代码: wx.getClipboardData({ success: function(res){ console.log(res.data) } })
wx.scanCode(Object object) 调起客户端扫码界面进行扫码 参数 Object object 属性 类型 默认值 必填 说明 最低版本 onlyFromCamera boolean false 否 是否只能从相机扫码,不允许从相册选择图片 1.2.0 scanType Array.<string> [‘barCode’, ‘qrCode’] 否 扫码类型 1.7.0 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.scanType 的合法值 值 说明 最低版本 barCode 一维码 qrCode 二维码 datamatrix Data Matrix 码 pdf417 PDF417 条码 object.success 回调函数 参数 Object res 属性 类型 说明 result string 所扫码的内容 scanType string 所扫码的类型 charSet string 所扫码的字符集 path string 当所扫的码为当前小程序二维码时,会返回此字段,内容为二维码携带的 path rawData string 原始数据,base64编码 res.scanType 的合法值 值 说明 最低版本 QR_CODE 二维码 AZTEC 一维码 CODABAR 一维码 CODE_39 一维码 CODE_93 一维码 CODE_128 一维码 DATA_MATRIX 二维码 EAN_8 一维码 EAN_13 一维码 ITF 一维码 MAXICODE 一维码 PDF_417 二维码 RSS_14 一维码 RSS_EXPANDED 一维码 UPC_A 一维码 UPC_E 一维码 UPC_EAN_EXTENSION 一维码 WX_CODE 二维码 CODE_25 一维码...
wx.makePhoneCall(OBJECT) OBJECT参数说明: 参数 类型 必填 说明 phoneNumber String 是 需要拨打的电话号码 success Function 否 接口调用成功的回调 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码: wx.makePhoneCall({ phoneNumber: '1340000' //仅为示例,并非真实的电话号码 })
wx.onCompassChange(CALLBACK) 监听罗盘数据,频率:5次/秒,接口调用后会自动开始监听,可使用wx.stopCompass停止监听。 CALLBACK返回参数: 参数 类型 说明 direction Number 面对的方向度数 示例代码: wx.onCompassChange(function (res) { console.log(res.direction) }) wx.startCompass(OBJECT) 基础库 1.1.0 开始支持,低版本需做兼容处理 开始监听罗盘数据。 OBJECT参数说明: 参数 类型 必填 说明 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码: wx.startCompass() wx.stopCompass(OBJECT) 基础库 1.1.0 开始支持,低版本需做兼容处理 停止监听罗盘数据。 OBJECT参数说明: 参数 类型 必填 说明 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码: wx.stopCompass() wx.offCompassChange(function callback) 基础库 2.9.3 开始支持,低版本需做兼容处理 取消监听罗盘数据变化事件,参数为空,则取消所有的事件监听。 参数 function callback 罗盘数据变化事件的回调函数
wx.onAccelerometerChange(CALLBACK) 监听重力感应数据,频率:5次/秒,接口调用后会自动开始监听,可使用wx.stopAccelerometer停止监听。 CALLBACK返回参数: 参数 类型 说明 x Number X 轴 y Number Y 轴 z Number Z 轴 示例代码: wx.onAccelerometerChange(function(res) { console.log(res.x) console.log(res.y) console.log(res.z) }) wx.startAccelerometer(OBJECT) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 微信客户端 6.5.6 版本开始支持 开始监听加速度数据。 OBJECT参数说明: 参数 类型 必填 说明 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码: wx.startAccelerometer() wx.stopAccelerometer(OBJECT) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 微信客户端 6.5.6 版本开始支持 停止监听加速度数据。 OBJECT参数说明: 参数 类型 必填 说明 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码: wx.stopAccelerometer() wx.offAccelerometerChange(function callback) 基础库 2.9.3 开始支持,低版本需做兼容处理。 取消监听加速度数据事件,参数为空,则取消所有的事件监听。 参数 function callback 加速度数据事件的回调函数
wx.getNetworkType(OBJECT) 获取网络类型。 OBJECT参数说明: 参数 类型 必填 说明 success Function 是 接口调用成功,返回网络类型 networkType fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数说明: 参数 说明 networkType 网络类型 wx.getNetworkType({ success: function(res) { // 返回网络类型, 有效值: // wifi/2g/3g/4g/unknown(Android下不常见的网络类型)/none(无网络) var networkType = res.networkType } }) wx.onNetworkStatusChange(CALLBACK) 基础库 1.1.0 开始支持,低版本需做兼容处理。 监听网络状态变化。 CALLBACK返回参数: 参数 类型 说明 isConnected Boolean 当前是否有网络连接 networkType String 网络类型 networkType 有效值: 值 说明 wifi wifi 网络 2g 2g 网络 3g 3g 网络 4g 4g 网络 none 无网络 unknown Android下不常见的网络类型 示例代码: wx.onNetworkStatusChange(function(res) { console.log(res.isConnected) console.log(res.networkType) }) wx.offNetworkStatusChange(function callback) 基础库 2.9.3 开始支持,低版本需做兼容处理。 取消监听网络状态变化事件,参数为空,则取消所有的事件监听。 参数 function callback 网络状态变化事件的回调函数
wx.getSystemInfo(OBJECT) 获取系统信息。 OBJECT参数说明: 参数 类型 必填 说明 success Function 是 接口调用成功的回调 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success回调参数说明: 参数 说明 最低版本 model 手机型号 pixelRatio 设备像素比 screenWidth 屏幕宽度 1.1.0 screenHeight 屏幕高度 1.1.0 windowWidth 可使用窗口宽度 windowHeight 可使用窗口高度 language 微信设置的语言 version 微信版本号 system 操作系统版本 platform 客户端平台 fontSizeSetting 用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准,单位:px 1.5.0 SDKVersion 客户端基础库版本 1.1.0 示例代码: wx.getSystemInfo({ success: function(res) { console.log(res.model) console.log(res.pixelRatio) console.log(res.windowWidth) console.log(res.windowHeight) console.log(res.language) console.log(res.version) console.log(res.platform) }}) wx.getSystemInfoSync() 获取系统信息同步接口 同步返回参数说明: 参数 说明 最低版本 model 手机型号 pixelRatio 设备像素比 screenWidth 屏幕宽度 1.1.0 screenHeight 屏幕高度 1.1.0 windowWidth 可使用窗口宽度 windowHeight 可使用窗口高度 language 微信设置的语言 version 微信版本号 system 操作系统版本 platform 客户端平台 SDKVersion 客户端基础库版本 1.1.0 示例代码: try { var res = wx.getSystemInfoSync() console.log(res.model) console.log(res.pixelRatio)...