1.0.5 • Published 4 years ago
launch-app-lib v1.0.5
launch-app-lib
launch-app-lib 是一个在 H5 唤起 APP 的解决方案
在使用过程中,如有bug请提issue,我会及时跟进。有更好的解决方案欢迎讨论。
Install
Install with npm:
$ npm install --save launch-app-lib
Usage
const LaunchApp = require('launch-app-lib');
or;
import LaunchApp from 'launch-app-lib';
const config = {
scheme: {
url: 'scheme://host/path'
},
intent: {
path: 'scan/',
scheme: 'zxing',
packageName: 'com.google.zxing.client.android',
fallbackUrl: 'https://dl.yzcdn.cn/koudaitong.apk'
},
universal: {
url: 'https://host/path'
},
yingyongbao: '',
itunes: '',
apk: ''
};
const launchApp = new LaunchApp(config);
const params = {
url: 'https://xxx/xxx',
id: 123
};
launchApp.launch(params);
launchApp.getScheme(params);
// scheme://host/path?url=https://xxx/xxx&id=123
launchApp.getIntent(params);
// intent://scan/#Intent;scheme=zxing;package=com.google.zxing.client.android;S.url=https://xxx/xxx;l.id=123;S.browser_fallback_url=https%A%F%Fitunes.apple.com%Fcn%Fapp%Fid880579403;end
launchApp.getUniversalLink(params);
// https://host/path?url=https://xxx/xxx&id=123
config
参数 | 说明 | 类型 | 是否必须 |
---|---|---|---|
scheme | APP scheme 信息 | object | 是 |
intent | APP intent 信息 | object | 是 |
universal | APP universal 信息 | object | 是 |
yingyongbao | APP 应用宝地址 | string | 是 |
itunes | APP 的 App Store 地址 | string | 是 |
apk | APP 的 apk 下载地址 | string | 是 |
timeout | 唤起 APP 超时时间 | number or string | 否 |
intentNotSupportedBrowserList | 不支持intent唤起的ua关键字名单(针对国产手机自带浏览器) | array | 否 |
scheme
参数 | 说明 | 类型 | 是否必须 |
---|---|---|---|
url | scheme url "scheme://host/path" | string | 是 |
intent
eg:
intent:
//scan/
#Intent;
package=com.google.zxing.client.android;
scheme=zxing;
end;
参数 | 说明 | 类型 | 是否必须 |
---|---|---|---|
path | intent path "scan/" | string | 是 |
scheme | scheme "zxing" | string | 是 |
packageName | APP 包名 "com.google.zxing.client.android" | string | 是 |
fallbackUrl | 唤起失败降级访问 url | string | 是 |
universal
参数 | 说明 | 类型 | 是否必须 |
---|---|---|---|
url | universal url | string | 是 |
Method
launch
唤起 APP 方法
参数 | 说明 | 类型 | 是否必须 |
---|---|---|---|
params | 启动 APP 参数,用于拼接到对应的启动 url 中 "scheme://host/path?key=value" | object | 是 |
failCallback | 指定启动失败后的回调函数 | fun | 否 |
getScheme
获取 Scheme url
参数 | 说明 | 类型 | 是否必须 |
---|---|---|---|
params | 启动 APP 参数,用于拼接到对应的启动 url 中 | object | 是 |
getIntent
获取 Scheme url
参数 | 说明 | 类型 | 是否必须 |
---|---|---|---|
params | 启动 APP 参数,用于拼接到对应的启动 url 中 | object | 是 |
getUniversalLink
获取 Scheme url
参数 | 说明 | 类型 | 是否必须 |
---|---|---|---|
params | 启动 APP 参数,用于拼接到对应的启动 url 中 | object | 是 |