概述

ff-jssdk是(shì)firefly平台面向WEB前端開發者提供的(de)基于(yú)firefly原生客戶端内的(de)網頁開發工具包。

安裝

# --registry 爲(wéi / wèi) npm 私有倉庫的(de)地(dì / de)址
$ npm install ff-jssdk --registry=http://xxx.x.x.x

接口調用說(shuō)明

ff-jssdk默認導出(chū)Native構造函數，可以(yǐ)通過new Native()的(de)方式創建實例，所有的(de)接口通過該實例對象來(lái)調用。每個(gè)接口除了(le／liǎo)本身需要(yào / yāo)傳遞的(de)參數之(zhī)外，還有以(yǐ)下通用參數：

• success：接口調用成功時(shí)執行的(de)回調函數
• fail：接口調用失敗時(shí)執行的(de)回調函數
• complete：接口調用完成時(shí)的(de)回調函數，無論接口調用成功與否
• processing：包含進度信息的(de)接口在(zài)執行中調用的(de)函數，例如文件的(de)上(shàng)傳和(hé / huò)下載

以(yǐ)上(shàng)通用回調函數均接收一(yī / yì ／yí)個(gè)參數，參數爲(wéi / wèi)一(yī / yì ／yí)個(gè)對象，包括code和(hé / huò)data兩個(gè)字段。code代表接口調用狀态，擁有如下通用狀态值：

• 0：調用成功
• -1：調用失敗

其他(tā)狀态碼在(zài)接口文檔中會有說(shuō)明。data的(de)值是(shì)一(yī / yì ／yí)個(gè)對象，包含接口的(de)返回值

示例

import Native from 'ff-jssdk'

const native = new Native()

