Cordova插件清单及使用说明.docx

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

2、r);/使用的cordova插件再参考插件的文档，书写对应的js。例如二维码插件barcodesacnner，代码如下：123456789101112/扫描二维码，返回二维码信息cordova.plugins.barcodeScanner.scan(function (result) alert(We got a barcoden +Result: + result.text + n +Format: + result.format + n +Cancelled: + result.cancelled);,function (error) alert(Scanning failed: + er

3、ror););二、插件列表见下表其中：“所在位置”为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下载插件下载多个或单个文件，可以进行校验的一致性或下载完成自动解压文件所在位置

5、:cordova-plugin-fastrde-downloader调用名称: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的文档并使用系统注册过的应用打开所在位置

7、:ch.ti8m.documenthandler调用名称:window.handleDocumentWithURLmd5校验读取大文件并生成md5sum增量所在位置：de.fastr.phonegap.plugins.md5chksum调用名称：window.md5chksum极光推送 (使用方法)推送消息，支持Android，ISO所在位置:cn.jpush.phonegap.JPushPlugin调用名称:window.plugins.jPushPlugin参数：需要案例路径:/UI2/takeout近场通讯近场通讯插件，仅支持Android所在位置:phonegap-nfc调用名称:wi

8、ndow.nfc地理位置 (使用方法)地理位置位置插件，提供地理位置信息，依赖XX定位插件所在位置:cordova-plugin-geolocation调用名称:navigator.geolocation案例路径:/UI2/demo/native/geolocation社交分享分享插件，可分享文本、图片等文件，并关联打开本地注册过的可分享类型所在位置:cordova-plugin-x-socialsharing调用名称:plugins.socialsharing案例路径:/UI2/demo/native/shareInfo二维码扫描二维码、条形码扫描插件所在位置:phonegap-plugin

9、-barcodescanner调用名称:cordova.plugins.barcodeScanner案例路径:/UI2/demo/native/barcode视频播放插件视频播放插件，支持本地路径和http:/路径所在位置:com.phonegap.plugins.videoplayer调用名称:cordova.plugins.videoPlayer案例路径:/UI2/demo/native/videoplayer状态栏 (使用方法)状态栏本地插件，用来控制状态栏的显示方式所在位置:cordova-plugin-statusbar调用名称:window.StatusBar参数:需要Http请求

10、 (使用方法)Http请求插件，使用本地接口发送http请求，这将提供跨域的ajax调用所在位置:plugin.http.request调用名称:navigator.plugins.HttpRequest案例路径:/UI2/demo/netease内置浏览内置浏览本地插件，类似浏览器中js的window.open，用指定模式打开url所在位置:cordova-plugin-inappbrowser调用名称:window.open案例路径:/UI2/demo/account蓝牙蓝牙插件，提供对蓝牙设备的监听和使用所在位置:cordova-plugin-ble-central调用名称:window

11、.ble照相机照相机本地插件，调用照相机获取图片所在位置:cordova-plugin-camera调用名称:navigator.camera案例路径:/UI2/demo/native/camera设备信息 (使用方法)设备信息本地插件，获取设备信息，包括操作系统类型和版本、设备uuid等所在位置:cordova-plugin-device调用名称:window.device设备传感器加速器本地插件，获取设备加速器(acceleration)信息所在位置:cordova-plugin-device-motion调用名称:navigator.accelerometer案例路径:/UI2/demo

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

13、ova-plugin-media-capture调用名称:navigator.device.capture案例路径:/UI2/demo/native/camera电池状态电池状态插件，监控设备电池状态所在位置:cordova-plugin-battery-status调用名称:navigator.battery屏幕旋转 (使用方法)控制屏幕旋转方向所在位置:cordova-plugin-screen-orientation调用名称:window.plugins.screen案例路径:/UI2/demo/native/screenorientation屏幕常亮插件 (使用方法)使屏幕禁止睡眠所在

14、位置:cordova-plugin-insomnia调用名称:plugins.insomnia设备震动震动本地插件，调用设备进行震动所在位置:cordova-plugin-vibration调用名称:navigator.notification本地日历插件 (使用方法)用于调用本地日历，设置活动相关操作所在位置:cordova-plugin-calendar调用名称:plugins.calendar案例路径:/UI2/demo/native/calendar本地浮动框提示浮动提示插件，弹出本地浮动提示框所在位置:cordova-plugin-x-toast调用名称:plugins.toast案

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

16、用所在位置:cordova-plugin-dialogs调用名称:navigator.notificationSQLite插件 (使用方法)SQLite插件，提供本地数据库的存储所在位置:com.brodysoft.sqlitePlugin调用名称:window.SQLitePlugin案例路径:/UI2/demo/native/sqliteapp缓存清除插件清除app缓存所在位置:at.modalog.cordova.plugin.cache调用名称:window.cache案例路径:/UI2/demo/native/clearCache应用安装状态 (使用方法)应用安装状态插件， 通过UR

17、I Scheme (iOS) 或者包名(Android)判断指定的应用是否已安装所在位置:cordova-plugin-appavailability调用名称:window.appAvailabilityapp后台运行app后台运行插件,防止app在后台进入睡眠状态所在位置:de.appplant.cordova.plugin.background-mode调用名称:cordova.plugins.backgroundMode案例路径:/UI2/demo/native/backgroundMode应用图标数字提醒 (使用方法)应用图标数字提醒。IOS通过应用图标数字进行提醒；Android系统

