导航|地址|刷新
设备 | “人民网+”小程序 | 开放平台










“人民网+”小程序|文档中心






指引

开发

数据

设计

运营











# 设备

# 电量

# getBatteryInfoSync

getBatteryInfoSync()

ft.getBatteryInfo 的同步版本

返回值

Object res

属性	类型	说明
level	string	设备电量，范围 1 - 100
isCharging	boolean	是否正在充电中

# getBatteryInfo

getBatteryInfo(Object object)

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.success 回调函数

参数

Object object

属性	类型	说明
level	string	设备电量，范围 1 - 100
isCharging	boolean	是否正在充电中

# 剪贴板

# setClipboardData

基础库 1.3.9 开始支持，iOS 版本 2.1.23，Android 版本 2.1.38, 依赖扩展 SDK 自 iOS 版本 2.35.13，Android 2.35.9 起，该 API 需要宿主 App 注入实现，SDK 内已移除该 API。


setClipboardData(Object object)

设置系统剪贴板的内容。

参数

Object object

属性	类型	默认值	必填	说明
data	string		是	剪贴板的内容
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

示例代码

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 自 iOS 版本 2.35.13，Android 2.35.9 起，该 API 需要宿主 App 注入实现，SDK 内已移除该 API。


getClipboardData(Object object)

获取系统剪贴板的内容。

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.success 回调函数

参数

Object object

属性	类型	说明
data	string	剪贴板的内容

示例代码

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

属性	类型	说明
isConnected	boolean	当前是否有网络连接
networkType	string	网络类型

res.networkType 的合法值

值	说明
wifi	wifi 网络
2g	2g 网络
3g	3g 网络
4g	4g 网络
unknown	wifi 网络
none	无网络

示例代码

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

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.success 回调函数

参数

Object res

属性	类型	说明
networkType	string	网络类型

res.networkType 的合法值

值	说明
wifi	wifi 网络
2g	2g 网络
3g	3g 网络
4g	4g 网络
unknown	wifi 网络
none	无网络

示例代码

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

# getRandomValues

获取密码学安全随机数

参数

Object object

属性	类型	默认值	必填	说明
length	number		是	整数，生成随机数的字节数，最大 1048576
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.success 回调函数

参数

Object object

属性	类型	说明
randomValues	ArrayBuffer	随机数内容，长度为传入的字节数

示例代码

