Cordova插件清单及使用说明

1、Cordova 插件清单及使用说明（持续更新中）WeX5 的混合模式底层基于 cordova/phonegap,所以开发本地插件只需要按照相应规范就可以，由于 BeX5 基于 WeX5,所以本文档也适用于 BeX5一、如何使用本地插件(CordovapluginCordovaplugin) )在需要使用插件的页面对应的 js 中，如下代码引用：1require($UI/system/lib/cordova/cordova);2/cordova运行环境，多个页面用cordova插件，每个页面都需要require进来3require(cordova!phonegap-plugin-barcodes

2、canner);4/使用的cordova插件再参考插件的文档，书写对应的 js。例如二维码插件 barcodesacnner,代码如下：1/扫描二维码，返回二维码信息2cordova.plugins.barcodeScanner.scan(3function(result)4alert(Wegotabarcoden+5Result:+result.text+n+6Format:+result.format+n+7Cancelled:+result.cancelled);8,9function(error)10alert(Scanningfailed:+error);1112）；二、插件列表见下

3、表其中：所在位置”为 studio.exe（也就是 IDE 工具中）Native/plugins 文件夹下；调用名称”为 JS 调用时使用到的名称；参数”，如果需要参数，那么在打包为 APP 应用的时候，需要进行参数的填写；案例路径，为 studio.exe（也就是 IDE 工具中）具体案例所在路径。注意：1、插件相关说明，均在对应插件所在位置”目录下的 xdoc 文件中，详细使用方法请参考对应文档插件名称支付宝支付功能描述阿里支付本地扩展插件详情所在位置：com.justep.cordova.plugin.alipay调用名称：navigator.alipay参数：需要插件名称功能描述详情案

4、例路径:/UI2/takeout银联支付银联支付本地扩展插件所在位置:com.justep.cordova.plugin.unionpay调用名称:navigator.unionpay参数：需要案例路径:/UI2/takeout微信支付（分享）微信v3本地扩展插件，包括微信支付和微信分享所在位置：com.justep.cordova.plugin.weixin.v3调用名称:navigator.weixin参数：需要支付案例路径:/UI2/takeout;分享案例路径：/UI2/demo/native/share下载插件下载多个或单所在位置：cordova-plugin-fastrde-dow

5、nloader个文件，可以进行调用名称:window.downloader校验的一致性或下载完成自动解案例路径:/UI2/demo/native/downloader压文件本地文件插件法）（使用方本地文件插件，提供对本地文件的存取操作，该插件基于html5的File所在位置：cordova-plugin-file调用名称:window.File案例路径:/UI2/demo/native/downloader文件打开插件在app中使用默认打开方式打开本地文件所在位置:cordova-plugin-file-opener2调用名称：cordova.plugins.fileOpener2案例路径:/

6、UI2/demo/native/fileOpener本地文件传输本地文件传输插件， 提供文件的上传下载操作所在位置：cordova-plugin-file-transfer调用名称:window.FileTransfer案例路径:/UI2/system/api/native文件打开在app中用打开首频，视频，图片或其他格式的文件等，支持本地文件和远程文件所在位置:cordova-open调用名称：cordova.plugins.disusered案例路径:/UI2/demo/native/open打开文档插件用方法）（使打开文档插件,下载指定url的文档并使用系统注册过的应用打开所在位置：ch

7、.ti8m.documenthandler调用名称：window.handleDocumentW让hURLmd服验读取大文件并生成md5suni曾量所在位置：de.fastr.phonegap.plugins.md5chksum调用名称：window.md5chksum极光推送法）（使用方推送消息，支持Android,ISO所在位置：cn.jpush.phonegap.JPushPlugin调用名称：window.plugins.jPushPlugin参数：需要地理位置位置（使插件，提供地理位置信息，依赖百度定位插件所在位置：cordova-plugin-x-socialsharing调用名称

8、：plugins.socialsharing案例路径:/UI2/demo/native/shareInfo近场通讯近场通讯插件,仅支持Android案例路径:/UI2/takeout所在位置:phonegap-nfc调用名称：window.nfc维码扫描二维码、 条形码扫描插件所在位置：phonegap-plugin-barcodescanner调用名称：cordova.plugins.barcodeScanner地理位置用方法）所在位置：cordova-plugin-geolocation调用名称：navigator.geolocation案例路径:/UI2/demo/native/geol

9、ocation社交分享分享插件，可分享文本、图片等文件，并关联打开本地注册过的可分享类型视频播放插件视频播放插件,支持本地路径和http:/路径案例路径:/UI2/demo/native/barcode所在位置：com.phonegap.plugins.videoplayer调用名称：cordova.plugins.videoPlayer案例路径:/UI2/demo/native/videoplayer状态栏法）（使用方状态栏本地插件，用来控制状态栏的显示方式所在位置:cordova-plugin-statusbar调用名称：window.StatusBar参数：需要Http请求（使用方法）H

10、ttp请求插件,使用本地接口发送http请求，这将提供跨域的ajax调用所在位置：plugin.http.request调用名称：navigator.plugins.HttpRequest案例路径:/UI2/demo/netease内置浏览内置浏览本地所在位置:cordova-plugin-inappbrowser蓝牙照相机设备信（使用方法）插件，类似浏览器中js的window.open,用指定模式打开url蓝牙插件，提供对蓝牙设备的监听和使用照相机本地插件，调用照相机获取图片设备信息本地插件，获取设备信息，包括操作系统类型和版本、设备uuid等调用名称:window.open案例路径:/UI

11、2/demo/account所在位置：cordova-plugin-ble-central调用名称:window.ble所在位置：cordova-plugin-camera调用名称:navigator.camera案例路径:/UI2/demo/native/camera所在位置：cordova-plugin-device调用名称:window.device设备传感器加速器本地插件,获取设备加速器(acceleration)信息所在位置:cordova-plugin-device-motion调用名称:navigator.accelerometer案例路径:/UI2/demo/native/ac

12、celerometer指南针电子罗盘本地插件，获取设备方向信息所在位置:cordova-plugin-device-orientation调用名称:pass联系人联系人本地插件，获取设备联系人信息所在位置:cordova-plugin-contacts调用名称:navigator.contacts声音设备(使用方法)本地声音设备插件，用于播放声首、控制首量等所在位置:cordova-plugin-media调用名称:window.Media案例路径:/UI2/demo/native/audio多媒体文件录制多媒体录制本地插件，用于捕获所在位置:cordova-plugin-media-capt

13、ure图片、录制声音和调用名称:navigator.device.capture视频案例路径:/UI2/demo/native/camera电池状态插所在位置：cordova-plugin-battery-status电池状态件，监控设备电池调用名称：navigator.battery状态所在位置:cordova-plugin-screen-orientation调用名称:window.plugins.screen案例路径:/UI2/demo/native/screenorientation所在位置:cordova-plugin-vibration调用名称:navigator.notifica

14、tion屏幕常亮插件方法）（使用使屏幕禁止睡眠所在位置:cordova-plugin-insomnia调用名称:plugins.insomnia屏幕旋转用方法）（使控制屏幕旋转方向设备震动震动本地插件,调用设备进行震动本地日历插件方法）（使用用于调用本地日历， 设置活动相关操作所在位置:cordova-plugin-calendar调用名称:plugins.calendar案例路径:/UI2/demo/native/calendar本地浮动框提示浮动提示插件,弹出本地浮动提示框所在位置:cordova-plugin-x-toast调用名称:plugins.toast案例路径:/UI2/demo

15、/native/toast本地等待和进度（使用方法）基 于Spinner提供的本地等待和进度对话框所在位置:cordova-plugin-spinner-dialog调用名称:plugins.spinnerDialog本地选项卡用方法）（使本地选项卡插件，用来展示一组本地选项列表所在位置:cordova-plugin-actionsheet调用名称:plugins.actionsheet案例路径:/UI2/demo/native/actionsheet本地对话框插件，提供提醒(alert)、询问(confirm,prompt)和蜂鸣音(beep)的本地调用所在位置：at.modalog.cor

16、dova.plugin.cache调用名称:window.cache案例路径:/UI2/demo/native/clearCacheSQLite插件用方法)(使SQLite插件,提供本地数据库的存储所在位置：com.brodysoft.sqlitePlugin调用名称：window.SQLitePlugin案例路径：/UI2/demo/native/sqliteapp缓存清除插件消除app缓存应 用 安 装 状态(使用方法)应用安装状态插件，通过URI所在位置:cordova-plugin-appavailability本地对话框所在位置:cordova-plugin-dialogs调用名称:

17、navigator.notificationapp后台运行应用图标数字提醒用方法)获取app版本信息(使用方法)Scheme(iOS)或调用名称：window.appAvailability者包名(Android)判断指定的应用是否已安装app后台运行插，防止app在后台进入睡眠状态应用图标数字提醒。IOS通过应用图标数字进行提醒；Android系统由于系统限制，通过状态栏进行提醒获取app版本相关信息所在位置:de.appplant.cordova.plugin.background-mode调用名称：cordova.plugins.backgroundMode案例路径:/UI2/demo/

