Cordova插件清單及使用說明

1、Cordova 插件清單及使用說明(持續(xù)更新中)WeX5 的混合模式底層基于 cordova/phonegap，所以開發(fā)本地插件只需要按照相應(yīng)規(guī)范就可以，由于BeX5 基于 WeX5，所以本文檔也適用于一、如何使用本地插件(CordovaCordova pluginplugin)在需要使用插件的頁面對應(yīng)的js 中，如下代碼引用：1require($UI/system/lib/cordova/cordova);2/cordova 運行環(huán)境，多個頁面用 cordova 插件，每個頁面都需要 require 進來3require(cordova!ph on egap-plug in-barcodes

2、ca nn er);4/使用的 cordova 插件再參考插件的文檔，書寫對應(yīng)的js。例如二維碼插件barcodesacnner，代碼如下：1/掃描二維碼，返回二維碼信息2cordova.plug in s.barcodeSca nn er.sca n(3fun ctio n (result) 4alert(We got a barcoden +5Result: + result.text + n +6Format: + result.format + n +7Ca ncelled: + result.ca ncelled);8,9fun cti on (error) 10alert(Sca

3、nningfailed: + error);11BeX512）；二、插件列表見下表其中：所在位置為 studio.exe （也就是 IDE 工具中）“ Native/plugins 文件夾下；調(diào)用名稱”為 JS 調(diào)用時使用到的名稱；參數(shù)”如果需要參數(shù)，那么在打包為APP 應(yīng)用的時候，需要進行參數(shù)的填寫;案例路徑”為 studio.exe （也就是 IDE 工具中）具體案例所在路徑。1、插件相關(guān)說明，均在對應(yīng)插件所在位置”目錄下的 xdoc 文件中，詳細使用方法請參考對應(yīng)文檔插件名稱功能描述詳情支付寶支付阿里支付本地擴 展插件所在位置:com.justep.cordova.plugin.alip

4、ay 調(diào)用名稱:navigator.alipay參數(shù)：需要插件名稱功能描述詳情案例路徑：/UI2/takeout銀聯(lián)支付銀聯(lián)支付本地擴展插件所在位置：com.justep.cordova.plugin.unionpay 調(diào)用名稱：navigator.unionpay參數(shù)：需要案例路徑:/UI2/takeout微信支付（分享）微信 v3 本地擴 展插件，包括微信 支付和微信分享所在位置:com.justep.cordova.plugin.weixin.v3 調(diào)用名稱：navigator.weixin參數(shù)：需要支付案例路徑:/UI2/takeout；分享案例路徑：/UI2/demo/native/

5、share下載插件下載多個或單所在位置:cordova-plugin-fastrde-downloader插件名稱功能描述詳情個文件，可以進行校驗的一致性或 下載完成自動解 壓文件調(diào)用名稱:window.downloader案例路徑：/UI2/demo/native/downloader本地文件插件（使用方法）本地文件插件， 提供對本地文件 的存取操作，該插 件基于html5 的File所在位置：cordova-plugin-file調(diào)用名稱:window.File案例路徑：/UI2/demo/native/downloader文件打開插件在app中使用 默認打開方式打 開本地文件所在位置:c

6、ordova-plugin-file-opener2 調(diào)用名稱:cordova.plugins.fileOpener2案例路徑：/UI2/demo/native/fileOpener本地文件傳輸本地文件傳輸 插件，提供文件的 上傳下載操作所在位置:cordova-plugin-file-transfer 調(diào)用名稱:window.FileTransfer案例路徑：/UI2/system/api/native插件名稱功能描述詳情文件打開在app中用打 開音頻，視頻，圖 片或其他格式的 文件等，支持本地 文件和遠程文件所在位置：cordova-open調(diào)用名稱:cordova.plugins.dis

7、usered案例路徑：/UI2/demo/native/open打開文檔插件（使用方法）打開文檔插件， 下載指定 url 的 文檔并使用系統(tǒng) 注冊過的應(yīng)用打 開所在位置：ch.ti8m.documenthandler調(diào)用名稱:window.handleDocumentWithURLmd5 校 驗讀取大文件并生成 md5sumi 增量所在位置：de.fastr.pho negap.plugi ns.md5chksum調(diào)用名稱：win dow.md5chksum極光推送（使用方法）推送消息，支持An droid，ISO所在位置：cn.jpush.phonegap.JPushPlugin 調(diào)用名稱:

8、window.plugins.jPushPlugin參數(shù)：需要插件名稱功能描述詳情案例路徑：/UI2/takeout近場通訊近場通訊插件，僅支持 An droid所在位置:ph on egap-nfc 調(diào)用名稱:window.nfc地理位置（使用方法）地理位置位置 插件，提供地理位 置信息，依賴百度 定位插件所在位置：cordova-plugin-geolocation 調(diào)用名稱：navigator.geolocation案例路徑:/UI2/demo/native/geolocation社交分享分享插件，可分 享文本、圖片等文 件，并關(guān)聯(lián)打開本 地注冊過的可分 享類型所在位置:cordova-

9、plugin-x-socialsharing 調(diào)用名稱:plugins.socialsharing案例路徑:/UI2/demo/native/shareInfo二維碼掃描二維碼、條形碼 掃描插件所在位置:ph on egap-plug in-barcodesca nner 調(diào)用名稱:cordova.plugins.barcodeScanner插件名稱功能描述詳情案例路徑：/UI2/demo/native/barcode視頻播放插件視頻播放插件，支持本地路徑和 http:/路徑所在位置:com.phonegap.plugins.videoplayer 調(diào)用名稱:cordova.plugins.v

10、ideoPlayer案例路徑:/UI2/demo/native/videoplayer狀態(tài)欄（使用方法）狀態(tài)欄本地插 件，用來控制狀態(tài) 欄的顯示方式所在位置:cordova-plugin-statusbar 調(diào)用名稱:window.StatusBar參數(shù):需要Http 請求（使用方法）Http 請求插 件,使用本地接口 發(fā)送 http請求， 這將提供跨域的 ajax 調(diào)用所在位置:plugin.http.request調(diào)用名稱:navigator.plugins.HttpRequest案例路徑:/UI2/demo/netease內(nèi)置瀏覽內(nèi)置瀏覽本地所在位置:cordova-plugin-ina

11、ppbrowser插件名稱功能描述詳情插件，類似瀏覽器 中js 的win dow.ope n， 用 指疋模式打開url調(diào)用名稱:window.open案例路徑：/UI2/demo/account藍牙藍牙插件，提供 對藍牙設(shè)備的監(jiān) 聽和使用所在位置：cordova-plugin-ble-central 調(diào)用名稱：window.ble照相機照相機本地插 件，調(diào)用照相機獲 取圖片所在位置:cordova-plugin-camera 調(diào)用名稱：navigator.camera案例路徑:/UI2/demo/native/camera設(shè)備信息（使用方法）設(shè)備信息本地 插件，獲取設(shè)備信 息，包括操作系統(tǒng) 類

12、型和版本、設(shè)備 uuid 等所在位置:cordova-plugin-device 調(diào)用名稱:window.device插件名稱功能描述詳情設(shè)備傳感器加速器本地插 件，獲取設(shè)備加速 器(accelerati on) 信息所在位置：cordova-plugin-device-motion調(diào)用名稱：navigator.accelerometer案例路徑：/UI2/demo/native/accelerometer指南針電子羅盤本地 插件，獲取設(shè)備方 向信息所在位置:cordova-plugin-device-orientation 調(diào)用名稱：pass聯(lián)系人聯(lián)系人本地插 件，獲取設(shè)備聯(lián)系 人信息所在位

13、置:cordova-plugin-contacts 調(diào)用名稱:navigator.c on tacts聲音設(shè)備(使用方法)本地聲音設(shè)備 插件，用于播放聲 音、控制音量等所在位置:cordova-plugin-media 調(diào)用名稱:window.Media案例路徑:/UI2/demo/native/audio多媒體文件錄制多媒體錄制本 地插件，用于捕獲所在位置:cordova-plugin-media-capture插件名稱功能描述詳情圖片、錄制聲音和 視頻調(diào)用名稱：navigator.device.capture案例路徑：/UI2/demo/native/camera電池狀態(tài)電池狀態(tài)插 件，監(jiān)

14、控設(shè)備電池 狀態(tài)所在位置:cordova-plugin-battery-status 調(diào)用名稱:navigator.battery屏幕旋轉(zhuǎn)（使控制屏幕旋轉(zhuǎn)所在位置:cordova-plugin-screen-orientation 調(diào)用名稱:window.plugins.screen用方法）方向案例路徑:/UI2/demo/native/screenorientation屏幕常亮插件 方法）（使用使屏幕禁止睡眠所在位置:cordova-plugin-insomnia 調(diào)用名稱:plugins.insomnia設(shè)備震動震動本地插件， 調(diào)用設(shè)備進行震 動所在位置:cordova-plugin-vi

15、bration 調(diào)用名稱:navigator.notification插件名稱功能描述詳情本地日歷插件方法）（使用用于調(diào)用本地 日歷，設(shè)置活動相 關(guān)操作所在位置：cordova-plugin-calendar 調(diào)用名稱:plugins.calendar案例路徑：/UI2/demo/native/calendar本地浮動框提示浮動提示插件，彈出本地浮動提 示框所在位置:cordova-plugin-x-toast 調(diào)用名稱:plugins.toast案例路徑:/UI2/demo/native/toast本地等待和進度（使用方法）基于 Spinner提供的本地等待 和進度對話框所在位置:cordo

16、va-plugin-spinner-dialog 調(diào)用名稱:plugins.spinnerDialog本地選項卡 用方法）（使本地選項卡插 件，用來展示一組 本地選項列表所在位置:cordova-plugin-actionsheet 調(diào)用名稱:plugins.acti on sheet案例路徑:/UI2/demo/native/actionsheet插件名稱功能描述詳情本地對話框本地對話框插 件，提供提醒 (alert)、詢問 (con firm, prompt)和蜂鳴音 (beep)的本地調(diào) 用所在位置:cordova-plugin-dialogs 調(diào)用名稱:navigator.notifi

17、cationSQLite 插件用方法)(使SQLite 插件， 提供本地數(shù)據(jù)庫 的存儲所在位置：com.brodysoft.sqlitePlugin 調(diào)用名稱:window.SQLitePlugin案例路徑：/UI2/demo/native/sqliteapp 緩存清除插件清除 app 緩存所在位置:at.modalog.cordova.plugin.cache 調(diào)用名稱:window.cache案例路徑：/UI2/demo/native/clearCache應(yīng)用安裝狀 態(tài)(使用方法)應(yīng)用安裝狀態(tài) 插件，通過 URI所在位置:cordova-plugin-appavailability插件名稱

18、功能描述詳情Scheme（iOS） 或 者包名（Android） 判斷指定的應(yīng)用 是否已安裝調(diào)用名稱：window.appAvailabilityapp 后臺運行app 后臺運行 插件,防止 app 在 后臺進入睡眠狀 態(tài)所在位置:de.apppla nt.cordova.plugi n.backgro un d-mode 調(diào)用名稱:cordova.plugins.backgroundMode案例路徑：/UI2/demo/native/backgroundMode應(yīng)用圖標數(shù)字提醒 用方法）（使應(yīng)用圖標數(shù)字 提醒。IOS 通過應(yīng) 用圖標數(shù)字進行 提醒；Android 系 統(tǒng)由于系統(tǒng)限制， 通過狀

19、態(tài)欄進行 提醒所在位置:de.appplant.cordova.plugin.badge 調(diào)用名稱:plugi n.no tificati on .badge案例路徑:/UI2/demo/native/badge獲取 app 版本信息（使用方法）獲取app版本 相關(guān)信息所在位置:cordova-plugin-app-version插件名稱功能描述詳情調(diào)用名稱：cordova.getAppVersion案例路徑：/UI2/demo/account閃屏插件歡迎頁本地插 件，默認建議包 含。啟動本地應(yīng)用 時顯示指定的圖 片所在位置:cordova-plugin-splashscreen 調(diào)用名稱:n

20、avigator.splashscreen國際化國際化插件，提 供語言、日期、貨 幣等本地化信息所在位置:cordova-plugin-globalization 調(diào)用名稱:navigator.globalization本地轉(zhuǎn)場動畫本地轉(zhuǎn)場動畫 插件，提供頁面間 的本地轉(zhuǎn)場動畫 效果所在位置:com.telerik.plug ins.n ativepagetra nsiti ons 調(diào)用名稱:plugins.nativepagetransitions案例路徑:/UI2/demo/native/barcode插件名稱功能描述詳情復(fù)制粘貼復(fù)制粘貼文本所在位置：com.verso.cordova.c

21、lipboard 調(diào)用名稱:cordova.plugins.clipboard案例路徑：/UI2/demo/native/clipboard自定義 URL 協(xié)議(使用方法)自定義指定的 協(xié)議類型URL_SCHEM 并通過han dleOpe nURL 回調(diào)進行接管。例 如指定協(xié)議mycoolapp，貝聽將接管mycoolapp:/xxx所在位置:cordova-plugin-customurlscheme 調(diào)用名稱:window.plugins.launchmyapp參數(shù):需要con sole提供全局對象 console，通過 console .lo g()記 錄日志所在位置:cordova-

22、plugin-console 調(diào)用名稱:window.console插件名稱功能描述詳情鍵盤插件鍵盤插件，用來 顯示隱藏鍵盤及 其他關(guān)于鍵盤的 操作所在位置：cordova-plugin-keyboard 調(diào)用名稱:window.Keyboard案例路徑：/UI2/demo/native/keyboard網(wǎng)絡(luò)信息網(wǎng)絡(luò)信息本地插 件，獲取網(wǎng)絡(luò)連接 信息所在位置:cordova-plugin-network-information 調(diào)用名稱：navigator.connection隱私屏幕（使用方法）隱私屏幕插件，本 插件無調(diào)用接口， 包含即可。包含 后，如果用應(yīng)用管 理程序切換應(yīng)用 時將不會看到

23、當(dāng)前應(yīng)用的屏幕快 昭八、所在位置:cordova-plugin-privacyscreen 調(diào)用名稱:PrivacyScreenPluginappUtils提供app更新 資源包更新能力 設(shè)置首頁等相關(guān)所在位置： com.justep.cordova.plug in. app.utils 調(diào)用名稱：n avigator.appUtils插件名稱功能描述詳情能力百度定位插件百度定位插件，提 供定位相關(guān)能力， 僅限安卓客戶端所在位置：com.justep.cordova.plug in .baidulocatio n 調(diào)用名稱：navigator.baiduLocati on案例路徑/UI2/ta

24、keout百度地圖插件舊版調(diào)用百度地圖客戶端所在位置：com.justep.cordova.plug in .bmap調(diào)用名稱：導(dǎo)入相應(yīng)模塊案例路徑 /UI2/system/api/native科大訊飛插件（使用方法）集成了科大訊飛 的SDK 提供語音 聽寫、語音合成的 功能所在位置：com.justep.cordova.plugi n.iFlytek 調(diào)用名稱：navigator.speech參數(shù)：需要QC 插件集成了 QQSD,K所在位置：com.justep.cordova.plugi n.QQ插件名稱功能描述詳情提供了授權(quán)登錄， 分享功能調(diào)用名稱：n avigator.QQ參數(shù)：需要案

25、例路徑：/UI2/demo/native/share安全驗證插件集成了 mobSDK提供短信驗證的 功能所在位置：com.justep.cordova.plugi n.security.mob 調(diào)用名稱：navigator.mobsms參數(shù)：需要案例路徑：/UI2/demo/netease指紋識別（使用方法）蘋果設(shè)備指紋識別插件所在位置：com.justep.cordova.plug in .touchid 調(diào)用名稱：n avigator.touchid音頻控制插件（使用方法）通過參數(shù)調(diào)節(jié)手 機播放音頻所在位置：com.justep.cordova.plug in.v oiceMa nager

26、插件名稱功能描述詳情調(diào)用名稱：n avigator.voiceMa nager微博插件集成了weibo.SDK,提供微博授權(quán)登錄與 微博分享的能力所在位置：com.justep.cordova.plugi n. weibo 調(diào)用名稱：navigator.Weibo參數(shù)：需要案例路徑：/UI2/demo/native/shareAppEve nt為第三方提供各 種活動，使其可供 使用所在位置：cordova-plugi n-app-eve nt調(diào)用名稱：導(dǎo)入模塊AppPrefere nces（使用方法）應(yīng)用屬性設(shè)置插件所在位置：cordova-plugi n-app-prefere nces 調(diào)用名稱：plug in s.appPrefere nces增強型瀏覽器基于Crosswalk 引擎的瀏覽器，能力比所在位置：cordova-plugi n-crosswalk-webview插件名稱功能描述詳情自帶 webview 更，但會增大 apk 體 積，只針對于安卓md5 插件根據(jù)一個文件 生成對應(yīng)的 md5 值所在位置：cordova-plugi n-fastrde-md5 調(diào)