ft.getRandomValues({length:6// 生成 6 个字节长度的随机数,success:res=>{ console.log(ft.arrayBufferToBase64(res.randomValues))// 转换为 base64 字符串后打印}})

# 屏幕

# setVisualEffectOnCapture

基础库 2.12.16 开始支持，Android 版本 2.37.1


setVisualEffectOnCapture(Object object)

设置屏幕亮度。

参数

Object object

属性	类型	默认值	必填	说明
visualEffect	string	none	是	截屏/录屏时的表现，仅支持 none / hidden，传入 hidden 则表示在截屏/录屏时隐藏屏幕
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

# setScreenBrightness

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


setScreenBrightness(Object object)

设置屏幕亮度。

参数

Object object

属性	类型	默认值	必填	说明
value	number		是	屏幕亮度值，范围 0 ~ 1。0 最暗，1 最亮
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

# setKeepScreenOn

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


setKeepScreenOn(Object object)

设置是否保持常亮状态。

参数

Object object

属性	类型	默认值	必填	说明
keepScreenOn	boolean		是	是否保持屏幕常亮
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

示例代码

ft.setKeepScreenOn({keepScreenOn:true})

# onUserCaptureScreen

onUserCaptureScreen(function callback)

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

参数

function callback

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

示例代码

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

# onScreenRecordingStateChanged

onScreenRecordingStateChanged(function callback)

监听用户录屏事件，用户录屏时触发

参数

function callback

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

参数

Object res

属性	类型	说明
state	string	值为 start 或 stop，start：开始录屏；stop：停止录屏

示例代码

ft.onScreenRecordingStateChanged(function(res){ console.log(res.state)})

# offUserCaptureScreen

offUserCaptureScreen(function callback)

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

参数

function callback

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

# offScreenRecordingStateChanged

offScreenRecordingStateChanged(function callback)

移除用户录屏事件的监听

参数

function callback

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

参数为 onScreenRecordingStateChanged 传入的监听函数，不传参数则移除所有监听函数

# getScreenRecordingState

基础库 2.12.16 开始支持，iOS 版本 2.37.1，Android 版本 2.37.1


getScreenRecordingState(Object object)

查询用户是否在录屏

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.success 回调函数

参数

Object res

属性	类型	说明
state	string	录屏状态，值为 on 或 off

# getScreenBrightness

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


getScreenBrightness(Object object)

获取屏幕亮度。

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.success 回调函数

参数

Object res

属性	类型	说明
value	number	屏幕亮度值，范围 0 ~ 1，0 最暗，1 最亮

# 键盘

# onKeyboardHeightChange

onKeyboardHeightChange(function callback)

监听键盘高度变化

参数

function callback

参数

object res

属性	类型	说明
height	number	键盘高度

示例代码

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

# offKeyboardHeightChange

offKeyboardHeightChange(function callback)

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

参数

function callback

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

# hideKeyboard

hideKeyboard(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

示例代码

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

# getSelectedTextRange

getSelectedTextRange(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.success 回调函数

参数

Object res

属性	类型	说明
start	number	输入框光标起始位置
end	number	输入框光标结束位置

示例代码

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

属性	类型	默认值	必填	说明
phoneNumber	string		是	需要拨打的电话号码
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

示例代码

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

# 加速计

# stopAccelerometer

stopAccelerometer(Object object)

停止监听加速度数据。

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

示例代码

ft.stopAccelerometer()

# startAccelerometer

startAccelerometer(Object object)

开始监听加速度数据。

参数

Object object

属性	类型	默认值	必填	说明
interval	string	normal	否	监听加速度数据回调函数的执行频率
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.interval 的合法值

值	说明
game	适用于更新游戏的回调频率，在 20ms/次 左右
ui	适用于更新 UI 的回调频率，在 60ms/次 左右
normal	普通的回调频率，在 200ms/次 左右

示例代码

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

# onAccelerometerChange

onAccelerometerChange(function callback)

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

参数

function callback

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

参数

Object res

属性	类型	说明
x	number	X 轴
y	number	Y 轴
z	number	Z 轴

示例代码

ft.onAccelerometerChange(callback)

# offAccelerometerChange

offAccelerometerChange(function callback)

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

参数

function callback

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

# 罗盘

# stopCompass

stopCompass(Object object)

停止监听罗盘数据

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

示例代码

ft.stopCompass()

# startCompass

startCompass(Object object)

开始监听罗盘数据

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

示例代码

ft.startCompass()

# onCompassChange

onCompassChange(function callback)

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

参数

function callback

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

参数

Object object

属性	类型	说明
direction	number	面对的方向度数
accuracy	number/string	精度

示例代码

ft.onCompassChange(callback)

accuracy 在 iOS/Android 的差异

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

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

Android：accuracy 是一个 string 类型的枚举值。

值	说明
high	高精度
medium	中等精度
low	低精度
no-contact	不可信，传感器失去连接
unreliable	不可信，原因未知
unknow ${value}	未知的精度枚举值，即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值

# offCompassChange

offCompassChange(function callback)

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

参数

function callback

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

# 设备方向

# stopDeviceMotionListening

stopDeviceMotionListening(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

# startDeviceMotionListening

startDeviceMotionListening(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
interval	string	normal	否	监听设备方向的变化回调函数的执行频率
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.interval 的合法值

值	说明
game	适用于更新游戏的回调频率，在 20ms/次 左右
ui	适用于更新 UI 的回调频率，在 60ms/次 左右
normal	普通的回调频率，在 200ms/次 左右

# onDeviceMotionChange

onDeviceMotionChange(function callback)

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

参数

function callback

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

参数

Object res

属性	类型	说明
alpha	number	当 手机坐标 X/Y 和 地球 X/Y 重合时，绕着 Z 轴转动的夹角为 alpha，范围值为 [0, 2*PI)。逆时针转动为正。
beta	number	当手机坐标 Y/Z 和地球 Y/Z 重合时，绕着 X 轴转动的夹角为 beta。范围值为 [-1*PI, PI) 。顶部朝着地球表面转动为正。也有可能朝着用户为正。
gamma	number	当手机 X/Z 和地球 X/Z 重合时，绕着 Y 轴转动的夹角为 gamma。范围值为 [-1*PI/2, PI/2)。右边朝着地球表面转动为正。

# offDeviceMotionChange

offDeviceMotionChange(function callback)

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

参数

function callback

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

# 陀螺仪

# stopGyroscope

stopGyroscope(Object object)

停止监听陀螺仪数据。

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

# startGyroscope

startGyroscope(Object object)

开始监听陀螺仪数据。

参数

Object object

属性	类型	默认值	必填	说明
interval	string	normal	否	监听陀螺仪数据回调函数的执行频率
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.interval 的合法值

值	说明
game	适用于更新游戏的回调频率，在 20ms/次 左右
ui	适用于更新 UI 的回调频率，在 60ms/次 左右
normal	普通的回调频率，在 200ms/次 左右

# onGyroscopeChange

onGyroscopeChange(function callback)

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

参数

function callback

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

参数

Object res

属性	类型	说明
x	number	x 轴的角速度
y	number	y 轴的角速度
z	number	z 轴的角速度

# offGyroscopeChange

offGyroscopeChange(function callback)

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

参数

function callback

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

# 扫码

# scanCode

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


scanCode(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
onlyFromCamera	boolean	false	否	是否只能从相机扫码，不允许从相册选择图片
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数（当授权失败时，返回错误信息：fail unauthorized 用户未授予相机权限）
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

object.success 回调函数

参数

Object res

示例代码

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


注意

接口授权失败（iOS）:

用户拒绝授权，会返回错误信息： unauthorized,用户未授予相机权限

宿主 App 禁止小程序主动申请权限，会返回错误信息：unauthorized disableauthorized,SDK 被禁止申请相机权限

接口授权失败（Android）：

用户拒绝授权，会返回错误信息：fail unauthorized 用户未授予相机权限

宿主 App 禁止小程序主动申请权限，会返回错误信息：unauthorized disableauthorized SDK 被禁止了主动发起权限申请


# 振动

# vibrateShort

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


vibrateShort(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
type	String		是	震动强度类型，有效值为：heavy、medium、light。 iOS:2.39.11支持；Android:2.25.1支持
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数(当授权失败时，返回错误信息：fail unauthorized 用户未授予震动权限)
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行)

注意

接口授权失败（Android）：

用户拒绝授权，会返回错误信息：unauthorized 用户未授予震动权限

宿主 App 禁止小程序主动申请权限，会返回错误信息：unauthorized disableauthorized SDK 被禁止了主动发起权限申请


# vibrateLong

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


vibrateLong(Object object)

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

参数

Object object
…(内容过长已截断)

------
导航页 打开网址