设备

日历

addPhoneRepeatCalendar

addPhoneRepeatCalendar(Object object)

向系统日历添加重复事件

参数

Object object

addPhoneCalendar

addPhoneCalendar(Object object)

向系统日历添加事件

参数

Object object

联系人

searchContacts

searchContacts(Object object)

查找通讯录，匹配相近的手机号

参数

Object object

object.success 回调函数

参数

Object object

object.result 的结构

示例代码

wx.searchContacts({
  phoneNumber: '10000000',
  success (res) {},
  fail: console.error,
})

chooseContact

chooseContact(Object object)

拉起手机通讯录，选择联系人。

参数

Object object

object.success 回调函数

参数

Object object

addPhoneContact

基础库1.3.9开始支持，需要 SDK 通过自定义 API 自行实现

addPhoneContact(Object object)

添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式，写入手机系统通讯录。

参数

Object object

电量

getBatteryInfoSync

getBatteryInfoSync()

ft.getBatteryInfo 的同步版本

返回值

Object res

getBatteryInfo

getBatteryInfo(Object object)

object.success 回调函数

参数

Object object

剪贴板

setClipboardData

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38, 依赖扩展 SDK

setClipboardData(Object object)

设置系统剪贴板的内容。

参数

Object object

示例代码

ft.setClipboardData({
  data: 'data',
  success(res) {
    ft.getClipboardData({
      success(res) {
        console.log(res.data) // data
      }
    })
  }
})

getClipboardData

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38, 依赖扩展 SDK

getClipboardData(Object object)

获取系统剪贴板的内容。

参数

Object object

object.success 回调函数

参数

Object object

示例代码

ft.getClipboardData({
  success(res) {
    console.log(res.data)
  }
})

网络

onNetworkStatusChange

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

onNetworkStatusChange(function callback)

监听网络状态变化事件。

参数

function callback

网络状态变化事件的回调函数

参数

Object res

res.networkType 的合法值

示例代码

ft.onNetworkStatusChange(function (res) {
  console.log(res.isConnected)
  console.log(res.networkType)
})

offNetworkStatusChange

offNetworkStatusChange(function callback)

取消监听网络状态变化事件，参数为空，则取消所有的事件监听。

参数

function callback

网络状态变化事件的回调函数

getNetworkType

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

getNetworkType(Object object)

获取网络类型。

参数

Object object

object.success 回调函数

参数

Object res

res.networkType 的合法值

示例代码

ft.getNetworkType({
  success(res) {
    const networkType = res.networkType
  }
})

屏幕

setScreenBrightness

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

setScreenBrightness(Object object)

设置屏幕亮度。

参数

Object object

setKeepScreenOn

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

setKeepScreenOn(Object object)

设置是否保持常亮状态。

参数

Object object

示例代码

ft.setKeepScreenOn({
  keepScreenOn: true
})

onUserCaptureScreen

onUserCaptureScreen(function callback)

监听用户主动截屏事件。用户使用系统截屏按键截屏时触发，只能注册一个监听

参数

function callback

用户主动截屏事件的回调函数

示例代码

ft.onUserCaptureScreen(function (res) {
  console.log('用户截屏了')
})

offUserCaptureScreen

offUserCaptureScreen(function callback)

用户主动截屏事件。取消事件监听。

参数

function callback

用户主动截屏事件的回调函数

getScreenBrightness

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

getScreenBrightness(Object object)

获取屏幕亮度。

参数

Object object

object.success 回调函数

参数

Object object

键盘

onKeyboardHeightChange

onKeyboardHeightChange(function callback)

监听键盘高度变化

参数

function callback

参数

object res

示例代码

ft.onKeyboardHeightChange(res => {
  console.log(res.height)
})

offKeyboardHeightChange

offKeyboardHeightChange(function callback)

取消监听键盘高度变化事件

参数

function callback

键盘高度变化事件的回调函数

hideKeyboard

hideKeyboard(Object object)

在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘

参数

Object object

示例代码

ft.hideKeyboard({
  complete: res => {
    console.log('hideKeyboard res', res)
  }
})

getSelectedTextRange

getSelectedTextRange(Object object)

在input、textarea等focus之后，获取输入框的光标位置。注意：只有在focus的时候调用此接口才有效。

参数

Object object

object.success 回调函数

参数

Object res

示例代码

ft.getSelectedTextRange({
  complete: res => {
    console.log('getSelectedTextRange res', res.start, res.end)
  }
})
})