18、由于系统限制，通过状态栏进行提醒所在位置:de.appplant.cordova.plugin.badge调用名称:plugin.notification.badge案例路径:/UI2/demo/native/badge获取app版本信息 (使用方法)获取app版本相关信息所在位置:cordova-plugin-app-version调用名称:cordova.getAppVersion案例路径:/UI2/demo/account闪屏插件欢迎页本地插件，默认建议包含。启动本地应用时显示指定的图片所在位置:cordova-plugin-splashscreen调用名称:navigator.spla

19、shscreen国际化国际化插件，提供语言、日期、货币等本地化信息所在位置:cordova-plugin-globalization调用名称:navigator.globalization本地转场动画本地转场动画插件，提供页面间的本地转场动画效果所在位置:com.telerik.plugins.nativepagetransitions调用名称:plugins.nativepagetransitions案例路径:/UI2/demo/native/barcode复制粘贴复制粘贴文本所在位置:com.verso.cordova.clipboard调用名称:cordova.plugins.clipb

20、oard案例路径:/UI2/demo/native/clipboard自定义URL协议 (使用方法)自定义指定的协议类型URL_SCHEME，并通过handleOpenURL回调进行接管。例如指定协议mycoolapp，则将接管mycoolapp:/xxx所在位置:cordova-plugin-customurlscheme调用名称:window.plugins.launchmyapp参数:需要console提供全局对象console，通过console.log()记录日志所在位置:cordova-plugin-console调用名称:window.console键盘插件键盘插件，用来显示隐藏

21、键盘及其他关于键盘的操作所在位置:cordova-plugin-keyboard调用名称:window.Keyboard案例路径:/UI2/demo/native/keyboard网络信息网络信息本地插件，获取网络连接信息所在位置:cordova-plugin-network-information调用名称:navigator.connection隐私屏幕 (使用方法)隐私屏幕插件，本插件无调用接口，包含即可。包含后，如果用应用管理程序切换应用时将不会看到当前应用的屏幕快照所在位置:cordova-plugin-privacyscreen调用名称:PrivacyScreenPluginappU

22、tils提供app更新 资源包更新能力设置首页等相关能力所在位置：com.justep.cordova.plugin.app.utils调用名称：navigator.appUtilsXX定位插件XX定位插件，提供定位相关能力，仅限安卓客户端所在位置：com.justep.cordova.plugin.baidulocation调用名称：navigator.baiduLocation案例路径/UI2/takeoutXX地图插件旧版调用XX地图客户端所在位置：com.justep.cordova.plugin.bmap调用名称：导入相应模块案例路径/UI2/system/api/native科大讯

23、飞插件 (使用方法)集成了科大讯飞的SDK，提供语音听写、语音合成的功能所在位置：com.justep.cordova.plugin.iFlytek调用名称：navigator.speech参数：需要QQ插件集成了QQSDK，提供了授权登录，分享功能所在位置：com.justep.cordova.plugin.QQ调用名称：navigator.QQ参数：需要案例路径：/UI2/demo/native/share安全验证插件集成了mobSDK，提供短信验证的功能所在位置：com.justep.cordova.plugin.security.mob调用名称：navigator.mobsms参数：需

24、要案例路径：/UI2/demo/netease指纹识别 (使用方法)苹果设备指纹识别插件所在位置：com.justep.cordova.plugin.touchid调用名称：navigator.touchid音频控制插件 (使用方法)通过参数调节手机播放音频所在位置：com.justep.cordova.plugin.voiceManager调用名称：navigator.voiceManager微博插件集成了weibo.SDK，提供微博授权登录与微博分享的能力所在位置：com.justep.cordova.plugin.weibo调用名称：navigator.Weibo参数：需要案例路径：/U

25、I2/demo/native/shareAppEvent为第三方提供各种活动，使其可供使用所在位置：cordova-plugin-app-event调用名称：导入模块AppPreferences (使用方法)应用属性设置插件所在位置：cordova-plugin-app-preferences调用名称：plugins.appPreferences增强型浏览器基于Crosswalk引擎的浏览器，能力比自带webview更，但会增大apk体积，只针对于安卓所在位置：cordova-plugin-crosswalk-webviewmd5插件根据一个文件生成对应的md5值所在位置：cordova-pl

26、ugin-fastrde-md5调用名称：window.downloadersim插件获取手机sim卡信息所在位置:cordova-plugin-sim调用名称:window.plugins.sim案例路径:/UI2/demo/plugin/simAFNetworking提供iOS上常用的AFNetworking框架，不需要主动调用所在位置:com.justep.cordova.plugin.AFNetworkingace插件微软公司提供的插件，可以使用html和js非常容易的创建原生UI并调用原生代码。所在位置:cordova-plugin-ace调用名称:aceXX地图插件基础模块（使用方

27、法）集成了XX地图SDK的基础模块，可在应用内嵌入XX地图所在位置:com.justep.cordova.plugin.baiduMapBase调用名称:navigator.baiduMap.base案例路径：/UI2/demo/plugin/baiduMapXX地图插件搜索模块（使用方法）集成了XX地图SDK的搜索模块，依赖于XX地图插件基础版所在位置:com.justep.cordova.plugin.baiduMapSearch调用名称:navigator.baiduMap.search案例路径：/UI2/demo/plugin/baiduMapwifi插件获取手机wifi相关信息，iOS与Android略有差异所在位置:cordova-plugin-wifi调用名称:plugins.WifiAdmin图片选择插件在图片库选择一张或者多张图片所在位置:com.synconset.imagepicker调用名称:plugins.imagePicker案例路径:UI2/demo/plugin/imagepicker系统设置插件打开系统设置的插件所在位置:cordova-open-native-settings调用名称:cordova.plugins.settings