// 下載文件到(dào)本地(dì / de)
native.downloadFile({
    url: 'api/downloadSth',
    filePath: 'download',
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    processing: (ret) => {
        // 下載過程中的(de)回調函數
        const { code, data: { progress } } = ret

        console.log(progress) // 下載進度
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

ff-jssdk接口定義

網絡

下載文件資源到(dào)本地(dì / de)：downloadFile()

客戶端發起一(yī / yì ／yí)個(gè) HTTP GET 請求

參數

回調參數

狀态碼說(shuō)明

示例代碼

import Native from 'ff-jssdk'

const native = new Native()

// 下載文件到(dào)本地(dì / de)
native.downloadFile({
    url: 'static/picture/542c3569-51f3-4a13-b7df-57f5da454847.jpg',
    filePath: '/test_download/aaa.jpg',
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    processing: (ret) => {
        // 下載過程中的(de)回調函數
        const { code, data: { progress } } = ret

        console.log(progress) // 下載進度
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

上(shàng)傳文件資源：uploadFile()

客戶端發起一(yī / yì ／yí)個(gè) HTTP POST 請求，其中 content-type 爲(wéi / wèi) multipart/form-data

參數

回調參數

狀态碼說(shuō)明

示例代碼

native.uploadFile({
    url:"http://www.httpbin.org/post",
    filePath:"/test_download/aaa.jpg",
    fileKey:"aaa",
    formData:{
        id:"123456",
        key:"67890"
    }},
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    processing: (ret) => {
        // 下載過程中的(de)回調函數
        const { code, data: { progress } } = ret

        console.log(progress) // 下載進度
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

媒體

相機拍照：cameraTakePhoto()

注意：就(jiù)蘋果設備而(ér)言，因爲(wéi / wèi)隐私權限調整，需要(yào / yāo)在(zài)App的(de)Info.plist中自行添加NSCameraUsageDescription；若未添加，則可能造成閃退。

參數：

回調參數

狀态碼說(shuō)明

示例代碼

native.cameraTakePhoto({
    quality: "normal",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

相機錄像：cameraStartRecord()、cameraStopRecord()

注意：就(jiù)蘋果設備而(ér)言，因爲(wéi / wèi)隐私權限調整，需要(yào / yāo)在(zài)App的(de)Info.plist中自行添加NSMicrophoneUsageDescription；若未添加，則可能造成閃退。

cameraStartRecord參數：

cameraStopRecord參數：無

共同的(de)回調參數:

狀态碼說(shuō)明

示例代碼

native.cameraStartRecord({
    quality: "normal",
    recordDuration: 20,
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

選擇图片：chooseImage()

從本地(dì / de)相冊選擇图片或使用相機拍照。

參數：

回調參數

狀态碼說(shuō)明

示例代碼

native.chooseImage({
    sourceType:["album"]
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

壓縮图片：compressImage()

參數：

回調參數

狀态碼說(shuō)明

示例代碼

native.compressImage({
    srcFile: "/xxx/test.jpg",
    quality: 0.7,
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

保存图片到(dào)系統相冊：saveImageToPhotosAlbum()

注意：就(jiù)蘋果設備而(ér)言，因爲(wéi / wèi)隐私權限調整，需要(yào / yāo)在(zài)App的(de)Info.plist中自行添加NSPhotoLibraryAddUsageDescription；若未添加，則可能造成閃退。

參數：

回調參數 無

狀态碼說(shuō)明

示例代碼

native.saveImageToPhotosAlbum({
    filePath:"/xxx/test.jpg",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

文件

讀文件: readFile()

目前僅支持文本文件

參數:

回調參數

狀态碼說(shuō)明

示例代碼

native.readFile({
    filePath:"/xx/xx/test.txt",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

保存文件: saveFile()

目前僅支持文本文件

參數:

回調參數 無

狀态碼說(shuō)明

示例代碼

native.saveFile({
    filePath:"/xx/xx/test.txt",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

删除文件: removeSavedFile()

參數:

回調參數 無

狀态碼說(shuō)明

示例代碼

native.removeSavedFile({
    filePath:"/xx/xx/test.txt",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

數據緩存

本地(dì / de)緩存操作

獲取緩存: getStorage()

參數:

回調參數

狀态碼說(shuō)明

示例代碼

native.getStorage({
    key:"k1",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

更新緩存: setStorage()

參數:

回調參數 無

狀态碼說(shuō)明

示例代碼

native.setStorage({
    key:"k1",
    value:[1,2,3,4],
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

移除緩存: removeStorage()

參數:

回調參數 無

狀态碼說(shuō)明

示例代碼

native.removeStorage({
    key:"k1",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

清除所有緩存: clearStorage()

參數: 無

回調參數: 無

狀态碼說(shuō)明

示例代碼

native.clearStorage({
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

設備

獲取系統剪貼闆的(de)内容: getClipboardData()

回調參數: 無

示例代碼

native.getClipboardData({
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

設置系統剪貼闆的(de)内容: setClipboardData()

參數

回調參數

示例代碼

native.setClipboardData({
    data:"設置剪貼闆",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

獲取網絡類型：getNetworkType（）

回調參數

網絡類型 networkType 的(de)合法值：

示例代碼

native.getNetworkType({
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

添加更新聯系人(rén)：addPhoneContact（）

注意：就(jiù)蘋果設備而(ér)言，因爲(wéi / wèi)隐私權限調整，需要(yào / yāo)在(zài)App的(de)Info.plist中自行添加NSContactsUsageDescription；若未添加，則可能造成閃退。

添加手機通訊錄聯系人(rén)。用戶可以(yǐ)選擇将該表單以(yǐ)「新增聯系人(rén)」或「添加到(dào)已有聯系人(rén)」的(de)方式，寫入手機系統通訊錄。

參數

回調參數 無

狀态碼說(shuō)明

示例代碼

native.addPhoneContact({
    firstName:"Limi",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

HCE能力：getHCEState（）

判斷當前設備是(shì)否支持 HCE 能力

注意：目前，就(jiù)蘋果而(ér)言，該接口不(bù)會返回0

參數: 無

回調參數: 無

狀态碼說(shuō)明

示例代碼

native.getHCEState({
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

撥打電話：makePhoneCall()

參數：

回調參數: 無

狀态碼說(shuō)明

示例代碼

native.makePhoneCall({
    phoneNumber:"12345678901",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

掃碼：scanCode()

參數：無

回調參數

狀态碼說(shuō)明

示例代碼

native.scanCode({
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
        const { code } = ret

        if (code === 1) {
            // 用戶取消
        }
    }
})

toast提示：showToast()

參數：

回調參數: 無

狀态碼說(shuō)明

示例代碼

native.showToast({
    tip:"hello world",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

toast提示：hideToast()

參數：無

回調參數 無

狀态碼說(shuō)明

示例代碼

native.hideToast({
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

導航錯誤碼

設置導航欄顔色：setNavigationBarColor()

參數：

回調參數: 無

狀态碼說(shuō)明

參見導航錯誤碼

示例代碼

native.setNavigationBarColor({
    frontColor:"#FF0000",
    backgroundColor:"#00FFFF",
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

設置導航欄标題：setNavigationBarTitle()

參數：

回調參數: 無

狀态碼說(shuō)明

示例代碼

native.setNavigationBarTitle({
    title:"page title"
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

設置導航欄内容：setNavigationBarContent()

參數：

導航欄按鈕（leftButton, rightButton）：

回調參數: 無

狀态碼說(shuō)明

參見導航錯誤碼

示例代碼

native.setNavigationBarTitle({
    hide:0,
    title:"page title",
    leftButton: {
        title:"返回",
        callback:"closepage", //closepage接受一(yī / yì ／yí)個(gè)參數
        callbackData:"123456"
    },
    rightButton: {
        hide:0
    },
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

關閉本頁面：navigationCloseThisPage()

參數

回調參數: 無

狀态碼說(shuō)明

參見導航錯誤碼

示例代碼

native.navigationCloseThisPage({
    animated: 10,
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

系統

異步獲取系統信息: getSystemInfo()

回調參數

示例代碼

native.getSystemInfo({
    success: (ret) => {
        // 成功後的(de)回調
    },
    fail: (ret) => {
        // 失敗後的(de)回調
    },
    complete: (ret) => {
        // 接口調用完成後的(de)回調函數
    }
})

同步獲取系統信息: getSystemInfoSync()

返回值:

示例代碼

const str = native.getSystemInfoSync()

同步獲取app版本: getAppVersion()

返回值:

示例代碼

const str = native.getAppVersion()

基礎

判斷Jsbridge是(shì)否在(zài)當前版本可用: hasNativeMethod()

判斷小程序的(de)API是(shì)否在(zài)當前版本可用。

參數

string

使用 ${API} 方式來(lái)調用

返回值

boolean

當前版本是(shì)否可用

示例代碼

const boolean = cmbc.hasNativeMethod('chooseImage')

console.log(boolean)