概述

ff-jssdk是firefly平台面向WEB前端开发者提供的基于firefly原生客户端内的网页开发工具包。

安装

# --registry 为 npm 私有仓库的地址 $ npm install ff-jssdk --registry=http://xxx.x.x.x 

接口调用说明

ff-jssdk默认导出Native构造函数，可以通过new Native()的方式创建实例，所有的接口通过该实例对象来调用。每个接口除了本身需要传递的参数之外，还有以下通用参数：

• success：接口调用成功时执行的回调函数
• fail：接口调用失败时执行的回调函数
• complete：接口调用完成时的回调函数，无论接口调用成功与否
• processing：包含进度信息的接口在执行中调用的函数，例如文件的上传和下载

以上通用回调函数均接收一个参数，参数为一个对象，包括code和data两个字段。code代表接口调用状态，拥有如下通用状态值：

• 0：调用成功
• -1：调用失败

其他状态码在接口文档中会有说明。data的值是一个对象，包含接口的返回值

示例

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

ff-jssdk接口定义

网络

下载文件资源到本地：downloadFile()

客户端发起一个 HTTP GET 请求

参数

回调参数

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

上传文件资源：uploadFile()

客户端发起一个 HTTP POST 请求，其中 content-type 为 multipart/form-data

参数

回调参数

状态码说明

示例代码

native.uploadFile({     url:"http://www.httpbin.org/post",     filePath:"/test_download/aaa.jpg",     fileKey:"aaa",     formData:{         id:"123456",         key:"67890"     }},     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

媒体

相机拍照：cameraTakePhoto()

注意：就苹果设备而言，因为隐私权限调整，需要在App的Info.plist中自行添加NSCameraUsageDescription；若未添加，则可能造成闪退。

参数：

回调参数

状态码说明

示例代码

native.cameraTakePhoto({     quality: "normal",     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

相机录像：cameraStartRecord()、cameraStopRecord()

注意：就苹果设备而言，因为隐私权限调整，需要在App的Info.plist中自行添加NSMicrophoneUsageDescription；若未添加，则可能造成闪退。

cameraStartRecord参数：

cameraStopRecord参数：无

共同的回调参数:

状态码说明

示例代码

native.cameraStartRecord({     quality: "normal",     recordDuration: 20,     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

选择图片：chooseImage()

从本地相册选择图片或使用相机拍照。

参数：

回调参数

状态码说明

示例代码

native.chooseImage({     sourceType:["album"]     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

压缩图片：compressImage()

参数：

回调参数

状态码说明

示例代码

native.compressImage({     srcFile: "/xxx/test.jpg",     quality: 0.7,     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

保存图片到系统相册：saveImageToPhotosAlbum()

注意：就苹果设备而言，因为隐私权限调整，需要在App的Info.plist中自行添加NSPhotoLibraryAddUsageDescription；若未添加，则可能造成闪退。

参数：

回调参数 无

状态码说明

示例代码

native.saveImageToPhotosAlbum({     filePath:"/xxx/test.jpg",     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

文件

读文件: readFile()

目前仅支持文本文件

参数:

回调参数

状态码说明

示例代码

native.readFile({     filePath:"/xx/xx/test.txt",     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 

保存文件: saveFile()

目前仅支持文本文件

参数:

回调参数 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 0

删除文件: removeSavedFile()

参数:

回调参数 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 1

数据缓存

本地缓存操作

获取缓存: getStorage()

参数:

回调参数

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 2

更新缓存: setStorage()

参数:

回调参数 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 3

移除缓存: removeStorage()

参数:

回调参数 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 4

清除所有缓存: clearStorage()

参数: 无

回调参数: 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 5

设备

获取系统剪贴板的内容: getClipboardData()

回调参数: 无

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 6

设置系统剪贴板的内容: setClipboardData()

参数

回调参数

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 7

获取网络类型：getNetworkType（）

回调参数

网络类型 networkType 的合法值：

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 8

添加更新联系人：addPhoneContact（）

注意：就苹果设备而言，因为隐私权限调整，需要在App的Info.plist中自行添加NSContactsUsageDescription；若未添加，则可能造成闪退。

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

参数

回调参数 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'api/downloadSth',     filePath: 'download',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 9

HCE能力：getHCEState（）

判断当前设备是否支持 HCE 能力

注意：目前，就苹果而言，该接口不会返回0

参数: 无

回调参数: 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 0

拨打电话：makePhoneCall()

参数：

回调参数: 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 1

扫码：scanCode()

参数：无

回调参数

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 2

toast提示：showToast()

参数：

回调参数: 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 3

toast提示：hideToast()

参数：无

回调参数 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 4

导航错误码

设置导航栏颜色：setNavigationBarColor()

参数：

回调参数: 无

状态码说明

参见导航错误码

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 5

设置导航栏标题：setNavigationBarTitle()

参数：

回调参数: 无

状态码说明

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 6

设置导航栏内容：setNavigationBarContent()

参数：

导航栏按钮（leftButton, rightButton）：

回调参数: 无

状态码说明

参见导航错误码

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 7

关闭本页面：navigationCloseThisPage()

参数

回调参数: 无

状态码说明

参见导航错误码

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 8

系统

异步获取系统信息: getSystemInfo()

回调参数

示例代码

import Native from 'ff-jssdk'  const native = new Native()  // 下载文件到本地 native.downloadFile({     url: 'http://www.cmbc.com.cn/upload/images/2018/9/542c3569-51f3-4a13-b7df-57f5da454847.jpg',     filePath: '/test_download/aaa.jpg',     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 9

同步获取系统信息: getSystemInfoSync()

返回值:

示例代码

native.uploadFile({     url:"http://www.httpbin.org/post",     filePath:"/test_download/aaa.jpg",     fileKey:"aaa",     formData:{         id:"123456",         key:"67890"     }},     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 0

同步获取app版本: getAppVersion()

返回值:

示例代码

native.uploadFile({     url:"http://www.httpbin.org/post",     filePath:"/test_download/aaa.jpg",     fileKey:"aaa",     formData:{         id:"123456",         key:"67890"     }},     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 1

基础

判断Jsbridge是否在当前版本可用: hasNativeMethod()

判断小程序的API是否在当前版本可用。

参数

string

使用 ${API} 方式来调用

返回值

boolean

当前版本是否可用

示例代码

native.uploadFile({     url:"http://www.httpbin.org/post",     filePath:"/test_download/aaa.jpg",     fileKey:"aaa",     formData:{         id:"123456",         key:"67890"     }},     success: (ret) => {         // 成功后的回调     },     fail: (ret) => {         // 失败后的回调     },     processing: (ret) => {         // 下载过程中的回调函数         const { code, data: { progress } } = ret          console.log(progress) // 下载进度     },     complete: (ret) => {         // 接口调用完成后的回调函数     } }) 2