WApp介绍
WApp是一款App的混合开发框架,义在让开发者使用HTML、Javascript、CSS等开发跨平台的移动应用程序。它提供了非富js接口和配置项,使小白和专业开发人员都可以轻松制作App。
2015年6月第一版发布以来,经过两年多的更新迭代。优化了在各品牌手机稳定性,通过简单的配置制作出混合App。
DEMO
http://www.appbsl.cn/demo2/api/index.html (原生组件API Demo)
http://www.appbsl.cn/demo2/windows/index.html (App界面API Demo)
https://pan.baidu.com/s/1row6EfQFMVmBUidn755iVA (支付宝/微信支付)
API接口列表
WApp提供丰写的原生API,可以方便的调起各种原生功能模块,如分享,支付,登录,推送,扫一扫,指纹,系统,网络等。
注:网页无需引入js文件,在网页加载完成后直接调用。原生组件可以用预加载进行对其控制。
编号 | JS函数 | 参数 | 描述 |
---|---|---|---|
1 | appFinishiLoad() | 无 | 自动运行JS函数。更加简单的实现一些App的调用功能和网页功能。如隐藏对应的模块,原生栏的控制,横竖屏的功能。 帮助:自动运行JS函数 |
2 | BSL.Pay('data','payType','callbackMethod'); |
data:定单数据 payType:支付方式 WEIXIN(微信),ALIPAY(支付宝)固定值 callbackMethod:自定义回调函数,支付操作后返回网页要运行的JS函数。不要定义在其它函数内部。 | 实现原生的支付宝与微信支付 帮助:原生支付(微信/支付宝) |
3 | BSL.Login('platform','forwardurl','callbackMethod'); |
platform:QQ(QQ),WEIXIN(微信),SINA(微博),固定值大写。 forwardurl:为登陆成功以后跳转的地址,返回当前页为空; callbackMethod:自定义回调函数,登陆操作后回调的js函数; | 实现微信,QQ,微博登录 |
4 | BSL.Share('content', 'imageurl', 'targetUrl', 'title' , 'callbackMethod'); |
content:分享内容 imageurl:图片网址 targetUrl:联接网址 title:分享标题 callbackMethod:自定义回调函数; | 实现标准分享。可以分享至微信,QQ,微博平台。调出原生弹层分享 |
5 | BSL.ShareImg('imageurl', 'callbackMethod'); |
imageurl:图片网址 callbackMethod:自定义回调函数; | 实现单图片分享。可以分享至微信,QQ,微博平台。调出原生弹层分享。 |
6 | BSL.ShareCImg(callbackMethod); | callbackMethod:自定义回调函数 | 截图当前App页面进行分享,可以分享至微信,QQ,微博平台。调出原生弹层分享。 |
7 | BSL.ShareImgWithTxt('platform','content', 'imageurl', 'targetUrl', 'title', 'callbackMethod') |
platform:WEIXIN(微信),WEIXIN_TIMELINE(微信朋友圈),QQ(QQ好友),QZONE(QQ空间), SINA(新浪微博) content:分享内容; imageurl:图片网址; targetUrl:联接网址; title:分享标题; callbackMethod:自定义回调函数; | 标准分享,页面内指定平台。自主写分享按键。 |
8 | BSL.ShareImgByPlatfrom('platform','imageurl', 'callbackMethod') |
platform:WEIXIN(微信),WEIXIN_TIMELINE(微信朋友圈),QQ(QQ好友),QZONE(QQ空间), SINA(新浪微博) imageurl:图片网址; callbackMethod:自定义回调函数; | 单图片分享,页面内指定平台.自主写分享按键。 |
9 | BSL.ShareCImgByPlatform('platform','callbackMethod') |
platform:WEIXIN(微信),WEIXIN_TIMELINE(微信朋友圈),QQ(QQ好友),QZONE(QQ空间), SINA(新浪微博) callbackMethod:自定义回调函数; | 截图当前App页面进行分享,页面内指定平台.自主写分享按键。 |
10 | BSL.ShareMultiImage(data,descript); |
data:字符串数组,大于1,不能空; descript:分享描述,不能空; | 一次分享多张图片到微信,QQ。不用配置任何项直接可以使用。自主写分享按键。 帮助:原生分享(QQ、微博、微信) |
11 | BSL.hideStateBar('state'); | state:0(隐藏),1(显示),固定值 | 显示与隐藏电池栏 帮助:原生导航栏控制 |
12 | BSL.downRefresh(open,isLong) |
open:0(关闭),1(开启) isLong:0(当前)1(全局) | 开启与关闭某一页面内的原生刷新 帮助:原生下拉刷新 |
13 | BSL.AppLeft('state') | state:1 | 打开原生左侧栏 |
14 | BSL.AppBottom(flag,isLong) |
flag:0(隐藏),1(显示) isLong:0(当前页),1(全局) | 实现当前页和全App内的菜单栏的显示与隐藏 帮助:原生菜单栏控制 |
15 | BSL.tabbarColor(‘color’,isLong) |
color:16进制颜色值,例如 #FFC0CB isLong:0(当前页),1(全局) | 改变菜单栏背景颜色 帮助:原生菜单栏控制 |
16 | BSL.SetTabbarAlpha('alpha'); | alpha:0.01-0.99 小数,不能为其它数据。0.01为全透明。0.99为不透明 | 改变菜单栏透明度 帮助:原生菜单栏控制 |
16 | BSL.ChangeTabbar(json); | json:{\"itemId\":0,\"title\":\"首页\",\"fontSize\":12,\"imageDefault\":\"back\",\"imageSelect\":\"back\",\"colorDefault\":\"#00ff00\",\"colorSelect\":\"#0000ff\"} | 改变菜单按键的功能,颜色,图标 帮助:原生菜单栏控制 |
17 | BSL.AppTop('flag','isLong'); |
flag:0(隐藏),1(显示) isLong:0(当前页),1(全局) | 实现当前页和全App内的导航栏的显示与隐藏 |
18 | BSL.AppTopL('state','buttonImage'); |
state:0~9功能选择 0分享;1二维码;2关于;3清除缓存;4打开链接;5前进;6后退;7刷新;8关闭;9打开左侧栏; buttonImage:图片网址,为空时显示默认图标 | 控制导航栏的左侧按键 |
19 | BSL.AppTopR('state','buttonImage'); |
state:0~9功能选择 0分享;1二维码;2关于;3清除缓存;4打开链接;5前进;6后退;7刷新;8关闭;9打开左侧栏; buttonImage:图片网址,为空时显示默认图标 | 控制导航栏的右侧按键 |
20 | BSL.navbarColor(‘color’,isLong) |
color:16进制颜色值,例如 #FFC0CB isLong:0(当前页),1(全局) | 改变导航栏背景颜色 |
21 | BSL.SetTitleName(title,color); |
title:标题 color:color:16进制颜色值,例如 #FFC0CB | 修改原生导航栏上的标题显示 |
22 | BSL.SetNavBarAlpha('alpha','isLong'); |
alpha:0.01-0.99 小数,不能为其它数据。0.01为全透明。0.99为不透明 isLong:0(当前页),1(全局) | 原生导航栏透明度控制 |
23 | BSL.Qcode('type','callbackMethod'); | flag:0(回调处理),1(固定方式处理) | 二维码扫码。回调处理进入回调函授内自行处理。固定方式网址自动打开,其它弹出窗口显示 帮助:扫码(一维码/二维码) |
24 | BSL.GPS('callbackmethod'); | callbackMethod:自定义回调函数 | 安卓返回为谷歌坐标,苹果返回为GPS坐标 帮助:GPS调用 |
25 | BSL.CCache(); | 无 | 清除缓存 帮助:App缓存管理 |
26 | BSL.cacheSize('callbackMethod'); | callbackMethod:自定义回调函数 | 缓存数据大小,带单位 帮助:App缓存管理 |
27 | BSL.CopyText('content'); | content:复制的内容 | 复制内容到手机剪切板内 帮助:剪切板管理 |
28 | BSL.CopyUrl(); | 无 | 复制当前网址到剪切板 帮助:剪切板管理 |
29 | BSL.getClipboard('callbackMethod'); | callbackMethod:自定义回调函数 | 获取剪切板内容 帮助:剪切板管理 |
30 | BSL.touchID('callbackMethod'); | callbackMethod:自定义回调函数; | 指纹或面容验证,返回是固定值1(成功)、0(失败) 帮助:指纹/面容ID验证 |
31 | BSL.WifiSsid('callbackMethod'); | callbackMethod:自定义回调函数 | 返回当前的wifi的ssid,没有联接wifi返回为空 帮助:网络接口 |
32 | BSL.GetNetType('callbackMethod'); | callbackMethod:自定义回调函数 | 获取当前网络值,网络类型:2G/3G/4G/wifi/未联接/未知网络 帮助:网络接口 |
33 | BSL.MonitorNetWork('callbackMethod') | callbackMethod:自定义回调函数 | 用于网络变化时接收到变化的网络类型,当网络变化时自动运行回调。要求当前网址内必须有设置的回调 帮助:网络接口 |
34 | BSL.CloseMonitorNetWork() | 无 | 结束网络监听 帮助:网络接口 |
35 | BSL.PhoneID('callbackMethod'); | callbackMethod:自定义回调函数; | 调取手机标识,苹果读取UID值,安卓读取IMEI 帮助:设备标识码 |
36 | BSL.AppScreen('orientation'); | orientation:0 随屏,1 竖屏,2 向左横屏,3 向右横屏; | App横屏、竖屏控制 帮助:屏幕接口 |
37 | BSL.SetBrightness(value,flag); |
value:0.00-1.00之间小数 flag:1(系统亮度),0(app亮度) | 系统亮度:设置系统的亮度,退出App后依然有效。App高度:退出App无效 帮助:屏幕接口 |
38 | BSL.GetBrightness('orientation'); | orientation:自定义回调函数; | 当前屏亮度 帮助:屏幕接口 |
39 | BSL.OpenWeb('url'); | url:可为空 | url为空时跳转当前网页,有值跳转指定值网页 |
40 | BSL.OpenBrowser(callbackMethod,type,url); |
callbackMethod:自定义回调,0(成功)1)没有安装)2)打开失败) type:打开的浏览器类型,UC(UC浏览器)QQ(QQ浏览器)Google(谷歌浏览器)SYS(系统) url:要打开的网址 | 指定浏览器打开网址 |
41 | BSL.GetContact(callbackMethod); | callbackMethod:自定义回调函数。 | 获取单个联系人,返回信息lastName:姓氏、firstName:名字、telNums:电话数组,每个人可能有多个电话、emails:电子邮箱数组 帮助:通信录接口 |
42 | BSL.GetAllContact(callbackMethod); | callbackMethod:自定义回调函数。 | 获取所有联系人,返回信息lastName:姓氏、firstName:名字、telNums:电话数组,每个人可能有多个电话、emails:电子邮箱数组 |
43 | BSL. AddContact(json, callback); |
json:增加联系人信息 callback:自定义回调函数,0(失败),1(成功), | 联系人数据{\"telNums\":[\"155-1165-7958\",\"12365896523\"],\"firstName\":\"大锤\",\"workEmails\":[\"2@126.com\"],\"homeEmails\":[\"1@126.com\"],\"lastName\":\"张\"} |
44 | BSL.JPushTag('tags','callbackmethod') |
tags:注册的标签 callbackMethod:自定义回调函数,0(成功)其他(失败) | 注册极光和小米推送的单独标签,标签可以是多个中间用”,“格开 帮助:推送功能 |
45 | BSL.navMap(startlat,startlon,endlat,endlon,callbackMethod,mapType) |
startLat:开始纬度 startLon:开始经度 endLat:终点纬度 endLon:终点经度 callbackMethod:自定义回调 mapType:地图类型。AppleMap苹果、GDMap高德、GGMap谷歌、TXMap腾讯、BDMap百度 | 调用导航软件,可以配合检测App使用 |
46 | BSL.checkApp(app,callbackMethod) |
app:安卓(包名packageName),苹果(urlScheme) callbackMethod:自定义回调函数,1(安装)0(未安装) | 检测App是否安装 帮助:调用App |
47 | BSL.openApp(app,callbackMethod) |
app:安卓(包名packageName),苹果(urlScheme) callbackMethod:自定义回调函数,1(安装)0(未安装) | 打开App 帮助:调用App |
48 | BSL.checkWX('callbackMethod'); | callbackMethod:自定义回调函数; | 打开微信 帮助:调用App |
49 | BSL.checkZFB('callbackMethod') | callbackMethod:自定义回调函数; | 打开支付宝 帮助:调用App |
50 | BSL.setVolume(value); | value:值的范围 0.00-1.00之间的小数值。 | 设置系统铃声,只支持安卓系统 帮助:铃声接口 |
51 | BSL.getVolume('callbackMethod') | callbackMethod:回调函数。 | 获得系统音量,只支持安卓系统 帮助:铃声接口 |
52 | BSL.msgRing() | 无 | 调用系统提示音 帮助:铃声接口 |
53 | BSL.setAVVolume(value); | value:值的范围 0.00-1.00之间的小数值。 | 设置系统播放音、视频音量 帮助:铃声接口 |
54 | BSL.getAVVolume('callbackMethod') | callbackMethod:回调函数。 | 获得系统播放音频视频音量 帮助:铃声接口 |
55 | BSL.OpenVideo(url,title) |
url:视频地址,要求全网址。如:http://www.xxx.com/1.mp4 title:视频标题。 | 调用App原生播放器 |
56 | BSL.PhoneInfo(callback); | callback:自定义回调函数、返回为json格式 | 调用设备信息 帮助:设备信息接口 |
57 | BSL.GetVersion(callbackMethod); | callback:自定义回调函数 | 获取app版本号,基础设置内配置的版本号 |
58 | BSL.SetJsClose(); | 无 | 关闭App,适用于安卓系统,苹果操作系统上没有关闭 |
59 | BSL.DownloadFile(data,callbackMethod) |
data:下载文件的地址。参数为字符串数组类型。 callbackMethod:自定义回调函数,文件下载完成后调用。 | 下载文件到指定的目录下 帮助:下载接口 |
60 | URL Scheme:// | URL Scheme:苹果软件的urlScheme | 苹果系统,打开App应用 帮助:调用App |
61 | URL Scheme://url=http://www.xxx.com | URL Scheme:苹果软件的urlScheme | 苹果系统,打开App应用并打开对应的网址 帮助:调用App |
62 | 应用包名:// | 应用包名:安卓软件的应用包名 | 安卓系统,打开App应用 帮助:调用App |
63 | 应用包名://url=http://www.xxx.com | 应用包名:安卓软件的应用包名 | 安卓系统,打开App应用并打开对应的网址 帮助:调用App |
64 | UA标识 | bsl | 浏览器的UA(user-Agent)标识 |
65 | 原生栏指定分享内容 |
BSLimg:分享图片 BSLTitle:分享标题 BSLContent:分享内容 | class标签。图片地址一定是完全地址,如:http://www.xxx.com/img/1.png; |
66 | bslImgClick | bslImgClick:浏览的图片。 | class标签,图片浏览功能,提高用户体验度 帮助:原生图片浏览 |
67 | BSL.checkMap(callbackMethod,mapType) |
callbackMethod:自定义回调函数 mapType:地图类型,固定值。 | 检测软件是否安装 |
68 | BSL.openMap(callbackMethod,mapType) |
callbackMethod:自定义回调函数 mapType:地图类型,固定值。 | 打开地图软件。 |
69 | BSL.SlideHideNav(flag) | flag:固定值。1(开启)0(关闭) | 开启/关闭上下滑动隐藏导航栏 |
70 | BSL.SlideHideTab(flag) | flag:固定值。1(开启)0(关闭) | 开启/关闭上下滑动隐藏菜单栏 |
71 | BSL.KeepBright(flag) | flag:固定值。1(开启)0(关闭) | 打开/关闭设备屏幕长亮 |
72 | BSL.AudioPlayBG(flag); | flag:固定值。1(开启)0(关闭) | 开启/关闭音频后台播放。开启后音频可以后台播放。WApp默认是关闭。 |
73 | BSL.Vibrator() | 调用手机震动功能。注:ios必须打开铃声震动模式。 | |
74 | BSL.ShowImages(urls,titles,orientation) |
urls:图片网络地址,参数为字符串数组类型。 titles:图片标题,参数为字符串数组类型。 orientation:固定值,控制显示方向。1(竖屏)2(横屏)3(随屏) | 调用原生图片浏览插件 |
75 | BSL.StartGPS(callbackMethod,timeOrDistance) |
callbackMethod:自定义回调函数 timeOrDistance:安卓(android):传入是时间,即为多少秒定位一次,单位为秒。例如1就是一秒。 苹果(ios):传入是距离,即为多少米定位一次单位为米。必须大约等于0,为0时只要有距离变动就会返回 | 开启定位监听,数据自动进入回调函数内。 |
76 | BSL.StopGPS() | 结束定位监听。 | |
77 | BSL.ControlScreenshot(flag) | flag:1:禁止 0:允许 | 禁止截屏 |
78 | BSL.Screenshot(start,'callbackMethod') |
start:布尔值,true开启,false关闭 callbackMethod:回调函数。当开启监听后有截屏行为将通过该方法返回图片保存路径(ios只有回调没有图片返回) | 截屏监听 |
79 | BSL.CheckBiometrics('callbackMethod') | callbackMethod:用来接收返回信息的方法,返回结果: 0:都不支持 1:支持指纹 2:支持面容 | 面容与指纹验支持检测。 |
80 | BSL.GetStepCount('callbackMethod') | callbackMethod:接收回调的数据。 | 开启计步功能之后,通过js方法获取今日的步数。 |
81 | onBack() | 无 | 开启按键监听功能后,返回键回调 |
82 | onHome() | 无 | 开启按键监听功能后,home键回调 |
83 | onTask() | 无 | 开启按键监听功能后,多任务键回调 |
84 | BSL.ShareMusic(platform,title,description,imageUrl,musicUlr,targetUrl,callbackMethod) |
platform:固定值。WEIXIN(微信)WEIXIN_TIMELINE(朋友圈) title:分享标题 description:分享描述 imageUrl:图片的地址 musicUlr:要分享的音乐地址 targetUrl:点击后的跳转地址 callbackMethod:回调的JS函数,只有失败有回调数据。失败:0 | 分享音乐到微信 |
85 | BSL.ShareVideo(platform,title,description,imageUrl,videoUrl,callbackMethod) |
platform:固定值。WEIXIN(微信)WEIXIN_TIMELINE(朋友圈) title:分享标题 description:分享描述 imageUrl:图片的地址 videoUrl:要分享的视频地址 callbackMethod:回调的JS函数,只有失败有回调数据。失败:0 | 分享视频到微信 |
86 | BSL.OpenXCX(id,path,type,callbackMethod) |
id:小程序的id path:小程序中的地址。可为空,空值为小程序的首页 type:小程序开发版本。0:正式,1:预览版,2:测试版 callbackMethod:回调的JS函数,只有失败有回调数据。失败:0 | 调用小程序。非打包小程序。 |
87 | BSL.WXPay(ProductName, Desicript, Price, OuttradeNo,attach, callbackMethod) |
ProductName:商品描述 Desicript:商品详细描述 Price:订单总金额 OuttradeNo:商户系统内部订单号 attach:附加数据 callbackMethod:回调的JS函数,只有失败有回调数据。失败:0 | 微信的快捷支付功能可以免去用户统一下单流程。使用微信的快捷支付需要先填写微信的支付配置。支付完成后自动转入设置的网址。 |
88 | BSL.QrPhoto(type,callbackMethod) |
type:固定值:1/0。1:固定方式,0:数据回调。 callbackMethod:回调的JS函数 | 调起手机相册,选择二维码图片识别。 |
89 | BSL.QrUrl(type,url,callbackMethod) |
type:固定值:1/0。1:固定方式,0:数据回调。 url:二维码图片链接 callbackMethod:回调的JS函数 | 网络图片,进行识别二维码。 |
90 | BSL.CleanData() | 无 | 清除app所有数据 |
91 | BSL.IsOpenNotice(callbackMethod) | callbackMethod:回调方法,用来接收回调给网页的结果,1:允许,0:禁止 | 获取系统是否禁止或允许app接收通知 |
92 | BSL.GetToken('callbackMethod') | callbackMethod:回调方法,用来接收回调给网页的结果,1:允许,0:禁止 | 使用华为推送,需要以手机的token为媒介推送到对应华为手机。得到华为手机token值。 |
93 | BSL.ShareMultiImageToSome(data) | data:字符串数组,大于1,小于等于9张图片。不能null. | 多图分享到微信好友,无需申请微信开放平台。(安卓版可用) |
94 | BSL.CreateWindow(url) | url:要打开的网址 | 打开新窗口,也可以是网页联接直接打开新窗口,在多窗口内打开对应的配置项 |
95 | BSL.CloseTopWindow() | 无 | 关闭当前打开的窗口 |
96 | BSL.CloseTopWindowRefresh() | 无 | 关闭当前打开的窗口,并刷新最的上层窗口中网页。 |
97 | BSL.DownloadFileByPath(datas,path,callbackMethod) | data:下载文件的地址。参数为字符串数组类型。 path:文件保存路径。多级目录使用 '/' 分割,例如:A/B/C。文件最终存放在:内存卡根目录/A/B/C 。空,图片直接保存到相册。 callbackMethod:回调函数。 | 通过js调用系统下载文件功能,并可以指定下载目录. |
98 | BSL.CheckFirstInstall('callbackMethod') | callbackMethod:自定义回调函数,1:是第一次打开,0:不是第一次打开。 | 获取当前App用户是否为第一次安装且第一次打开。 |