18、native/backgroundMode所在位置：de.appplant.cordova.plugin.badge调用名称：plugin.notification.badge案例路径:/UI2/demo/native/badge所在位置：cordova-plugin-app-version闪屏插件欢迎页本地插件，默认建议包含。启动本地应用时显示指定的图片国际化国际化插件，提供语言、日期、货币等本地化信息本地转场动画本地转场动画插件， 提供页面问的本地转场动画效果调用名称:cordova.getAppVersion案例路径:/UI2/demo/account所在位置：cordova-plugi

19、n-splashscreen调用名称:navigator.splashscreen所在位置：cordova-plugin-globalization调用名称：navigator.globalization所在位置:com.telerik.plugins.nativepagetransitions调用名称:plugins.nativepagetransitions案例路径:/UI2/demo/native/barcode复制粘贴复制粘贴文本所在位置:com.verso.cordova.clipboard调用名称:cordova.plugins.clipboard案例路径:/UI2/demo/na

20、tive/clipboard自定义URL协议方法)(使用自定义指定的协议类型URL_SCHEMffi通handleOpenURL回调进行接管。例如指定协议mycoolapp,贝 将接管mycoolapp:/xxx所在位置：cordova-plugin-customurlscheme调用名称:window.plugins.launchmyapp参数：需要console提供全局对象console,通过console.log()记录日志所在位置：cordova-plugin-console调用名称:window.console键盘插件键盘插件，用来显示隐藏键盘及其他关于键盘的操作所在位置:cordo

21、va-plugin-keyboard调用名称：window.Keyboard案例路径:/UI2/demo/native/keyboard网络信息网络信息本地插件，获取网络连接信息所在位置：cordova-plugin-network-information调用名称:navigator.connection隐私屏幕法）（使用方隐私屏幕插件，本插件无调用接口，包含即可。包含后，如果用应用管理程序切换应用时将不会看到当前应用的屏幕快昭八、所在位置:cordova-plugin-privacyscreen调用名称：PrivacyScreenPluginappUtils提供app更新资源包更新能力设置首

22、页等相关所在位置：com.justep.cordova.plugin.app.utils调用名称：navigator.appUtils百度定位插件百度地图插件旧版科大讯飞插件（使用方法）能力百度定位插件，提供定位相关能力，仅限安卓客户端调用百度地图客户端集成了科大讯飞的SDK提供语音听写、语音合成的功能QQS件集成了QQSDK所在位置：com.justep.cordova.plugin.baidulocation调用名称：navigator.baiduLocation案例路径/UI2/takeout所在位置：com.justep.cordova.plugin.bmap调用名称：导入相应模块案例

23、路径/UI2/system/api/native所在位置：com.justep.cordova.plugin.iFlytek调用名称：navigator.speech参数：需要所在位置：com.justep.cordova.plugin.QQ插件名称功能描述详情提供了授权登录，分享功能调用名称：navigator.QQ参数：需要案例路径：/UI2/demo/native/share安全验证插件集成了mobSDK提供短信验证的功能所在位置：com.justep.cordova.plugin.security.mob调用名称：navigator.mobsms参数：需要案例路径：/UI2/demo/

24、netease指纹识别（使用方法）苹果设备指纹识另I插件所在位置：com.justep.cordova.plugin.touchid调用名称：navigator.touchid音频控制插件（使用方法）通过参数调节手机播放首频所在位置：com.justep.cordova.plugin.voiceManager微博插件集成了weibo.SDK,提供微博授权登录与微博分享的能力AppEventAppPreferences用方法）增强型浏览器调用名称：navigator.voiceManager所在位置：com.justep.cordova.plugin.weibo调用名称：navigator.We

25、ibo参数：需要案例路径：/UI2/demo/native/share为第三方提供各所在位置：cordova-plugin-app-event种活动，使其可供调用名称：导入模块使用（使应用属性设置插件所在位置：cordova-plugin-app-preferences调用名称：plugins.appPreferences基于Crosswalk引擎的浏览器，能力比所在位置：cordova-plugin-crosswalk-webview自带webview更,但会增大apk体积，只针对于安卓根据一个文件生成对应的md5值所在位置:cordova-plugin-sim调用名称：window.plugins.