电话

makePhoneCall

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

makePhoneCall(Object object)

拨打电话。

参数

Object object

示例代码

ft.makePhoneCall({
  phoneNumber: '1340000' // 仅为示例，并非真实的电话号码
})

加速计

stopAccelerometer

stopAccelerometer(Object object)

停止监听加速度数据。

参数

Object object

示例代码

ft.stopAccelerometer()

startAccelerometer

startAccelerometer(Object object)

开始监听加速度数据。

参数

Object object

object.interval 的合法值

示例代码

ft.startAccelerometer({
  interval: 'game'
})

onAccelerometerChange

onAccelerometerChange(function callback)

监听加速度数据事件。频率根据 ft.startAccelerometer() 的 interval 参数, 接口调用后会自动开始监听。

参数

function callback

加速度数据事件的回调函数

参数

Object res

示例代码

ft.onAccelerometerChange(callback)

offAccelerometerChange

offAccelerometerChange(function callback)

取消监听加速度数据事件，参数为空，则取消所有的事件监听。

参数

function callback

加速度数据事件的回调函数

罗盘

stopCompass

stopCompass(Object object)

停止监听罗盘数据

参数

Object object

示例代码

ft.stopCompass()

startCompass

startCompass(Object object)

开始监听罗盘数据

参数

Object object

示例代码

ft.startCompass()

onCompassChange

onCompassChange(function callback)

监听罗盘数据变化事件。频率：5 次/秒，接口调用后会自动开始监听，可使用 ft.stopCompass 停止监听。

参数

function callback

罗盘数据变化事件的回调函数

参数

Object object

示例代码

ft.onCompassChange(callback)

accuracy 在 iOS/Android 的差异

由于平台差异，accuracy 在 iOS/Android 的值不同。

• iOS：accuracy 是一个 number 类型的值，表示相对于磁北极的偏差。0 表示设备指向磁北，90 表示指向东，180 表示指向南，依此类推。
• Android：accuracy 是一个 string 类型的枚举值。

offCompassChange

offCompassChange(function callback)

取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听。

参数

function callback

罗盘数据变化事件的回调函数

设备方向

stopDeviceMotionListening

stopDeviceMotionListening(Object object)

停止监听设备方向的变化。

参数

Object object

startDeviceMotionListening

startDeviceMotionListening(Object object)

开始监听设备方向的变化。

参数

Object object

object.interval 的合法值

onDeviceMotionChange

onDeviceMotionChange(function callback)

监听设备方向变化事件。频率根据 ft.startDeviceMotionListening() 的 interval 参数。可以使用 ft.stopDeviceMotionListening() 停止监听。

参数

function callback

设备方向变化事件的回调函数

参数

Object res

offDeviceMotionChange

offDeviceMotionChange(function callback)

取消监听设备方向变化事件，参数为空，则取消所有的事件监听。

参数

function callback

设备方向变化事件的回调函数

陀螺仪

stopGyroscope

stopGyroscope(Object object)

停止监听陀螺仪数据。

参数

Object object

startGyroscope

startGyroscope(Object object)

开始监听陀螺仪数据。

参数

Object object

object.interval 的合法值

onGyroscopeChange

onGyroscopeChange(function callback)

监听陀螺仪数据变化事件。频率根据 ft.startGyroscope() 的 interval 参数。可以使用 ft.stopGyroscope() 停止监听。

参数

function callback

陀螺仪数据变化事件的回调函数

参数

Object res

offGyroscopeChange

offGyroscopeChange(function callback)

取消监听陀螺仪数据变化事件。

参数

function callback

陀螺仪数据变化事件的回调函数

扫码

scanCode

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

scanCode(Object object)

调起客户端扫码界面进行扫码。

参数

Object object

object.success 回调函数

参数

Object res

示例代码

// 允许从相机和相册扫码
ft.scanCode({
  success(res) {
    console.log(res)
  }
})

// 只允许从相机扫码
ft.scanCode({
  onlyFromCamera: true,
  success(res) {
    console.log(res)
  }
})

振动

vibrateShort

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

vibrateShort(Object object)

使手机发生较短时间的振动（15 ms）。仅在 iPhone 7 / 7 Plus 以上及 Android 机型生效。

参数

Object object

vibrateLong

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

vibrateLong(Object object)

使手机发生较长时间的振动（400 ms)。

参数

Object object