mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2026-02-16 00:00:02 +08:00
Compare commits
291 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6112d724f2 | ||
|
|
2913a68d8f | ||
|
|
4d346437f0 | ||
|
|
904455df9e | ||
|
|
cac9872796 | ||
|
|
d4465681cf | ||
|
|
fd3a8de693 | ||
|
|
4c07af7782 | ||
|
|
2ad03fa89b | ||
|
|
ed37c68990 | ||
|
|
66da511526 | ||
|
|
817f0d11b9 | ||
|
|
c8d3afc91d | ||
|
|
3b18135ebf | ||
|
|
614ade447f | ||
|
|
1bcaa39ffd | ||
|
|
82939763ee | ||
|
|
15ed431819 | ||
|
|
7baeab9fee | ||
|
|
41895c165c | ||
|
|
80f4ced369 | ||
|
|
95a67a813d | ||
|
|
799cf94674 | ||
|
|
2b2eb88a64 | ||
|
|
7cad3f350f | ||
|
|
4c8ec5d1fc | ||
|
|
82b632d772 | ||
|
|
240feba76b | ||
|
|
e55a1e1117 | ||
|
|
8764440087 | ||
|
|
07b958ac4e | ||
|
|
dd39c2fa85 | ||
|
|
515b82d634 | ||
|
|
ecb0bb22ed | ||
|
|
3f1fa37a8d | ||
|
|
a74c894064 | ||
|
|
4d7e937d7a | ||
|
|
fc90795a2c | ||
|
|
129ba4dbe2 | ||
|
|
8582fac076 | ||
|
|
d0f665f6fc | ||
|
|
0254cf730e | ||
|
|
92a99145f8 | ||
|
|
a22ee6ed2b | ||
|
|
1aa89ae311 | ||
|
|
6f4d23d072 | ||
|
|
ecd451ceb3 | ||
|
|
bddc221b60 | ||
|
|
27e844cbc2 | ||
|
|
b8695220ea | ||
|
|
364b30af59 | ||
|
|
860d79828d | ||
|
|
9057dc2c93 | ||
|
|
5223dc7dd5 | ||
|
|
bb77620d0d | ||
|
|
b280ef4c55 | ||
|
|
8e79890251 | ||
|
|
f4a4bb9e55 | ||
|
|
d108776981 | ||
|
|
8a65cc943a | ||
|
|
d2e4d3e5ce | ||
|
|
3440dca70f | ||
|
|
499cc5c075 | ||
|
|
f2961fb4bb | ||
|
|
48082eeaef | ||
|
|
4c56d227a8 | ||
|
|
2fd4885fb1 | ||
|
|
7d756394dd | ||
|
|
f4b03bcce4 | ||
|
|
01bfa5cc5e | ||
|
|
996bf00e85 | ||
|
|
30360fe29d | ||
|
|
88bf517697 | ||
|
|
e6ac206b8d | ||
|
|
00ef998ee5 | ||
|
|
f81e181588 | ||
|
|
08332b7c02 | ||
|
|
86cca49236 | ||
|
|
2718bccccc | ||
|
|
042e36de08 | ||
|
|
ec933011e6 | ||
|
|
2312665792 | ||
|
|
eae8c1000c | ||
|
|
509bd72dde | ||
|
|
fe38903e4b | ||
|
|
1ebf447240 | ||
|
|
4788104931 | ||
|
|
fdd38b97b6 | ||
|
|
409a985142 | ||
|
|
8534061b2f | ||
|
|
275741faed | ||
|
|
4c5d70eacd | ||
|
|
0b43c69993 | ||
|
|
fb5d47bff2 | ||
|
|
7033a1822e | ||
|
|
a840a03e33 | ||
|
|
fb540f7774 | ||
|
|
cb4d5b5064 | ||
|
|
265b4ba02f | ||
|
|
5fc13abb10 | ||
|
|
b7a4e44308 | ||
|
|
a1fb93707f | ||
|
|
a575233f23 | ||
|
|
66f2e155f0 | ||
|
|
5f16fcd292 | ||
|
|
fc6d1d0c7f | ||
|
|
acec6cfb18 | ||
|
|
f5d94d824d | ||
|
|
70d4fcd30e | ||
|
|
5cea6141c4 | ||
|
|
cb543b9841 | ||
|
|
3f172cc2b8 | ||
|
|
98b463b0d3 | ||
|
|
8940301e87 | ||
|
|
493405426c | ||
|
|
fcec2d16b3 | ||
|
|
d9ded4d164 | ||
|
|
141f0e6e41 | ||
|
|
199380c0c3 | ||
|
|
a46e308ea8 | ||
|
|
fb0ee819be | ||
|
|
1b6506f53a | ||
|
|
d539eb4f62 | ||
|
|
cfcd8d16a6 | ||
|
|
6bc1b932c8 | ||
|
|
650615e883 | ||
|
|
8b3b2a4b27 | ||
|
|
2b347fe889 | ||
|
|
8032429faa | ||
|
|
4cb97eeec4 | ||
|
|
1d878c6902 | ||
|
|
e65ce4a879 | ||
|
|
bfa4f62e2b | ||
|
|
1af96d1369 | ||
|
|
dcce3489f4 | ||
|
|
3a5c790a56 | ||
|
|
73493e222f | ||
|
|
26447d22ea | ||
|
|
a55bb60d70 | ||
|
|
4d1e0e6949 | ||
|
|
189570d255 | ||
|
|
64ca73e5cc | ||
|
|
4337515961 | ||
|
|
c0d4a2ee34 | ||
|
|
1f7e6a5d02 | ||
|
|
fd81a5e5b7 | ||
|
|
f3b8e34091 | ||
|
|
5cc91bc79a | ||
|
|
e37a7221b1 | ||
|
|
016023a7bb | ||
|
|
852df98647 | ||
|
|
7696706080 | ||
|
|
2c0aa4f124 | ||
|
|
8bcbc955e0 | ||
|
|
3bb6b59112 | ||
|
|
f6e77db7b0 | ||
|
|
acc587aca2 | ||
|
|
c77bdf17c1 | ||
|
|
0c9bf3bf49 | ||
|
|
f54b9e0797 | ||
|
|
7e08680d31 | ||
|
|
de83edb99b | ||
|
|
fac94485a0 | ||
|
|
9c9ed3518f | ||
|
|
a0779de633 | ||
|
|
50408b08c6 | ||
|
|
767391a4b4 | ||
|
|
a2f5acb48c | ||
|
|
3a3e9338e7 | ||
|
|
8badd2943a | ||
|
|
9a46ab1a6d | ||
|
|
952a5c8e11 | ||
|
|
2a995d94ec | ||
|
|
941d394da9 | ||
|
|
cc1f25c38c | ||
|
|
7aa08109ce | ||
|
|
8ce541ff9a | ||
|
|
75190f5166 | ||
|
|
c697139089 | ||
|
|
717f6864f3 | ||
|
|
e9fa3ee6f2 | ||
|
|
28ce962677 | ||
|
|
f576c5f11e | ||
|
|
f488a75e26 | ||
|
|
55fb503d81 | ||
|
|
afe95a6752 | ||
|
|
2ca8bda8f7 | ||
|
|
2b684fadb1 | ||
|
|
7f2da56a28 | ||
|
|
4a546bd11a | ||
|
|
a0f5254988 | ||
|
|
8521b32306 | ||
|
|
d52278b2d1 | ||
|
|
2fadb6b0e1 | ||
|
|
ad11ed21ac | ||
|
|
5857b9654c | ||
|
|
92d5764e01 | ||
|
|
a4db080786 | ||
|
|
54ac2bfdf5 | ||
|
|
9274083b24 | ||
|
|
d04396e631 | ||
|
|
c4b4584d2d | ||
|
|
1fc09098fe | ||
|
|
b217bdb62a | ||
|
|
1b60247807 | ||
|
|
b75f40c76e | ||
|
|
09ca1a1843 | ||
|
|
6cbb226ed2 | ||
|
|
ed80933b6c | ||
|
|
300d7c229c | ||
|
|
43442ac4ea | ||
|
|
12f2782fef | ||
|
|
a586734b92 | ||
|
|
f58183260d | ||
|
|
a3c49fd17a | ||
|
|
6ee94b93ba | ||
|
|
a0ec1252e0 | ||
|
|
dfb0aa3d5d | ||
|
|
312c126cc8 | ||
|
|
b79c8b1ea0 | ||
|
|
49e81cc414 | ||
|
|
2942ebfae4 | ||
|
|
4ae35cba9a | ||
|
|
bb7b516c50 | ||
|
|
c0b092b242 | ||
|
|
a2fe674a3f | ||
|
|
f12da1f4f5 | ||
|
|
0e7bec3633 | ||
|
|
7588eaf9fd | ||
|
|
c5a9d0d258 | ||
|
|
18e4a9cda6 | ||
|
|
26f63c744d | ||
|
|
1cb4c989f9 | ||
|
|
c80d081c92 | ||
|
|
3e0a7395ca | ||
|
|
4c6dc71cbe | ||
|
|
81a10280cc | ||
|
|
56e4a7827f | ||
|
|
c4fe2b7203 | ||
|
|
0dc320bbd2 | ||
|
|
b4201e1b52 | ||
|
|
9a4bef34bb | ||
|
|
2bc8bdc49c | ||
|
|
e363d98bd8 | ||
|
|
980447673b | ||
|
|
7afed90b56 | ||
|
|
0634e64b58 | ||
|
|
a42e7b8258 | ||
|
|
5b5c6e61ac | ||
|
|
79037743b8 | ||
|
|
ed36dc492d | ||
|
|
1f31954cb3 | ||
|
|
4601ea3e01 | ||
|
|
45c64b0394 | ||
|
|
591c290dbd | ||
|
|
66b9d1a011 | ||
|
|
25ef7c98bc | ||
|
|
19ddf3fb93 | ||
|
|
20a3791a88 | ||
|
|
9800271352 | ||
|
|
e288a5d757 | ||
|
|
ab7c7fa491 | ||
|
|
9e306e7de1 | ||
|
|
92e0cb2385 | ||
|
|
0800f4a414 | ||
|
|
e47774b771 | ||
|
|
c0ce17b170 | ||
|
|
c518c8114d | ||
|
|
21dc1f9a56 | ||
|
|
7ea51fcf06 | ||
|
|
c063652800 | ||
|
|
9024ea516a | ||
|
|
e92b7aeb74 | ||
|
|
dc51c3e1e8 | ||
|
|
4859387925 | ||
|
|
10787c8056 | ||
|
|
f874185a35 | ||
|
|
00e34877f3 | ||
|
|
4de49c37dd | ||
|
|
bd4b2e2bb4 | ||
|
|
aa138c4cfe | ||
|
|
4e60c631ae | ||
|
|
767d3b3dd4 | ||
|
|
39be27566b | ||
|
|
029f82f1fd | ||
|
|
6a19509ded | ||
|
|
c75aeb9c39 | ||
|
|
dcd95582d2 | ||
|
|
354af9fe6f | ||
|
|
419b68217e | ||
|
|
cd97375e63 |
31
.github/workflows/nodejs.yml
vendored
Normal file
31
.github/workflows/nodejs.yml
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
name: Node CI
|
||||
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [12.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Lint
|
||||
run: npm run lint
|
||||
- name: Build
|
||||
run: npm run build
|
||||
- name: Test
|
||||
run: npm run test
|
||||
- name: Readmes
|
||||
run: npm run readmes
|
||||
env:
|
||||
CI: true
|
||||
38
.github/workflows/npmpublish.yml
vendored
Normal file
38
.github/workflows/npmpublish.yml
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
name: Node.js Package
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [created]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 12
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Lint
|
||||
run: npm run lint
|
||||
- name: Build
|
||||
run: npm run build
|
||||
- name: Test
|
||||
run: npm run test
|
||||
- name: Readmes
|
||||
run: npm run readmes
|
||||
|
||||
publish-npm:
|
||||
needs: build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 12
|
||||
registry-url: https://registry.npmjs.org/
|
||||
- run: npm ci
|
||||
- run: npm run shipit
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
||||
3
.vscode/settings.json
vendored
Normal file
3
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"typescript.tsdk": "node_modules/typescript/lib"
|
||||
}
|
||||
3592
CHANGELOG.md
3592
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
@@ -88,8 +88,6 @@ It's just a stub. The `return` is only there to keep the TypeScript type-checker
|
||||
|
||||
By default, the `@Cordova` decorator wraps the plugin callbacks in a Promise that resolves when the success callback is called and rejects when the error callback is called. It also ensures that Cordova and the underlying plugin are available, and prints helpful diagnostics if they aren't.
|
||||
|
||||
You'll also notice that `getCurrentPosition` is a static method. That's because the plugin class is just a utility class to call the underlying Cordova plugin methods, it's not an instance and has no state.
|
||||
|
||||
Next, let's look at the `watchPosition` method.
|
||||
|
||||
```
|
||||
|
||||
@@ -3,7 +3,7 @@ jobs:
|
||||
build:
|
||||
working_directory: ~/ionic-native/
|
||||
docker:
|
||||
- image: node:10
|
||||
- image: node:12
|
||||
steps:
|
||||
- checkout
|
||||
- restore_cache:
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
key: node_modules_{{ checksum "package.json" }}
|
||||
- run:
|
||||
name: Install node modules
|
||||
command: npm i
|
||||
command: npm ci
|
||||
- save_cache:
|
||||
key: node_modules_{{ checksum "package.json" }}
|
||||
paths:
|
||||
|
||||
16220
package-lock.json
generated
16220
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
67
package.json
67
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "ionic-native",
|
||||
"version": "5.3.0",
|
||||
"version": "5.21.3",
|
||||
"description": "Native plugin wrappers for Cordova and Ionic with TypeScript, ES6+, Promise and Observable support",
|
||||
"homepage": "https://ionicframework.com/",
|
||||
"author": "Ionic Team <hi@ionic.io> (https://ionic.io)",
|
||||
@@ -18,50 +18,50 @@
|
||||
"lint": "gulp lint",
|
||||
"readmes": "gulp readmes",
|
||||
"docs-json": "ts-node -P scripts/tsconfig.json scripts/docs-json",
|
||||
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
|
||||
"postchangelog": "git commit -am \"chore(): update changelog\"",
|
||||
"version": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md",
|
||||
"shipit": "npm run build && npm run readmes && npm run npmpub"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@angular/common": "^7.2.9",
|
||||
"@angular/compiler": "^7.2.9",
|
||||
"@angular/compiler-cli": "^7.2.9",
|
||||
"@angular/core": "^7.2.9",
|
||||
"@angular/common": "^8.2.14",
|
||||
"@angular/compiler": "^8.2.14",
|
||||
"@angular/compiler-cli": "^8.2.14",
|
||||
"@angular/core": "^8.2.14",
|
||||
"@types/cordova": "0.0.34",
|
||||
"@types/fs-extra": "^5.0.5",
|
||||
"@types/jest": "^24.0.11",
|
||||
"@types/lodash": "^4.14.123",
|
||||
"@types/node": "^10.14.1",
|
||||
"@types/rimraf": "^2.0.2",
|
||||
"@types/webpack": "^4.4.26",
|
||||
"ajv": "^6.10.0",
|
||||
"async-promise-queue": "^1.0.4",
|
||||
"conventional-changelog-cli": "^2.0.12",
|
||||
"cz-conventional-changelog": "^2.1.0",
|
||||
"@types/fs-extra": "^8.0.1",
|
||||
"@types/jest": "^25.1.2",
|
||||
"@types/lodash": "^4.14.149",
|
||||
"@types/node": "^12.12.26",
|
||||
"@types/rimraf": "^2.0.3",
|
||||
"@types/webpack": "^4.41.6",
|
||||
"ajv": "^6.11.0",
|
||||
"async-promise-queue": "^1.0.5",
|
||||
"conventional-changelog-cli": "^2.0.31",
|
||||
"cz-conventional-changelog": "^3.1.0",
|
||||
"dgeni": "^0.4.12",
|
||||
"dgeni-packages": "0.16.10",
|
||||
"fs-extra": "^7.0.1",
|
||||
"gulp": "3.9.1",
|
||||
"gulp-rename": "^1.4.0",
|
||||
"fs-extra": "^8.1.0",
|
||||
"gulp": "^4.0.2",
|
||||
"gulp-rename": "^2.0.0",
|
||||
"gulp-replace": "^1.0.0",
|
||||
"gulp-tslint": "^8.1.4",
|
||||
"jest": "^24.5.0",
|
||||
"lodash": "^4.17.11",
|
||||
"jest": "^25.1.0",
|
||||
"lodash": "^4.17.15",
|
||||
"minimist": "1.2.0",
|
||||
"natives": "^1.1.6",
|
||||
"rimraf": "^2.6.3",
|
||||
"rxjs": "^6.4.0",
|
||||
"ts-jest": "^24.0.0",
|
||||
"ts-node": "^8.0.3",
|
||||
"tslint": "^5.14.0",
|
||||
"rimraf": "^3.0.2",
|
||||
"rxjs": "^6.5.4",
|
||||
"ts-jest": "^25.2.0",
|
||||
"ts-node": "^8.6.2",
|
||||
"tslint": "^5.20.1",
|
||||
"tslint-ionic-rules": "0.0.21",
|
||||
"typedoc": "^0.14.2",
|
||||
"typescript": "3.2.4",
|
||||
"uglifyjs-webpack-plugin": "^2.1.2",
|
||||
"typedoc": "^0.16.9",
|
||||
"typescript": "~3.5.3",
|
||||
"typescript-tslint-plugin": "0.5.5",
|
||||
"uglifyjs-webpack-plugin": "^2.2.0",
|
||||
"unminified-webpack-plugin": "^2.0.0",
|
||||
"webpack": "^4.29.6",
|
||||
"webpack": "^4.41.5",
|
||||
"winston": "^3.2.1",
|
||||
"zone.js": "^0.8.29"
|
||||
"zone.js": "^0.9.1"
|
||||
},
|
||||
"jest": {
|
||||
"transform": {
|
||||
@@ -87,5 +87,8 @@
|
||||
"commitizen": {
|
||||
"path": "./node_modules/cz-conventional-changelog"
|
||||
}
|
||||
},
|
||||
"dependencies": {
|
||||
"tslib": "1.10.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -35,7 +35,7 @@ export function getDecoratorArgs(decorator: any) {
|
||||
const args = {};
|
||||
|
||||
properties.forEach(prop => {
|
||||
let val;
|
||||
let val: number | boolean;
|
||||
|
||||
switch (prop.initializer.kind) {
|
||||
case ts.SyntaxKind.StringLiteral:
|
||||
|
||||
@@ -1,29 +1,30 @@
|
||||
import * as ts from 'typescript';
|
||||
import * as fs from 'fs-extra';
|
||||
import * as path from 'path';
|
||||
import * as ngc from '@angular/compiler-cli';
|
||||
import * as rimraf from 'rimraf';
|
||||
import { generateDeclarations } from './transpile';
|
||||
import { clone } from 'lodash';
|
||||
import { EmitFlags } from '@angular/compiler-cli';
|
||||
import { EmitFlags, createCompilerHost, CompilerOptions, CompilerHost, createProgram } from '@angular/compiler-cli';
|
||||
import { importsTransformer } from './transformers/imports';
|
||||
import { pluginClassTransformer } from './transformers/plugin-class';
|
||||
import { COMPILER_OPTIONS, PLUGIN_PATHS, ROOT } from './helpers';
|
||||
|
||||
export function getProgram(rootNames: string[] = createSourceFiles()) {
|
||||
const options: ngc.CompilerOptions = clone(COMPILER_OPTIONS);
|
||||
const options: CompilerOptions = clone(COMPILER_OPTIONS);
|
||||
options.basePath = ROOT;
|
||||
options.moduleResolution = ts.ModuleResolutionKind.NodeJs;
|
||||
options.module = ts.ModuleKind.ES2015;
|
||||
options.target = ts.ScriptTarget.ES5;
|
||||
options.lib = ['dom', 'es2017'];
|
||||
options.inlineSourceMap = true;
|
||||
options.importHelpers = true;
|
||||
options.inlineSources = true;
|
||||
options.enableIvy = false;
|
||||
|
||||
delete options.baseUrl;
|
||||
|
||||
const host: ngc.CompilerHost = ngc.createCompilerHost({ options });
|
||||
|
||||
return ngc.createProgram({
|
||||
const host: CompilerHost = createCompilerHost({ options });
|
||||
return createProgram({
|
||||
rootNames,
|
||||
options,
|
||||
host
|
||||
@@ -34,8 +35,9 @@ export function getProgram(rootNames: string[] = createSourceFiles()) {
|
||||
export function transpileNgxCore() {
|
||||
getProgram([path.resolve(ROOT, 'src/@ionic-native/core/index.ts')]).emit({
|
||||
emitFlags: EmitFlags.Metadata,
|
||||
emitCallback: ({ program, writeFile, customTransformers, cancellationToken, targetSourceFile }) =>
|
||||
program.emit(targetSourceFile, writeFile, cancellationToken, true, customTransformers)
|
||||
emitCallback: ({ program, writeFile, customTransformers, cancellationToken, targetSourceFile }) => {
|
||||
return program.emit(targetSourceFile, writeFile, cancellationToken, true, customTransformers);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@@ -57,10 +59,11 @@ export function generateDeclarationFiles() {
|
||||
|
||||
// remove reference to @ionic-native/core decorators
|
||||
export function modifyMetadata() {
|
||||
debugger;
|
||||
PLUGIN_PATHS.map(p => p.replace(path.join(ROOT, 'src'), path.join(ROOT, 'dist')).replace('index.ts', 'ngx/index.metadata.json'))
|
||||
.forEach(p => {
|
||||
const content = fs.readJSONSync(p);
|
||||
let _prop;
|
||||
let _prop: { members: { [x: string]: any[]; }; };
|
||||
for (const prop in content[0].metadata) {
|
||||
_prop = content[0].metadata[prop];
|
||||
removeIonicNativeDecorators(_prop);
|
||||
@@ -78,7 +81,7 @@ export function modifyMetadata() {
|
||||
|
||||
function removeIonicNativeDecorators(node: any) {
|
||||
if (node.decorators && node.decorators.length) {
|
||||
node.decorators = node.decorators.filter((d, i) => d.expression.module !== '@ionic-native/core');
|
||||
node.decorators = node.decorators.filter((d: { expression: { module: string; }; }) => d.expression.module !== '@ionic-native/core');
|
||||
}
|
||||
|
||||
if (node.decorators && !node.decorators.length) delete node.decorators;
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
import * as fs from 'fs-extra';
|
||||
import { Application } from 'typedoc';
|
||||
import { basename, dirname, resolve } from 'path';
|
||||
import { Application } from 'typedoc';
|
||||
import { runInNewContext } from 'vm';
|
||||
|
||||
import TypeDoc = require('typedoc');
|
||||
|
||||
interface Plugin {
|
||||
packageName: string;
|
||||
displayName: string;
|
||||
@@ -10,6 +12,7 @@ interface Plugin {
|
||||
platforms: string[];
|
||||
usage: string;
|
||||
repo: string;
|
||||
installVariables: string[];
|
||||
cordovaPlugin: {
|
||||
name: string;
|
||||
};
|
||||
@@ -18,9 +21,13 @@ interface Plugin {
|
||||
const rootDir = resolve(__dirname, '../..');
|
||||
const typedocTmp = resolve(__dirname, 'typedoc.tmp.json');
|
||||
const pluginsDir = resolve(rootDir, 'src/@ionic-native/plugins');
|
||||
const typedoc = new Application({
|
||||
const typedoc = new Application();
|
||||
|
||||
typedoc.options.addReader(new TypeDoc.TSConfigReader());
|
||||
typedoc.options.addReader(new TypeDoc.TypeDocReader());
|
||||
|
||||
typedoc.bootstrap({
|
||||
mode: 'modules',
|
||||
tsconfig: resolve(rootDir, 'tsconfig.json'),
|
||||
ignoreCompilerErrors: true
|
||||
});
|
||||
|
||||
@@ -45,7 +52,9 @@ async function generateTypedoc(root: string, outputPath = typedocTmp) {
|
||||
function processPlugin(pluginModule): Plugin {
|
||||
const pluginClass = pluginModule.children.find(isPlugin);
|
||||
const decorator = getPluginDecorator(pluginClass);
|
||||
const packageName = `@ionic-native/${basename(dirname(pluginModule.originalName))}`;
|
||||
const packageName = `@ionic-native/${basename(
|
||||
dirname(pluginModule.originalName)
|
||||
)}`;
|
||||
const displayName = getTag(pluginClass, 'name');
|
||||
const usage = getTag(pluginClass, 'usage');
|
||||
const description = getTag(pluginClass, 'description');
|
||||
@@ -56,6 +65,7 @@ function processPlugin(pluginModule): Plugin {
|
||||
usage,
|
||||
platforms: decorator.platforms,
|
||||
repo: decorator.repo,
|
||||
installVariables: decorator.installVariables,
|
||||
cordovaPlugin: {
|
||||
name: decorator.plugin
|
||||
}
|
||||
@@ -83,17 +93,17 @@ const getTag = (child: any, tagName: string): string => {
|
||||
}
|
||||
};
|
||||
|
||||
const isModule = (child: any): boolean =>
|
||||
child.kind === 1;
|
||||
const isModule = (child: any): boolean => child.kind === 1;
|
||||
|
||||
const isClass = (child: any): boolean =>
|
||||
child.kind === 128;
|
||||
const isClass = (child: any): boolean => child.kind === 128;
|
||||
|
||||
const isPlugin = (child: any): boolean =>
|
||||
isClass(child) && hasTags(child) && Array.isArray(child.decorators) && child.decorators.some(d => d.name === 'Plugin');
|
||||
isClass(child) &&
|
||||
hasTags(child) &&
|
||||
Array.isArray(child.decorators) &&
|
||||
child.decorators.some(d => d.name === 'Plugin');
|
||||
|
||||
const hasPlugin = (child: any): boolean =>
|
||||
child.children.some(isPlugin);
|
||||
const hasPlugin = (child: any): boolean => child.children.some(isPlugin);
|
||||
|
||||
const hasTags = (child: any): boolean =>
|
||||
child.comment && Array.isArray(child.comment.tags);
|
||||
|
||||
@@ -6,35 +6,27 @@ const config = require('./config.json'),
|
||||
Dgeni = require('dgeni');
|
||||
|
||||
module.exports = gulp => {
|
||||
gulp.task('docs', [], () => {
|
||||
gulp.task('docs', () => {
|
||||
try {
|
||||
const ionicPackage = require('./dgeni/dgeni-config')(
|
||||
projectPackage.version
|
||||
),
|
||||
const ionicPackage = require('./dgeni/dgeni-config')(projectPackage.version),
|
||||
dgeni = new Dgeni([ionicPackage]);
|
||||
|
||||
return dgeni
|
||||
.generate()
|
||||
.then(docs => console.log(docs.length + ' docs generated'));
|
||||
return dgeni.generate().then(docs => console.log(docs.length + ' docs generated'));
|
||||
} catch (err) {
|
||||
console.log(err.stack);
|
||||
}
|
||||
});
|
||||
|
||||
gulp.task('readmes', [], function() {
|
||||
gulp.task('readmes', () => {
|
||||
fs.copySync(
|
||||
path.resolve(__dirname, '..', '..', 'README.md'),
|
||||
path.resolve(__dirname, '..', '..', config.pluginDir, 'core', 'README.md')
|
||||
);
|
||||
|
||||
try {
|
||||
const ionicPackage = require('./dgeni/dgeni-readmes-config')(
|
||||
projectPackage.version
|
||||
),
|
||||
const ionicPackage = require('./dgeni/dgeni-readmes-config')(projectPackage.version),
|
||||
dgeni = new Dgeni([ionicPackage]);
|
||||
return dgeni
|
||||
.generate()
|
||||
.then(docs => console.log(docs.length + ' README files generated'));
|
||||
return dgeni.generate().then(docs => console.log(docs.length + ' README files generated'));
|
||||
} catch (err) {
|
||||
console.log(err.stack);
|
||||
}
|
||||
|
||||
@@ -30,13 +30,14 @@ const DIST = path.resolve(ROOT, 'dist/@ionic-native');
|
||||
const PACKAGES = [];
|
||||
|
||||
const MIN_CORE_VERSION = '^5.1.0';
|
||||
const RXJS_VERSION = '^6.3.0';
|
||||
const RXJS_VERSION = '^5.5.0 || ^6.5.0';
|
||||
|
||||
const PLUGIN_PEER_DEPENDENCIES = {
|
||||
'@ionic-native/core': MIN_CORE_VERSION,
|
||||
rxjs: RXJS_VERSION
|
||||
};
|
||||
|
||||
|
||||
function getPackageJsonContent(name: string, peerDependencies = {}, dependencies = {}) {
|
||||
return merge(PACKAGE_JSON_BASE, {
|
||||
name: '@ionic-native/' + name,
|
||||
@@ -64,8 +65,9 @@ function prepare() {
|
||||
const pluginName = pluginPath.split(/[\/\\]+/).slice(-2)[0];
|
||||
const packageJsonContents = getPackageJsonContent(pluginName, PLUGIN_PEER_DEPENDENCIES);
|
||||
const dir = path.resolve(DIST, 'plugins', pluginName);
|
||||
|
||||
const ngxDir = path.join(dir, 'ngx');
|
||||
writePackageJson(packageJsonContents, dir);
|
||||
writePackageJson(packageJsonContents, ngxDir);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
@@ -149,7 +149,7 @@ function wrapObservable(pluginObj: any, methodName: string, args: any[], opts: a
|
||||
* @returns {Observable}
|
||||
*/
|
||||
function wrapEventObservable(event: string, element: any): Observable<any> {
|
||||
element = (typeof window !== 'undefined' && element) ? get(window, element) : element || typeof window !== 'undefined' || {};
|
||||
element = (typeof window !== 'undefined' && element) ? get(window, element) : element || (typeof window !== 'undefined' ? window : {});
|
||||
return fromEvent(element, event);
|
||||
}
|
||||
|
||||
|
||||
@@ -2,24 +2,20 @@ import { checkAvailability } from './decorators/common';
|
||||
import { get } from './util';
|
||||
|
||||
export class IonicNativePlugin {
|
||||
static pluginName: string;
|
||||
|
||||
static pluginRef: string;
|
||||
|
||||
static plugin: string;
|
||||
|
||||
static repo: string;
|
||||
|
||||
static platforms: string[];
|
||||
|
||||
static install: string;
|
||||
static pluginName = '';
|
||||
static pluginRef = '';
|
||||
static plugin = '';
|
||||
static repo = '';
|
||||
static platforms: string[] = [];
|
||||
static install = '';
|
||||
|
||||
/**
|
||||
* Returns a boolean that indicates whether the plugin is installed
|
||||
* @return {boolean}
|
||||
*/
|
||||
static installed(): boolean {
|
||||
return checkAvailability(this.pluginRef) === true;
|
||||
const isAvailable = checkAvailability(this.pluginRef) === true;
|
||||
return isAvailable;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -36,27 +32,31 @@ export class IonicNativePlugin {
|
||||
* Returns the plugin's name
|
||||
*/
|
||||
static getPluginName(): string {
|
||||
return this.pluginName;
|
||||
const pluginName = this.pluginName;
|
||||
return pluginName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the plugin's reference
|
||||
*/
|
||||
static getPluginRef(): string {
|
||||
return this.pluginRef;
|
||||
const pluginRef = this.pluginRef;
|
||||
return pluginRef;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the plugin's install name
|
||||
*/
|
||||
static getPluginInstallName(): string {
|
||||
return this.plugin;
|
||||
const plugin = this.plugin;
|
||||
return plugin;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the plugin's supported platforms
|
||||
*/
|
||||
static getSupportedPlatforms(): string[] {
|
||||
return this.platforms || [];
|
||||
const platform = this.platforms;
|
||||
return platform;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,7 +15,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
* constructor(private alipay: Alipay) {
|
||||
*
|
||||
* //alipayOrder is a string that has been generated and signed by the server side.
|
||||
* this.alipay.pay(alipayOrder)
|
||||
* this.alipay.pay(alipayOrder, success, error)
|
||||
* .then(result => {
|
||||
* console.log(result); // Success
|
||||
* })
|
||||
@@ -30,7 +30,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
@Plugin({
|
||||
pluginName: 'Alipay',
|
||||
plugin: 'cordova-plugin-gubnoi-alipay',
|
||||
pluginRef: 'Alipay',
|
||||
pluginRef: 'cordova.plugins.alipay',
|
||||
repo: 'https://github.com/jing-zhou/cordova-plugin-alipay',
|
||||
install: 'ionic cordova plugin add cordova-plugin-gubnoi-alipay --variable APP_ID=your_app_id',
|
||||
installVariables: ['APP_ID'],
|
||||
@@ -44,7 +44,7 @@ export class Alipay extends IonicNativePlugin {
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with the success return, or rejects with an error.
|
||||
*/
|
||||
@Cordova()
|
||||
pay(order: string): Promise<any> {
|
||||
pay(order: string, success?: (res?: any) => void, error?: (err?: any) => void): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -204,20 +204,20 @@ export class AndroidPermissions extends IonicNativePlugin {
|
||||
/**
|
||||
* Check permission
|
||||
* @param {string} permission The name of the permission
|
||||
* @return {Promise<any>} Returns a promise
|
||||
* @return {Promise<AndroidPermissionResponse>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
checkPermission(permission: string): Promise<any> {
|
||||
checkPermission(permission: string): Promise<AndroidPermissionResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Request permission
|
||||
* @param {string} permission The name of the permission to request
|
||||
* @return {Promise<any>}
|
||||
* @return {Promise<AndroidPermissionResponse>}
|
||||
*/
|
||||
@Cordova()
|
||||
requestPermission(permission: string): Promise<any> {
|
||||
requestPermission(permission: string): Promise<AndroidPermissionResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -234,10 +234,14 @@ export class AndroidPermissions extends IonicNativePlugin {
|
||||
/**
|
||||
* This function still works now, will not support in the future.
|
||||
* @param {string} permission The name of the permission
|
||||
* @return {Promise<any>} Returns a promise
|
||||
* @return {Promise<AndroidPermissionResponse>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
hasPermission(permission: string): Promise<any> {
|
||||
hasPermission(permission: string): Promise<AndroidPermissionResponse> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
export interface AndroidPermissionResponse {
|
||||
hasPermission: boolean;
|
||||
}
|
||||
|
||||
51
src/@ionic-native/plugins/anyline/index.ts
Normal file
51
src/@ionic-native/plugins/anyline/index.ts
Normal file
@@ -0,0 +1,51 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export interface AnylineOptions {
|
||||
// Valid License Key
|
||||
licenseKey: string;
|
||||
|
||||
// Scanning options
|
||||
config: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Anyline
|
||||
* @description
|
||||
* Anyline provides an easy-to-use SDK for applications to enable Optical Character Recognition (OCR) on mobile devices.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { Anyline } from '@ionic-native/anyline/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private anyline: Anyline) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.anyline.scan(options)
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'Anyline',
|
||||
plugin: 'io-anyline-cordova',
|
||||
pluginRef: 'Anyline',
|
||||
repo: 'https://github.com/Anyline/anyline-ocr-cordova-module',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class Anyline extends IonicNativePlugin {
|
||||
/**
|
||||
* Scan
|
||||
* @param options {AnylineOptions} Scanning options
|
||||
* @return {Promise<any>} Returns a promise that resolves when Code is captured
|
||||
*/
|
||||
@Cordova()
|
||||
scan(options: AnylineOptions): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -80,6 +80,12 @@ export interface AppRateCustomLocale {
|
||||
|
||||
/** Feedback prompt title */
|
||||
feedbackPromptTitle?: string;
|
||||
|
||||
/** Feedback prompt message */
|
||||
appRatePromptMessage?: string;
|
||||
|
||||
/** Feedback prompt message */
|
||||
feedbackPromptMessage?: string;
|
||||
}
|
||||
|
||||
export interface AppRateCallbacks {
|
||||
|
||||
@@ -2,9 +2,11 @@ import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export interface AppUpdateOptions {
|
||||
authType: string;
|
||||
authType?: string;
|
||||
username?: string;
|
||||
password?: string;
|
||||
skipPromptDialog?: boolean;
|
||||
skipProgressDialog?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -21,7 +21,7 @@ export interface CardData {
|
||||
paymentNetwork?: string;
|
||||
}
|
||||
|
||||
export interface EligibilityData {
|
||||
export interface PairedDevicesFlags {
|
||||
isInWallet: boolean;
|
||||
isInWatch: boolean;
|
||||
FPANID: string;
|
||||
@@ -31,10 +31,6 @@ export interface WatchExistData {
|
||||
isWatchPaired: boolean;
|
||||
}
|
||||
|
||||
export interface CardPrimarySuffixData {
|
||||
primaryAccountSuffix: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Apple Wallet
|
||||
* @description
|
||||
@@ -60,14 +56,13 @@ export interface CardPrimarySuffixData {
|
||||
* // Catch {{err}} here
|
||||
* });
|
||||
*
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* // Simple call to check existence and ellibagility to add a card
|
||||
* this.appleWallet.isCardExistInWalletOrWatch(data: CardPrimarySuffixData)
|
||||
* .then((res: EligibilityData) => {
|
||||
* // object contains boolean values that ensure that card is already exists in wallet or paired-watch
|
||||
* // Simple call to check Card Eligibility
|
||||
* this.appleWallet.checkCardEligibility(primaryAccountIdentifier: string)
|
||||
* .then((res: boolean) => {
|
||||
* // Expect res to be boolean
|
||||
* })
|
||||
* .catch((err) => {
|
||||
* // Catch {{err}} here
|
||||
@@ -77,10 +72,36 @@ export interface CardPrimarySuffixData {
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* // Simple call to checkCardEligibilityBySuffix
|
||||
* this.appleWallet.checkCardEligibilityBySuffix(cardSuffix: string)
|
||||
* .then((res: boolean) => {
|
||||
* // Expect res to be boolean
|
||||
* })
|
||||
* .catch((err) => {
|
||||
* // Catch {{err}} here
|
||||
* });
|
||||
*
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* // Simple call to check out if there is any paired Watches so that you can toggle visibility of 'Add to Watch' button
|
||||
* this.appleWallet.isPairedWatchExist()
|
||||
* this.appleWallet.checkPairedDevices()
|
||||
* .then((res: WatchExistData) => {
|
||||
* // object contains boolean value that ensure that there is already a paired Watch
|
||||
* // object contains boolean flags showing paired devices
|
||||
* })
|
||||
* .catch((err) => {
|
||||
* // Catch {{err}} here
|
||||
* });
|
||||
*
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
*
|
||||
* // Simple call to check paired devices with a card by its suffix
|
||||
* this.appleWallet.checkPairedDevicesBySuffix(cardSuffix: string)
|
||||
* .then((res: PairedDevicesFlags) => {
|
||||
* // object contains boolean values that ensure that card is already exists in wallet or paired-watch
|
||||
* })
|
||||
* .catch((err) => {
|
||||
* // Catch {{err}} here
|
||||
@@ -121,9 +142,8 @@ export interface CardPrimarySuffixData {
|
||||
* EncryptedCardData
|
||||
* SignatureCertificatesData
|
||||
* CardData
|
||||
* EligibilityData
|
||||
* PairedDevicesFlags
|
||||
* WatchExistData
|
||||
* CardPrimarySuffixData
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'AppleWallet',
|
||||
@@ -144,12 +164,22 @@ export class AppleWallet extends IonicNativePlugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple call to check existence and ellibagility to add a card
|
||||
* @param {CardPrimarySuffixData} data
|
||||
* @return {Promise<EligibilityData>}
|
||||
* Simple call to check Card Eligibility
|
||||
* @param {string} primaryAccountIdentifier
|
||||
* @return {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
isCardExistInWalletOrWatch(data: CardPrimarySuffixData): Promise<EligibilityData> {
|
||||
checkCardEligibility(primaryAccountIdentifier: string): Promise<boolean> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple call to checkCardEligibilityBySuffix
|
||||
* @param {string} cardSuffix
|
||||
* @return {Promise<PairedDevicesFlags>}
|
||||
*/
|
||||
@Cordova()
|
||||
checkCardEligibilityBySuffix(cardSuffix: string): Promise<boolean> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -158,7 +188,17 @@ export class AppleWallet extends IonicNativePlugin {
|
||||
* @return {Promise<WatchExistData>}
|
||||
*/
|
||||
@Cordova()
|
||||
isPairedWatchExist(): Promise<WatchExistData> {
|
||||
checkPairedDevices(): Promise<WatchExistData> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple call to check paired devices with a card by its suffix
|
||||
* @param {string} cardSuffix
|
||||
* @return {Promise<PairedDevicesFlags>}
|
||||
*/
|
||||
@Cordova()
|
||||
checkPairedDevicesBySuffix(cardSuffix: string): Promise<PairedDevicesFlags> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -404,7 +404,7 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* @default 100
|
||||
*/
|
||||
syncThreshold?: string;
|
||||
syncThreshold?: number;
|
||||
|
||||
/**
|
||||
* Optional HTTP headers sent along in HTTP request.
|
||||
@@ -499,7 +499,7 @@ export declare enum BackgroundGeolocationIOSActivity {
|
||||
* BackgroundGeolocation must be called within app.ts and or before Geolocation. Otherwise the platform will not ask you for background tracking permission.
|
||||
*
|
||||
* ```typescript
|
||||
* import { BackgroundGeolocation, BackgroundGeolocationConfig, BackgroundGeolocationResponse } from '@ionic-native/background-geolocation';
|
||||
* import { BackgroundGeolocation, BackgroundGeolocationConfig, BackgroundGeolocationEvents, BackgroundGeolocationResponse } from '@ionic-native/background-geolocation/ngx';
|
||||
*
|
||||
* constructor(private backgroundGeolocation: BackgroundGeolocation) { }
|
||||
*
|
||||
@@ -516,7 +516,7 @@ export declare enum BackgroundGeolocationIOSActivity {
|
||||
* this.backgroundGeolocation.configure(config)
|
||||
* .then(() => {
|
||||
*
|
||||
* this.backgroundGeolocation.on('location').subscribe((location: BackgroundGeolocationResponse) => {
|
||||
* this.backgroundGeolocation.on(BackgroundGeolocationEvents.location).subscribe((location: BackgroundGeolocationResponse) => {
|
||||
* console.log(location);
|
||||
*
|
||||
* // IMPORTANT: You must execute the finish method here to inform the native plugin that you're finished,
|
||||
@@ -540,7 +540,7 @@ export declare enum BackgroundGeolocationIOSActivity {
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'BackgroundGeolocation',
|
||||
plugin: 'cordova-plugin-mauron85-background-geolocation@alpha',
|
||||
plugin: '@mauron85/cordova-plugin-background-geolocation',
|
||||
pluginRef: 'BackgroundGeolocation',
|
||||
repo: 'https://github.com/mauron85/cordova-plugin-background-geolocation',
|
||||
platforms: ['Android', 'iOS']
|
||||
|
||||
@@ -91,8 +91,37 @@ export class BackgroundMode extends IonicNativePlugin {
|
||||
* Disable the background mode.
|
||||
* Once the background mode has been disabled, the app will be paused when in background.
|
||||
*/
|
||||
@Cordova()
|
||||
disable(): Promise<any> {
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
disable(): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable or disable the background mode.
|
||||
*
|
||||
* @param enable {boolean} The status to set for.
|
||||
*
|
||||
* @return {void}
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
setEnabled(enable: boolean): void {}
|
||||
|
||||
/**
|
||||
* Fire event with given arguments.
|
||||
*
|
||||
* @param event {string} event The event's name.
|
||||
* @param args {array} The callback's arguments.
|
||||
*
|
||||
* @return {string}
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
fireEvent(event: string, ...args: any[]): string {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -119,17 +148,15 @@ export class BackgroundMode extends IonicNativePlugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Override the default title, ticker and text.
|
||||
* Overwrite the default settings.
|
||||
* Available only for Android platform.
|
||||
* @param {BackgroundModeConfiguration} options List of option to configure. See table below
|
||||
* @param overrides {BackgroundModeConfiguration} Dict of options to be overridden.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
platforms: ['Android']
|
||||
})
|
||||
setDefaults(options?: BackgroundModeConfiguration): Promise<any> {
|
||||
return;
|
||||
}
|
||||
setDefaults(overrides?: BackgroundModeConfiguration): void {}
|
||||
|
||||
/**
|
||||
* Modify the displayed information.
|
||||
@@ -143,7 +170,8 @@ export class BackgroundMode extends IonicNativePlugin {
|
||||
configure(options?: BackgroundModeConfiguration): void {}
|
||||
|
||||
/**
|
||||
* Listen for events that the plugin fires. Available events are `enable`, `disable`, `activate`, `deactivate` and `failure`.
|
||||
* Register callback for given event.
|
||||
* > Available events are `enable`, `disable`, `activate`, `deactivate` and `failure`.
|
||||
* @param event {string} Event name
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@@ -156,6 +184,17 @@ export class BackgroundMode extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Listen for events that the plugin fires. Available events are `enable`, `disable`, `activate`, `deactivate` and `failure`.
|
||||
* @param event {string} Event name
|
||||
* @param callback {function} The function to be exec as callback.
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
un(event: string, callback: (...args: any[]) => void): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android allows to programmatically move from foreground to background.
|
||||
*/
|
||||
@@ -202,15 +241,14 @@ export class BackgroundMode extends IonicNativePlugin {
|
||||
excludeFromTaskList(): void {}
|
||||
|
||||
/**
|
||||
* The method works async instead of isActive() or isEnabled().
|
||||
* If the screen is off.
|
||||
* @param fn {function} Callback function to invoke with boolean arg.
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({
|
||||
platforms: ['Android']
|
||||
})
|
||||
isScreenOff(): Promise<boolean> {
|
||||
return;
|
||||
}
|
||||
isScreenOff(fn: (arg0: boolean) => void): void {}
|
||||
|
||||
/**
|
||||
* Turn screen on
|
||||
@@ -229,4 +267,13 @@ export class BackgroundMode extends IonicNativePlugin {
|
||||
sync: true
|
||||
})
|
||||
unlock(): void {}
|
||||
|
||||
/**
|
||||
* Disables battery optimazation mode for the app (android only)
|
||||
*/
|
||||
@Cordova({
|
||||
platforms: ['Android'],
|
||||
sync: true
|
||||
})
|
||||
disableBatteryOptimizations(): void {}
|
||||
}
|
||||
|
||||
102
src/@ionic-native/plugins/biocatch/index.ts
Normal file
102
src/@ionic-native/plugins/biocatch/index.ts
Normal file
@@ -0,0 +1,102 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name BioCatch
|
||||
* @description
|
||||
* BioCatch SDK Cordova support
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { BioCatch } from '@ionic-native/biocatch';
|
||||
*
|
||||
*
|
||||
* constructor(private biocatch: BioCatch) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.biocatch.start('customer-session-1', 'http://example.com', 'some-public-key')
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'BioCatch',
|
||||
plugin: 'cordova-plugin-biocatch',
|
||||
pluginRef: 'BioCatch',
|
||||
repo: 'https://bitbucket.org/carlos_orellana/ionic-plugin',
|
||||
platforms: ['iOS', 'Android'],
|
||||
})
|
||||
@Injectable()
|
||||
export class BioCatch extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Start a session
|
||||
* @param customerSessionID {String} Customer session id
|
||||
* @param wupUrl {String} WUP server URL
|
||||
* @param publicKey {String} Public Key
|
||||
* @return {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
start(customerSessionID: string | null, wupUrl: string, publicKey: string | null): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pause the session
|
||||
* @return {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
pause(): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resume the session
|
||||
* @return {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
resume(): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop the session
|
||||
* @return {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
stop(): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset the session
|
||||
* @return {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
resetSession(): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Change the session context
|
||||
* @param contextName {String} Context name
|
||||
* @return {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
changeContext(contextName: string): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the customer session ID
|
||||
* @param customerSessionID {String}
|
||||
* @return {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
updateCustomerSessionID(customerSessionID: string | null): Promise<void> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
59
src/@ionic-native/plugins/biometric-wrapper/index.ts
Normal file
59
src/@ionic-native/plugins/biometric-wrapper/index.ts
Normal file
@@ -0,0 +1,59 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name BiometricWrapper
|
||||
* @description
|
||||
* This plugin capture biometric(Iris and Fingerprint) and validate the user.
|
||||
* May be used in Banking domain
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { BiometricWrapper } from '@ionic-native/biometric-wrapper/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private biometricWrapper: BiometricWrapper) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.biometricWrapper.activateIris({'PID_XML': '<pid-xml/>'})
|
||||
* .then((res: any) => )
|
||||
* .catch((error: any) => );
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
|
||||
|
||||
@Plugin({
|
||||
pluginName: 'BiometricWrapper',
|
||||
plugin: 'cordova-plugin-biometric',
|
||||
pluginRef: 'cordova.plugins.BiometricWrapper',
|
||||
repo: '',
|
||||
install: '',
|
||||
installVariables: [],
|
||||
platforms: ['Android']
|
||||
})
|
||||
|
||||
@Injectable()
|
||||
export class BiometricWrapper extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* This function activate iris activity
|
||||
* @return {Promise<any>} Returns a promise that resolves when iris data captured
|
||||
*/
|
||||
@Cordova()
|
||||
activateIris(args: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function activate fingerprint activity
|
||||
* @return {Promise<any>} Returns a promise that resolves when FP data captured
|
||||
*/
|
||||
@Cordova()
|
||||
activateFingerprint(args: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -198,6 +198,13 @@ export interface DocumentVerificationOverlaySettingsCtor {
|
||||
new(): DocumentVerificationOverlaySettings;
|
||||
}
|
||||
|
||||
export interface BlinkCardOverlaySettings extends OverlaySettings {
|
||||
glareMessage: string;
|
||||
}
|
||||
export interface BlinkCardOverlaySettingsCtor {
|
||||
new(): BlinkCardOverlaySettings;
|
||||
}
|
||||
|
||||
export interface RecognizerResult {
|
||||
resultState: RecognizerResultState;
|
||||
}
|
||||
@@ -837,47 +844,26 @@ export interface EgyptIdFrontRecognizer extends Recognizer<EgyptIdFrontRecognize
|
||||
}
|
||||
export interface EgyptIdFrontRecognizerCtor extends RecognizerCtor<EgyptIdFrontRecognizer> {}
|
||||
|
||||
export interface ElitePaymentCardBackRecognizerResult extends RecognizerResult {
|
||||
cardNumber: string;
|
||||
cvv: string;
|
||||
fullDocumentImage: string;
|
||||
inventoryNumber: string;
|
||||
validThru: Date;
|
||||
}
|
||||
export interface ElitePaymentCardBackRecognizerResultCtor extends RecognizerResultCtor<ElitePaymentCardBackRecognizerResult> {}
|
||||
|
||||
export interface ElitePaymentCardBackRecognizer extends Recognizer<ElitePaymentCardBackRecognizerResult> {
|
||||
anonymizeCardNumber: boolean;
|
||||
anonymizeCvv: boolean;
|
||||
detectGlare: boolean;
|
||||
extractCvv: boolean;
|
||||
extractInventoryNumber: boolean;
|
||||
extractValidThru: boolean;
|
||||
fullDocumentImageDpi: number;
|
||||
fullDocumentImageExtensionFactors: ImageExtensionFactors;
|
||||
returnFullDocumentImage: boolean;
|
||||
}
|
||||
|
||||
export interface ElitePaymentCardCombinedRecognizerResult extends RecognizerResult {
|
||||
export interface BlinkCardEliteRecognizerResult extends RecognizerResult {
|
||||
cardNumber: string;
|
||||
cvv: string;
|
||||
digitalSignature: string;
|
||||
digitalSignatureVersion: string;
|
||||
documentDataMatch: boolean;
|
||||
fullDocumentImage: string;
|
||||
fullDocumentBackImage: string;
|
||||
fullDocumentFrontImage: string;
|
||||
inventoryNumber: string;
|
||||
owner: string;
|
||||
scanningFirstSideDone: boolean;
|
||||
validThru: Date;
|
||||
}
|
||||
export interface ElitePaymentCardCombinedRecognizerResultCtor extends RecognizerResultCtor<ElitePaymentCardCombinedRecognizerResult> {}
|
||||
export interface BlinkCardEliteRecognizerResultCtor extends RecognizerResultCtor<BlinkCardEliteRecognizerResult> {}
|
||||
|
||||
export interface ElitePaymentCardCombinedRecognizer extends Recognizer<ElitePaymentCardCombinedRecognizerResult> {
|
||||
export interface BlinkCardEliteRecognizer extends Recognizer<BlinkCardEliteRecognizerResult> {
|
||||
anonymizeCardNumber: boolean;
|
||||
anonymizeCvv: boolean;
|
||||
anonymizeOwner: boolean;
|
||||
detectGlare: boolean;
|
||||
extractCvv: boolean;
|
||||
extractInventoryNumber: boolean;
|
||||
extractOwner: boolean;
|
||||
extractValidThru: boolean;
|
||||
@@ -886,20 +872,7 @@ export interface ElitePaymentCardCombinedRecognizer extends Recognizer<ElitePaym
|
||||
returnFullDocumentImage: boolean;
|
||||
signResult: boolean;
|
||||
}
|
||||
|
||||
export interface ElitePaymentCardFrontRecognizerResult extends RecognizerResult {
|
||||
fullDocumentImage: string;
|
||||
owner: string;
|
||||
}
|
||||
export interface ElitePaymentCardFrontRecognizerResultCtor extends RecognizerResultCtor<ElitePaymentCardFrontRecognizerResult> {}
|
||||
|
||||
export interface ElitePaymentCardFrontRecognizer extends Recognizer<ElitePaymentCardFrontRecognizerResult> {
|
||||
anonymizeOwner: boolean;
|
||||
detectGlare: boolean;
|
||||
extractOwner: boolean;
|
||||
fullDocumentImageDpi: number;
|
||||
fullDocumentImageExtensionFactors: ImageExtensionFactors;
|
||||
}
|
||||
export interface BlinkCardEliteRecognizerCtor extends RecognizerCtor<BlinkCardEliteRecognizer> {}
|
||||
|
||||
export interface EudlRecognizerResult extends RecognizerResult {
|
||||
address: string;
|
||||
@@ -1731,24 +1704,7 @@ export interface NewZealandDlFrontRecognizer extends Recognizer<NewZealandDlFron
|
||||
}
|
||||
export interface NewZealandDlFrontRecognizerCtor extends RecognizerCtor<NewZealandDlFrontRecognizer> {}
|
||||
|
||||
export interface PaymentCardBackRecognizerResult extends RecognizerResult {
|
||||
cvv: string;
|
||||
fullDocumentImage: string;
|
||||
inventoryNumber: string;
|
||||
}
|
||||
export interface PaymentCardBackRecognizerResultCtor extends RecognizerResultCtor<PaymentCardBackRecognizerResult> {}
|
||||
|
||||
export interface PaymentCardBackRecognizer extends Recognizer<PaymentCardBackRecognizerResult> {
|
||||
anonymizeCvv: boolean;
|
||||
detectGlare: boolean;
|
||||
extractInventoryNumber: boolean;
|
||||
fullDocumentImageDpi: number;
|
||||
fullDocumentImageExtensionFactors: ImageExtensionFactors;
|
||||
returnFullDocumentImage: boolean;
|
||||
}
|
||||
export interface PaymentCardBackRecognizerCtor extends RecognizerCtor<PaymentCardBackRecognizer> {}
|
||||
|
||||
export interface PaymentCardCombinedRecognizerResult extends RecognizerResult {
|
||||
export interface BlinkCardRecognizerResult extends RecognizerResult {
|
||||
cardNumber: string;
|
||||
cvv: string;
|
||||
digitalSignature: string;
|
||||
@@ -1757,16 +1713,19 @@ export interface PaymentCardCombinedRecognizerResult extends RecognizerResult {
|
||||
fullDocumentBackImage: string;
|
||||
fullDocumentFrontImage: string;
|
||||
inventoryNumber: string;
|
||||
issuer: string;
|
||||
owner: string;
|
||||
scanningFirstSideDone: boolean;
|
||||
validThru: Date;
|
||||
}
|
||||
export interface PaymentCardCombinedRecognizerResultCtor extends RecognizerResultCtor<PaymentCardCombinedRecognizerResult> {}
|
||||
export interface BlinkCardRecognizerResultCtor extends RecognizerResultCtor<BlinkCardRecognizerResult> {}
|
||||
|
||||
export interface PaymentCardCombinedRecognizer extends Recognizer<PaymentCardCombinedRecognizerResult> {
|
||||
export interface BlinkCardRecognizer extends Recognizer<BlinkCardRecognizerResult> {
|
||||
anonymizeCardNumber: boolean;
|
||||
anonymizeCvv: boolean;
|
||||
anonymizeOwner: boolean;
|
||||
detectGlare: boolean;
|
||||
extractCvv: boolean;
|
||||
extractInventoryNumber: boolean;
|
||||
extractOwner: boolean;
|
||||
extractValidThru: boolean;
|
||||
@@ -1775,27 +1734,7 @@ export interface PaymentCardCombinedRecognizer extends Recognizer<PaymentCardCom
|
||||
returnFullDocumentImage: boolean;
|
||||
signResult: boolean;
|
||||
}
|
||||
export interface PaymentCardCombinedRecognizerCtor extends RecognizerCtor<PaymentCardCombinedRecognizer> {}
|
||||
|
||||
export interface PaymentCardFrontRecognizerResult extends RecognizerResult {
|
||||
cardNumber: string;
|
||||
fullDocumentImage: string;
|
||||
owner: string;
|
||||
validThru: Date;
|
||||
}
|
||||
export interface PaymentCardFrontRecognizerResultCtor extends RecognizerResultCtor<PaymentCardFrontRecognizerResult> {}
|
||||
|
||||
export interface PaymentCardFrontRecognizer extends Recognizer<PaymentCardFrontRecognizerResult> {
|
||||
anonymizeCardNumber: boolean;
|
||||
anonymizeOwner: boolean;
|
||||
detectGlare: boolean;
|
||||
extractOwner: boolean;
|
||||
extractValidThru: boolean;
|
||||
fullDocumentImageDpi: number;
|
||||
fullDocumentImageExtensionFactors: ImageExtensionFactors;
|
||||
returnFullDocumentImage: boolean;
|
||||
}
|
||||
export interface PaymentCardFrontRecognizerCtor extends RecognizerCtor<PaymentCardFrontRecognizer> {}
|
||||
export interface BlinkCardRecognizerCtor extends RecognizerCtor<BlinkCardRecognizer> {}
|
||||
|
||||
export interface Pdf417RecognizerResult extends RecognizerResult {
|
||||
barcodeType: string;
|
||||
@@ -2738,6 +2677,40 @@ export interface UsdlCombinedRecognizerCtor extends RecognizerCtor<UsdlCombinedR
|
||||
* this.barcodeStringData = barcodeRecognizer.result.stringData;
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* const overlaySettings = new this.blinkId.BlinkCardOverlaySettings();
|
||||
* const recognizer = new this.blinkId.BlinkCardRecognizer();
|
||||
* recognizer.returnFullDocumentImage = false;
|
||||
* recognizer.detectGlare = true;
|
||||
* recognizer.extractCvv = true;
|
||||
* recognizer.extractValidThru = true;
|
||||
* recognizer.extractOwner = true;
|
||||
*
|
||||
* const recognizerCollection = new this.blinkId.RecognizerCollection([recognizer]);
|
||||
* const canceled = await this.blinkId.scanWithCamera(
|
||||
* overlaySettings,
|
||||
* recognizerCollection,
|
||||
* {
|
||||
* ios: '', //iOS License Key
|
||||
* android: '' //Android License Key
|
||||
* },
|
||||
* );
|
||||
*
|
||||
* if (!canceled) {
|
||||
* if (recognizer.result.resultState === RecognizerResultState.valid) {
|
||||
* const results = recognizer.result;
|
||||
*
|
||||
* if (results.resultState === RecognizerResultState.valid) {
|
||||
* const ccInfo = {
|
||||
* cardNumber: Number(results.cardNumber),
|
||||
* expirationMonth: Number(results.validThru.month),
|
||||
* expirationYear: Number(results.validThru.year),
|
||||
* cvv: Number(results.cvv)
|
||||
* };
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
@@ -2753,7 +2726,7 @@ export interface UsdlCombinedRecognizerCtor extends RecognizerCtor<UsdlCombinedR
|
||||
export class BlinkId extends IonicNativePlugin {
|
||||
/**
|
||||
* Opens the camera dialog and attempts to scan a barcode/document
|
||||
* @param overlaySettings {OverlaySettings} for camera overla customization
|
||||
* @param overlaySettings {OverlaySettings} for camera overlay customization
|
||||
* @param recognizerCollection {RecognizerCollection} collection of recognizers to scan with
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@@ -2773,6 +2746,7 @@ export class BlinkId extends IonicNativePlugin {
|
||||
@CordovaProperty() BarcodeOverlaySettings: BarcodeOverlaySettingsCtor;
|
||||
@CordovaProperty() DocumentOverlaySettings: DocumentOverlaySettingsCtor;
|
||||
@CordovaProperty() DocumentVerificationOverlaySettings: DocumentVerificationOverlaySettingsCtor;
|
||||
@CordovaProperty() BlinkCardOverlaySettings: BlinkCardOverlaySettingsCtor;
|
||||
|
||||
@CordovaProperty() RecognizerCollection: RecognizerCollectionCtor;
|
||||
|
||||
@@ -2795,6 +2769,10 @@ export class BlinkId extends IonicNativePlugin {
|
||||
@CordovaProperty() AustriaIdFrontRecognizer: AustriaIdFrontRecognizerCtor;
|
||||
@CordovaProperty() AustriaPassportRecognizerResult: AustriaPassportRecognizerResultCtor;
|
||||
@CordovaProperty() AustriaPassportRecognizer: AustriaPassportRecognizerCtor;
|
||||
@CordovaProperty() BlinkCardEliteRecognizer: BlinkCardEliteRecognizerCtor;
|
||||
@CordovaProperty() BlinkCardEliteRecognizerResult: BlinkCardEliteRecognizerResultCtor;
|
||||
@CordovaProperty() BlinkCardRecognizerResult: BlinkCardRecognizerResultCtor;
|
||||
@CordovaProperty() BlinkCardRecognizer: BlinkCardRecognizerCtor;
|
||||
@CordovaProperty() ColombiaDlFrontRecognizerResult: ColombiaDlFrontRecognizerResultCtor;
|
||||
@CordovaProperty() ColombiaIdBackRecognizerResult: ColombiaIdBackRecognizerResultCtor;
|
||||
@CordovaProperty() ColombiaIdBackRecognizer: ColombiaIdBackRecognizerCtor;
|
||||
@@ -2812,9 +2790,6 @@ export class BlinkId extends IonicNativePlugin {
|
||||
@CordovaProperty() DocumentFaceRecognizerResult: DocumentFaceRecognizerResultCtor;
|
||||
@CordovaProperty() EgyptIdFrontRecognizerResult: EgyptIdFrontRecognizerResultCtor;
|
||||
@CordovaProperty() EgyptIdFrontRecognizer: EgyptIdFrontRecognizerCtor;
|
||||
@CordovaProperty() ElitePaymentCardBackRecognizerResult: ElitePaymentCardBackRecognizerResultCtor;
|
||||
@CordovaProperty() ElitePaymentCardCombinedRecognizerResult: ElitePaymentCardCombinedRecognizerResultCtor;
|
||||
@CordovaProperty() ElitePaymentCardFrontRecognizerResult: ElitePaymentCardFrontRecognizerResultCtor;
|
||||
@CordovaProperty() EudlRecognizerResult: EudlRecognizerResultCtor;
|
||||
@CordovaProperty() GermanyCombinedRecognizerResult: GermanyCombinedRecognizerResultCtor;
|
||||
@CordovaProperty() GermanyCombinedRecognizer: GermanyCombinedRecognizerCtor;
|
||||
@@ -2868,12 +2843,6 @@ export class BlinkId extends IonicNativePlugin {
|
||||
@CordovaProperty() MyKadFrontRecognizer: MyKadFrontRecognizerCtor;
|
||||
@CordovaProperty() NewZealandDlFrontRecognizerResult: NewZealandDlFrontRecognizerResultCtor;
|
||||
@CordovaProperty() NewZealandDlFrontRecognizer: NewZealandDlFrontRecognizerCtor;
|
||||
@CordovaProperty() PaymentCardBackRecognizerResult: PaymentCardBackRecognizerResultCtor;
|
||||
@CordovaProperty() PaymentCardBackRecognizer: PaymentCardBackRecognizerCtor;
|
||||
@CordovaProperty() PaymentCardCombinedRecognizerResult: PaymentCardCombinedRecognizerResultCtor;
|
||||
@CordovaProperty() PaymentCardCombinedRecognizer: PaymentCardCombinedRecognizerCtor;
|
||||
@CordovaProperty() PaymentCardFrontRecognizerResult: PaymentCardFrontRecognizerResultCtor;
|
||||
@CordovaProperty() PaymentCardFrontRecognizer: PaymentCardFrontRecognizerCtor;
|
||||
@CordovaProperty() Pdf417RecognizerResult: Pdf417RecognizerResultCtor;
|
||||
@CordovaProperty() Pdf417Recognizer: Pdf417RecognizerCtor;
|
||||
@CordovaProperty() PolandCombinedRecognizerResult: PolandCombinedRecognizerResultCtor;
|
||||
|
||||
@@ -82,6 +82,8 @@ export interface ScanParams {
|
||||
matchNum?: BluetoothMatchNum;
|
||||
/** Defaults to All Matches. Available from API21 / API 23. (Android) */
|
||||
callbackType?: BluetoothCallbackType;
|
||||
/** True/false to show only connectable devices, rather than all devices ever seen, defaults to false (Windows) */
|
||||
isConnectable?: boolean;
|
||||
}
|
||||
|
||||
export interface NotifyParams {
|
||||
@@ -431,20 +433,20 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
* @name initialize
|
||||
* Initialize Bluetooth on the device
|
||||
* @param {InitParams} [params]
|
||||
* @returns {(Promise<{ status: 'enabled' | 'disabled'}>)} The callback that is passed initialize status (enabled/disabled)
|
||||
* @returns {(Observable<{ status: 'enabled' | 'disabled'}>)} The callback that is passed initialize status (enabled/disabled)
|
||||
*/
|
||||
@Cordova({ callbackOrder: 'reverse' })
|
||||
initialize(params?: InitParams): Promise<{ status: 'enabled' | 'disabled' }> {
|
||||
@Cordova({ successIndex: 0, errorIndex: 2, observable: true })
|
||||
initialize(params?: InitParams): Observable<{ status: 'enabled' | 'disabled' }> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name enable (Android)
|
||||
* Enable Bluetooth on the device. Android support only
|
||||
* @returns {Promise<{ status: boolean }>}
|
||||
* @returns void
|
||||
*/
|
||||
@Cordova({ callbackOrder: 'reverse', sync: true })
|
||||
enable(): Promise<{ status: boolean }> {
|
||||
enable() {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -480,10 +482,10 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
* Android API >= 23 also requires location services to be enabled. Use isLocationEnabled to determine whether location services are enabled.
|
||||
* If not enabled, use requestLocation to prompt the location services settings page.
|
||||
* @param {ScanParams} params Scan params
|
||||
* @returns {(Observable<{ status: ScanStatus }>)}
|
||||
* @returns {(Observable< ScanStatus >)}
|
||||
*/
|
||||
@Cordova({ callbackOrder: 'reverse', observable: true })
|
||||
startScan(params: ScanParams): Observable<{ status: ScanStatus }> {
|
||||
startScan(params: ScanParams): Observable< ScanStatus > {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -559,7 +561,7 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
connect(params: {
|
||||
address: string;
|
||||
autoConnect?: boolean;
|
||||
}): Observable<{ status: DeviceInfo }> {
|
||||
}): Observable< DeviceInfo > {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -579,10 +581,10 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
* Disconnect from a Bluetooth LE device.
|
||||
* Note: It's simpler to just call close(). Starting with iOS 10, disconnecting before closing seems required!
|
||||
* @param {{address: string}} params The address/identifier
|
||||
* @returns {Promise<{ status: DeviceInfo }>}
|
||||
* @returns {Promise<DeviceInfo>}
|
||||
*/
|
||||
@Cordova({ callbackOrder: 'reverse' })
|
||||
disconnect(params: { address: string }): Promise<{ status: DeviceInfo }> {
|
||||
disconnect(params: { address: string }): Promise<DeviceInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -592,10 +594,10 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
* Prior to 2.7.0, you needed to disconnect to the device before closing, but this is no longer the case.
|
||||
* Starting with iOS 10, disconnecting before closing seems required!
|
||||
* @param {{ address: string }} params The address/identifier
|
||||
* @returns {Promise<{ status: DeviceInfo }>}
|
||||
* @returns {Promise<DeviceInfo>}
|
||||
*/
|
||||
@Cordova({ callbackOrder: 'reverse' })
|
||||
close(params: { address: string }): Promise<{ status: DeviceInfo }> {
|
||||
close(params: { address: string }): Promise<DeviceInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -609,7 +611,7 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
* Subsequent discover events will make use of this cache.
|
||||
* If your device's services change, set the clearCache parameter to force Android to re-discover services.
|
||||
* @param {{ address: string, clearCache: boolean }} params The address/identifier
|
||||
* @returns {Promise<{ device: Device }>}
|
||||
* @returns {Promise<Device>}
|
||||
* success: device object (contains array of service objects)
|
||||
* error: The callback that will be triggered when the unbond operation fails
|
||||
*/
|
||||
@@ -617,7 +619,7 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
discover(params: {
|
||||
address: string;
|
||||
clearCache?: boolean;
|
||||
}): Promise<{ device: Device }> {
|
||||
}): Promise<Device> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -626,13 +628,13 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
* Discover the device's services.
|
||||
* Not providing an array of services will return all services and take longer to discover. iOS support only.
|
||||
* @param {{address: string, services: string[]}} params
|
||||
* @returns {Promise<{ services: Services }>}
|
||||
* @returns {Promise<Services>}
|
||||
*/
|
||||
@Cordova({ callbackOrder: 'reverse' })
|
||||
services(params: {
|
||||
address: string;
|
||||
services?: string[];
|
||||
}): Promise<{ services: Services }> {
|
||||
}): Promise<Services> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -747,10 +749,10 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
* @name rssi
|
||||
* Read RSSI of a connected device. RSSI is also returned with scanning.
|
||||
* @param {{ address: string }} params
|
||||
* @returns {Promise<{ rssi: RSSI }>}
|
||||
* @returns {Promise< RSSI >}
|
||||
*/
|
||||
@Cordova({ callbackOrder: 'reverse' })
|
||||
rssi(params: { address: string }): Promise<{ rssi: RSSI }> {
|
||||
rssi(params: { address: string }): Promise< RSSI > {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -758,10 +760,10 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
* @name mtu (Android, Android 5+)
|
||||
* Set MTU of a connected device. Android only.
|
||||
* @param {{ address: string, mtu: number }} params
|
||||
* @returns {Promise<{ mtu: MTU }>}
|
||||
* @returns {Promise< MTU >}
|
||||
*/
|
||||
@Cordova({ callbackOrder: 'reverse' })
|
||||
mtu(params: { address: string; mtu?: number }): Promise<{ mtu: MTU }> {
|
||||
mtu(params: { address: string; mtu?: number }): Promise< MTU > {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -1057,7 +1059,7 @@ export class BluetoothLE extends IonicNativePlugin {
|
||||
@CordovaProperty()
|
||||
SCAN_MODE_LOW_LATENCY: number;
|
||||
@CordovaProperty()
|
||||
MATCH_MODE_AGRESSIVE: number;
|
||||
MATCH_MODE_AGGRESSIVE: number;
|
||||
@CordovaProperty()
|
||||
MATCH_MODE_STICKY: number;
|
||||
@CordovaProperty()
|
||||
|
||||
@@ -475,6 +475,21 @@ export class Calendar extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an event by id.
|
||||
*
|
||||
* @param {string} [id] The event id
|
||||
* @param {Date} [fromDate] The date where it start deleting from
|
||||
* @return Returns a Promise
|
||||
*/
|
||||
@Cordova()
|
||||
deleteEventById(
|
||||
id: string,
|
||||
fromDate?: Date
|
||||
): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Open the calendar at the specified date.
|
||||
* @param {Date} date The date you want to open the calendar on
|
||||
|
||||
@@ -113,6 +113,14 @@ export interface CameraPreviewPictureOptions {
|
||||
* this.picture = 'assets/img/test.jpg';
|
||||
* });
|
||||
*
|
||||
* // take a snap shot
|
||||
* this.cameraPreview.takeSnapshot(this.pictureOpts).then((imageData) => {
|
||||
* this.picture = 'data:image/jpeg;base64,' + imageData;
|
||||
* }, (err) => {
|
||||
* console.log(err);
|
||||
* this.picture = 'assets/img/test.jpg';
|
||||
* });
|
||||
*
|
||||
*
|
||||
* // Switch camera
|
||||
* this.cameraPreview.switchCamera();
|
||||
@@ -245,6 +253,20 @@ export class CameraPreview extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Take a snapshot of preview window (size specified in startCamera options)
|
||||
* @param {CameraPreviewPictureOptions} [options] quality of the picture to take
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
})
|
||||
takeSnapshot(options?: CameraPreviewPictureOptions): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Set camera color effect.
|
||||
@@ -456,4 +478,22 @@ export class CameraPreview extends IonicNativePlugin {
|
||||
onBackButton(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return in use device camera fov
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getHorizontalFOV(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the characteristics of all available cameras
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getCameraCharacteristics(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -211,11 +211,11 @@ export class Camera extends IonicNativePlugin {
|
||||
* Convenience constant
|
||||
*/
|
||||
PictureSourceType = {
|
||||
/** Choose image from picture library (same as SAVEDPHOTOALBUM for Android) */
|
||||
/** Choose image from picture library (same as PHOTOLIBRARY for Android) */
|
||||
PHOTOLIBRARY: 0,
|
||||
/** Take picture from camera */
|
||||
CAMERA: 1,
|
||||
/** Choose image from picture library (same as PHOTOLIBRARY for Android) */
|
||||
/** Choose image from picture library (same as SAVEDPHOTOALBUM for Android) */
|
||||
SAVEDPHOTOALBUM: 2
|
||||
};
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ export class Chooser extends IonicNativePlugin {
|
||||
* base64-encoded data: URI, MIME type, display name, and original URI.
|
||||
*/
|
||||
@Cordova()
|
||||
getFile(accept: string): Promise<ChooserResult | undefined> {
|
||||
getFile(accept?: string): Promise<ChooserResult | undefined> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
/**
|
||||
* @name Couchbase Lite
|
||||
* @description
|
||||
* Plugin to install Couchbase Lite in your PhoneGap app on iOS or Android
|
||||
* Plugin to install Couchbase Lite in your PhoneGap app on iOS or Android <docs-card href="https://ionicframework.com/integrations/couchbase-lite" ionicon="alert">This Plugin is no longer supported by Couchbase. Please see our Couchbase Lite Integration</docs-card>
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
|
||||
@@ -33,6 +33,9 @@ export interface DeeplinkOptions {
|
||||
* @description This plugin handles deeplinks on iOS and Android for both custom URL scheme links
|
||||
* and Universal App Links.
|
||||
*
|
||||
* Please read the [ionic plugin deeplinks docs](https://github.com/ionic-team/ionic-plugin-deeplinks) for iOS and Android integration.
|
||||
* You must add `universal-links` to your `config.xml` and set up Apple App Site Association (AASA) for iOS and Asset Links for Android.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { Deeplinks } from '@ionic-native/deeplinks/ngx';
|
||||
|
||||
@@ -35,9 +35,9 @@ export interface AndroidAccount {
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'DeviceAccounts',
|
||||
plugin: 'cordova-device-accounts',
|
||||
pluginRef: 'plugins.DeviceAccounts',
|
||||
repo: 'https://github.com/danielsogl/cordova-device-accounts',
|
||||
plugin: 'cordova-device-accounts-v2',
|
||||
pluginRef: 'DeviceAccounts',
|
||||
repo: 'https://github.com/xUnholy/cordova-device-accounts-v2',
|
||||
platforms: ['Android']
|
||||
})
|
||||
@Injectable()
|
||||
@@ -78,4 +78,23 @@ export class DeviceAccounts extends IonicNativePlugin {
|
||||
getEmail(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get permissions for access to email registered on Android device 8.0+
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova()
|
||||
getPermissions(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get permissions for access to email registered on Android device 8.0+ for requested type
|
||||
* @param {string} type
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova()
|
||||
getPermissionsByType(type: string): Promise<string> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -73,7 +73,11 @@ export class Diagnostic extends IonicNativePlugin {
|
||||
@CordovaProperty()
|
||||
permissionStatus: {
|
||||
GRANTED: string;
|
||||
/**
|
||||
* @deprecated cordova.plugins.diagnostic@5.0.0 uses DENIED_ONCE to unify DENIED* statuses across iOS/Android
|
||||
*/
|
||||
DENIED: string;
|
||||
DENIED_ONCE: string;
|
||||
NOT_REQUESTED: string;
|
||||
DENIED_ALWAYS: string;
|
||||
RESTRICTED: string;
|
||||
@@ -812,6 +816,15 @@ export class Diagnostic extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Requests reminders authorization for the application.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
requestRemoteNotificationsAuthorization(types?: string[], omitRegistration?: boolean): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Indicates the current setting of notification types for the app in the Settings app.
|
||||
* Note: on iOS 8+, if "Allow Notifications" switch is OFF, all types will be returned as disabled.
|
||||
|
||||
94
src/@ionic-native/plugins/document-scanner/index.ts
Normal file
94
src/@ionic-native/plugins/document-scanner/index.ts
Normal file
@@ -0,0 +1,94 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export enum DocumentScannerSourceType {
|
||||
/**
|
||||
* Scan directly from device camera.
|
||||
* This is the default.
|
||||
*/
|
||||
CAMERA = 1,
|
||||
|
||||
/**
|
||||
* Scan from an image already stored on device.
|
||||
*/
|
||||
GALLERY = 0
|
||||
}
|
||||
|
||||
export interface DocumentScannerOptions {
|
||||
/**
|
||||
* Choose to scan from camera or existing image file. Only valid for Android.
|
||||
*/
|
||||
sourceType?: DocumentScannerSourceType;
|
||||
|
||||
/**
|
||||
* Filename to save scanned image to (minus extension, which is always ".png").
|
||||
* Only valid for iOS. Caller is responsible for cleaning up any files created
|
||||
* if this parameter is set to anything other than the default value,
|
||||
* which is "image".
|
||||
*/
|
||||
fileName?: string;
|
||||
|
||||
/**
|
||||
* Quality to use when capturing the image, must be a float value
|
||||
* from 1.0(default - Highest quality) to 5.0(Lowest Quality). Any value
|
||||
* in between will be accepted. Any value not equal to or not between these values
|
||||
* will default to the highest quality of 1.0.
|
||||
*/
|
||||
quality?: number;
|
||||
|
||||
/**
|
||||
* If the image should be returned as a base64 encoding instead of as a file URL.
|
||||
* If true, the plugin will return the scanned image as base64. If false,
|
||||
* the plugin will return the image URL of the image.
|
||||
*/
|
||||
returnBase64?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Document Scanner
|
||||
* @description
|
||||
* This plugin processes images of documents, compensating for perspective.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { DocumentScanner, DocumentScannerOptions } from '@ionic-native/document-scanner';
|
||||
*
|
||||
*
|
||||
* constructor(private documentScanner: DocumentScanner) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* let opts: DocumentScannerOptions = {};
|
||||
* this.documentScanner.scanDocument(opts)
|
||||
* .then((res: string) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* @interfaces
|
||||
* DocumentScannerOptions
|
||||
* @enums
|
||||
* DocumentScannerSourceType
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'DocumentScanner',
|
||||
plugin: 'cordova-plugin-document-scanner',
|
||||
pluginRef: 'scan',
|
||||
repo: 'https://github.com/NeutrinosPlatform/cordova-plugin-document-scanner',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class DocumentScanner extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Scan a document
|
||||
* @param opts {DocumentScannerOptions} optional parameter for controlling scanning
|
||||
* @return {Promise<string>} file URL of scanned document image
|
||||
*/
|
||||
@Cordova({
|
||||
callbackOrder: 'reverse'
|
||||
})
|
||||
scanDoc(opts?: DocumentScannerOptions): Promise<string> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -70,9 +70,27 @@ export interface EmailComposerOptions {
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.emailComposer.isAvailable().then((available: boolean) =>{
|
||||
* this.emailComposer.getClients().then((apps: []) => {
|
||||
* // Returns an array of configured email clients for the device
|
||||
* });
|
||||
*
|
||||
* this.emailComposer.hasClient().then(app, (isValid: boolean) => {
|
||||
* if (isValid) {
|
||||
* // Now we know we have a valid email client configured
|
||||
* // Not specifying an app will return true if at least one email client is configured
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* this.emailComposer.hasAccount().then((isValid: boolean) => {
|
||||
* if (isValid) {
|
||||
* // Now we know we have a valid email account configured
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* this.emailComposer.isAvailable().then(app, (available: boolean) => {
|
||||
* if(available) {
|
||||
* //Now we know we can send
|
||||
* // Now we know we can send an email, calls hasClient and hasAccount
|
||||
* // Not specifying an app will return true if at least one email client is configured
|
||||
* }
|
||||
* });
|
||||
*
|
||||
@@ -142,6 +160,68 @@ export class EmailComposer extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifies if an email account is configured on the device.
|
||||
*
|
||||
* @returns {Promise<any>} Resolves if available, rejects if not available
|
||||
*/
|
||||
@CordovaCheck()
|
||||
hasAccount(): Promise<any> {
|
||||
return getPromise<boolean>((resolve) => {
|
||||
EmailComposer.getPlugin().hasAccount((result: boolean) => {
|
||||
if (result) {
|
||||
resolve(true);
|
||||
} else {
|
||||
resolve(false);
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifies if a specific email client is installed on the device.
|
||||
*
|
||||
* @param {string} [app] App id or uri scheme.
|
||||
* @returns {Promise<any>} Resolves if available, rejects if not available
|
||||
*/
|
||||
|
||||
@CordovaCheck()
|
||||
hasClient(app?: string): Promise<any> {
|
||||
return getPromise<boolean>((resolve) => {
|
||||
if (app) {
|
||||
EmailComposer.getPlugin().hasClient(app, (result: boolean) => {
|
||||
if (result) {
|
||||
resolve(true);
|
||||
} else {
|
||||
resolve(false);
|
||||
}
|
||||
});
|
||||
} else {
|
||||
EmailComposer.getPlugin().getClients((apps: string[]) => {
|
||||
resolve(apps.length && apps.length > 0);
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of email clients installed on the device.
|
||||
*
|
||||
* @returns {Promise<string[]>} Resolves if available, rejects if not available
|
||||
*/
|
||||
@CordovaCheck()
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
getClients(): Promise<string[]> {
|
||||
return getPromise<string[]>(resolve => {
|
||||
EmailComposer.getPlugin().getClients((apps: any) => {
|
||||
if (Object.prototype.toString.call(apps) === '[object String]') {
|
||||
apps = [apps];
|
||||
}
|
||||
resolve(apps);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifies if sending emails is supported on the device.
|
||||
*
|
||||
@@ -150,24 +230,11 @@ export class EmailComposer extends IonicNativePlugin {
|
||||
*/
|
||||
@CordovaCheck()
|
||||
isAvailable(app?: string): Promise<any> {
|
||||
return getPromise<boolean>((resolve, reject) => {
|
||||
if (app) {
|
||||
EmailComposer.getPlugin().isAvailable(app, (isAvailable: boolean) => {
|
||||
if (isAvailable) {
|
||||
resolve();
|
||||
} else {
|
||||
reject();
|
||||
}
|
||||
return getPromise<boolean>((resolve) => {
|
||||
Promise.all([this.hasAccount, this.hasClient(app)])
|
||||
.then((results) => {
|
||||
return resolve(results.length === 2 && results[0] && results[1]);
|
||||
});
|
||||
} else {
|
||||
EmailComposer.getPlugin().isAvailable((isAvailable: boolean) => {
|
||||
if (isAvailable) {
|
||||
resolve();
|
||||
} else {
|
||||
reject();
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
61
src/@ionic-native/plugins/emm-app-config/index.ts
Normal file
61
src/@ionic-native/plugins/emm-app-config/index.ts
Normal file
@@ -0,0 +1,61 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
/**
|
||||
* @name Emm App Config
|
||||
* @description
|
||||
* This plugin provides information on EMM application configuration
|
||||
*
|
||||
* Requires the Cordova plugin: `cordova-plugin-emm-app-config`. For more info, please see the [Cordova EMM App Config Plugin Docs](https://github.com/oracle/cordova-plugin-emm-app-config).
|
||||
*
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { EmmAppConfig } from '@ionic-native/emm-app-config/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private readonly emmAppConfig: EmmAppConfig) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* // Get all the values of the emm app configuration
|
||||
* const values = this.emmAppConfig.getValue();
|
||||
*
|
||||
* // Get specific value of the emm app configuration
|
||||
* const value = this.emmAppConfig.getValue('serverUrl');
|
||||
*
|
||||
* // Get an event every time the emm app config changes
|
||||
* this.emmAppConfig.registerChangedListener()
|
||||
* .subscribe(() => console.log('App config changes'));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
platforms: ['Android', 'iOS'],
|
||||
plugin: 'cordova-plugin-emm-app-config',
|
||||
pluginName: 'EmmAppConfig',
|
||||
pluginRef: 'cordova.plugins.EmmAppConfig',
|
||||
repo: 'https://github.com/oracle/cordova-plugin-emm-app-config',
|
||||
})
|
||||
@Injectable()
|
||||
export class EmmAppConfig extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Get value from the Emm application configuration.
|
||||
* @param configKey {string} Key of the value to get, or null to get all the values as an object.
|
||||
* @return {any} Returns configuration on an object
|
||||
*/
|
||||
@Cordova({ sync: true }) getValue(configKey?: string): any {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register a listener that will be invoked when the application configuration is changed.
|
||||
* @return {void}
|
||||
*/
|
||||
@Cordova({ observable: true }) registerChangedListener(): Observable<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -117,39 +117,39 @@ export interface FacebookLoginResponse {
|
||||
})
|
||||
@Injectable()
|
||||
export class Facebook extends IonicNativePlugin {
|
||||
EVENTS: {
|
||||
EVENT_NAME_ACTIVATED_APP: 'fb_mobile_activate_app';
|
||||
EVENT_NAME_DEACTIVATED_APP: 'fb_mobile_deactivate_app';
|
||||
EVENT_NAME_SESSION_INTERRUPTIONS: 'fb_mobile_app_interruptions';
|
||||
EVENT_NAME_TIME_BETWEEN_SESSIONS: 'fb_mobile_time_between_sessions';
|
||||
EVENT_NAME_COMPLETED_REGISTRATION: 'fb_mobile_complete_registration';
|
||||
EVENT_NAME_VIEWED_CONTENT: 'fb_mobile_content_view';
|
||||
EVENT_NAME_SEARCHED: 'fb_mobile_search';
|
||||
EVENT_NAME_RATED: 'fb_mobile_rate';
|
||||
EVENT_NAME_COMPLETED_TUTORIAL: 'fb_mobile_tutorial_completion';
|
||||
EVENT_NAME_PUSH_TOKEN_OBTAINED: 'fb_mobile_obtain_push_token';
|
||||
EVENT_NAME_ADDED_TO_CART: 'fb_mobile_add_to_cart';
|
||||
EVENT_NAME_ADDED_TO_WISHLIST: 'fb_mobile_add_to_wishlist';
|
||||
EVENT_NAME_INITIATED_CHECKOUT: 'fb_mobile_initiated_checkout';
|
||||
EVENT_NAME_ADDED_PAYMENT_INFO: 'fb_mobile_add_payment_info';
|
||||
EVENT_NAME_PURCHASED: 'fb_mobile_purchase';
|
||||
EVENT_NAME_ACHIEVED_LEVEL: 'fb_mobile_level_achieved';
|
||||
EVENT_NAME_UNLOCKED_ACHIEVEMENT: 'fb_mobile_achievement_unlocked';
|
||||
EVENT_NAME_SPENT_CREDITS: 'fb_mobile_spent_credits';
|
||||
EVENT_PARAM_CURRENCY: 'fb_currency';
|
||||
EVENT_PARAM_REGISTRATION_METHOD: 'fb_registration_method';
|
||||
EVENT_PARAM_CONTENT_TYPE: 'fb_content_type';
|
||||
EVENT_PARAM_CONTENT_ID: 'fb_content_id';
|
||||
EVENT_PARAM_SEARCH_STRING: 'fb_search_string';
|
||||
EVENT_PARAM_SUCCESS: 'fb_success';
|
||||
EVENT_PARAM_MAX_RATING_VALUE: 'fb_max_rating_value';
|
||||
EVENT_PARAM_PAYMENT_INFO_AVAILABLE: 'fb_payment_info_available';
|
||||
EVENT_PARAM_NUM_ITEMS: 'fb_num_items';
|
||||
EVENT_PARAM_LEVEL: 'fb_level';
|
||||
EVENT_PARAM_DESCRIPTION: 'fb_description';
|
||||
EVENT_PARAM_SOURCE_APPLICATION: 'fb_mobile_launch_source';
|
||||
EVENT_PARAM_VALUE_YES: '1';
|
||||
EVENT_PARAM_VALUE_NO: '0';
|
||||
EVENTS = {
|
||||
EVENT_NAME_ACTIVATED_APP: 'fb_mobile_activate_app',
|
||||
EVENT_NAME_DEACTIVATED_APP: 'fb_mobile_deactivate_app',
|
||||
EVENT_NAME_SESSION_INTERRUPTIONS: 'fb_mobile_app_interruptions',
|
||||
EVENT_NAME_TIME_BETWEEN_SESSIONS: 'fb_mobile_time_between_sessions',
|
||||
EVENT_NAME_COMPLETED_REGISTRATION: 'fb_mobile_complete_registration',
|
||||
EVENT_NAME_VIEWED_CONTENT: 'fb_mobile_content_view',
|
||||
EVENT_NAME_SEARCHED: 'fb_mobile_search',
|
||||
EVENT_NAME_RATED: 'fb_mobile_rate',
|
||||
EVENT_NAME_COMPLETED_TUTORIAL: 'fb_mobile_tutorial_completion',
|
||||
EVENT_NAME_PUSH_TOKEN_OBTAINED: 'fb_mobile_obtain_push_token',
|
||||
EVENT_NAME_ADDED_TO_CART: 'fb_mobile_add_to_cart',
|
||||
EVENT_NAME_ADDED_TO_WISHLIST: 'fb_mobile_add_to_wishlist',
|
||||
EVENT_NAME_INITIATED_CHECKOUT: 'fb_mobile_initiated_checkout',
|
||||
EVENT_NAME_ADDED_PAYMENT_INFO: 'fb_mobile_add_payment_info',
|
||||
EVENT_NAME_PURCHASED: 'fb_mobile_purchase',
|
||||
EVENT_NAME_ACHIEVED_LEVEL: 'fb_mobile_level_achieved',
|
||||
EVENT_NAME_UNLOCKED_ACHIEVEMENT: 'fb_mobile_achievement_unlocked',
|
||||
EVENT_NAME_SPENT_CREDITS: 'fb_mobile_spent_credits',
|
||||
EVENT_PARAM_CURRENCY: 'fb_currency',
|
||||
EVENT_PARAM_REGISTRATION_METHOD: 'fb_registration_method',
|
||||
EVENT_PARAM_CONTENT_TYPE: 'fb_content_type',
|
||||
EVENT_PARAM_CONTENT_ID: 'fb_content_id',
|
||||
EVENT_PARAM_SEARCH_STRING: 'fb_search_string',
|
||||
EVENT_PARAM_SUCCESS: 'fb_success',
|
||||
EVENT_PARAM_MAX_RATING_VALUE: 'fb_max_rating_value',
|
||||
EVENT_PARAM_PAYMENT_INFO_AVAILABLE: 'fb_payment_info_available',
|
||||
EVENT_PARAM_NUM_ITEMS: 'fb_num_items',
|
||||
EVENT_PARAM_LEVEL: 'fb_level',
|
||||
EVENT_PARAM_DESCRIPTION: 'fb_description',
|
||||
EVENT_PARAM_SOURCE_APPLICATION: 'fb_mobile_launch_source',
|
||||
EVENT_PARAM_VALUE_YES: '1',
|
||||
EVENT_PARAM_VALUE_NO: '0'
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -306,4 +306,13 @@ export class Facebook extends IonicNativePlugin {
|
||||
getDeferredApplink(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Manually log activation events
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
activateApp(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -47,6 +47,12 @@ export interface NotificationData {
|
||||
* backend.registerToken(token);
|
||||
* });
|
||||
*
|
||||
* this.fcm.hasPermission().then(hasPermission => {
|
||||
* if (hasPermission) {
|
||||
* console.log("Has permission!");
|
||||
* }
|
||||
* })
|
||||
*
|
||||
* this.fcm.unsubscribeFromTopic('marketing');
|
||||
*
|
||||
* ```
|
||||
@@ -62,6 +68,16 @@ export interface NotificationData {
|
||||
})
|
||||
@Injectable()
|
||||
export class FCM extends IonicNativePlugin {
|
||||
/**
|
||||
* Gets ios device's current APNS token
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the APNS token
|
||||
*/
|
||||
@Cordova()
|
||||
getAPNSToken(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets device's current registration id
|
||||
*
|
||||
@@ -108,6 +124,19 @@ export class FCM extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checking for permissions on iOS. On android, it always returns `true`.
|
||||
*
|
||||
* @returns {Promise<boolean | null>} Returns a Promise:
|
||||
* - true: push was allowed (or platform is android)
|
||||
* - false: push will not be available
|
||||
* - null: still not answered, recommended checking again later.
|
||||
*/
|
||||
@Cordova()
|
||||
hasPermission(): Promise<boolean | null> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Watch for incoming notifications
|
||||
*
|
||||
|
||||
@@ -1,6 +1,13 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export interface FileChooserOptions {
|
||||
/**
|
||||
* comma seperated mime types to filter files.
|
||||
*/
|
||||
mime: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name File Chooser
|
||||
* @description
|
||||
@@ -20,6 +27,8 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
* .catch(e => console.log(e));
|
||||
*
|
||||
* ```
|
||||
* @interfaces
|
||||
* FileChooserOptions
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'FileChooser',
|
||||
@@ -33,10 +42,11 @@ export class FileChooser extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Open a file
|
||||
* @param {FileChooserOptions} [options] Optional parameter, defaults to ''. Filters the file selection list according to mime types
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova()
|
||||
open(): Promise<string> {
|
||||
open(options?: FileChooserOptions): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -18,6 +18,10 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
* .then(() => console.log('File is opened'))
|
||||
* .catch(e => console.log('Error opening file', e));
|
||||
*
|
||||
* this.fileOpener.showOpenWithDialog('path/to/file.pdf', 'application/pdf')
|
||||
* .then(() => console.log('File is opened'))
|
||||
* .catch(e => console.log('Error opening file', e));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
@@ -71,4 +75,19 @@ export class FileOpener extends IonicNativePlugin {
|
||||
appIsInstalled(packageId: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens with system modal to open file with an already installed app.
|
||||
* @param {string} filePath File Path
|
||||
* @param {string} fileMIMEType File MIME Type
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
callbackStyle: 'object',
|
||||
successName: 'success',
|
||||
errorName: 'error'
|
||||
})
|
||||
showOpenWithDialog(filePath: string, fileMIMEType: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -66,13 +66,13 @@ export interface LocalFileSystem {
|
||||
/**
|
||||
* Allows the user to look up the Entry for a file or directory referred to by a local URL.
|
||||
* @param url A URL referring to a local file in a filesystem accessable via this API.
|
||||
* @param successCallback A callback that is called to report the Entry to which the supplied URL refers.
|
||||
* @param successCallback A callback that is called to report the FileEntry to which the supplied URL refers.
|
||||
* @param errorCallback A callback that is called when errors happen, or when the request to obtain the Entry is
|
||||
* denied.
|
||||
*/
|
||||
resolveLocalFileSystemURL(
|
||||
url: string,
|
||||
successCallback: EntryCallback,
|
||||
successCallback: FileEntryCallback,
|
||||
errorCallback?: ErrorCallback
|
||||
): void;
|
||||
|
||||
|
||||
@@ -3,29 +3,41 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export interface FingerprintOptions {
|
||||
/**
|
||||
* Key for platform keychain
|
||||
* Title in biometric prompt (android only)
|
||||
* @default {APP_NAME} Biometric Sign On
|
||||
*/
|
||||
clientId: string;
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Secret password. Only for android
|
||||
* Subtitle in biometric Prompt (android only)
|
||||
* @default null
|
||||
*/
|
||||
clientSecret?: string;
|
||||
subtitle?: string;
|
||||
|
||||
/**
|
||||
* Disable 'use backup' option. Only for android (optional)
|
||||
* Description in biometric Prompt
|
||||
* @default null
|
||||
*/
|
||||
description?: string;
|
||||
|
||||
/**
|
||||
* Title of fallback button.
|
||||
* @default "Use Pin"
|
||||
*/
|
||||
fallbackButtonTitle?: string;
|
||||
|
||||
/**
|
||||
* Title for cancel button on Android
|
||||
* @default "Cancel"
|
||||
*/
|
||||
cancelButtonTitle?: string;
|
||||
|
||||
/**
|
||||
* Disable 'use backup' option.
|
||||
* @default false
|
||||
*/
|
||||
disableBackup?: boolean;
|
||||
|
||||
/**
|
||||
* Title of fallback button. Only for iOS
|
||||
*/
|
||||
localizedFallbackTitle?: string;
|
||||
|
||||
/**
|
||||
* Description in authentication dialogue. Only for iOS
|
||||
*/
|
||||
localizedReason?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -42,12 +54,17 @@ export interface FingerprintOptions {
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.faio.show().then((result: any) => console.log(result)).catch((error: any) => console.log(error));
|
||||
*
|
||||
* OR with options...
|
||||
*
|
||||
* this.faio.show({
|
||||
* clientId: 'Fingerprint-Demo',
|
||||
* clientSecret: 'password', //Only necessary for Android
|
||||
* disableBackup:true, //Only for Android(optional)
|
||||
* localizedFallbackTitle: 'Use Pin', //Only for iOS
|
||||
* localizedReason: 'Please authenticate' //Only for iOS
|
||||
* title: 'Biometric Authentication', // (Android Only) | optional | Default: "<APP_NAME> Biometric Sign On"
|
||||
* subtitle: 'Coolest Plugin ever' // (Android Only) | optional | Default: null
|
||||
* description: 'Please authenticate' // optional | Default: null
|
||||
* fallbackButtonTitle: 'Use Backup', // optional | When disableBackup is false defaults to "Use Pin".
|
||||
* // When disableBackup is true defaults to "Cancel"
|
||||
* disableBackup:true, // optional | default: false
|
||||
* })
|
||||
* .then((result: any) => console.log(result))
|
||||
* .catch((error: any) => console.log(error));
|
||||
@@ -65,6 +82,73 @@ export interface FingerprintOptions {
|
||||
})
|
||||
@Injectable()
|
||||
export class FingerprintAIO extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_UNKNOWN_ERROR = -100;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_UNAVAILABLE = -101;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_AUTHENTICATION_FAILED = -102;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_SDK_NOT_SUPPORTED = -103;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_HARDWARE_NOT_SUPPORTED = -104;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_PERMISSION_NOT_GRANTED = -105;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_NOT_ENROLLED = -106;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_INTERNAL_PLUGIN_ERROR = -107;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_DISMISSED = -108;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_PIN_OR_PATTERN_DISMISSED = -109;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_SCREEN_GUARD_UNSECURED = -110;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_LOCKED_OUT = -111;
|
||||
/**
|
||||
* Convenience constant
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_LOCKED_OUT_PERMANENT = -112;
|
||||
|
||||
/**
|
||||
* Check if fingerprint authentication is available
|
||||
* @return {Promise<any>} Returns a promise with result
|
||||
|
||||
@@ -90,4 +90,13 @@ export class FirebaseAnalytics extends IonicNativePlugin {
|
||||
setCurrentScreen(name: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all analytics data for this instance from the device and resets the app instance ID
|
||||
* @return {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
resetAnalyticsData(): Promise<void> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -28,18 +28,38 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
plugin: 'cordova-plugin-firebase-config',
|
||||
pluginRef: 'cordova.plugins.firebase.config',
|
||||
repo: 'https://github.com/chemerisuk/cordova-plugin-firebase-config',
|
||||
platforms: ['Android', 'iOS']
|
||||
platforms: ['Android', 'iOS'],
|
||||
})
|
||||
@Injectable()
|
||||
export class FirebaseConfig extends IonicNativePlugin {
|
||||
/**
|
||||
* Fetches remote config values with appropriate TTL and then activates them.
|
||||
* Starts fetching configs, adhering to the specified minimum fetch interval.
|
||||
*
|
||||
* @param {number} ttlSeconds
|
||||
* @param {number} expirationDuration
|
||||
* @returns {Promise<null>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
update(ttlSeconds: number): Promise<null> {
|
||||
fetch(expirationDuration?: number): Promise<null> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Asynchronously activates the most recently fetched configs, so that the fetched key value pairs take effect.
|
||||
*
|
||||
* @returns {Promise<null>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
activate(): Promise<null> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Asynchronously fetches and then activates the fetched configs.
|
||||
*
|
||||
* @returns {Promise<null>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
fetchAndActivate(): Promise<null> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -47,11 +67,10 @@ export class FirebaseConfig extends IonicNativePlugin {
|
||||
* Fetches a boolean configuration value from RemoteConfig
|
||||
*
|
||||
* @param {string} key
|
||||
* @param {string} [namespace]
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
getBoolean(key: string, namespace?: string): Promise<boolean> {
|
||||
getBoolean(key: string): Promise<boolean> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -59,11 +78,10 @@ export class FirebaseConfig extends IonicNativePlugin {
|
||||
* Fetches a string configuration value from RemoteConfig
|
||||
*
|
||||
* @param {string} key
|
||||
* @param {string} [namespace]
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
getString(key: string, namespace?: string): Promise<string> {
|
||||
getString(key: string): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -71,11 +89,10 @@ export class FirebaseConfig extends IonicNativePlugin {
|
||||
* Fetches a numeric configuration value from RemoteConfig
|
||||
*
|
||||
* @param {string} key
|
||||
* @param {string} [namespace]
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
getNumber(key: string, namespace?: string): Promise<number> {
|
||||
getNumber(key: string): Promise<number> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -83,11 +100,10 @@ export class FirebaseConfig extends IonicNativePlugin {
|
||||
* Fetches an array of bytes configuration value from RemoteConfig
|
||||
*
|
||||
* @param {string} key
|
||||
* @param {string} [namespace]
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
getBytes(key: string, namespace?: string): Promise<any[]> {
|
||||
getBytes(key: string): Promise<any[]> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
64
src/@ionic-native/plugins/firebase-crash/index.ts
Normal file
64
src/@ionic-native/plugins/firebase-crash/index.ts
Normal file
@@ -0,0 +1,64 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name FirebaseCrash
|
||||
* @description
|
||||
* This plugin brings crash reporting from Google Firebase to your Cordova project! Android and iOS supported.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { FirebaseCrash } from '@ionic-native/firebase-crash';
|
||||
*
|
||||
* constructor(private firebaseCrash: FirebaseCrash) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.firebaseCrash.setUserId('123456789');
|
||||
* this.firebaseCrash.log('message');
|
||||
* this.firebaseCrash.logError('non fatal exception');
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'FirebaseCrash',
|
||||
plugin: 'cordova-plugin-firebase-crash',
|
||||
pluginRef: 'cordova.plugins.firebase.crashlytics',
|
||||
repo: 'https://github.com/chemerisuk/cordova-plugin-firebase-crash',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class FirebaseCrash extends IonicNativePlugin {
|
||||
/**
|
||||
* Add logging that will be sent with your crash data in case of app crash.
|
||||
* https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#add_custom_logs
|
||||
* @param {string} message
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
log(message: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Log non-fatal exceptions in addition to automatically reported app crashes.
|
||||
* https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#log_non-fatal_exceptions
|
||||
* @param {string} message
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
logError(message: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the user identifier property for crashlytics reporting.
|
||||
* https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#set_user_ids
|
||||
* @param {string} userId value to set the userId
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setUserId(userId: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -40,7 +40,7 @@ export class FirebaseCrashlytics extends IonicNativePlugin {
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
initialize(): void {
|
||||
initialise(): any {
|
||||
return; // We add return; here to avoid any IDE / Compiler errors
|
||||
}
|
||||
|
||||
|
||||
@@ -2,11 +2,41 @@ import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
export interface IFirebaseMessage {
|
||||
aps: any;
|
||||
gcm: any;
|
||||
export interface IFirebaseGCMMessage {
|
||||
gcm: {
|
||||
body: string;
|
||||
title: string;
|
||||
sound: string;
|
||||
icon: string;
|
||||
tag: string;
|
||||
color: string;
|
||||
clickAction: string;
|
||||
};
|
||||
'google.message_id': string;
|
||||
'google.sent_time': number;
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
export interface IFirebaseAPSMessage {
|
||||
aps: {
|
||||
alert: {
|
||||
title: string;
|
||||
body: string;
|
||||
};
|
||||
badge?: number;
|
||||
};
|
||||
'gcm.message_id': 'string';
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
export type IFirebaseMessage = IFirebaseAPSMessage | IFirebaseGCMMessage;
|
||||
|
||||
export interface IRequestPermissionOptions {
|
||||
forceShow?: boolean;
|
||||
}
|
||||
|
||||
export type FirebaseMessagingTokenType = 'apns-buffer' | 'apns-string';
|
||||
|
||||
/**
|
||||
* @beta
|
||||
* @name Firebase Messaging
|
||||
@@ -36,7 +66,7 @@ export interface IFirebaseMessage {
|
||||
plugin: 'cordova-plugin-firebase-messaging',
|
||||
pluginRef: 'cordova.plugins.firebase.messaging',
|
||||
repo: 'https://github.com/chemerisuk/cordova-plugin-firebase-messaging',
|
||||
platforms: ['Android', 'iOS']
|
||||
platforms: ['Android', 'iOS'],
|
||||
})
|
||||
@Injectable()
|
||||
export class FirebaseMessaging extends IonicNativePlugin {
|
||||
@@ -61,22 +91,27 @@ export class FirebaseMessaging extends IonicNativePlugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Grant permission to recieve push notifications (will trigger prompt on iOS).
|
||||
* Grant permission to receive push notifications (will trigger prompt on iOS).
|
||||
*
|
||||
* @param {IRequestPermissionOptions} [options]
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
requestPermission(): Promise<string> {
|
||||
requestPermission(options?: { forceShow?: boolean }): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a promise that fulfills with the current FCM token
|
||||
*
|
||||
* This method also accepts optional argument type.
|
||||
* Currently iOS implementation supports values "apns-buffer" and "apns-string" that defines presentation of resolved APNS token.
|
||||
*
|
||||
* @param {FirebaseMessagingTokenType} [type] iOS only. Defines presentation of resolved APNS token
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
getToken(): Promise<string> {
|
||||
getToken(type?: FirebaseMessagingTokenType): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
589
src/@ionic-native/plugins/firebase-x/index.ts
Normal file
589
src/@ionic-native/plugins/firebase-x/index.ts
Normal file
@@ -0,0 +1,589 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
export interface IChannelOptions {
|
||||
/**
|
||||
* Channel ID - must be unique per app package
|
||||
*/
|
||||
id: string;
|
||||
|
||||
/**
|
||||
* Channel name. Default: empty string
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* Channel description. Default: empty string
|
||||
*/
|
||||
description?: string;
|
||||
|
||||
/**
|
||||
* The sound to play once a push comes. Default value: 'default'
|
||||
* Values allowed:
|
||||
* 'default' - plays the default notification sound
|
||||
* 'ringtone' - plays the currently set ringtone
|
||||
* 'false' - silent; don't play any sound
|
||||
* filename - the filename of the sound file located in '/res/raw' without file extension (mysound.mp3 -> mysound)
|
||||
*/
|
||||
sound?: string;
|
||||
|
||||
/**
|
||||
* Vibrate on new notification. Default value: true
|
||||
* Possible values:
|
||||
* Boolean - vibrate or not
|
||||
* Array - vibration pattern - e.g. [500, 200, 500] - milliseconds vibrate, milliseconds pause, vibrate, pause, etc.
|
||||
*/
|
||||
vibration?: boolean | number[];
|
||||
|
||||
/**
|
||||
* Whether to blink the LED
|
||||
*/
|
||||
light?: boolean;
|
||||
|
||||
/**
|
||||
* LED color in ARGB format - this example BLUE color. If set to -1, light color will be default. Default value: -1.
|
||||
*/
|
||||
lightColor?: string;
|
||||
|
||||
/**
|
||||
* Importance - integer from 0 to 4. Default value: 4
|
||||
* 0 - none - no sound, does not show in the shade
|
||||
* 1 - min - no sound, only shows in the shade, below the fold
|
||||
* 2 - low - no sound, shows in the shade, and potentially in the status bar
|
||||
* 3 - default - shows everywhere, makes noise, but does not visually intrude
|
||||
* 4 - high - shows everywhere, makes noise and peeks
|
||||
*/
|
||||
importance?: 0 | 1 | 2 | 3 | 4;
|
||||
|
||||
/**
|
||||
* Show badge over app icon when non handled pushes are present. Default value: true
|
||||
*/
|
||||
badge?: boolean;
|
||||
|
||||
/**
|
||||
* Show message on locked screen. Default value: 1
|
||||
* Possible values (default 1):
|
||||
* -1 - secret - Do not reveal any part of the notification on a secure lockscreen.
|
||||
* 0 - private - Show the notification on all lockscreens, but conceal sensitive or private information on secure lockscreens.
|
||||
* 1 - public - Show the notification in its entirety on all lockscreens.
|
||||
*/
|
||||
visibility?: -1 | 0 | 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Firebase X
|
||||
* @description
|
||||
* This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported.
|
||||
* It is a maintained fork from unmaintained ionic-navite plugin called Firebase.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { FirebaseX } from '@ionic-native/firebase-x/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private firebaseX: FirebaseX) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.firebaseX.getToken()
|
||||
* .then(token => console.log(`The token is ${token}`)) // save the token server-side and use it to push notifications to this device
|
||||
* .catch(error => console.error('Error getting token', error));
|
||||
*
|
||||
* this.firebaseX.onMessageReceived()
|
||||
* .subscribe(data => console.log(`User opened a notification ${data}`));
|
||||
*
|
||||
* this.firebaseX.onTokenRefresh()
|
||||
* .subscribe((token: string) => console.log(`Got a new token ${token}`));
|
||||
* ```
|
||||
* @interfaces
|
||||
* IChannelOptions
|
||||
*
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'FirebaseX',
|
||||
plugin: 'cordova-plugin-firebasex',
|
||||
pluginRef: 'FirebasePlugin',
|
||||
repo: 'https://github.com/dpa99c/cordova-plugin-firebasex',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class FirebaseX extends IonicNativePlugin {
|
||||
/**
|
||||
* Get the current FCM token.
|
||||
* @return {Promise<null | string>} Note that token will be null if it has not been established yet
|
||||
*/
|
||||
@Cordova()
|
||||
getToken(): Promise<null | string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get notified when a token is refreshed.
|
||||
* @return {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
observable: true
|
||||
})
|
||||
onTokenRefresh(): Observable<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* iOS only.
|
||||
* Get the APNS token allocated for this app install.
|
||||
* @return {Promise<null | string>} Note that token will be null if it has not been established yet
|
||||
*/
|
||||
@Cordova()
|
||||
getAPNSToken(): Promise<null | string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* iOS only.
|
||||
* Registers a handler to call when the APNS token is allocated.
|
||||
* This will be called once when remote notifications permission has been granted by the user at runtime.
|
||||
* @return {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
observable: true
|
||||
})
|
||||
onApnsTokenReceived(): Observable<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a callback function to invoke when:
|
||||
* - a notification or data message is received by the app
|
||||
* - a system notification is tapped by the user
|
||||
* @return {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
observable: true
|
||||
})
|
||||
onMessageReceived(): Observable<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Grant permission to receive push notifications (will trigger prompt) and return hasPermission: true. iOS only (Android will always return true).
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
platforms: ['iOS']
|
||||
})
|
||||
grantPermission(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check permission to receive push notifications and return hasPermission: true. iOS only (Android will always return true).
|
||||
* @return {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
hasPermission(): Promise<boolean> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregister from firebase, used to stop receiving push notifications. Call this when you logout user from your app.
|
||||
*/
|
||||
@Cordova()
|
||||
unregister(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a number on the icon badge. Set 0 to clear the badge
|
||||
* @param {number} badgeNumber
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setBadgeNumber(badgeNumber: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get icon badge number.
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getBadgeNumber(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all pending notifications from the drawer.
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
platforms: ['Android']
|
||||
})
|
||||
clearAllNotifications(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Subscribe to a topic. Topic messaging allows you to send a message to multiple devices that have opted in to a particular topic.
|
||||
* @param {string} topic
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
subscribe(topic: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unsubscribe from a topic. This will stop you receiving messages for that topic.
|
||||
* @param {string} topic
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
unsubscribe(topic: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android 8+ only. Creates a custom channel to be used by notification messages which have the channel property set in the message payload to the id of the created channel:
|
||||
* - for background (system) notifications: android.notification.channel_id
|
||||
* - for foreground/data notifications: data.notification_android_channel_id
|
||||
*
|
||||
* Calling on Android 7 or below or another platform will have no effect.
|
||||
* @param {IChannelOptions} channelOptions
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
createChannel(channelOptions: IChannelOptions): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android 8+ only. Overrides the properties for the default channel.
|
||||
* The default channel is used if no other channel exists or is specified in the notification.
|
||||
* Any options not specified will not be overridden. Should be called as soon as possible (on app start) so default notifications will work as expected.
|
||||
* Calling on Android 7 or below or another platform will have no effect.
|
||||
* @param {IChannelOptions} channelOptions
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setDefaultChannel(channelOptions: IChannelOptions): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android 8+ only. Removes a previously defined channel.
|
||||
* Calling on Android 7 or below or another platform will have no effect.
|
||||
* @param {string} channelID
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
deleteChannel(channelID: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android 8+ only. Gets a list of all channels.
|
||||
* Calling on Android 7 or below or another platform will have no effect.
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
listChannels(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable/disable analytics collection (useful for GDPR/privacy settings).
|
||||
* @param {boolean} enabled
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setAnalyticsCollectionEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable/disable Crashlytics collection.
|
||||
* @param {boolean} enabled
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setCrashlyticsCollectionEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable/disable performance collection.
|
||||
* @param {boolean} enabled
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setPerformanceCollectionEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Log an event using Analytics
|
||||
* @param {string} type
|
||||
* @param {Object} data
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
logEvent(type: string, data: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the name of the current screen in Analytics
|
||||
* @param {string} name Screen name
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setScreenName(name: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a user id for use in Analytics
|
||||
* @param {string} userId
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setUserId(userId: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a user property for use in Analytics
|
||||
* @param {string} name
|
||||
* @param {string} value
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setUserProperty(name: string, value: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set Crashlytics user identifier.
|
||||
* To diagnose an issue, it’s often helpful to know which of your users experienced a given crash.
|
||||
* Crashlytics includes a way to anonymously identify users in your crash reports.
|
||||
* To add user IDs to your reports, assign each user a unique identifier in the form of an ID number, token, or hashed value.
|
||||
*
|
||||
* More info https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#set_user_ids
|
||||
* @param {string} userId
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setCrashlyticsUserId(userId: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Simulates (causes) a fatal native crash which causes a crash event to be sent to Crashlytics (useful for testing).
|
||||
* See the Firebase documentation regarding crash testing.
|
||||
* Crashes will appear under Event type = "Crashes" in the Crashlytics console.
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
sendCrash(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a crash-related log message that will appear in the Logs section of the next native crash event.
|
||||
* Note: if you don't then crash, the message won't be sent! Also logs the message to the native device console.
|
||||
* @param {string} message
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
logMessage(message: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a non-fatal error event to Crashlytics. In a Cordova app, you may use this to log unhandled Javascript exceptions, for example.
|
||||
* The event will appear under Event type = "Non-fatals" in the Crashlytics console.
|
||||
* The error message will appear in the Logs section of the non-fatal error event.
|
||||
* Also logs the error message to the native device console.
|
||||
* @param {string} error
|
||||
* @param {object} (optional) a stack trace generated by stacktrace.js
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
logError(error: string, stackTrace?: object): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Requests verification of a phone number in order to authenticate a user and sign then into Firebase in your app.
|
||||
*
|
||||
* NOTE: This will only work on physical devices with a SIM card (not iOS Simulator or Android Emulator)
|
||||
*
|
||||
* In response to your request, you'll receive a verification ID which you can use in conjunction with the verification code
|
||||
* to sign the user in.
|
||||
*
|
||||
* On iOS and some Android devices, the user will receive and SMS containing the verification code which they must manually enter
|
||||
* into your app.
|
||||
*
|
||||
* Some Android devices support "instant verfication", in which case an SMS will not be send and you will be returned
|
||||
* the verification code along with the verification ID. In this case, the user doesn't need to do anything in order for you
|
||||
* to sign them in.
|
||||
*
|
||||
* @param {function} success - callback function to pass {object} credentials to as an argument
|
||||
* @param {function} error - callback function which will be passed a {string} error message as an argument
|
||||
* @param {string} phoneNumber - phone number to verify
|
||||
* @param {integer} timeOutDuration - (optional) time to wait in seconds before timing out
|
||||
* @param {string} fakeVerificationCode - (optional) to test instant verification on Android ,specify a fake verification code to return for whitelisted phone numbers.
|
||||
*
|
||||
* The success callback will be passed a credential object with the following properties:
|
||||
* instantVerification {boolean} - true if the Android device supports instant verification, in which case the verification code will be included in the credential object. If this is false, the device will be sent an SMS containing the verification code for the user to manually enter into your app. Always false on iOS.
|
||||
* verificationId {string} - the verification ID you'll need to pass along with the verification code to sign the user in. Always returned on both Android & iOS.
|
||||
* code {string} - verification code. Will only be present if instantVerification is true. Always undefined on iOS.
|
||||
*/
|
||||
@Cordova()
|
||||
verifyPhoneNumber(
|
||||
success: (value: string | object) => void,
|
||||
error: (err: string) => void,
|
||||
phoneNumber: string,
|
||||
timeoutDuration = 0
|
||||
): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Signs the user into Firebase with credentials obtained using verifyPhoneNumber().
|
||||
* See the Android- and iOS-specific Firebase documentation for more info.
|
||||
* @param {string} verificationId - the verification ID returned in the credentials object to the verifyPhoneNumber() success callback.
|
||||
* @param {string} code - the activation code, either returned in the credentials object to the verifyPhoneNumber() success callback if using Instant Verification on Android, or the activation code as entered by the user from the received SMS message.
|
||||
* @param {function} success - callback function to call on successful sign-in using credentials
|
||||
* @param {function} error - callback function which will be passed a {string} error message as an argument
|
||||
*/
|
||||
@Cordova()
|
||||
signInWithCredential(
|
||||
verificationId: string,
|
||||
code: string,
|
||||
success: () => void,
|
||||
error: (err: string) => void
|
||||
): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Links the user account to an existing Firebase user account with credentials obtained using verifyPhoneNumber().
|
||||
* See the Android- and iOS-specific Firebase documentation for more info.
|
||||
* @param {string} verificationId - the verification ID returned in the credentials object to the verifyPhoneNumber() success callback.
|
||||
* @param {string} code - the activation code, either returned in the credentials object to the verifyPhoneNumber() success callback if using Instant Verification on Android, or the activation code as entered by the user from the received SMS message.
|
||||
* @param {function} success - callback function to call on successful sign-in using credentials
|
||||
* @param {function} error - callback function which will be passed a {string} error message as an argument
|
||||
*/
|
||||
@Cordova()
|
||||
linkUserWithCredential(
|
||||
verificationId: string,
|
||||
code: string,
|
||||
success: () => void,
|
||||
error: (err: string) => void
|
||||
): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch Remote Config parameter values for your app.
|
||||
* @param {number} cacheExpirationSeconds specify the cacheExpirationSeconds
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
fetch(cacheExpirationSeconds?: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Activate the Remote Config fetched config.
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
activateFetched(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a Remote Config value.
|
||||
* @param {string} key
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getValue(key: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android only. Retrieve a Remote Config byte array.
|
||||
* @param {string} key
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getByteArray(key: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android only. Get the current state of the FirebaseRemoteConfig singleton object.
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getInfo(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android only. Change the settings for the FirebaseRemoteConfig object's operations.
|
||||
* @param {Object} settings
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setConfigSettings(settings: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Android only. Set defaults in the Remote Config.
|
||||
* @param {Object} settings
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
setDefaults(settings: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Start a trace.
|
||||
* @param {string} name
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
startTrace(name: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* To count the performance-related events that occur in your app (such as cache hits or retries),
|
||||
* add a line of code similar to the following whenever the event occurs,
|
||||
* using a string other than retry to name that event if you are counting a different type of event.
|
||||
* @param {string} name
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
incrementCounter(name: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop the trace.
|
||||
* @param {string} name
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
stopTrace(name: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -343,6 +343,9 @@ export class Firebase extends IonicNativePlugin {
|
||||
* Clear all pending notifications from the drawer
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
platforms: ['Android']
|
||||
})
|
||||
clearAllNotifications(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
94
src/@ionic-native/plugins/foreground-service/index.ts
Normal file
94
src/@ionic-native/plugins/foreground-service/index.ts
Normal file
@@ -0,0 +1,94 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name Foreground Service
|
||||
* @description
|
||||
* This plugin allows for android devices to continue running services in the background, using a
|
||||
* foreground ongoing notification. This is targeted towards use with plugins such as
|
||||
* 'cordova-geolocation' that will not run while the app is in the background on android API 26+.
|
||||
*
|
||||
* For android API 28+, the following xml snippet should be inserted into ```config.xml```:
|
||||
*
|
||||
* ```
|
||||
* ...
|
||||
* <platform name="android">
|
||||
* <config-file parent="/*" target="AndroidManifest.xml">
|
||||
* <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
|
||||
* </config-file>
|
||||
* ...
|
||||
* ```
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { ForegroundService } from '@ionic-native/foreground-service/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(public foregroundService: ForegroundService) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* startService() {
|
||||
* // Notification importance is optional, the default is 1 - Low (no sound or vibration)
|
||||
* this.foregroundService.start('GPS Running', 'Background Service', 'drawable/fsicon');
|
||||
* }
|
||||
*
|
||||
* stopService() {
|
||||
* // Disable the foreground service
|
||||
* this.foregroundService.stop();
|
||||
* }
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'ForegroundService',
|
||||
plugin: 'cordova-plugin-foreground-service',
|
||||
pluginRef: 'cordova.plugins.foregroundService',
|
||||
repo: 'https://github.com/DavidBriglio/cordova-plugin-foreground-service',
|
||||
platforms: ['Android']
|
||||
})
|
||||
@Injectable()
|
||||
export class ForegroundService extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Enables the foreground service
|
||||
*
|
||||
* @param {string} title (content title) A brief headline for the notification
|
||||
* @param {string} text (content text) Supporting information
|
||||
* @param {string} icon The drawable icon can be any drawable image that exists in the resource folder. This means you must copy the icon you want to use into the platforms/android/app/src/main/res/drawable folder set. If no icon can be found using the icon name parameter, a default star icon will be used.
|
||||
*
|
||||
* For an example, if the `fsicon.png` (see xml below) resides here: ```src/assets/icon/fsicon.png```. Then ```icon``` parameter value would be ```'drawable/fsicon'```. In order for this example to work, the following xml snippet must be in ```config.xml```.
|
||||
*
|
||||
* ```
|
||||
* <platform name="android">
|
||||
* <resource-file src="www/assets/icon/fsicon.png" target="app/src/main/res/drawable/fsicon.png" />
|
||||
* ...
|
||||
* ```
|
||||
* @param {number} importance Notification importance dictates how the notification is initially presented:
|
||||
*
|
||||
* Value | Importance | Description | Examples
|
||||
* --- | --- | --- | ---
|
||||
* 1|IMPORTANCE_LOW|Does not make a sound or heads-up display (plugin's default)|New content the user has subscribed to, social network invitations
|
||||
* 2|IMPORTANCE_DEFAULT|Makes a sound, but no heads-up display|Traffic alerts, task reminders
|
||||
* 3|IMPORTANCE_HIGH|Makes a sound and heads-up display|Text messages, alarms, phone calls
|
||||
*
|
||||
* @param {number} id The notification id is a customizable integer that is used to reference the notification that will be launched. This is customizable to avoid conflicting with any other notifications. If this is not included, a [*unique*] default id will be used.
|
||||
*
|
||||
* @see https://material.io/design/platform-guidance/android-notifications.html
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
start(title: string, text: string, icon?: string, importance: 1 | 2 | 3 = 1, id = 0): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Disables the foreground service
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
stop(): void {
|
||||
return;
|
||||
}
|
||||
}
|
||||
61
src/@ionic-native/plugins/full-screen-image/index.ts
Normal file
61
src/@ionic-native/plugins/full-screen-image/index.ts
Normal file
@@ -0,0 +1,61 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name Full Screen Image
|
||||
* @description
|
||||
* This plugin does something
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { FullScreenImage } from '@ionic-native/full-screen-image';
|
||||
*
|
||||
*
|
||||
* constructor(private fullScreenImage: FullScreenImage) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.fullScreenImage.showImageURL('/assets/...')
|
||||
* .then((data: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.fullScreenImage.showImageBase64('iVBORw0KGgoAAAANSUhEUgAAA...')
|
||||
* .then((data: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'FullScreenImage',
|
||||
plugin: 'es.keensoft.fullscreenimage',
|
||||
pluginRef: 'FullScreenImage',
|
||||
repo: 'https://github.com/keensoft/FullScreenImage-Cordova-Plugin',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class FullScreenImage extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Opens an image from a URL or path
|
||||
* @param url {string} url or image path
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
showImageURL(url: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens an image from a base64 string
|
||||
* @param base64String {string} base64 string
|
||||
* @param name? {string} image name
|
||||
* @param type? {string} image extension
|
||||
* @return {Promise<any>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
showImageBase64(base64String: string, name?: string, type?: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
64
src/@ionic-native/plugins/ge-tui-sdk-plugin/index.ts
Normal file
64
src/@ionic-native/plugins/ge-tui-sdk-plugin/index.ts
Normal file
@@ -0,0 +1,64 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name Ge Tui Sdk Plugin
|
||||
* @description
|
||||
* This plugin does something
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { GeTuiSdkPlugin } from '@ionic-native/ge-tui-sdk-plugin';
|
||||
*
|
||||
*
|
||||
* constructor(private geTuiSdkPlugin: GeTuiSdkPlugin) { }
|
||||
*
|
||||
* this.geTuiSdkPlugin.callback_init((res) => { console.log(res)});
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
* this.geTuiSdkPlugin.initialize();
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
* this.geTuiSdkPlugin.getClientId();
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
* this.geTuiSdkPlugin.getVersion();
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'GeTuiSdkPlugin',
|
||||
plugin: 'cordova-plugin-getuisdk',
|
||||
pluginRef: 'GeTuiSdkPlugin',
|
||||
repo: 'git@github.com:GetuiLaboratory/cordova-plugin-getuisdk.git',
|
||||
install: 'cordova plugin add cordova-plugin-getuisdk --variable PUSH_APPID=your appid --variable PUSH_APPKEY=your appkey --variable PUSH_APPSECRET=your appsecret',
|
||||
installVariables: ['PUSH_APPID', 'PUSH_APPKEY', 'PUSH_APPSECRET'],
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class GeTuiSdkPlugin extends IonicNativePlugin {
|
||||
|
||||
@Cordova()
|
||||
callback_init(callback: Function): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
@Cordova({
|
||||
sync: true,
|
||||
})
|
||||
initialize() {
|
||||
return;
|
||||
}
|
||||
|
||||
@Cordova()
|
||||
getClientId(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
@Cordova()
|
||||
getVersion(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -15,6 +15,13 @@ export interface ScoreData {
|
||||
|
||||
}
|
||||
|
||||
export interface PlayerScoreData {
|
||||
/**
|
||||
* The player score.
|
||||
*/
|
||||
playerScore: number;
|
||||
}
|
||||
|
||||
export interface LeaderboardData {
|
||||
|
||||
/**
|
||||
@@ -83,6 +90,40 @@ export interface Player {
|
||||
|
||||
}
|
||||
|
||||
export interface SubmittedScoreData {
|
||||
|
||||
/**
|
||||
* The leaderboard ID from Goole Play Developer console.
|
||||
*/
|
||||
leaderboardId: string;
|
||||
|
||||
/**
|
||||
* The player ID from Goole Play Developer console.
|
||||
*/
|
||||
playerId: string;
|
||||
|
||||
/**
|
||||
* The score data in a display-appropriate format.
|
||||
*/
|
||||
formattedScore: string;
|
||||
|
||||
/**
|
||||
* Whether or not this score was the player's new best score.
|
||||
*/
|
||||
newBest: boolean;
|
||||
|
||||
/**
|
||||
* The raw score value of this score result.
|
||||
*/
|
||||
rawScore: number;
|
||||
|
||||
/**
|
||||
* The score tag associated with this result, if any.
|
||||
*/
|
||||
scoreTag: string;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Google Play Games Services
|
||||
* @description
|
||||
@@ -126,6 +167,21 @@ export interface Player {
|
||||
* leaderboardId: 'SomeLeaderboardId'
|
||||
* });
|
||||
*
|
||||
* // Submit a score and wait for reponse.
|
||||
* this.googlePlayGamesServices.submitScoreNow({
|
||||
* score: 100,
|
||||
* leaderboardId: 'SomeLeaderboardId'
|
||||
* }).then((data: SubmittedScoreData) => {
|
||||
* console.log('Score related data', data);
|
||||
* });
|
||||
*
|
||||
* // Get the player score on a leaderboard.
|
||||
* this.googlePlayGamesServices.getPlayerScore({
|
||||
* leaderboardId: 'SomeLeaderBoardId'
|
||||
* }).then((data: PlayerScoreData) => {
|
||||
* console.log('Player score', data);
|
||||
* });
|
||||
*
|
||||
* // Show the native leaderboards window.
|
||||
* this.googlePlayGamesServices.showAllLeaderboards()
|
||||
* .then(() => console.log('The leaderboard window is visible.'));
|
||||
@@ -138,12 +194,23 @@ export interface Player {
|
||||
* // Unlock an achievement.
|
||||
* this.googlePlayGamesServices.unlockAchievement({
|
||||
* achievementId: 'SomeAchievementId'
|
||||
* }).then(() => console.log('Achievement sent'));
|
||||
*
|
||||
* // Unlock an achievement and wait for response.
|
||||
* this.googlePlayGamesServices.unlockAchievementNow({
|
||||
* achievementId: 'SomeAchievementId'
|
||||
* }).then(() => console.log('Achievement unlocked'));
|
||||
*
|
||||
* // Incremement an achievement.
|
||||
* this.googlePlayGamesServices.incrementAchievement({
|
||||
* step: 1,
|
||||
* achievementId: 'SomeAchievementId'
|
||||
* }).then(() => console.log('Achievement increment sent'));
|
||||
*
|
||||
* // Incremement an achievement and wait for response.
|
||||
* this.googlePlayGamesServices.incrementAchievementNow({
|
||||
* step: 1,
|
||||
* achievementId: 'SomeAchievementId'
|
||||
* }).then(() => console.log('Achievement incremented'));
|
||||
*
|
||||
* // Show the native achievements window.
|
||||
@@ -220,6 +287,33 @@ export class GooglePlayGamesServices extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Submit a score to a leaderboard and waits for the response from
|
||||
* Google Play Games. You should ensure that you have a
|
||||
* successful return from auth() before submitting a score.
|
||||
*
|
||||
* @param data {ScoreData} The score data you want to submit.
|
||||
* @return {Promise<SubmittedScoreData>} Returns a promise that resolves when Play
|
||||
* Games Services returns the score information.
|
||||
*/
|
||||
@Cordova()
|
||||
submitScoreNow(data: ScoreData): Promise<SubmittedScoreData> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the player score on a leaderboard. You should ensure that you have a
|
||||
* successful return from auth() before requesting a score.
|
||||
*
|
||||
* @param data {LeaderboardData} The leaderboard score you want to request.
|
||||
* @return {Promise<PlayerScoreData>} Returns a promise that resolves when Play
|
||||
* Games Services returns the player score.
|
||||
*/
|
||||
@Cordova()
|
||||
getPlayerScore(data: LeaderboardData): Promise<PlayerScoreData> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Launches the native Play Games leaderboard view controller to show all the
|
||||
* leaderboards.
|
||||
@@ -250,25 +344,49 @@ export class GooglePlayGamesServices extends IonicNativePlugin {
|
||||
*
|
||||
* @param data {AchievementData}
|
||||
* @return {Promise<any>} Returns a promise that resolves when the
|
||||
* achievement is unlocked.
|
||||
* achievement is sent.
|
||||
*/
|
||||
@Cordova()
|
||||
unlockAchievement(data: AchievementData): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unlock an achievement and wait for response.
|
||||
*
|
||||
* @param data {AchievementData}
|
||||
* @return {Promise<any>} Returns a promise that resolves when the Play
|
||||
* Games Services returns that the achievement is unlocked.
|
||||
*/
|
||||
@Cordova()
|
||||
unlockAchievementNow(data: AchievementData): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Increment an achievement.
|
||||
*
|
||||
* @param data {IncrementableAchievementData}
|
||||
* @return {Promise<any>} Returns a promise that resolves when the
|
||||
* achievement is incremented.
|
||||
* achievement is sent.
|
||||
*/
|
||||
@Cordova()
|
||||
incrementAchievement(data: IncrementableAchievementData): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Increment an achievement and wait for response.
|
||||
*
|
||||
* @param data {IncrementableAchievementData}
|
||||
* @return {Promise<any>} Returns a promise that resolves when the Play
|
||||
* Games Services returns that the achievement has been incremented.
|
||||
*/
|
||||
@Cordova()
|
||||
incrementAchievementNow(data: IncrementableAchievementData): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Lauches the native Play Games achievements view controller to show
|
||||
* achievements.
|
||||
|
||||
@@ -39,7 +39,7 @@ export class GooglePlus extends IonicNativePlugin {
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
})
|
||||
login(options?: any): Promise<any> {
|
||||
login(options: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
import { Cordova, CordovaProperty, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export interface HTTPResponse {
|
||||
/**
|
||||
* The status number of the response
|
||||
* The HTTP status number of the response or a negative internal error code.
|
||||
*/
|
||||
status: number;
|
||||
/**
|
||||
* The headers of the response
|
||||
* The headers of the response.
|
||||
*/
|
||||
headers: any;
|
||||
headers: {[ key: string ]: string };
|
||||
/**
|
||||
* The URL of the response. This property will be the final URL obtained after any redirects.
|
||||
*/
|
||||
@@ -30,8 +30,9 @@ export interface HTTPResponse {
|
||||
* Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android.
|
||||
*
|
||||
* Advantages over Javascript requests:
|
||||
* - Background threading - all requests are done in a background thread
|
||||
* - SSL Pinning
|
||||
* - SSL / TLS Pinning
|
||||
* - CORS restrictions do not apply
|
||||
* - Handling of HTTP code 401 - read more at [Issue CB-2415](https://issues.apache.org/jira/browse/CB-2415)
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
@@ -70,6 +71,21 @@ export interface HTTPResponse {
|
||||
})
|
||||
@Injectable()
|
||||
export class HTTP extends IonicNativePlugin {
|
||||
/**
|
||||
* This enum represents the internal error codes which can be returned in a HTTPResponse object.
|
||||
* @readonly
|
||||
*/
|
||||
@CordovaProperty()
|
||||
readonly ErrorCode: {
|
||||
GENERIC: number;
|
||||
SSL_EXCEPTION: number;
|
||||
SERVER_NOT_FOUND: number;
|
||||
TIMEOUT: number;
|
||||
UNSUPPORTED_URL: number;
|
||||
NOT_CONNECTED: number;
|
||||
POST_PROCESSING_FAILED: number;
|
||||
};
|
||||
|
||||
/**
|
||||
* This returns an object representing a basic HTTP Authorization header of the form.
|
||||
* @param username {string} Username
|
||||
@@ -118,11 +134,12 @@ export class HTTP extends IonicNativePlugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the data serializer which will be used for all future POST and PUT requests. Takes a string representing the name of the serializer.
|
||||
* @param serializer {string} The name of the serializer. Can be urlencoded, utf8 or json
|
||||
* Set the data serializer which will be used for all future POST, PUT and PATCH requests. Takes a string representing the name of the serializer.
|
||||
* @param serializer {string} The name of the serializer.
|
||||
* @see https://github.com/silkimen/cordova-plugin-advanced-http#setdataserializer
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setDataSerializer(serializer: string): void {}
|
||||
setDataSerializer(serializer: 'urlencoded' | 'json' | 'utf8' | 'multipart' | 'raw'): void {}
|
||||
|
||||
/**
|
||||
* Add a custom cookie.
|
||||
@@ -172,26 +189,32 @@ export class HTTP extends IonicNativePlugin {
|
||||
setRequestTimeout(timeout: number): void {}
|
||||
|
||||
/**
|
||||
* Set SSL Cert handling mode, being one of the following values
|
||||
* default: default SSL cert handling using system's CA certs
|
||||
* legacy: use legacy default behavior (< 2.0.3), excluding user installed CA certs (only for Android)
|
||||
* nocheck: disable SSL cert checking, trusting all certs (meant to be used only for testing purposes)
|
||||
* pinned: trust only provided certs
|
||||
* @see https://github.com/silkimen/cordova-plugin-advanced-http#setsslcertmode
|
||||
* @param {'default' | 'legacy' | 'nocheck' | 'pinned'} mode SSL Cert handling mode
|
||||
* Resolve if it should follow redirects automatically.
|
||||
* @returns {boolean} returns true if it is configured to follow redirects automatically
|
||||
*/
|
||||
@Cordova()
|
||||
setSSLCertMode(mode: 'default' | 'legacy' | 'nocheck' | 'pinned'): Promise<void> {
|
||||
@Cordova({ sync: true })
|
||||
getFollowRedirect(): boolean {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable following redirects automatically.
|
||||
* @param disable {boolean} Set to true to disable following redirects automatically
|
||||
* @returns {Promise<void>} returns a promise that will resolve on success, and reject on failure
|
||||
* Configure if it should follow redirects automatically.
|
||||
* @param follow {boolean} Set to false to disable following redirects automatically
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setFollowRedirect(follow: boolean): void {}
|
||||
|
||||
/**
|
||||
* Set server trust mode, being one of the following values:
|
||||
* default: default SSL trustship and hostname verification handling using system's CA certs;
|
||||
* legacy: use legacy default behavior (< 2.0.3), excluding user installed CA certs (only for Android);
|
||||
* nocheck: disable SSL certificate checking and hostname verification, trusting all certs (meant to be used only for testing purposes);
|
||||
* pinned: trust only provided certificates;
|
||||
* @see https://github.com/silkimen/cordova-plugin-advanced-http#setservertrustmode
|
||||
* @param {string} mode server trust mode
|
||||
*/
|
||||
@Cordova()
|
||||
disableRedirect(disable: boolean): Promise<void> {
|
||||
setServerTrustMode(mode: 'default' | 'legacy' | 'nocheck' | 'pinned'): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -200,7 +223,7 @@ export class HTTP extends IonicNativePlugin {
|
||||
* @param url {string} The url to send the request to
|
||||
* @param body {Object} The body of the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
post(url: string, body: any, headers: any): Promise<HTTPResponse> {
|
||||
@@ -212,7 +235,7 @@ export class HTTP extends IonicNativePlugin {
|
||||
* @param url {string} The url to send the request to
|
||||
* @param parameters {Object} Parameters to send with the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
get(url: string, parameters: any, headers: any): Promise<HTTPResponse> {
|
||||
@@ -224,7 +247,7 @@ export class HTTP extends IonicNativePlugin {
|
||||
* @param url {string} The url to send the request to
|
||||
* @param body {Object} The body of the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
put(url: string, body: any, headers: any): Promise<HTTPResponse> {
|
||||
@@ -236,7 +259,7 @@ export class HTTP extends IonicNativePlugin {
|
||||
* @param url {string} The url to send the request to
|
||||
* @param body {Object} The body of the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
patch(url: string, body: any, headers: any): Promise<HTTPResponse> {
|
||||
@@ -248,7 +271,7 @@ export class HTTP extends IonicNativePlugin {
|
||||
* @param url {string} The url to send the request to
|
||||
* @param parameters {Object} Parameters to send with the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
delete(url: string, parameters: any, headers: any): Promise<HTTPResponse> {
|
||||
@@ -260,24 +283,36 @@ export class HTTP extends IonicNativePlugin {
|
||||
* @param url {string} The url to send the request to
|
||||
* @param parameters {Object} Parameters to send with the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
head(url: string, parameters: any, headers: any): Promise<HTTPResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make an OPTIONS request
|
||||
* @param url {string} The url to send the request to
|
||||
* @param parameters {Object} Parameters to send with the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
options(url: string, parameters: any, headers: any): Promise<HTTPResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param url {string} The url to send the request to
|
||||
* @param body {Object} The body of the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @param filePath {string} The local path of the file to upload
|
||||
* @param name {string} The name of the parameter to pass the file along as
|
||||
* @returns {Promise<any>} returns a FileEntry promise that resolve on success, and reject on failure
|
||||
* @param filePath {string} The local path(s) of the file(s) to upload
|
||||
* @param name {string} The name(s) of the parameter to pass the file(s) along as
|
||||
* @returns {Promise<any>} returns a FileEntry promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
uploadFile(url: string, body: any, headers: any, filePath: string, name: string): Promise<any> {
|
||||
uploadFile(url: string, body: any, headers: any, filePath: string | string[], name: string | string[]): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -287,7 +322,7 @@ export class HTTP extends IonicNativePlugin {
|
||||
* @param body {Object} The body of the request
|
||||
* @param headers {Object} The headers to set for this request
|
||||
* @param filePath {string} The path to download the file to, including the file name.
|
||||
* @returns {Promise<any>} returns a FileEntry promise that resolve on success, and reject on failure
|
||||
* @returns {Promise<any>} returns a FileEntry promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
downloadFile(url: string, body: any, headers: any, filePath: string): Promise<any> {
|
||||
@@ -304,23 +339,25 @@ export class HTTP extends IonicNativePlugin {
|
||||
* @param options.serializer {string} data serializer to be used (only applicable on post, put or patch methods), defaults to global serializer value, see setDataSerializer for supported values
|
||||
* @param options.timeout {number} timeout value for the request in seconds, defaults to global timeout value
|
||||
* @param options.headers {Object} headers object (key value pair), will be merged with global values
|
||||
* @param options.filePath {string} filePath to be used during upload and download see uploadFile and downloadFile for detailed information
|
||||
* @param options.name {string} name to be used during upload see uploadFile for detailed information
|
||||
* @param options.filePath {string} file path(s) to be used during upload and download see uploadFile and downloadFile for detailed information
|
||||
* @param options.name {string} name(s) to be used during upload see uploadFile for detailed information
|
||||
* @param options.responseType {string} response type, defaults to text
|
||||
*
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
|
||||
* @returns {Promise<HTTPResponse>} returns a promise that will resolve on success, and reject on failure
|
||||
*/
|
||||
@Cordova()
|
||||
sendRequest(
|
||||
url: string,
|
||||
options: {
|
||||
method: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete' | 'upload' | 'download';
|
||||
method: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete' | 'options' | 'upload' | 'download';
|
||||
data?: { [index: string]: any };
|
||||
params?: { [index: string]: string | number };
|
||||
serializer?: 'json' | 'urlencoded' | 'utf8';
|
||||
serializer?: 'json' | 'urlencoded' | 'utf8' | 'multipart';
|
||||
timeout?: number;
|
||||
headers?: { [index: string]: string };
|
||||
filePath?: string;
|
||||
name?: string;
|
||||
filePath?: string | string[];
|
||||
name?: string | string[];
|
||||
responseType?: 'text' | 'arraybuffer' | 'blob' | 'json';
|
||||
}
|
||||
): Promise<HTTPResponse> {
|
||||
return;
|
||||
|
||||
@@ -12,6 +12,7 @@ export interface ImagePickerOptions {
|
||||
* Max width to allow images to be
|
||||
*/
|
||||
width?: number;
|
||||
|
||||
/**
|
||||
* Max height to allow images to be
|
||||
*/
|
||||
@@ -22,6 +23,21 @@ export interface ImagePickerOptions {
|
||||
*/
|
||||
quality?: number;
|
||||
|
||||
/**
|
||||
* Videos allowed?
|
||||
*/
|
||||
allow_video?: boolean;
|
||||
|
||||
/**
|
||||
* the default is the message of the old plugin impl
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* the old plugin impl didn't have it, so passing null by default
|
||||
*/
|
||||
message?: string;
|
||||
|
||||
/**
|
||||
* Choose the format of the return value.
|
||||
* Defined in ImagePicker.OutputType. Default is FILE_URI.
|
||||
@@ -29,6 +45,11 @@ export interface ImagePickerOptions {
|
||||
* DATA_URL : 1, Return image as base64-encoded string
|
||||
*/
|
||||
outputType?: number;
|
||||
|
||||
/**
|
||||
* Disable the iOS popover as seen on iPad
|
||||
*/
|
||||
disable_popover?: boolean;
|
||||
}
|
||||
|
||||
export enum OutputType {
|
||||
@@ -42,7 +63,7 @@ export enum OutputType {
|
||||
* Cordova Plugin For Multiple Image Selection
|
||||
*
|
||||
* Requires Cordova plugin: `cordova-plugin-image-picker`.
|
||||
* For more info, please see the https://github.com/wymsee/cordova-imagePicker
|
||||
* For more info, please see the https://github.com/Telerik-Verified-Plugins/ImagePicker
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
|
||||
@@ -10,83 +10,123 @@ import { Observable, Observer } from 'rxjs';
|
||||
declare const cordova: Cordova & { InAppBrowser: any };
|
||||
|
||||
export interface InAppBrowserOptions {
|
||||
/** Set to yes or no to turn the InAppBrowser's location bar on or off. */
|
||||
location?: 'yes' | 'no';
|
||||
/* Set to yes to create the browser and load the page, but not show it. The loadstop event fires when loading is complete.
|
||||
* Omit or set to no (default) to have the browser open and load normally. */
|
||||
hidden?: 'yes' | 'no';
|
||||
/**
|
||||
* (iOS Only) Set to yes or no to allow in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface.
|
||||
* The HTML's video element must also include the webkit-playsinline attribute (defaults to no)
|
||||
*/
|
||||
allowInlineMediaPlayback?: 'yes' | 'no';
|
||||
/**
|
||||
* set to enable the beforeload event to modify which pages are actually loaded in the browser. Accepted values are get to
|
||||
* intercept only GET requests, post to intercept on POST requests or yes to intercept both GET & POST requests.
|
||||
* Note that POST requests are not currently supported and will be ignored (if you set beforeload=post it will raise an error).
|
||||
*/
|
||||
beforeload?: 'yes' | 'get' | 'post';
|
||||
/** Set to yes to have the browser's cookie cache cleared before the new window is opened. */
|
||||
clearcache?: 'yes';
|
||||
/* Set to yes to have the session cookie cache cleared before the new window is opened. */
|
||||
/** set to yes to have the browser's entire local storage cleared (cookies, HTML5 local storage, IndexedDB, etc.) before the new window is opened */
|
||||
cleardata?: 'yes';
|
||||
/**
|
||||
* Set to yes to have the session cookie cache cleared before the new window is opened.
|
||||
* For WKWebView, requires iOS 11+ on target device.
|
||||
*/
|
||||
clearsessioncache?: 'yes';
|
||||
/* (Android) Set to a string to use as the close button's caption instead of a X. Note that you need to localize this value yourself.
|
||||
* (iOS) Set to a string to use as the Done button's caption. Note that you need to localize this value yourself. */
|
||||
/**
|
||||
* (Android) Set to a string to use as the close button's caption instead of a X. Note that you need to localize this value yourself.
|
||||
* (iOS) Set to a string to use as the Done button's caption. Note that you need to localize this value yourself.
|
||||
*/
|
||||
closebuttoncaption?: string;
|
||||
/* (Android) Set to a valid hex color string, for example: #00ff00, and it will change the close button color from default, regardless of being a text or default X. Only has effect if user has location set to yes.
|
||||
* (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default Done button's color. Only applicable if toolbar is not disabled. */
|
||||
/**
|
||||
* (Android) Set to a valid hex color string, for example: #00ff00, and it will change the close button color from default, regardless of being a text or default X. Only has effect if user has location set to yes.
|
||||
* (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default Done button's color. Only applicable if toolbar is not disabled.
|
||||
*/
|
||||
closebuttoncolor?: string;
|
||||
/** (Android Only) Set to yes to show Android browser's zoom controls, set to no to hide them. Default value is yes. */
|
||||
zoom?: 'yes' | 'no';
|
||||
/* (Android & Windows Phone Only) Set to yes to use the hardware back button to navigate backwards through the InAppBrowser's history.
|
||||
* If there is no previous page, the InAppBrowser will close. The default value is yes, so you must set it to no if you want the back button to simply close the InAppBrowser. */
|
||||
hardwareback?: 'yes' | 'no';
|
||||
/*
|
||||
* Set to yes to prevent HTML5 audio or video from autoplaying (defaults to no). */
|
||||
mediaPlaybackRequiresUserAction?: 'yes' | 'no';
|
||||
/* (Android) Set to yes to hide the navigation buttons on the location toolbar, only has effect if user has location set to yes. The default value is no.
|
||||
* (iOS) Set to yes or no to turn the toolbar navigation buttons on or off (defaults to no). Only applicable if toolbar is not disabled.*/
|
||||
hidenavigationbuttons?: 'yes' | 'no';
|
||||
/* (Android) Set to yes to hide the url bar on the location toolbar, only has effect if user has location set to yes. The default value is no.*/
|
||||
hideurlbar?: 'yes' | 'no';
|
||||
/* (Android) Set to a valid hex color string, for example: #00ff00, and it will change the color of both navigation buttons from default. Only has effect if user has location set to yes and not hidenavigationbuttons set to yes.
|
||||
* (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default color. Only applicable if navigation buttons are visible. */
|
||||
navigationbuttoncolor?: string;
|
||||
/* (Android) Set to a valid hex color string, for example: #00ff00, and it will change the color the toolbar from default. Only has effect if user has location set to yes.
|
||||
* (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default color of the toolbar. Only applicable if toolbar is not disabled.*/
|
||||
toolbarcolor?: string;
|
||||
/** (Android Only) Set to yes to make InAppBrowser WebView to pause/resume with the app to stop background audio (this may be required to avoid Google Play issues) */
|
||||
shouldPauseOnSuspend?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no (default is no). Turns on/off the UIWebViewBounce property. */
|
||||
disallowoverscroll?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to prevent viewport scaling through a meta tag (defaults to no). */
|
||||
enableViewportScale?: 'yes' | 'no';
|
||||
/** (Android Only) Set to yes to show a close button in the footer similar to the iOS Done button. The close button will appear the same as for the header hence use closebuttoncaption and closebuttoncolor to set its properties */
|
||||
footer?: 'yes' | 'no';
|
||||
/** (Android Only) Set to a valid hex color string, for example #00ff00 or #CC00ff00 (#aarrggbb), and it will change the footer color from default. Only has effect if user has footer set to yes */
|
||||
footercolor?: string;
|
||||
/** (iOS Only) Set to yes or no (default is no). Turns on/off the UIWebViewBounce property. */
|
||||
disallowoverscroll?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to turn the toolbar on or off for the InAppBrowser (defaults to yes) */
|
||||
toolbar?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to make the toolbar translucent(semi-transparent) (defaults to yes). Only applicable if toolbar is not disabled. */
|
||||
toolbartranslucent?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to prevent viewport scaling through a meta tag (defaults to no). */
|
||||
enableViewportScale?: 'yes' | 'no';
|
||||
/* (iOS Only) Set to yes or no to allow in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface.
|
||||
* The HTML's video element must also include the webkit-playsinline attribute (defaults to no) */
|
||||
allowInlineMediaPlayback?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to open the keyboard when form elements receive focus via JavaScript's focus() call (defaults to yes). */
|
||||
keyboardDisplayRequiresUserAction?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to wait until all new view content is received before being rendered (defaults to no). */
|
||||
suppressesIncrementalRendering?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to pagesheet, formsheet or fullscreen to set the presentation style (defaults to fullscreen). */
|
||||
presentationstyle?: 'pagesheet' | 'formsheet' | 'fullscreen';
|
||||
/** (iOS Only) Set to fliphorizontal, crossdissolve or coververtical to set the transition style (defaults to coververtical). */
|
||||
transitionstyle?: 'fliphorizontal' | 'crossdissolve' | 'coververtical';
|
||||
/** (iOS Only) Set to top or bottom (default is bottom). Causes the toolbar to be at the top or bottom of the window. */
|
||||
toolbarposition?: 'top' | 'bottom';
|
||||
/**
|
||||
* (Windows only) Set to yes to create the browser control without a border around it.
|
||||
* Please note that if location=no is also specified, there will be no control presented to user to close IAB window.
|
||||
*/
|
||||
fullscreen?: 'yes';
|
||||
/**
|
||||
* (Android & Windows Only) Set to yes to use the hardware back button to navigate backwards through the InAppBrowser's history.
|
||||
* If there is no previous page, the InAppBrowser will close. The default value is yes, so you must set it to no if you want the back button to simply close the InAppBrowser.
|
||||
*/
|
||||
hardwareback?: 'yes' | 'no';
|
||||
/**
|
||||
* Set to yes to create the browser and load the page, but not show it. The loadstop event fires when loading is complete.
|
||||
* Omit or set to no (default) to have the browser open and load normally.
|
||||
*/
|
||||
hidden?: 'yes' | 'no';
|
||||
/**
|
||||
* (Android) Set to yes to hide the navigation buttons on the location toolbar, only has effect if user has location set to yes. The default value is no.
|
||||
* (iOS) Set to yes or no to turn the toolbar navigation buttons on or off (defaults to no). Only applicable if toolbar is not disabled.
|
||||
*/
|
||||
hidenavigationbuttons?: 'yes' | 'no';
|
||||
/**
|
||||
* (iOS Only) Set to yes or no to change the visibility of the loading indicator (defaults to no).
|
||||
*/
|
||||
hidespinner?: 'yes' | 'no';
|
||||
/* (Windows only) Set to yes to create the browser control without a border around it.
|
||||
* Please note that if location=no is also specified, there will be no control presented to user to close IAB window. */
|
||||
fullscreen?: 'yes';
|
||||
/** (Android) Set to yes to hide the url bar on the location toolbar, only has effect if user has location set to yes. The default value is no. */
|
||||
hideurlbar?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to open the keyboard when form elements receive focus via JavaScript's focus() call (defaults to yes). */
|
||||
keyboardDisplayRequiresUserAction?: 'yes' | 'no';
|
||||
/**
|
||||
* (Android) Set to yes to swap positions of the navigation buttons and the close button. Specifically, navigation buttons go to the left and close button to the right.
|
||||
* (iOS) Set to yes to swap positions of the navigation buttons and the close button. Specifically, close button goes to the right and navigation buttons to the left.
|
||||
*/
|
||||
lefttoright?: 'yes' | 'no';
|
||||
/** Set to yes or no to turn the InAppBrowser's location bar on or off. */
|
||||
location?: 'yes' | 'no';
|
||||
/**
|
||||
* Set to yes to prevent HTML5 audio or video from autoplaying (defaults to no).
|
||||
*/
|
||||
mediaPlaybackRequiresUserAction?: 'yes' | 'no';
|
||||
/**
|
||||
* (Android) Set to a valid hex color string, for example: #00ff00, and it will change the color of both navigation buttons from default. Only has effect if user has location set to yes and not hidenavigationbuttons set to yes.
|
||||
* (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default color. Only applicable if navigation buttons are visible.
|
||||
*/
|
||||
navigationbuttoncolor?: string;
|
||||
/** (iOS Only) Set to pagesheet, formsheet or fullscreen to set the presentation style (defaults to fullscreen). */
|
||||
presentationstyle?: 'pagesheet' | 'formsheet' | 'fullscreen';
|
||||
/** (Android Only) Set to yes to make InAppBrowser WebView to pause/resume with the app to stop background audio (this may be required to avoid Google Play issues) */
|
||||
shouldPauseOnSuspend?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to wait until all new view content is received before being rendered (defaults to no). */
|
||||
suppressesIncrementalRendering?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes or no to turn the toolbar on or off for the InAppBrowser (defaults to yes) */
|
||||
toolbar?: 'yes' | 'no';
|
||||
/**
|
||||
* (Android) Set to a valid hex color string, for example: #00ff00, and it will change the color the toolbar from default. Only has effect if user has location set to yes.
|
||||
* (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default color of the toolbar. Only applicable if toolbar is not disabled.
|
||||
*/
|
||||
toolbarcolor?: string;
|
||||
/** (iOS Only) Set to top or bottom (default is bottom). Causes the toolbar to be at the top or bottom of the window. */
|
||||
toolbarposition?: 'top' | 'bottom';
|
||||
/** (iOS Only) Set to yes or no to make the toolbar translucent(semi-transparent) (defaults to yes). Only applicable if toolbar is not disabled. */
|
||||
toolbartranslucent?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to fliphorizontal, crossdissolve or coververtical to set the transition style (defaults to coververtical). */
|
||||
transitionstyle?: 'fliphorizontal' | 'crossdissolve' | 'coververtical';
|
||||
/** (Android Only) Sets whether the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport. When the value of the setting is no, the layout width is always set to the width of the WebView control in device-independent (CSS) pixels. When the value is yes and the page contains the viewport meta tag, the value of the width specified in the tag is used. If the page does not contain the tag or does not provide a width, then a wide viewport will be used. (defaults to yes). */
|
||||
useWideViewPort?: 'yes' | 'no';
|
||||
/** (iOS Only) Set to yes to use WKWebView engine for the InappBrowser. Omit or set to no (default) to use UIWebView. */
|
||||
usewkwebview?: 'yes' | 'no';
|
||||
/** (Android Only) Set to yes to show Android browser's zoom controls, set to no to hide them. Default value is yes. */
|
||||
zoom?: 'yes' | 'no';
|
||||
/**
|
||||
* @hidden
|
||||
*/
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
export type InAppBrowserEventType = 'loadstart' | 'loadstop' | 'loaderror' | 'exit' | 'beforeload' | 'message' | 'customscheme';
|
||||
|
||||
export interface InAppBrowserEvent extends Event {
|
||||
/** the eventname, either loadstart, loadstop, loaderror, or exit. */
|
||||
/** the event name */
|
||||
type: string;
|
||||
/** the URL that was loaded. */
|
||||
url: string;
|
||||
@@ -94,6 +134,8 @@ export interface InAppBrowserEvent extends Event {
|
||||
code: number;
|
||||
/** the error message, only in the case of loaderror. */
|
||||
message: string;
|
||||
/** the postMessage data, only in the case of message. */
|
||||
data: any;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -138,6 +180,13 @@ export class InAppBrowserObject {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to be called after the "beforeload" event to continue the script
|
||||
* @param strUrl {String} The URL the InAppBrowser should navigate to.
|
||||
*/
|
||||
@CordovaInstance({ sync: true })
|
||||
_loadAfterBeforeload(strUrl: string): void {}
|
||||
|
||||
/**
|
||||
* Displays an InAppBrowser window that was opened hidden. Calling this has no effect
|
||||
* if the InAppBrowser was already visible.
|
||||
@@ -178,6 +227,28 @@ export class InAppBrowserObject {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* A method that allows you to listen to events happening in the browser.
|
||||
* @param event {InAppBrowserEventType} Name of the event
|
||||
* @returns {Observable<InAppBrowserEvent>} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe.
|
||||
*/
|
||||
@InstanceCheck()
|
||||
on(event: InAppBrowserEventType): Observable<InAppBrowserEvent> {
|
||||
return new Observable<InAppBrowserEvent>(
|
||||
(observer: Observer<InAppBrowserEvent>) => {
|
||||
this._objectInstance.addEventListener(
|
||||
event,
|
||||
observer.next.bind(observer)
|
||||
);
|
||||
return () =>
|
||||
this._objectInstance.removeEventListener(
|
||||
event,
|
||||
observer.next.bind(observer)
|
||||
);
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* A method that allows you to listen to events happening in the browser.
|
||||
* @param event {string} Name of the event
|
||||
|
||||
@@ -1,79 +1,10 @@
|
||||
import { Cordova, CordovaProperty, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
import { Injectable } from '@angular/core';
|
||||
|
||||
/**
|
||||
* @name In App Purchase 2
|
||||
* @description
|
||||
* In-App Purchase for Cordova on iOS, Android and Windows
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { InAppPurchase2 } from '@ionic-native/in-app-purchase-2/ngx';
|
||||
*
|
||||
* constructor(private store: InAppPurchase2) { }
|
||||
*
|
||||
* ...
|
||||
* ```
|
||||
*
|
||||
* * @advanced
|
||||
*
|
||||
* ```typescript
|
||||
* // After Platform Ready
|
||||
* this.store.verbosity = this.store.DEBUG;
|
||||
* this.store.register({
|
||||
* id: productId,
|
||||
* alias: productId,
|
||||
* type: this.store.NON_RENEWING_SUBSCRIPTION
|
||||
* });
|
||||
*
|
||||
* // Register Event Handlers for the specific product
|
||||
* this.store.when(productId).registered( (product: IAPProduct) => {
|
||||
* console.log('Registered: ' + JSON.stringify(product));
|
||||
* });
|
||||
*
|
||||
* // Updated
|
||||
* this.store.when(productId).updated( (product: IAPProduct) => {
|
||||
* console.log('Loaded' + JSON.stringify(product));
|
||||
* });
|
||||
*
|
||||
* // Issue with buying
|
||||
* this.store.when(productId).cancelled( (product) => {
|
||||
* alert('Purchase was Cancelled');
|
||||
* });
|
||||
*
|
||||
* // Track All Store Errors
|
||||
* this.store.error( (err) => {
|
||||
* alert('Store Error ' + JSON.stringify(err));
|
||||
* });
|
||||
*
|
||||
* this.store.ready(() => {
|
||||
* console.log(JSON.stringify(this.store.get(productId)));
|
||||
* console.log('Store is Ready: ' + JSON.stringify(status));
|
||||
* console.log('Products: ' + JSON.stringify(this.store.products));
|
||||
* });
|
||||
*
|
||||
*
|
||||
* // Errors
|
||||
* this.store.when(productId).error( (error) => {
|
||||
* this.loader.dismiss();
|
||||
* alert('An Error Occured' + JSON.stringify(error));
|
||||
* });
|
||||
* // Refresh Starts Handlers
|
||||
* console.log('Refresh Store');
|
||||
* this.store.refresh();
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* // To Purchase
|
||||
* this.store.order(productId);
|
||||
*
|
||||
* ```
|
||||
*
|
||||
*/
|
||||
|
||||
export interface IAPProductOptions {
|
||||
id: string;
|
||||
alias: string;
|
||||
alias?: string;
|
||||
type: string;
|
||||
}
|
||||
|
||||
@@ -98,7 +29,7 @@ export interface IAPProduct {
|
||||
|
||||
id: string;
|
||||
|
||||
alias: string;
|
||||
alias?: string;
|
||||
|
||||
type: string;
|
||||
|
||||
@@ -122,16 +53,91 @@ export interface IAPProduct {
|
||||
|
||||
owned: boolean;
|
||||
|
||||
downloading: boolean;
|
||||
downloading?: boolean;
|
||||
|
||||
downloaded: boolean;
|
||||
downloaded?: boolean;
|
||||
|
||||
additionalData: any;
|
||||
lastRenewalDate?: Date;
|
||||
|
||||
transaction: any;
|
||||
expiryDate?: Date;
|
||||
|
||||
introPrice?: string;
|
||||
|
||||
introPriceMicros?: number;
|
||||
|
||||
introPriceNumberOfPeriods?: number;
|
||||
|
||||
introPriceSubscriptionPeriod?: string;
|
||||
|
||||
introPricePaymentMode?: string;
|
||||
|
||||
ineligibleForIntroPrice?: boolean;
|
||||
|
||||
billingPeriod?: number;
|
||||
|
||||
billingPeriodUnit?: string;
|
||||
|
||||
trialPeriod?: number;
|
||||
|
||||
trialPeriodUnit?: string;
|
||||
|
||||
additionalData?: any;
|
||||
|
||||
transaction?: any;
|
||||
|
||||
/**
|
||||
* Call `product.finish()` to confirm to the store that an approved order has been delivered.
|
||||
*
|
||||
* This will change the product state from `APPROVED` to `FINISHED` (see product life-cycle).
|
||||
*
|
||||
* As long as you keep the product in state `APPROVED`:
|
||||
*
|
||||
* - the money may not be in your account (i.e. user isn't charged)
|
||||
* - you will receive the `approved` event each time the application starts,
|
||||
* where you should try again to finish the pending transaction.
|
||||
*
|
||||
* **example use**
|
||||
*
|
||||
* ```js
|
||||
* store.when("product.id").approved(function(product){
|
||||
* // synchronous
|
||||
* app.unlockFeature();
|
||||
* product.finish();
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* ```js
|
||||
* store.when("product.id").approved(function(product){
|
||||
* // asynchronous
|
||||
* app.downloadFeature(function() {
|
||||
* product.finish();
|
||||
* });
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
finish(): void;
|
||||
|
||||
/**
|
||||
* Initiate purchase validation as defined by the `store.validator` attribute.
|
||||
*
|
||||
* **return value**
|
||||
*
|
||||
* A Promise with the following methods:
|
||||
*
|
||||
* - `done(function(product){})`
|
||||
* - called whether verification failed or succeeded.
|
||||
* - `expired(function(product){})`
|
||||
* - called if the purchase expired.
|
||||
* - `success(function(product, purchaseData){})`
|
||||
* - called if the purchase is valid and verified.
|
||||
* - `purchaseData` is the device dependent transaction details
|
||||
* returned by the validator, which you can most probably ignore.
|
||||
* - `error(function(err){})`
|
||||
* - validation failed, either because of expiry or communication
|
||||
* failure.
|
||||
* - `err` is a store.Error object, with a code expected to be
|
||||
* `store.ERR_PAYMENT_EXPIRED` or `store.ERR_VERIFICATION_FAILED`.
|
||||
*/
|
||||
verify(): any;
|
||||
|
||||
set(key: string, value: any): void;
|
||||
@@ -149,23 +155,41 @@ export interface IAPProduct {
|
||||
}
|
||||
|
||||
export interface IAPProductEvents {
|
||||
/** Called when product data is loaded from the store. */
|
||||
loaded: (callback: IAPQueryCallback) => void;
|
||||
/** Called when any change occured to a product. */
|
||||
updated: (callback: IAPQueryCallback) => void;
|
||||
/** Called when an order failed. The `err` parameter is an IAPError object. */
|
||||
error: (callback: IAPQueryCallback) => void;
|
||||
/** Called when a product order is approved. */
|
||||
approved: (callback: IAPQueryCallback) => void;
|
||||
/** Called when a non-consumable product or subscription is owned. */
|
||||
owned: (callback: IAPQueryCallback) => void;
|
||||
/** Called when a product order is cancelled by the user. */
|
||||
cancelled: (callback: IAPQueryCallback) => void;
|
||||
/** Called when an order is refunded by the user. */
|
||||
refunded: (callback: IAPQueryCallback) => void;
|
||||
/** Called when product has just been registered. */
|
||||
registered: (callback: IAPQueryCallback) => void;
|
||||
/** Called when the product details have been successfully loaded. */
|
||||
valid: (callback: IAPQueryCallback) => void;
|
||||
/** Called when the product cannot be loaded from the store. */
|
||||
invalid: (callback: IAPQueryCallback) => void;
|
||||
/** Called when an order has just been requested. */
|
||||
requested: (callback: IAPQueryCallback) => void;
|
||||
/** Called when the purchase process has been initiated. */
|
||||
initiated: (callback: IAPQueryCallback) => void;
|
||||
/** Called when the purchase process has completed. */
|
||||
finished: (callback: IAPQueryCallback) => void;
|
||||
/** Called when receipt validation successful. */
|
||||
verified: (callback: IAPQueryCallback) => void;
|
||||
/** Called when receipt verification failed. */
|
||||
unverified: (callback: IAPQueryCallback) => void;
|
||||
/** Called when validation find a subscription to be expired. */
|
||||
expired: (callback: IAPQueryCallback) => void;
|
||||
/** Called when content download is started. */
|
||||
downloading: (product: IAPProduct, progress: any, time_remaining: any) => void;
|
||||
/** Called when content download has successfully completed. */
|
||||
downloaded: (callback: IAPQueryCallback) => void;
|
||||
}
|
||||
|
||||
@@ -180,18 +204,343 @@ export class IAPError {
|
||||
/**
|
||||
* @name In App Purchase 2
|
||||
* @description
|
||||
* In-App Purchase on iOS, Android, Windows, macOS and XBox.
|
||||
*
|
||||
* ## Features
|
||||
*
|
||||
* | | ios | android | win-8 | win-10/uwp | mac |
|
||||
* |--|--|--|--|--|--|
|
||||
* | consumables | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
* | non consumables | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
* | subscriptions | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
* | restore purchases | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
* | receipt validations | ✅ | ✅ | | ✅ | ✅ |
|
||||
* | downloadable content | ✅ | | | | ✅ |
|
||||
* | introductory prices | ✅ | ✅ | | ✅ | ✅ |
|
||||
*
|
||||
* Supports:
|
||||
*
|
||||
* - **iOS** version 7.0 or higher.
|
||||
* - **Android** version 2.2 (API level 8) or higher
|
||||
* - with Google Play client version 3.9.16 or higher
|
||||
* - **Windows** Store/Phone 8.1 or higher
|
||||
* - **Windows 10 Mobile**
|
||||
* - **macOS** version 10
|
||||
* - **Xbox One**
|
||||
* - (and any platform supporting Microsoft's UWP)
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* ```typescript
|
||||
* import { InAppPurchase2 } from '@ionic-native/in-app-purchase-2/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private inAppPurchase2: InAppPurchase2) { }
|
||||
* constructor(public platform: Platform, private store: InAppPurchase2) {
|
||||
* platform.ready().then(() => {
|
||||
* this.store.register({
|
||||
* id: "my_product_id",
|
||||
* type: this.store.NON_RENEWING_SUBSCRIPTION,
|
||||
* });
|
||||
* this.store.when("my_product_id")
|
||||
* .approved(p => p.verify())
|
||||
* .verified(p => p.finish());
|
||||
* this.store.refresh();
|
||||
* });
|
||||
* }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.store.order("my_product_id");
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* ## Full example
|
||||
*
|
||||
* ```typescript
|
||||
* // After platform ready
|
||||
* this.store.verbosity = this.store.DEBUG;
|
||||
* this.store.register({
|
||||
* id: "my_product_id",
|
||||
* type: this.store.PAID_SUBSCRIPTION,
|
||||
* });
|
||||
*
|
||||
* // Register event handlers for the specific product
|
||||
* this.store.when("my_product_id").registered( (product: IAPProduct) => {
|
||||
* console.log('Registered: ' + JSON.stringify(product));
|
||||
* });
|
||||
*
|
||||
* // Updated
|
||||
* this.store.when("my_product_id").updated( (product: IAPProduct) => {
|
||||
* console.log('Updated' + JSON.stringify(product));
|
||||
* });
|
||||
*
|
||||
* // User closed the native purchase dialog
|
||||
* this.store.when("my_product_id").cancelled( (product) => {
|
||||
* console.error('Purchase was Cancelled');
|
||||
* });
|
||||
*
|
||||
* // Track all store errors
|
||||
* this.store.error( (err) => {
|
||||
* console.error('Store Error ' + JSON.stringify(err));
|
||||
* });
|
||||
*
|
||||
* // Run some code only when the store is ready to be used
|
||||
* this.store.ready(() => {
|
||||
* console.log('Store is ready');
|
||||
* console.log('Products: ' + JSON.stringify(this.store.products));
|
||||
* console.log(JSON.stringify(this.store.get("my_product_id")));
|
||||
* });
|
||||
*
|
||||
* // Refresh the status of in-app products
|
||||
* this.store.refresh();
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* // To make a purchase
|
||||
* this.store.order("my_product_id");
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* ## Philosophy
|
||||
*
|
||||
* The API is mostly events based. As a user of this plugin,
|
||||
* you will have to register listeners to changes happening to the products
|
||||
* you register.
|
||||
*
|
||||
* The core of the listening mechanism is the `when()` method. It allows you to
|
||||
* be notified of changes to one or a set of products using a query mechanism:
|
||||
* ```typescript
|
||||
* this.store.when("product").updated(refreshScreen); // match any product
|
||||
* this.store.when("full_version").owned(unlockApp); // match a specific product
|
||||
* this.store.when("subscription").approved(serverCheck); // match all subscriptions
|
||||
* this.store.when("downloadable content").downloaded(showContent);
|
||||
* ```
|
||||
*
|
||||
* The `updated` event is fired whenever one of the fields of a product is
|
||||
* changed (its `owned` status for instance).
|
||||
*
|
||||
* This event provides a generic way to track the statuses of your purchases,
|
||||
* to unlock features when needed and to refresh your views accordingly.
|
||||
*
|
||||
* ## Registering products
|
||||
*
|
||||
* The store needs to know the type and identifiers of your products before you
|
||||
* can use them in your code.
|
||||
*
|
||||
* Use `store.register()` to define them before your first call to `store.refresh()`.
|
||||
*
|
||||
* Once registered, you can use `store.get()` to retrieve an `IAPProduct` object.
|
||||
*
|
||||
* ```typescript
|
||||
* this.store.register({
|
||||
* id: "my_consumable1",
|
||||
* type: this.store.CONSUMABLE
|
||||
* });
|
||||
* ...
|
||||
* const p = this.store.get("my_consumable1");
|
||||
* ```
|
||||
*
|
||||
* The product `id` and `type` have to match products defined in your
|
||||
* Apple, Google or Microsoft developer consoles.
|
||||
*
|
||||
* Learn more about it [from the wiki](https://github.com/j3k0/cordova-plugin-purchase/wiki).
|
||||
*
|
||||
* ## Displaying products
|
||||
*
|
||||
* Right after you registered your products, nothing much is known about them
|
||||
* except their `id`, `type` and an optional `alias`.
|
||||
*
|
||||
* When you perform the initial call to `store.refresh()`, the platforms' server will
|
||||
* be contacted to load informations about the registered products: human
|
||||
* readable `title` and `description`, `price`, etc.
|
||||
*
|
||||
* This isn't an optional step, store owners require you
|
||||
* to display information about a product exactly as retrieved from their server: no
|
||||
* hard-coding of price and title allowed! This is also convenient for you
|
||||
* as you can change the price of your items knowing that it'll be reflected instantly
|
||||
* on your clients' devices.
|
||||
*
|
||||
* Note that the information may not be available when the first view that needs
|
||||
* them appears on screen. For you, the best option is to have your view monitor
|
||||
* changes made to the product.
|
||||
*
|
||||
* ## Purchasing
|
||||
*
|
||||
* #### initiate a purchase
|
||||
*
|
||||
* Purchases are initiated using the `store.order("some_product_id")` method.
|
||||
*
|
||||
* The store will manage the internal purchase flow. It'll end:
|
||||
*
|
||||
* - with an `approved` event. The product enters the `APPROVED` state.
|
||||
* - with a `cancelled` event. The product gets back to the `VALID` state.
|
||||
* - with an `error` event. The product gets back to the `VALID` state.
|
||||
*
|
||||
* See the product life-cycle section for details about product states.
|
||||
*
|
||||
* #### finish a purchase
|
||||
*
|
||||
* Once the transaction is approved, the product still isn't owned: the store needs
|
||||
* confirmation that the purchase was delivered before closing the transaction.
|
||||
*
|
||||
* To confirm delivery, you'll use the `product.finish()` method.
|
||||
*
|
||||
* #### example usage
|
||||
*
|
||||
* During initialization:
|
||||
* ```typescript
|
||||
* this.store.when("extra_chapter").approved((product: IAPProduct) => {
|
||||
* // download the feature
|
||||
* app.downloadExtraChapter()
|
||||
* .then(() => product.finish());
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* When the purchase button is clicked:
|
||||
* ```typescript
|
||||
* this.store.order("extra_chapter");
|
||||
* ```
|
||||
*
|
||||
* #### un-finished purchases
|
||||
*
|
||||
* If your app wasn't able to deliver the content, `product.finish()` won't be called.
|
||||
*
|
||||
* Don't worry: the `approved` event will be re-triggered the next time you
|
||||
* call `store.refresh()`, which can very well be the next time
|
||||
* the application starts. Pending transactions are persistant.
|
||||
*
|
||||
* #### simple case
|
||||
*
|
||||
* In the most simple case, where:
|
||||
*
|
||||
* - delivery of purchases is only local ;
|
||||
* - you don't want (or need) to implement receipt validation ;
|
||||
*
|
||||
* You may just want to finish all purchases automatically. You can do it this way:
|
||||
* ```js
|
||||
* this.store.when("product").approved((p: IAPProduct) => p.finish());
|
||||
* ```
|
||||
*
|
||||
* NOTE: the "product" query will match any purchases (see "queries" to learn more details about queries).
|
||||
*
|
||||
* ## Receipt validation
|
||||
*
|
||||
* To get the most up-to-date information about purchases (in case a purchase have been canceled, or a subscription renewed),
|
||||
* you should implement server side receipt validation.
|
||||
*
|
||||
* This also protects you against fake "purchases", made by some users using
|
||||
* "free in-app purchase" apps on their devices.
|
||||
*
|
||||
* When a purchase has been approved by the store, it's enriched with
|
||||
* transaction information (see `product.transaction` attribute).
|
||||
*
|
||||
* To verify a purchase you'll have to do three things:
|
||||
*
|
||||
* - configure the validator.
|
||||
* - call `product.verify()` from the `approved` event, before finishing the transaction.
|
||||
* - finish the transaction when transaction is `verified`.
|
||||
*
|
||||
* **Shameless Plug**: this is a feature many users struggle with, so as the author of this plugin, we can provide it to you as-a-service: https://billing.fovea.cc/
|
||||
* (which is free until you start making serious money)
|
||||
*
|
||||
* #### example using a validation URL
|
||||
*
|
||||
* ```js
|
||||
* this.store.validator = "https://billing.fovea.cc/";
|
||||
*
|
||||
* this.store.when("my stuff")
|
||||
* .approved((p: IAPProduct) => p.verify())
|
||||
* .verified((p: IAPProduct) => p.finish());
|
||||
* ```
|
||||
*
|
||||
* ## Subscriptions
|
||||
*
|
||||
* For subscription, you MUST implement remote receipt validation.
|
||||
*
|
||||
* When the receipt validator returns a `store.PURCHASE_EXPIRED` error code, the subscription will
|
||||
* automatically loose its `owned` status.
|
||||
*
|
||||
* Typically, you'll enable and disable access to your content this way.
|
||||
* ```typescript
|
||||
* this.store.when("my_subcription").updated((product: IAPProduct) => {
|
||||
* if (product.owned)
|
||||
* app.subscriberMode();
|
||||
* else
|
||||
* app.guestMode();
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* ## Product life-cycle
|
||||
*
|
||||
* A product will change state during the application execution.
|
||||
*
|
||||
* Find below a diagram of the different states a product can pass by.
|
||||
*
|
||||
* ```
|
||||
* REGISTERED +--> INVALID
|
||||
* |
|
||||
* +--> VALID +--> REQUESTED +--> INITIATED +-+
|
||||
* |
|
||||
* ^ +------------------------------+
|
||||
* | |
|
||||
* | | +--> DOWNLOADING +--> DOWNLOADED +
|
||||
* | | | |
|
||||
* | +--> APPROVED +--------------------------------+--> FINISHED +--> OWNED
|
||||
* | |
|
||||
* +-------------------------------------------------------------+
|
||||
*
|
||||
* #### Notes
|
||||
*
|
||||
* - When finished, a consumable product will get back to the `VALID` state, while other will enter the `OWNED` state.
|
||||
* - Any error in the purchase process will bring a product back to the `VALID` state.
|
||||
* - During application startup, products may go instantly from `REGISTERED` to `APPROVED` or `OWNED`, for example if they are purchased non-consumables or non-expired subscriptions.
|
||||
* - Non-Renewing Subscriptions are iOS products only. Please see the [iOS Non Renewing Subscriptions documentation](https://github.com/j3k0/cordova-plugin-purchase/blob/master/doc/ios.md#non-renewing) for a detailed explanation.
|
||||
*
|
||||
* ## events
|
||||
*
|
||||
* - `loaded(IAPProduct)`
|
||||
* - Called when product data is loaded from the store.
|
||||
* - `updated(IAPProduct)`
|
||||
* - Called when any change occured to a product.
|
||||
* - `error(err)`
|
||||
* - Called when an order failed.
|
||||
* - The `err` parameter is an error object
|
||||
* - `approved(IAPProduct)`
|
||||
* - Called when a product order is approved.
|
||||
* - `owned(IAPProduct)`
|
||||
* - Called when a non-consumable product or subscription is owned.
|
||||
* - `cancelled(IAPProduct)`
|
||||
* - Called when a product order is cancelled by the user.
|
||||
* - `refunded(IAPProduct)`
|
||||
* - Called when an order is refunded by the user.
|
||||
* - Actually, all other product states have their promise
|
||||
* - `registered`, `valid`, `invalid`, `requested`,
|
||||
* `initiated` and `finished`
|
||||
* - `verified(IAPProduct)`
|
||||
* - Called when receipt validation successful
|
||||
* - `unverified(IAPProduct)`
|
||||
* - Called when receipt verification failed
|
||||
* - `expired(IAPProduct)`
|
||||
* - Called when validation find a subscription to be expired
|
||||
* - `downloading(IAPProduct, progress, time_remaining)`
|
||||
* - Called when content download is started
|
||||
* - `downloaded(IAPProduct)`
|
||||
* - Called when content download has successfully completed
|
||||
*
|
||||
* ## Learn More
|
||||
*
|
||||
* - [GitHub](https://github.com/j3k0/cordova-plugin-purchase)
|
||||
* - [GitBook](https://purchase.cordova.fovea.cc/)
|
||||
* - [Wiki](https://github.com/j3k0/cordova-plugin-purchase/wiki)
|
||||
* - [API reference](https://github.com/j3k0/cordova-plugin-purchase/blob/master/doc/api.md)
|
||||
*
|
||||
* ## Technical Support or Questions
|
||||
*
|
||||
* If you have questions or need help integrating In-App Purchase, [Open an Issue on GitHub](https://github.com/j3k0/cordova-plugin-purchase/issues) or email us at _support@fovea.cc_.
|
||||
*
|
||||
* @interfaces
|
||||
* IAPProduct
|
||||
* IAPProductOptions
|
||||
* IAPProductEvents
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'InAppPurchase2',
|
||||
@@ -225,12 +574,26 @@ export class InAppPurchase2 extends IonicNativePlugin {
|
||||
@CordovaProperty()
|
||||
verbosity: number;
|
||||
|
||||
/**
|
||||
* Set to true to clear the transaction queue. Not recommended for production.
|
||||
* https://github.com/j3k0/cordova-plugin-purchase/blob/master/doc/api.md#random-tips
|
||||
*/
|
||||
@CordovaProperty()
|
||||
autoFinishTransactions: boolean;
|
||||
|
||||
/**
|
||||
* Set to true to invoke the platform purchase sandbox. (Windows only)
|
||||
*/
|
||||
@CordovaProperty()
|
||||
sandbox: boolean;
|
||||
|
||||
/**
|
||||
* Set to true to disable downloading of hosted content. (Apple only).
|
||||
* Useful in development or when migrating your app away from Apple Hosted Content.
|
||||
*/
|
||||
@CordovaProperty()
|
||||
disableHostedContent: boolean;
|
||||
|
||||
@CordovaProperty()
|
||||
FREE_SUBSCRIPTION: string;
|
||||
|
||||
@@ -342,6 +705,8 @@ export class InAppPurchase2 extends IonicNativePlugin {
|
||||
DOWNLOADED: string;
|
||||
|
||||
|
||||
/* validation error codes */
|
||||
|
||||
@CordovaProperty()
|
||||
INVALID_PAYLOAD: number;
|
||||
|
||||
@@ -351,11 +716,20 @@ export class InAppPurchase2 extends IonicNativePlugin {
|
||||
@CordovaProperty()
|
||||
PURCHASE_EXPIRED: number;
|
||||
|
||||
@CordovaProperty()
|
||||
PURCHASE_CONSUMED: number;
|
||||
|
||||
@CordovaProperty()
|
||||
INTERNAL_ERROR: number;
|
||||
|
||||
@CordovaProperty()
|
||||
NEED_MORE_DATA: number;
|
||||
|
||||
@CordovaProperty()
|
||||
products: IAPProducts;
|
||||
|
||||
@CordovaProperty()
|
||||
validator: string | ((product: string | IAPProduct, callback: Function) => void);
|
||||
validator: string | ((url: string | IAPProduct, callback: Function) => void);
|
||||
|
||||
@CordovaProperty()
|
||||
log: {
|
||||
@@ -387,7 +761,7 @@ export class InAppPurchase2 extends IonicNativePlugin {
|
||||
* @param product {IAPProductOptions}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
register(product: IAPProductOptions): void {}
|
||||
register(product: IAPProductOptions | IAPProductOptions[]): void {}
|
||||
|
||||
/**
|
||||
*
|
||||
@@ -421,6 +795,29 @@ export class InAppPurchase2 extends IonicNativePlugin {
|
||||
off(callback: Function): void {
|
||||
}
|
||||
|
||||
/**
|
||||
* Initiate the purchase of a product.
|
||||
*
|
||||
* The `product` argument can be either:
|
||||
*
|
||||
* - the `IAPProduct` object
|
||||
* - the product `id`
|
||||
* - the product `alias`
|
||||
*
|
||||
* The `additionalData` argument is an optional object with attributes:
|
||||
* - `oldPurchasedSkus`: a string array with the old subscription to upgrade/downgrade on Android. See: [android developer](https://developer.android.com/google/play/billing/billing_reference.html#upgrade-getBuyIntentToReplaceSkus) for more info
|
||||
* - `developerPayload`: string representing the developer payload as described in [billing best practices](https://developer.android.com/google/play/billing/billing_best_practices.html)
|
||||
* - `applicationUsername`: the identifier of the user in your application.
|
||||
*
|
||||
* See the "Purchasing section" to learn more about the purchase process.
|
||||
*
|
||||
* **return value**
|
||||
*
|
||||
* `store.order()` returns a Promise with the following methods:
|
||||
*
|
||||
* - `then` - called when the order was successfully initiated.
|
||||
* - `error` - called if the order couldn't be initiated.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
order(product: string | IAPProduct, additionalData?: any): { then: Function; error: Function; } {
|
||||
return;
|
||||
@@ -428,9 +825,50 @@ export class InAppPurchase2 extends IonicNativePlugin {
|
||||
|
||||
@Cordova()
|
||||
ready(callback: Function): void { return; }
|
||||
|
||||
/**
|
||||
* After you're done registering your store's product and events handlers,
|
||||
* time to call `store.refresh()`.
|
||||
*
|
||||
* This will initiate all the complex behind-the-scene work, to load product
|
||||
* data from the servers and restore whatever already have been
|
||||
* purchased by the user.
|
||||
*
|
||||
* Note that you can call this method again later during the application
|
||||
* execution to re-trigger all that hard-work. It's kind of expensive in term of
|
||||
* processing, so you'd better consider it twice.
|
||||
*
|
||||
* One good way of doing it is to add a "Refresh Purchases" button in your
|
||||
* applications settings. This way, if delivery of a purchase failed or
|
||||
* if a user wants to restore purchases he made from another device, he'll
|
||||
* have a way to do just that.
|
||||
*
|
||||
* **example usage**
|
||||
*
|
||||
* ```typescript
|
||||
* // ...
|
||||
* // register products and events handlers here
|
||||
* // ...
|
||||
* //
|
||||
* // then and only then, call refresh.
|
||||
* this.store.refresh();
|
||||
* ```
|
||||
*
|
||||
* **restore purchases**
|
||||
*
|
||||
* Add a "Refresh Purchases" button to call the `store.refresh()` method, like:
|
||||
*
|
||||
* `<button onclick="<pseudo_code>this.store.refresh()</pseudo_code>">Restore Purchases</button>`
|
||||
*
|
||||
* To make the restore purchases work as expected, please make sure that
|
||||
* the "approved" event listener had be registered properly,
|
||||
* and in the callback `product.finish()` should be called.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
refresh(): void {
|
||||
}
|
||||
|
||||
/** Opens the Manage Subscription page (AppStore, Play, Microsoft, ...). */
|
||||
@Cordova({ sync: true })
|
||||
manageSubscriptions(): void {}
|
||||
|
||||
}
|
||||
|
||||
@@ -61,6 +61,15 @@ export class Intercom extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
logout(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param secureHash {string}
|
||||
@@ -141,6 +150,15 @@ export class Intercom extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
displayHelpCenter(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
@@ -188,4 +206,15 @@ export class Intercom extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param token {string}
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
sendPushTokenToIntercom(token: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
@@ -1,7 +1,20 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
import { Cordova, IonicNativePlugin, CordovaProperty, Plugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
export enum KeyboardStyle {
|
||||
Light = 'light',
|
||||
Dark = 'dark'
|
||||
}
|
||||
|
||||
export enum KeyboardResizeMode {
|
||||
Native = 'native',
|
||||
Ionic = 'ionic',
|
||||
Body = 'body',
|
||||
None = 'none'
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @name Keyboard
|
||||
* @description
|
||||
@@ -43,7 +56,10 @@ export class Keyboard extends IonicNativePlugin {
|
||||
* Hide the keyboard accessory bar with the next, previous and done buttons.
|
||||
* @param hide {boolean}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@Cordova({
|
||||
sync: true,
|
||||
platforms: ['iOS']
|
||||
})
|
||||
hideFormAccessoryBar(hide: boolean): void {}
|
||||
|
||||
/**
|
||||
@@ -72,7 +88,27 @@ export class Keyboard extends IonicNativePlugin {
|
||||
sync: true,
|
||||
platforms: ['iOS']
|
||||
})
|
||||
setResizeMode(mode: string): void {}
|
||||
setResizeMode(mode: KeyboardResizeMode): void {}
|
||||
|
||||
/**
|
||||
* Programatically set Keyboard style
|
||||
* @param mode {string}
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true,
|
||||
platforms: ['iOS']
|
||||
})
|
||||
setKeyboardStyle(style: KeyboardStyle): void {}
|
||||
|
||||
/**
|
||||
* Programatically enable or disable the WebView scroll
|
||||
* @param mode {string}
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true,
|
||||
platforms: ['iOS']
|
||||
})
|
||||
disableScroll(disable: boolean): void {}
|
||||
|
||||
/**
|
||||
* Creates an observable that notifies you when the keyboard is shown. Unsubscribe to observable to cancel event watch.
|
||||
@@ -100,6 +136,19 @@ export class Keyboard extends IonicNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an observable that notifies you when the keyboard did show. Unsubscribe to observable to cancel event watch.
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
eventObservable: true,
|
||||
event: 'keyboardDidShow',
|
||||
platforms: ['iOS', 'Android']
|
||||
})
|
||||
onKeyboardDidShow(): Observable<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an observable that notifies you when the keyboard is hidden. Unsubscribe to observable to cancel event watch.
|
||||
* @returns {Observable<any>}
|
||||
@@ -125,4 +174,17 @@ export class Keyboard extends IonicNativePlugin {
|
||||
onKeyboardWillHide(): Observable<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an observable that notifies you when the keyboard did hide. Unsubscribe to observable to cancel event watch.
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
eventObservable: true,
|
||||
event: 'keyboardDidHide',
|
||||
platforms: ['iOS', 'Android']
|
||||
})
|
||||
onKeyboardDidHide(): Observable<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
167
src/@ionic-native/plugins/kommunicate/index.ts
Normal file
167
src/@ionic-native/plugins/kommunicate/index.ts
Normal file
@@ -0,0 +1,167 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
/**
|
||||
* @name Kommunicate
|
||||
* @description
|
||||
* The plugin for the Kommunicate SDK.
|
||||
* With the help of this plugin, you can easily add human + bot chat support functionality to you app.
|
||||
* Refer to: TODO: insert site link
|
||||
* For documentation: TODO: insert link
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { Kommunicate } from '@ionic-native/Kommunicate';
|
||||
*
|
||||
* constructor(private kommunicate: Kommunicate) { }
|
||||
* //also add [..., Kommunicate, ... ] inside the providers array, if required
|
||||
*
|
||||
* var kmUser = {
|
||||
* userId : 'randomstring',
|
||||
* authenticationTypeId : 1
|
||||
* };
|
||||
*
|
||||
* this.kommunicate.login(kmUser)
|
||||
* .then((res: any) => console.log("Sucessfully logged in." + res))
|
||||
* .catch((error: any) => console.error("Error logging in." + error));
|
||||
*
|
||||
* var conversationObject = {
|
||||
* isUnique : false
|
||||
* };
|
||||
*
|
||||
* this.kommunicate.conversationBuilder(converationObject)
|
||||
* .then((clientChannelKey: any) => console.log("Kommunicate create conversation successful the clientChannelKey is : " + clientChannelKey))
|
||||
* .catch((error: any) => console.error("Error creating conversation." + error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'Kommunicate',
|
||||
plugin: 'kommunicate-cordova-plugin',
|
||||
pluginRef: 'kommunicate',
|
||||
repo: 'https://github.com/Kommunicate-io/Kommunicate-Cordova-Ionic-PhoneGap-Chat-Plugin',
|
||||
platforms: ['Android', 'Browser', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class Kommunicate extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Login the user with the details passed in
|
||||
* Creates a new user with the details provided there is no existing user
|
||||
*
|
||||
* var kmUser = {
|
||||
* 'userId' : 'userId', //Replace it with the userId of the logged in user
|
||||
* 'password' : 'password', //replace with password
|
||||
* 'authenticationTypeId' : 1,
|
||||
* 'imageLink' : <image-link-for-user>
|
||||
* 'applicationId' : '<APP_ID>', //replace this with your APP_ID from Applozic Dashboard
|
||||
* 'deviceApnsType' : 0 //Set 0 for Development and 1 for Distribution (Release)
|
||||
* };
|
||||
*
|
||||
* @param kmUser {any} the user details
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
login(kmUser: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Register for push notification
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
registerPushNotification(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Check if any user is logged in or not
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
isLoggedIn(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Update the token for push notifications
|
||||
*
|
||||
* @param token {string} the user details
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
updatePushNotificationToken(token: string): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Launch the conversation screen (it contains all the existing conversations)
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
launchConversation(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Launch the conversation identified by the given channel(conversation) key
|
||||
*
|
||||
* let convObj = {
|
||||
* 'clientChannelKey' : clientChannelKey, //pass the clientChannelKey here
|
||||
* 'takeOrder' : true //skip chat list on back press, pass false if you want to show chat list on back press
|
||||
* };
|
||||
*
|
||||
* @param conversationObject {any} the channel key and other information
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
launchParticularConversation(conversationObject: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Start a new conversation, details about the conversation to be passed as parameters
|
||||
*
|
||||
* @deprecated
|
||||
* @param converationParams {any} the user details
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
startNewConversation(conversationParams: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Process push notifications
|
||||
*
|
||||
* @param data {any} the user details
|
||||
* @return {boolean} Returns true/false
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
processPushNotification(data: any): boolean { return; }
|
||||
|
||||
/**
|
||||
* Logout the current user
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
logout(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Start a single chat (conversation)
|
||||
*
|
||||
* @deprecated
|
||||
* @param data {any} the user details
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
startSingleChat(data: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Launches a conversation with the properties passed in the conversation param
|
||||
*
|
||||
* var conversationObject = {
|
||||
* 'isUnique' : false,
|
||||
* 'agentIds':['<AGENT_ID>'], //List of agentIds. AGENT_ID is the emailID used to signup on Kommunicate
|
||||
* 'botIds': ['<BOT_ID>'] //List of botIds. Go to Manage Bots(https://dashboard.kommunicate.io/bots/manage-bots) -> Copy botID
|
||||
* };
|
||||
*
|
||||
* @param conversationObject {any} the user details
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
conversationBuilder(converationObject: any): Promise<any> { return; }
|
||||
|
||||
}
|
||||
@@ -18,7 +18,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
* ...
|
||||
*
|
||||
* this.launchReview.launch()
|
||||
* .then(() => console.log('Successfully launched store app');
|
||||
* .then(() => console.log('Successfully launched store app'));
|
||||
*
|
||||
* if(this.launchReview.isRatingSupported()){
|
||||
* this.launchReview.rating()
|
||||
|
||||
@@ -23,6 +23,11 @@ export interface LineLoginProfile {
|
||||
* Line Profile Name
|
||||
*/
|
||||
displayName: string;
|
||||
|
||||
/**
|
||||
* Email
|
||||
*/
|
||||
email?: string;
|
||||
}
|
||||
|
||||
export interface LineLoginAccessToken {
|
||||
@@ -91,10 +96,7 @@ export class LineLogin extends IonicNativePlugin {
|
||||
* Login
|
||||
* @return {Promise<LineLoginProfile>}
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
})
|
||||
@Cordova()
|
||||
login(): Promise<LineLoginProfile> {
|
||||
return;
|
||||
}
|
||||
@@ -104,10 +106,7 @@ export class LineLogin extends IonicNativePlugin {
|
||||
* (iOS only)
|
||||
* @return {Promise<LineLoginProfile>}
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
})
|
||||
@Cordova()
|
||||
loginWeb(): Promise<LineLoginProfile> {
|
||||
return;
|
||||
}
|
||||
|
||||
115
src/@ionic-native/plugins/mlkit-translate/index.ts
Normal file
115
src/@ionic-native/plugins/mlkit-translate/index.ts
Normal file
@@ -0,0 +1,115 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* This is the language object which will be returned by `downloadModel`, `deleteModel`, `getAvailableModels` and `getDownloadedModels` methods.
|
||||
*/
|
||||
export interface LanguageModel {
|
||||
/**
|
||||
* BCP-47 language code of the language. For example: en
|
||||
* For full list of languages codes, see https://firebase.google.com/docs/ml-kit/translation-language-support
|
||||
*/
|
||||
code: string;
|
||||
|
||||
/**
|
||||
* Display name of the language. For example: English
|
||||
*/
|
||||
displayName: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name MLKitTranslate
|
||||
* @description
|
||||
* Plugin that implements MLKit Translation and Language Identification features.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { MLKitTranslate } from '@ionic-native/ml-kit-translate';
|
||||
*
|
||||
*
|
||||
* constructor(private mlkitTranslate: MLKitTranslate) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.mlkitTranslate.translate('Hello', 'en', 'es')
|
||||
* .then((resultText: string) => console.log(res))
|
||||
* .catch((error: string) => console.error(error));
|
||||
*
|
||||
* @interfaces
|
||||
* LanguageModel
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'MLKitTranslate',
|
||||
plugin: 'cordova-plugin-mlkit-translate',
|
||||
pluginRef: 'MLKitTranslate',
|
||||
repo: 'https://github.com/rigelglen/cordova-plugin-mlkit-translate',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class MLKitTranslate extends IonicNativePlugin {
|
||||
/**
|
||||
* Translates text from one language to another. Requires the source and target languages need to be downloaded.
|
||||
* If not the languages are downloaded in the background automatically.
|
||||
* @param text {string} text to be translated
|
||||
* @param targetLanguage {string} BCP-47 language code of the language to translate to
|
||||
* @param sourceLanguage {string=} (optional) BCP-47 language code of the language to translate to. If not provided, source language is inferred from text
|
||||
* @return {Promise<string>} Returns a promise that resolves with the translated text
|
||||
*/
|
||||
@Cordova()
|
||||
translate(
|
||||
text: string,
|
||||
targetLanguage: string,
|
||||
sourceLanguage?: string
|
||||
): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines the language of a string of text.
|
||||
* @param text {string} text to be translated
|
||||
* @return {Promise<LanguageModel>} Returns a promise that resolves with the identified language
|
||||
*/
|
||||
@Cordova()
|
||||
identifyLanguage(text: string): Promise<LanguageModel> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* List of language models that have been downloaded to the device.
|
||||
* @return {Promise<LanguageModel[]>} Returns a promise that resolves with an array of languages that have been downloaded.
|
||||
*/
|
||||
@Cordova()
|
||||
getDownloadedModels(): Promise<LanguageModel[]> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* List of language models that can be downloaded.
|
||||
* @return {Promise<LanguageModel[]>} Returns a promise that resolves with an array of possible languages that can be downloaded.
|
||||
*/
|
||||
@Cordova()
|
||||
getAvailableModels(): Promise<LanguageModel[]> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads a specified language model.
|
||||
* @param code {string} BCP-47 language code of the language to download
|
||||
* @return {Promise<LanguageModel>} Returns a promise that resolves with the downloaded language.
|
||||
*/
|
||||
@Cordova()
|
||||
downloadModel(code: string): Promise<LanguageModel> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a specified language model.
|
||||
* @param code {string} BCP-47 language code of the language to delete
|
||||
* @return {Promise<LanguageModel>} Returns a promise that resolves with the deleted language.
|
||||
*/
|
||||
@Cordova()
|
||||
deleteModel(code: string): Promise<LanguageModel> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -9,7 +9,7 @@ import { Injectable } from '@angular/core';
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { MobileAccessibility } from '@ionic-native/mobile-ccessibility/ngx';
|
||||
* import { MobileAccessibility } from '@ionic-native/mobile-accessibility/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private mobileAccessibility: MobileAccessibility) { }
|
||||
|
||||
@@ -3,7 +3,7 @@ import { CordovaInstance, InstanceProperty, IonicNativePlugin, Plugin, checkAvai
|
||||
|
||||
export interface AuthenticationResult {
|
||||
accessToken: string;
|
||||
accesSTokenType: string;
|
||||
accessTokenType: string;
|
||||
expiresOn: Date;
|
||||
idToken: string;
|
||||
isMultipleResourceRefreshToken: boolean;
|
||||
@@ -138,12 +138,13 @@ export class AuthenticationContext {
|
||||
* @param {String} extraQueryParameters
|
||||
* Extra query parameters (optional)
|
||||
* Parameters should be escaped before passing to this method (e.g. using 'encodeURI()')
|
||||
* @param {String} claims Claim parameter. Parameter should be used under conditional access scenarios (optional)
|
||||
* @returns {Promise} Promise either fulfilled with AuthenticationResult object or rejected with error
|
||||
*/
|
||||
@CordovaInstance({
|
||||
otherPromise: true
|
||||
})
|
||||
acquireTokenAsync(resourceUrl: string, clientId: string, redirectUrl: string, userId?: string, extraQueryParameters?: any): Promise<AuthenticationResult> {
|
||||
acquireTokenAsync(resourceUrl: string, clientId: string, redirectUrl: string, userId?: string, extraQueryParameters?: any, claims?: string): Promise<AuthenticationResult> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -165,3 +166,20 @@ export class AuthenticationContext {
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
export class AuthenticationSettings {
|
||||
/**
|
||||
* Sets flag to use or skip authentication broker.
|
||||
* By default, the flag value is false and ADAL will not talk to broker.
|
||||
*
|
||||
* @param useBroker Flag to use or skip authentication broker
|
||||
*
|
||||
* @returns {Promise} Promise either fulfilled or rejected with error
|
||||
*/
|
||||
@CordovaInstance({
|
||||
otherPromise: true
|
||||
})
|
||||
static setUseBroker(useBroker: boolean): Promise<void> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -134,6 +134,7 @@ export interface MusicControlsOptions {
|
||||
* break;
|
||||
* }
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* this.musicControls.listen(); // activates the observable above
|
||||
*
|
||||
@@ -203,7 +204,7 @@ export class MusicControls extends IonicNativePlugin {
|
||||
@Cordova({
|
||||
platforms: ['iOS']
|
||||
})
|
||||
updateElapsed(args: { elapsed: string; isPlaying: boolean }): void {}
|
||||
updateElapsed(args: { elapsed: number; isPlaying: boolean }): void {}
|
||||
|
||||
/**
|
||||
* Toggle dismissable:
|
||||
|
||||
@@ -8,7 +8,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { NativeGeocoder, NativeGeocoderReverseResult, NativeGeocoderForwardResult, NativeGeocoderOptions } from '@ionic-native/native-geocoder/ngx';
|
||||
* import { NativeGeocoder, NativeGeocoderResult, NativeGeocoderOptions } from '@ionic-native/native-geocoder/ngx';
|
||||
*
|
||||
* constructor(private nativeGeocoder: NativeGeocoder) { }
|
||||
*
|
||||
@@ -20,16 +20,15 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
* };
|
||||
*
|
||||
* this.nativeGeocoder.reverseGeocode(52.5072095, 13.1452818, options)
|
||||
* .then((result: NativeGeocoderReverseResult[]) => console.log(JSON.stringify(result[0])))
|
||||
* .then((result: NativeGeocoderResult[]) => console.log(JSON.stringify(result[0])))
|
||||
* .catch((error: any) => console.log(error));
|
||||
*
|
||||
* this.nativeGeocoder.forwardGeocode('Berlin', options)
|
||||
* .then((coordinates: NativeGeocoderForwardResult[]) => console.log('The coordinates are latitude=' + coordinates[0].latitude + ' and longitude=' + coordinates[0].longitude))
|
||||
* .then((result: NativeGeocoderResult[]) => console.log('The coordinates are latitude=' + result[0].latitude + ' and longitude=' + result[0].longitude))
|
||||
* .catch((error: any) => console.log(error));
|
||||
* ```
|
||||
* @interfaces
|
||||
* NativeGeocoderReverseResult
|
||||
* NativeGeocoderForwardResult
|
||||
* NativeGeocoderResult
|
||||
* NativeGeocoderOptions
|
||||
*/
|
||||
@Plugin({
|
||||
@@ -47,32 +46,40 @@ export class NativeGeocoder extends IonicNativePlugin {
|
||||
* @param latitude {number} The latitude
|
||||
* @param longitude {number} The longitude
|
||||
* @param options {NativeGeocoderOptions} The options
|
||||
* @return {Promise<NativeGeocoderReverseResult[]>}
|
||||
* @return {Promise<NativeGeocoderResult[]>}
|
||||
*/
|
||||
@Cordova({
|
||||
callbackOrder: 'reverse'
|
||||
})
|
||||
reverseGeocode(latitude: number, longitude: number, options?: NativeGeocoderOptions): Promise<NativeGeocoderReverseResult[]> { return; }
|
||||
reverseGeocode(latitude: number, longitude: number, options?: NativeGeocoderOptions): Promise<NativeGeocoderResult[]> { return; }
|
||||
|
||||
/**
|
||||
* Forward geocode a given address to find coordinates
|
||||
* @param addressString {string} The address to be geocoded
|
||||
* @param options {NativeGeocoderOptions} The options
|
||||
* @return {Promise<NativeGeocoderForwardResult[]>}
|
||||
* @return {Promise<NativeGeocoderResult[]>}
|
||||
*/
|
||||
@Cordova({
|
||||
callbackOrder: 'reverse'
|
||||
})
|
||||
forwardGeocode(addressString: string, options?: NativeGeocoderOptions): Promise<NativeGeocoderForwardResult[]> { return; }
|
||||
forwardGeocode(addressString: string, options?: NativeGeocoderOptions): Promise<NativeGeocoderResult[]> { return; }
|
||||
}
|
||||
|
||||
/**
|
||||
* Encapsulates format information about a reverse geocoding result.
|
||||
* Encapsulates format information about a geocoding result.
|
||||
* more Info:
|
||||
* - https://developer.apple.com/documentation/corelocation/clplacemark
|
||||
* - https://developer.android.com/reference/android/location/Address.html
|
||||
*/
|
||||
export interface NativeGeocoderReverseResult {
|
||||
export interface NativeGeocoderResult {
|
||||
/**
|
||||
* The latitude.
|
||||
*/
|
||||
latitude: string;
|
||||
/**
|
||||
* The longitude.
|
||||
*/
|
||||
longitude: string;
|
||||
/**
|
||||
* The country code.
|
||||
*/
|
||||
@@ -109,20 +116,10 @@ export interface NativeGeocoderReverseResult {
|
||||
* The subThoroughfare.
|
||||
*/
|
||||
subThoroughfare: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encapsulates format information about a forward geocoding result.
|
||||
*/
|
||||
export interface NativeGeocoderForwardResult {
|
||||
/**
|
||||
* The latitude.
|
||||
* The areasOfInterest
|
||||
*/
|
||||
latitude: string;
|
||||
/**
|
||||
* The longitude.
|
||||
*/
|
||||
longitude: string;
|
||||
areasOfInterest: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -104,7 +104,7 @@ export class Network extends IonicNativePlugin {
|
||||
* @return {Observable<any>}
|
||||
*/
|
||||
@CordovaCheck()
|
||||
onchange(): Observable<any> {
|
||||
onChange(): Observable<any> {
|
||||
return merge(this.onConnect(), this.onDisconnect());
|
||||
}
|
||||
|
||||
|
||||
@@ -196,7 +196,7 @@ export class NFC extends IonicNativePlugin {
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
makeReadyOnly(): Promise<any> {
|
||||
makeReadOnly(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
167
src/@ionic-native/plugins/ocr/index.ts
Normal file
167
src/@ionic-native/plugins/ocr/index.ts
Normal file
@@ -0,0 +1,167 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export enum OCRSourceType {
|
||||
/**
|
||||
* Normal processing from a file URL. This is the overall recommended choice
|
||||
* for most applications. The distinction between file and native URLs is
|
||||
* only relevant on iOS; under Android `NORMFILEURL` and `NORMNATIVEURL`
|
||||
* are interchangeable.
|
||||
*/
|
||||
NORMFILEURL = 0,
|
||||
|
||||
/**
|
||||
* Normal processing from a native URL. Since this source type uses deprecated
|
||||
* OS APIs to interact with the camera plugin, it is best avoided, especially
|
||||
* if ongoing forward compatibility is a concern. For further information, see
|
||||
* https://github.com/NeutrinosPlatform/cordova-plugin-mobile-ocr#plugin-usage
|
||||
* Under Android, this is equivalent to `NORMFILEURL`.
|
||||
*/
|
||||
NORMNATIVEURL = 1,
|
||||
|
||||
/**
|
||||
* Fast processing from a file URL. As the compression done internally causes
|
||||
* a significant loss in extraction quality, it should only be preferred when
|
||||
* dealing with large images containing significant amounts of text, where
|
||||
* the execution time required to perform normal processing is prohibitive.
|
||||
* The distinction between file and native URLs is only relevant on iOS;
|
||||
* under Android `FASTFILEURL` and `FASTNATIVEURL` are interchangeable.
|
||||
*/
|
||||
FASTFILEURL = 2,
|
||||
|
||||
/**
|
||||
* Fast processing from a native URL. See comments above for `FASTFILEURL`
|
||||
* concerning quality loss.
|
||||
*
|
||||
* The distinction between file and native URLs is only relevant on iOS;
|
||||
* under Android `FASTFILEURL` and `FASTNATIVEURL` are interchangeable.
|
||||
*/
|
||||
FASTNATIVEURL = 3,
|
||||
|
||||
/**
|
||||
* Normal processing from a base64-encoded string. Quality is equivalent
|
||||
* to `NORMFILEURL`, but due to significantly higher memory requirements,
|
||||
* is only appropriate for use with very small images.
|
||||
*/
|
||||
BASE64 = 4,
|
||||
}
|
||||
|
||||
/**
|
||||
* Four points (ordered in clockwise direction) that enclose a text
|
||||
* component. May not be axis-aligned due to perspective skew.
|
||||
*/
|
||||
export interface OCRCorners {
|
||||
x1: number;
|
||||
y1: number;
|
||||
x2: number;
|
||||
y2: number;
|
||||
x3: number;
|
||||
y3: number;
|
||||
x4: number;
|
||||
y4: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* An axis-aligned bounding rectangle. `x` and `y` represent the top left.
|
||||
*/
|
||||
export interface OCRRect {
|
||||
x: number;
|
||||
y: number;
|
||||
height: number;
|
||||
width: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* This is the return value from the `recText` method.
|
||||
*/
|
||||
export interface OCRResult {
|
||||
/**
|
||||
* Was any text extracted? If `foundText` is false, no other fields are
|
||||
* returned. If foundText is true, all other fields are reliable.
|
||||
*/
|
||||
foundText: boolean;
|
||||
|
||||
/**
|
||||
* A block is the largest unit of text, which can be thought of as a paragraph.
|
||||
* This field consists of several parallel arrays, so the text in `blocktext[0]`
|
||||
* is bounded by `blockpoints[0]` and `blockframe[0]`.
|
||||
*/
|
||||
blocks: {
|
||||
blocktext: string[];
|
||||
blockpoints: OCRCorners[];
|
||||
blockframe: OCRRect[];
|
||||
};
|
||||
|
||||
/**
|
||||
* A line is the central unit of text, containing several elements. A block
|
||||
* can contain N lines. This field consists of several parallel arrays, so the
|
||||
* text in `linetext[0]` is bounded by `linepoints[0]` and `lineframe[0]`.
|
||||
*/
|
||||
lines: {
|
||||
linetext: string[];
|
||||
linepoints: OCRCorners[];
|
||||
lineframe: OCRRect[];
|
||||
};
|
||||
|
||||
/**
|
||||
* A word (or element) is the smallest unit of text. This field consists of
|
||||
* several parallel arrays, so the text in `wordtext[0]` is bounded by
|
||||
* `wordpoints[0]` and `wordframe[0]`.
|
||||
*/
|
||||
words: {
|
||||
wordtext: string[];
|
||||
wordpoints: OCRCorners[];
|
||||
wordframe: OCRRect[];
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @name OCR
|
||||
* @description
|
||||
* This plugin attempts to identify and extract text from an image.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { OCR, OCRSourceType } from '@ionic-native/ocr/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private ocr: OCR) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.ocr.recText(OCRSourceType.NORMFILEURL, "file://path/to/image.png")
|
||||
* .then((res: OCRResult) => console.log(JSON.stringify(res)))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* @interfaces
|
||||
* OCRCorners
|
||||
* OCRRect
|
||||
* OCRResult
|
||||
*
|
||||
* @enums
|
||||
* OCRSourceType
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'OCR',
|
||||
plugin: 'cordova-plugin-mobile-ocr',
|
||||
pluginRef: 'textocr',
|
||||
repo: 'https://github.com/NeutrinosPlatform/cordova-plugin-mobile-ocr',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class OCR extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Extract text from image
|
||||
* @param sourceType {OCRSourceType} type of image source
|
||||
* @param source {string} image source (either file URL or base64 string)
|
||||
* @return {Promise<OCRResult>} extracted text and geometry
|
||||
*/
|
||||
@Cordova()
|
||||
recText(sourceType: OCRSourceType, source: string): Promise<OCRResult> {
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -770,4 +770,19 @@ export class OneSignal extends IonicNativePlugin {
|
||||
*/
|
||||
@Cordova()
|
||||
userProvidedPrivacyConsent(callback: Function): void {}
|
||||
|
||||
/**
|
||||
* Allows you to use your own system's user ID's to send push notifications to your users.
|
||||
* To tie a user to a given user ID, you can use this method.
|
||||
* @param {string} externalId
|
||||
*/
|
||||
@Cordova()
|
||||
setExternalUserId(externalId: string): void {}
|
||||
|
||||
/**
|
||||
* Removes whatever was set as the current user's external user ID.
|
||||
*/
|
||||
@Cordova()
|
||||
removeExternalUserId(): void {}
|
||||
|
||||
}
|
||||
|
||||
87
src/@ionic-native/plugins/pdf-generator/index.ts
Normal file
87
src/@ionic-native/plugins/pdf-generator/index.ts
Normal file
@@ -0,0 +1,87 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export interface PDFGeneratorOptions {
|
||||
/**
|
||||
* The document size, e.g., A2, A3, or A4.
|
||||
* Only supported on iOS.
|
||||
* The default is 'A4'.
|
||||
*/
|
||||
documentSize?: string;
|
||||
|
||||
/**
|
||||
* Option to change to landscape orientation.
|
||||
* Default is 'portrait'.
|
||||
*/
|
||||
landscape?: 'landscape' | 'portrait';
|
||||
|
||||
/**
|
||||
* The type to be returned, either 'share' or 'base64'.
|
||||
* If 'share is chosen, the PDF is shared with the system capabilities.
|
||||
* Default is 'base64'
|
||||
*/
|
||||
type?: string;
|
||||
|
||||
/**
|
||||
* The desired filename the resulting PDF should have.
|
||||
* Default is 'default.pdf'
|
||||
*/
|
||||
fileName?: string;
|
||||
|
||||
/**
|
||||
* Option to set the base URL for pathing.
|
||||
* Default is 'null'.
|
||||
*/
|
||||
baseUrl?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name PDFGenerator
|
||||
* @description
|
||||
* Simple plugin to generate (offline) pdf. The plugin transforms HTML to PDF and also provide the mechanism to share the pdf to other apps like Mail, etc.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { PDFGenerator } from '@ionic-native/pdf-generator';
|
||||
*
|
||||
* constructor(private pdfGenerator: PDFGenerator) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.pdfGenerator.fromURL(url, options).then(base64String => console.log(base64String));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'PDFGenerator',
|
||||
plugin: 'cordova-pdf-generator',
|
||||
pluginRef: 'cordova.plugins.pdf',
|
||||
repo: 'https://github.com/cesarvr/pdf-generator',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable({
|
||||
providedIn: 'root'
|
||||
})
|
||||
export class PDFGenerator extends IonicNativePlugin {
|
||||
/**
|
||||
* Creates a PDF using a URL, it download the document into an in memory Webkit object, and renders it into a PDF.
|
||||
* @param url {string} URL to create a PDF from
|
||||
* @param options {PDFGeneratorOptions} options for PDF generation
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ otherPromise: true })
|
||||
fromURL(url: string, options?: PDFGeneratorOptions): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a PDF using string with the HTML representation, it download the document into an in memory Webkit object, and renders it into a PDF.
|
||||
* @param data {string} HTML string representation to create a PDF from
|
||||
* @param options {PDFGeneratorOptions} options for PDF generation
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ otherPromise: true })
|
||||
fromData(data: string, options?: PDFGeneratorOptions): Promise<string> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -125,7 +125,7 @@ export class PhotoLibrary extends IonicNativePlugin {
|
||||
@Cordova({
|
||||
observable: true
|
||||
})
|
||||
getLibrary(options?: GetLibraryOptions): Observable<LibraryItem[]> {
|
||||
getLibrary(success?: (res?: any) => void, error?: (err?: any) => void, options?: GetLibraryOptions): Observable<LibraryItem[]> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
46
src/@ionic-native/plugins/preview-any-file/index.ts
Normal file
46
src/@ionic-native/plugins/preview-any-file/index.ts
Normal file
@@ -0,0 +1,46 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
/**
|
||||
* @name PreviewAnyFile
|
||||
* @description
|
||||
* Whatever the file is PDF document, Word document, Excel, office document,zip archive file, image, text, html or anything else, you can perform a preview by this cordova Plugin to preview any file in native mode by providing the local or external URL.
|
||||
*
|
||||
* Requires Cordova plugin: `cordova-plugin-preview-any-file`. For more info, please see the [previewAnyFile plugin docs](https://github.com/mostafa-mansour1/previewAnyFile).
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { PreviewAnyFile } from '@ionic-native/preview-any-file/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private previewAnyFile: PreviewAnyFile) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.previewAnyFile.preview('file://filepath.ext')
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'PreviewAnyFile',
|
||||
plugin: 'cordova-plugin-preview-any-file', // npm package name, example: cordova-plugin-camera
|
||||
pluginRef: 'PreviewAnyFile', // the variable reference to call the plugin, example: navigator.geolocation
|
||||
repo: 'https://github.com/mostafa-mansour1/previewAnyFile', // the github repository URL for the plugin
|
||||
install: '', // OPTIONAL install command, in case the plugin requires variables
|
||||
installVariables: [], // OPTIONAL the plugin requires variables
|
||||
platforms: ['Android', 'iOS'] // Array of platforms supported, example: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class PreviewAnyFile extends IonicNativePlugin {
|
||||
/**
|
||||
* this function return SUCCESS in success callback if the file successfully opened, if the content is base64 you have to write it into file by cordova-plugin-file
|
||||
* @param url {string} full absolute URL for the file, if the path is content:// you need to resolve the native url, if the path is https:// it may not work in android
|
||||
* @return {Promise<any>} Returns a promise that resolves if the file opened reject if not;
|
||||
*/
|
||||
@Cordova()
|
||||
preview(url: string): Promise<string> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,25 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, CordovaCheck, IonicNativePlugin, Plugin, getPromise } from '@ionic-native/core';
|
||||
|
||||
interface FontOptions {
|
||||
name: string; // The name of the font family. Only supported on iOS
|
||||
size: number; // The size of the font. Only supported on iOS, Android
|
||||
italic: boolean; // Set to true to enable these font traits. Only supported on iOS
|
||||
bold: boolean; // Set to true to enable these font traits. Only supported on iOS
|
||||
align: 'left' | 'right' | 'center' | 'justified'; // Possible alignments are left, right, center and justified. Only supported on iOS
|
||||
color: string; // The color of the font in hexa-decimal RGB format - "FF0000" means red. Only supported on iOS
|
||||
}
|
||||
|
||||
interface HeaderFooterLabelOptions {
|
||||
text: string; // The plain text to display. Use %ld to indicate where to insert the page index. For example "Page %ld" would result into "Page 1", "Page 2", .... Only supported on iOS
|
||||
top: string; // The relative position where to place the label within the footer or header area. Only supported on iOS
|
||||
right: string; // The relative position where to place the label within the footer or header area. Only supported on iOS
|
||||
left: string; // The relative position where to place the label within the footer or header area. Only supported on iOS
|
||||
bottom: string; // The relative position where to place the label within the footer or header area. Only supported on iOS
|
||||
font: FontOptions; // The font attributes for the label. Only supported on iOS
|
||||
showPageIndex: boolean; // Set to true if you want to display the page index. Only supported on iOS
|
||||
}
|
||||
|
||||
export interface PrintOptions {
|
||||
/**
|
||||
* The name of the print job and the document
|
||||
@@ -8,16 +27,22 @@ export interface PrintOptions {
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* The network URL of the printer.
|
||||
* Only supported on iOS.
|
||||
* The number of copies for the print task.
|
||||
* Only supported on iOS, Windows
|
||||
*/
|
||||
printerId?: string;
|
||||
copies?: number;
|
||||
|
||||
/**
|
||||
* Limits the pages to print even the document contains more.
|
||||
* To skip the last n pages you can assign a negative value on iOS.
|
||||
* Only supported on iOS, Android
|
||||
*/
|
||||
pageCount?: number;
|
||||
|
||||
/**
|
||||
* Specifies the duplex mode to use for the print job.
|
||||
* Either double-sided (duplex:true) or single-sided (duplex:false).
|
||||
* Double-sided by default.
|
||||
* Only supported on iOS
|
||||
* Either double-sided on short site (duplex:'short'),
|
||||
* double-sided on long site (duplex:'long') or single-sided (duplex:'none').
|
||||
*/
|
||||
duplex?: boolean;
|
||||
|
||||
@@ -25,18 +50,85 @@ export interface PrintOptions {
|
||||
* The orientation of the printed content, portrait or landscape
|
||||
* Portrait by default.
|
||||
*/
|
||||
landscape?: boolean;
|
||||
orientation?: 'landscape' | 'portrait';
|
||||
|
||||
/**
|
||||
* If your application only prints black text, setting this property to true can result in better performance in many cases.
|
||||
* False by default.
|
||||
*/
|
||||
grayscale?: boolean;
|
||||
monochrome?: boolean;
|
||||
|
||||
/**
|
||||
* The Size and position of the print view
|
||||
* If your application only prints black text, setting this property to true can result in better performance in many cases.
|
||||
* False by default.
|
||||
* Only supported on iOS, Windows
|
||||
*/
|
||||
bounds?: number[] | any;
|
||||
photo?: boolean;
|
||||
|
||||
/**
|
||||
* Set to false to disable downscaling the image to fit into the content aread.
|
||||
* Only supported on Android
|
||||
*/
|
||||
autoFit?: boolean;
|
||||
|
||||
/**
|
||||
* The network URL to the printer.
|
||||
* Only supported on iOS
|
||||
*/
|
||||
printer?: string;
|
||||
|
||||
/**
|
||||
* Defines the maximum size of the content area.
|
||||
* Only supported on iOS
|
||||
*/
|
||||
maxHeight?: string;
|
||||
|
||||
/**
|
||||
* Defines the maximum size of the content area.
|
||||
* Only supported on iOS
|
||||
*/
|
||||
maxWidth?: string;
|
||||
|
||||
/**
|
||||
* Set to false to avoid margins.
|
||||
* The margins for each printed page. Each printer might have its own minimum margins depends on media type and paper format.
|
||||
*/
|
||||
margin?: boolean | {
|
||||
top?: string;
|
||||
left?: string;
|
||||
right?: string;
|
||||
bottom?: string;
|
||||
};
|
||||
|
||||
ui?: {
|
||||
hideNumberOfCopies?: string; // Set to true to hide the control for the number of copies. Only supported on iOS
|
||||
hidePaperFormat?: string; // Set to true to hide the control for the paper format. Only supported on iOS
|
||||
top?: number; // The position of the printer picker. Only supported on iPad
|
||||
left?: number; // The position of the printer picker. Only supported on iPad
|
||||
height?: number; // The size of the printer picker. Only supported on iPad
|
||||
width?: number; // The size of the printer picker. Only supported on iPad
|
||||
};
|
||||
|
||||
paper?: {
|
||||
width: string; // The dimensions of the paper – iOS will will try to choose a format which fits bests. Only supported on iOS
|
||||
height: string; // The dimensions of the paper – iOS will will try to choose a format which fits bests. Only supported on iOS
|
||||
name: string; // The name of the format like IsoA4 or Roll22Inch. https://docs.microsoft.com/en-us/uwp/api/windows.graphics.printing.printmediasize. Only supported on Windows
|
||||
length: string; // On roll-fed printers you can decide when the printer cuts the paper. https://docs.microsoft.com/en-us/uwp/api/windows.graphics.printing.printmediasize. Only supported on iOs
|
||||
};
|
||||
|
||||
font?: FontOptions;
|
||||
|
||||
header?: {
|
||||
height: string; // The height of the header or footer on each page. Only supported on iOS
|
||||
labels: string[]; // An array of labels to display. Only use if there are more then one. Only supported on iOS
|
||||
label: HeaderFooterLabelOptions;
|
||||
};
|
||||
|
||||
footer?: {
|
||||
height: string; // The height of the header or footer on each page. Only supported on iOS
|
||||
labels: string[]; // An array of labels to display. Only use if there are more then one. Only supported on iOS
|
||||
label: HeaderFooterLabelOptions;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -54,11 +146,10 @@ export interface PrintOptions {
|
||||
*
|
||||
* let options: PrintOptions = {
|
||||
* name: 'MyDocument',
|
||||
* printerId: 'printer007',
|
||||
* duplex: true,
|
||||
* landscape: true,
|
||||
* grayscale: true
|
||||
* }
|
||||
* orientation: 'landscape',
|
||||
* monochrome: true
|
||||
* }
|
||||
*
|
||||
* this.printer.print(content, options).then(onSuccess, onError);
|
||||
* ```
|
||||
@@ -85,14 +176,14 @@ export class Printer extends IonicNativePlugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the printer service is available (iOS) or if printer services are installed and enabled (Android).
|
||||
* @return {Promise<any>} returns a promise that resolve with an object indicating whether printing is available, and providing the number of printers available
|
||||
* Checks To check if printing is supported in general
|
||||
* @return {Promise<any>} returns a promise that resolve with an object indicating whether printing is available
|
||||
*/
|
||||
@CordovaCheck()
|
||||
check(): Promise<any> {
|
||||
return getPromise<any>((resolve: Function) => {
|
||||
Printer.getPlugin()
|
||||
.check((avail: boolean, count: any) => {
|
||||
.canPrintItem((avail: boolean, count: any) => {
|
||||
resolve({ avail, count });
|
||||
});
|
||||
});
|
||||
@@ -117,7 +208,7 @@ export class Printer extends IonicNativePlugin {
|
||||
successIndex: 2,
|
||||
errorIndex: 4
|
||||
})
|
||||
print(content: string | HTMLElement, options?: PrintOptions): Promise<any> {
|
||||
print(content?: string | HTMLElement, options?: PrintOptions): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,198 +0,0 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, CordovaCheck, CordovaInstance, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
/**
|
||||
* Information about the currently running app
|
||||
*/
|
||||
export interface AppInfo {
|
||||
platform: string;
|
||||
platformVersion: string;
|
||||
version: string;
|
||||
bundleName: string;
|
||||
bundleVersion: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Information about the current live update
|
||||
*/
|
||||
export interface DeployInfo {
|
||||
deploy_uuid: string;
|
||||
channel: string;
|
||||
binary_version: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Object for manually configuring deploy
|
||||
*/
|
||||
export interface DeployConfig {
|
||||
appId?: string;
|
||||
host?: string;
|
||||
channel?: string;
|
||||
}
|
||||
|
||||
export type ProgressMessage = number | string;
|
||||
|
||||
/**
|
||||
* @hidden
|
||||
*/
|
||||
export class ProDeploy {
|
||||
constructor(private _objectInstance: any) {}
|
||||
|
||||
/**
|
||||
* Re-initialize Deploy plugin with a new App ID and host. Not used in most cases.
|
||||
* @param config A valid Deploy config object
|
||||
*/
|
||||
@CordovaInstance()
|
||||
init(config: DeployConfig): Promise<void> { return; }
|
||||
|
||||
/**
|
||||
* Check a channel for an available update
|
||||
* @return {Promise<string>} Resolves with 'true' or 'false', or rejects with an error.
|
||||
*/
|
||||
@CordovaInstance()
|
||||
check(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Download an available version
|
||||
* @return {Observable<ProgressMessage>} Updates with percent completion, or errors with a message.
|
||||
*/
|
||||
@CordovaInstance({
|
||||
observable: true
|
||||
})
|
||||
download(): Observable<ProgressMessage> { return; }
|
||||
|
||||
/**
|
||||
* Unzip the latest downloaded version
|
||||
* @return {Observable<ProgressMessage>} Updates with percent completion, or errors with a message.
|
||||
*/
|
||||
@CordovaInstance({
|
||||
observable: true
|
||||
})
|
||||
extract(): Observable<ProgressMessage> { return; }
|
||||
|
||||
/**
|
||||
* Reload app with the deployed version
|
||||
*/
|
||||
@CordovaInstance()
|
||||
redirect(): Promise<void> { return; }
|
||||
|
||||
/**
|
||||
* Get info about the version running on the device
|
||||
* @return {Promise<DeployInfo>} Information about the current version running on the app.
|
||||
*/
|
||||
@CordovaInstance()
|
||||
info(): Promise<DeployInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* List versions stored on the device
|
||||
*/
|
||||
@CordovaInstance()
|
||||
getVersions(): Promise<string[]> { return; }
|
||||
|
||||
/**
|
||||
* Delete a version stored on the device by UUID
|
||||
* @param version A version UUID
|
||||
*/
|
||||
@CordovaInstance()
|
||||
deleteVersion(version: string): Promise<void> { return; }
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Pro
|
||||
* @description
|
||||
* This plugin enables Ionic Pro services like live updates and error monitoring
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { Pro, AppInfo, DeployInfo } from '@ionic-native/pro/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private pro: Pro) { }
|
||||
*
|
||||
* // Get app info
|
||||
* this.pro.getAppInfo().then((res: AppInfo) => {
|
||||
* console.log(res)
|
||||
* })
|
||||
*
|
||||
* // Get live update info
|
||||
* this.pro.deploy.info().then((res: DeployInfo) => {
|
||||
* console.log(res)
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'Pro',
|
||||
plugin: 'cordova-plugin-ionic',
|
||||
pluginRef: 'IonicCordova',
|
||||
repo: 'https://github.com/ionic-team/cordova-plugin-ionic',
|
||||
platforms: ['Android', 'iOS'],
|
||||
install:
|
||||
'ionic cordova plugin add cordova-plugin-ionic --save --variable APP_ID="XXXXXXXX" --variable CHANNEL_NAME="Channel"'
|
||||
})
|
||||
@Injectable()
|
||||
export class Pro extends IonicNativePlugin {
|
||||
_deploy: ProDeploy;
|
||||
|
||||
/**
|
||||
* Ionic Pro Deploy .js API.
|
||||
*/
|
||||
@CordovaCheck({ sync: true })
|
||||
deploy(): ProDeploy {
|
||||
if (this._deploy) {
|
||||
return this._deploy;
|
||||
} else {
|
||||
this._deploy = new ProDeploy(Pro.getPlugin().deploy);
|
||||
return this._deploy;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Not yet implemented
|
||||
* @return {Promise<any>} Returns a promise that resolves when something happens
|
||||
*/
|
||||
@Cordova()
|
||||
enableCrashLogging(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Not yet implemented
|
||||
* @return {Promise<any>} Returns a promise that resolves when something happens
|
||||
*/
|
||||
@Cordova()
|
||||
checkForPendingCrash(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Not yet implemented
|
||||
* @return {Promise<any>} Returns a promise that resolves when something happens
|
||||
*/
|
||||
@Cordova()
|
||||
loadPendingCrash(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Not yet implemented
|
||||
* @return {Promise<any>} Returns a promise that resolves when something happens
|
||||
*/
|
||||
@Cordova()
|
||||
forceCrash(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get information about the currently running app
|
||||
* @return {Promise<any>} Returns a promise that resolves with current app info
|
||||
*/
|
||||
@Cordova()
|
||||
getAppInfo(): Promise<AppInfo> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
629
src/@ionic-native/plugins/pspdfkit-cordova/index.ts
Normal file
629
src/@ionic-native/plugins/pspdfkit-cordova/index.ts
Normal file
@@ -0,0 +1,629 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, CordovaProperty, CordovaInstance, InstanceProperty, IonicNativePlugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
/**
|
||||
* @name PSPDFKit-Cordova
|
||||
* @description
|
||||
* The official plugin to use PSPDFKit with Cordova and Ionic.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { PSPDFKit } from '@ionic-native/pspdfkit-cordova/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private pspdfkit: PSPDFKit) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* // Set your license key here.
|
||||
* this.pspdfkit.setLicenseKey("YOUR KEY");
|
||||
*
|
||||
* // Show a PDF in single page mode, with a black background.
|
||||
* this.pspdfkit.present('document.pdf', {pageMode: 'single', backgroundColor: "black"})
|
||||
* .then(result => {
|
||||
* console.log(result); // Success
|
||||
* })
|
||||
* .catch(error => {
|
||||
* console.log(error); // Failed
|
||||
* });
|
||||
* }
|
||||
*
|
||||
* // Scroll to page at index 1.
|
||||
* this.pspdfkit.setPage(1, true);
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'PSPDFKit',
|
||||
plugin: 'pspdfkit-cordova',
|
||||
pluginRef: 'PSPDFKit',
|
||||
repo: 'https://github.com/PSPDFKit/PSPDFKit-Cordova',
|
||||
install: 'ionic cordova plugin add pspdfkit-cordova',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class PSPDFKit extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Activates PSPDFKit with your license key from https://customers.pspdfkit.com.
|
||||
*
|
||||
* @param key {string} The license key.
|
||||
* @return {Promise<any>} Success and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
setLicenseKey(licenseKey: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* iOS: Displays a PDF in a full-screen modal.
|
||||
* Android: Opens the PSPDFActivity to show a document from the local device file system.
|
||||
*
|
||||
* @param path {string} The path should be a string containing the file path (not URL) for the PDF. Relative paths are assumed to be relative to the www directory (if the path has a different base URL set, this will be ignored). To specify a path inside the application documents or library directory, use a `~`, e.g. `"~/Documents/mypdf.pdf"` or `"~/Library/Application Support/mypdf.pdf"`. Path can be null, but must not be omitted
|
||||
* @param options {any} The `options` parameter is an optional object containing configuration properties for the PDF document and/or view controller. All currently supported values are listed below under Options.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
present(path: string, options?: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens the PSPDFActivity to show a document from the app's assets folder. This method copies the
|
||||
* file to the internal app directory on the device before showing it.
|
||||
* @param assetFile {string} Relative path within the app's assets folder.
|
||||
* @param options {any} PSPDFKit configuration options.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
presentFromAssets(assetFile: string, options?: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays a PDF in a full-screen modal and imports annotations from a given XFDF file.
|
||||
*
|
||||
* @param path {string} Should be a string containing the file path (not URL) for the PDF. Relative paths are assumed to be relative to the www directory (if the path has a different base URL set, this will be ignored). To specify a path inside the application documents or library directory, use a `~`, e.g. `"~/Documents/mypdf.pdf"` or `"~/Library/Application Support/mypdf.pdf"`. Path can be null, but must not be omitted
|
||||
* @param xfdfPath {string} should be a string containing the file path (not URL) for the XFDF file backing the PDF document. Relative paths are assumed to be relative to the www directory (if the xfdf path has a different base URL set, we will create an XFDF file in `'"~/Documents/" + xfdfPath'`). To specify a path inside the application documents or library directory, use a ~, e.g. `"~/Documents/myXFDF.xfdf"` or `"~/Library/Application Support/myXFDF.xfdf"`. The xfdfPath cannot be null and must not be omitted.
|
||||
* @param options {any} The `options` parameter is an optional object containing configuration properties for the PDF document and/or view controller. All currently supported values are listed below under Options.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
presentWithXFDF(path: string, xfdfPath: string, options?: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* iOS: Dismisses the modally presented PDF view.
|
||||
* Android: Dismisses any previously launched PDF activity. Calls the optional callback function after all activities have been dismissed.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
dismiss(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reloads the current PDF.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
reload(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
/**
|
||||
* Saves the document to original location if it has been changed. If there were no changes to the
|
||||
* document, the document file will not be modified.
|
||||
* Provides "wasModified" as a part of a successful response which will be equal to true if
|
||||
* the file was modified and changes were saved. false if there was nothing to save.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
saveDocument(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves any changed annotations in the current document.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
saveAnnotations(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return true in the success (or result) callback if the document has unsaved annotation. Returns false otherwise.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
getHasDirtyAnnotations(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Triggers a search for the specified query.
|
||||
*
|
||||
* @param query {string} Search Term to query
|
||||
* @param animated {boolean} Determines if the search should be animated (if omitted, the search will not be animated). The optional headless argument determines whether the search UI should be disaplyed (if omitted, the search UI *will* be displayed).
|
||||
* @param headless {boolean} Determines whether the search UI should be disaplyed (if omitted, the search UI *will* be displayed).
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
search(query: string, animated?: boolean, headless?: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets multiple document and view controller settings at once.
|
||||
*
|
||||
* @param options {any} The options set will be applied to the current document (if there is one) as well as all subsequently displayed documents. All currently supported values are listed below under Options.
|
||||
* @param animated {boolean} determines if the property should be animated. Not all property changes can be animated, so if the property does not support animation the animated argument will be ignored.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
setOptions(options: any, animated: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets several document or view controller options in a single call.
|
||||
*
|
||||
* @param names {any} array of option names
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
getOptions(names: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a single document or view controller settings at once.
|
||||
*
|
||||
* @param name {string} the option name
|
||||
* @param value {any} the option value
|
||||
* @param animated {boolean} determines if the property should be animated. Not all property changes can be animated, so if the property does not support animation the animated argument will be ignored.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
setOption(name: string, value: any, animated: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a single document or view controller settings at once.
|
||||
*
|
||||
* @param name {string} the option name
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
getOption(name: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the current visible page.
|
||||
*
|
||||
* @param page {number} the page index
|
||||
* @param animated {boolean} Optional argument. Determines if the page change should be animated (if omitted, the search will not be animated).
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
setPage(page: number, animated?: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the currently visible page.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
getPage(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the page count of the current document.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
getPageCount(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scrolls to the next page.
|
||||
*
|
||||
* @param animated {boolean} Optional argument. Determines if the page change should be animated (if omitted, the search will not be animated).
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
scrollToNextPage(animated?: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scrolls to the previous page.
|
||||
*
|
||||
* @param animated {boolean} Optional argument. Determines if the page change should be animated (if omitted, the search will not be animated).
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
scrollToPreviousPage(animated?: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the appearance mode.
|
||||
*
|
||||
* @param appearanceMode {string} the appearance mode. Can be 'default', 'sepia', or 'night'
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
setAppearanceMode(appearanceMode: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears the entire render cache. This invalidates render caches for all previously rendered documents.
|
||||
* Consider using `removeCacheForPresentedDocument()` or `clearCacheForPage()` instead of this,
|
||||
* since invalidating single documents or specific page caches since excessive cache invalidation may decrease performance.
|
||||
*
|
||||
* @param clearDiskCache {boolean} optional parameter. Android: if set to true clears disk cache as well. iOS: has no effect.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
clearCache(clearDiskCache?: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears the cache from the currently presented document.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
removeCacheForPresentedDocument(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidates the render cache for the specified page.
|
||||
*
|
||||
* @param pageIndex {number} 0-based index of the page whose render cache should be invalidated.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
clearCacheForPage(pageIndex: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Hides the annotation toolbar
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
hideAnnotationToolbar(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows the annotation toolbar
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
showAnnotationToolbar(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Toggles the annotation toolbar
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
toggleAnnotationToolbar(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Applies the passed in document Instant JSON.
|
||||
*
|
||||
* @param jsonValue {string} The document Instant JSON to apply.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
applyInstantJSON(jsonValue: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a new annotation to the current document using the Instant JSON Annotation
|
||||
* payload - https://pspdfkit.com/guides/ios/current/importing-exporting/instant-json/#instant-annotation-json-api
|
||||
*
|
||||
* @param jsonAnnotation {string} Instant JSON of the annotation to add.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
addAnnotation(jsonAnnotation: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a given annotation from the current document. The annotaion is expected to be in Instant
|
||||
* JSON format - https://pspdfkit.com/guides/ios/current/importing-exporting/instant-json/#instant-annotation-json-api
|
||||
*
|
||||
* @param jsonAnnotation {string} Instant JSON of the annotation to remove.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
removeAnnotation(jsonAnnotation: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all annotations of the given type from the page.
|
||||
*
|
||||
* @param pageIndex {number} The page to get the annotations for.
|
||||
* @param type {string} The type of annotations to get (See here for types https://pspdfkit.com/guides/server/current/api/json-format/) or `null` to get all annotations.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
getAnnotations(pageIndex: number, type?: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all unsaved changes to annotations.
|
||||
*
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
getAllUnsavedAnnotations(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of the form element of the fully qualified name.
|
||||
*
|
||||
* @param value {string} the value.
|
||||
* @param fullyQualifiedName {string} the fully qualified name of the form element.
|
||||
* @return {Promise<any>} callback Success (result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
setFormFieldValue(value: string, fullyQualifiedName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of the form element of the fully qualified name.
|
||||
*
|
||||
* @param fullyQualifiedName {string} description.
|
||||
* @return {Promise<any>} callback Success (result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
getFormFieldValue(fullyQualifiedName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Imports all annotations from the specified XFDF file to the current document.
|
||||
*
|
||||
* @param xfdfPath {string} XFDF file path to import annotations
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
importXFDF(xfdfPath: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Exports all annotations from the current document to the specified XFDF file path.
|
||||
*
|
||||
* @param xfdfPath {string} XFDF file path to export annotations
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
exportXFDF(xfdfPath: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes annotations (embed, remove, flatten, or print) and saves the processed document to the given document path.
|
||||
*
|
||||
* @param annotationChange {string} the annotation change. Can be 'flatten', 'remove', 'embed' or 'print'
|
||||
* @param processedDocumentPath {string} description.
|
||||
* @param annotationType {string} The optional string annotationType argument. If omitted, we process 'All' annotations. The annotation type can have one of the following values: None, Undefined, Link, Highlight, StrikeOut, Underline, Squiggly, FreeText, Ink, Square, Circle, Line, Text, Stamp, Caret, RichMedia, Screen, Widget, Sound, FileAttachment, Polygon, PolyLine, Popup, Watermark, TrapNet, 3D, Redact, All.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
* -Android
|
||||
*/
|
||||
@Cordova()
|
||||
processAnnotations(annotationChange: string, processedDocumentPath: string, annotationType: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a PDF document from HTML string.
|
||||
*
|
||||
* @param html {string} HTML string.
|
||||
* @param fileName {string} File name of the generated PDF.
|
||||
* @param options {string} Options to be considered when converting the HTML string to PDF.
|
||||
* @return {Promise<any>} callback Success (or result) and error callback function.
|
||||
*
|
||||
* __Supported Platforms__
|
||||
*
|
||||
* -iOS
|
||||
*/
|
||||
@Cordova()
|
||||
convertPDFFromHTMLString(html: string, fileName: string, options: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
842
src/@ionic-native/plugins/purchases/index.ts
Normal file
842
src/@ionic-native/plugins/purchases/index.ts
Normal file
@@ -0,0 +1,842 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
/**
|
||||
* @deprecated use ATTRIBUTION_NETWORK instead
|
||||
*
|
||||
* Enum for attribution networks
|
||||
* @readonly
|
||||
* @enum {Number}
|
||||
*/
|
||||
export enum ATTRIBUTION_NETWORKS {
|
||||
APPLE_SEARCH_ADS = 0,
|
||||
ADJUST = 1,
|
||||
APPSFLYER = 2,
|
||||
BRANCH = 3,
|
||||
TENJIN = 4,
|
||||
FACEBOOK = 5,
|
||||
}
|
||||
|
||||
export enum ATTRIBUTION_NETWORK {
|
||||
APPLE_SEARCH_ADS = 0,
|
||||
ADJUST = 1,
|
||||
APPSFLYER = 2,
|
||||
BRANCH = 3,
|
||||
TENJIN = 4,
|
||||
FACEBOOK = 5,
|
||||
}
|
||||
|
||||
export enum PURCHASE_TYPE {
|
||||
/**
|
||||
* A type of SKU for in-app products.
|
||||
*/
|
||||
INAPP = 'inapp',
|
||||
|
||||
/**
|
||||
* A type of SKU for subscriptions.
|
||||
*/
|
||||
SUBS = 'subs',
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use PURCHASE_TYPE instead
|
||||
*
|
||||
* Enum for attribution networks
|
||||
* @readonly
|
||||
* @enum {String}
|
||||
*/
|
||||
export enum ProductType {
|
||||
SUBS = 'subs',
|
||||
INAPP = 'inapp'
|
||||
}
|
||||
|
||||
export enum PRORATION_MODE {
|
||||
UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY = 0,
|
||||
|
||||
/**
|
||||
* Replacement takes effect immediately, and the remaining time will be
|
||||
* prorated and credited to the user. This is the current default behavior.
|
||||
*/
|
||||
IMMEDIATE_WITH_TIME_PRORATION = 1,
|
||||
|
||||
/**
|
||||
* Replacement takes effect immediately, and the billing cycle remains the
|
||||
* same. The price for the remaining period will be charged. This option is
|
||||
* only available for subscription upgrade.
|
||||
*/
|
||||
IMMEDIATE_AND_CHARGE_PRORATED_PRICE = 2,
|
||||
|
||||
/**
|
||||
* Replacement takes effect immediately, and the new price will be charged on
|
||||
* next recurrence time. The billing cycle stays the same.
|
||||
*/
|
||||
IMMEDIATE_WITHOUT_PRORATION = 3,
|
||||
|
||||
/**
|
||||
* Replacement takes effect when the old plan expires, and the new price will
|
||||
* be charged at the same time.
|
||||
*/
|
||||
DEFERRED = 4,
|
||||
}
|
||||
|
||||
export enum PACKAGE_TYPE {
|
||||
|
||||
/**
|
||||
* A package that was defined with a custom identifier.
|
||||
*/
|
||||
UNKNOWN = 'UNKNOWN',
|
||||
|
||||
/**
|
||||
* A package that was defined with a custom identifier.
|
||||
*/
|
||||
CUSTOM = 'CUSTOM',
|
||||
|
||||
/**
|
||||
* A package configured with the predefined lifetime identifier.
|
||||
*/
|
||||
LIFETIME = 'LIFETIME',
|
||||
|
||||
/**
|
||||
* A package configured with the predefined annual identifier.
|
||||
*/
|
||||
ANNUAL = 'ANNUAL',
|
||||
|
||||
/**
|
||||
* A package configured with the predefined six month identifier.
|
||||
*/
|
||||
SIX_MONTH = 'SIX_MONTH',
|
||||
|
||||
/**
|
||||
* A package configured with the predefined three month identifier.
|
||||
*/
|
||||
THREE_MONTH = 'THREE_MONTH',
|
||||
|
||||
/**
|
||||
* A package configured with the predefined two month identifier.
|
||||
*/
|
||||
TWO_MONTH = 'TWO_MONTH',
|
||||
|
||||
/**
|
||||
* A package configured with the predefined monthly identifier.
|
||||
*/
|
||||
MONTHLY = 'MONTHLY',
|
||||
|
||||
/**
|
||||
* A package configured with the predefined weekly identifier.
|
||||
*/
|
||||
WEEKLY = 'WEEKLY',
|
||||
}
|
||||
|
||||
export enum INTRO_ELIGIBILITY_STATUS {
|
||||
/**
|
||||
* RevenueCat doesn't have enough information to determine eligibility.
|
||||
*/
|
||||
INTRO_ELIGIBILITY_STATUS_UNKNOWN = 0,
|
||||
/**
|
||||
* The user is not eligible for a free trial or intro pricing for this product.
|
||||
*/
|
||||
INTRO_ELIGIBILITY_STATUS_INELIGIBLE,
|
||||
/**
|
||||
* The user is eligible for a free trial or intro pricing for this product.
|
||||
*/
|
||||
INTRO_ELIGIBILITY_STATUS_ELIGIBLE
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Purchases
|
||||
* @description
|
||||
* Purchases is a cross platform solution for managing in-app subscriptions. A backend is also provided via [RevenueCat](https://www.revenuecat.com)
|
||||
*
|
||||
* ## Features
|
||||
* | | RevenueCat |
|
||||
* | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
* | ✅ | Server-side receipt validation |
|
||||
* | ➡️ | [Webhooks](https://docs.revenuecat.com/docs/webhooks) - enhanced server-to-server communication with events for purchases, renewals, cancellations, and more |
|
||||
* | 🎯 | Subscription status tracking - know whether a user is subscribed whether they're on iOS, Android or web |
|
||||
* | 📊 | Analytics - automatic calculation of metrics like conversion, mrr, and churn |
|
||||
* | 📝 | [Online documentation](https://docs.revenuecat.com/docs) up to date |
|
||||
* | 🔀 | [Integrations](https://www.revenuecat.com/integrations) - over a dozen integrations to easily send purchase data where you need it |
|
||||
* | 💯 | Well maintained - [frequent releases](https://github.com/RevenueCat/cordova-plugin-purchases/releases) |
|
||||
* | 📮 | Great support - [Help Center](https://revenuecat.zendesk.com) |
|
||||
* | 🤩 | Awesome [new features](https://trello.com/b/RZRnWRbI/revenuecat-product-roadmap) |
|
||||
*
|
||||
* ## Getting Started
|
||||
*
|
||||
* For more detailed information, you can view our complete documentation at [docs.revenuecat.com](https://docs.revenuecat.com/docs).
|
||||
*
|
||||
* @usage
|
||||
* #### 1. Get a RevenueCat API key
|
||||
*
|
||||
* Log in to the [RevenueCat dashboard](https://app.revenuecat.com) and obtain a free API key for your application.
|
||||
*
|
||||
* #### 2. Initialize the SDK
|
||||
*
|
||||
* You should only configure _Purchases_ once (usually on app launch) as soon as your app has a unique user id for your user. This can be when a user logs in if you have accounts or on launch if you can generate a random user identifier.
|
||||
*
|
||||
* ```typescript
|
||||
* import { Platform } from "@ionic/angular";
|
||||
* import { Purchases } from "@ionic-native/purchases/ngx";
|
||||
*
|
||||
* constructor(public platform: Platform, private purchases: Purchases) {
|
||||
* platform.ready().then(() => {
|
||||
* this.purchases.setDebugLogsEnabled(true); // Enable to get debug logs
|
||||
* this.purchases.setup("my_api_key", "my_app_user_id");
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* #### 3. Quickstart
|
||||
* Please follow the [Quickstart Guide](https://docs.revenuecat.com/docs/) for more information on how to use the SDK
|
||||
*
|
||||
* ### Requirements
|
||||
* Requires XCode 10.2+ and minimum targets iOS 9.0+ and macOS 10.12+
|
||||
* This plugin has been tested with cordova-plugin-purchases@
|
||||
*
|
||||
* @interfaces
|
||||
* PurchasesError
|
||||
* IntroEligibility
|
||||
* UpgradeInfo
|
||||
* PurchasesOfferings
|
||||
* PurchasesOffering
|
||||
* PurchasesPackage
|
||||
* PurchasesProduct
|
||||
* PurchaserInfo
|
||||
* PurchasesEntitlementInfos
|
||||
* PurchasesEntitlementInfo
|
||||
*
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'Purchases',
|
||||
plugin: 'cordova-plugin-purchases@1.0.4',
|
||||
pluginRef: 'Purchases', // the variable reference to call the plugin, example: navigator.geolocation
|
||||
repo: 'https://github.com/RevenueCat/cordova-plugin-purchases', // the github repository URL for the plugin
|
||||
platforms: ['Android', 'iOS'] // Array of platforms supported, example: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable({
|
||||
providedIn: 'root'
|
||||
})
|
||||
export class Purchases extends IonicNativePlugin {
|
||||
|
||||
static ATTRIBUTION_NETWORKS = ATTRIBUTION_NETWORK;
|
||||
/**
|
||||
* Enum for attribution networks
|
||||
* @readonly
|
||||
* @enum {Number}
|
||||
*/
|
||||
static ATTRIBUTION_NETWORK = ATTRIBUTION_NETWORK;
|
||||
|
||||
/**
|
||||
* Supported SKU types.
|
||||
* @readonly
|
||||
* @enum {string}
|
||||
*/
|
||||
static PURCHASE_TYPE = PURCHASE_TYPE;
|
||||
|
||||
/**
|
||||
* Replace SKU's ProrationMode.
|
||||
* @readonly
|
||||
* @enum {number}
|
||||
*/
|
||||
static PRORATION_MODE = PRORATION_MODE;
|
||||
|
||||
/**
|
||||
* Enumeration of all possible Package types.
|
||||
* @readonly
|
||||
* @enum {string}
|
||||
*/
|
||||
static PACKAGE_TYPE = PACKAGE_TYPE;
|
||||
|
||||
/**
|
||||
* Enum of different possible states for intro price eligibility status.
|
||||
* @readonly
|
||||
* @enum {number}
|
||||
*/
|
||||
static INTRO_ELIGIBILITY_STATUS = INTRO_ELIGIBILITY_STATUS;
|
||||
|
||||
/**
|
||||
* Sets up Purchases with your API key and an app user id.
|
||||
* @param {string} apiKey RevenueCat API Key. Needs to be a String
|
||||
* @param {string?} appUserID A unique id for identifying the user
|
||||
* @param {boolean} observerMode An optional boolean. Set this to TRUE if you have your own IAP implementation and
|
||||
* want to use only RevenueCat's backend. Default is FALSE. If you are on Android and setting this to ON, you will have
|
||||
* to acknowledge the purchases yourself.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setup(
|
||||
apiKey: string,
|
||||
appUserID?: string | null,
|
||||
observerMode = false
|
||||
): void {}
|
||||
|
||||
/**
|
||||
* Set this to true if you are passing in an appUserID but it is anonymous, this is true by default if you didn't pass an appUserID
|
||||
* If a user tries to purchase a product that is active on the current app store account, we will treat it as a restore and alias
|
||||
* the new ID with the previous id.
|
||||
* @param allowSharing {boolean} true if enabled, false to disabled
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setAllowSharingStoreAccount(allowSharing: boolean): void {}
|
||||
|
||||
/**
|
||||
* Add a dict of attribution information
|
||||
* @param {object} data Attribution data from any of the attribution networks in Purchases.ATTRIBUTION_NETWORKS
|
||||
* @param {ATTRIBUTION_NETWORK} network Which network, see Purchases.ATTRIBUTION_NETWORK
|
||||
* @param {string?} networkUserId An optional unique id for identifying the user. Needs to be a string.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
addAttributionData(
|
||||
data: { [key: string]: any },
|
||||
network: ATTRIBUTION_NETWORK,
|
||||
networkUserId?: string
|
||||
): void {}
|
||||
|
||||
/**
|
||||
* Gets the Offerings configured in the dashboard
|
||||
*
|
||||
* @return {Observable<PurchasesOfferings>} Will return a [PurchasesError] if the offerings are not properly configured in RevenueCat or if there is another error retrieving them.
|
||||
*/
|
||||
@Cordova()
|
||||
getOfferings(): Promise<PurchasesOfferings> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch the product info
|
||||
* @param {string[]} productIdentifiers Array of product identifiers
|
||||
* @param {PURCHASE_TYPE} type Optional type of products to fetch, can be inapp or subs. Subs by default
|
||||
*
|
||||
* @return {Promise<PurchasesProduct[]>} Will return a [PurchasesError] if the products are not properly configured in RevenueCat or if there is another error retrieving them.
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
})
|
||||
getProducts(
|
||||
productIdentifiers: string[],
|
||||
type: PURCHASE_TYPE = PURCHASE_TYPE.SUBS
|
||||
): Promise<PurchasesProduct[]> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* @typedef {Object} MakePurchaseResponse
|
||||
* @property {string} productIdentifier - The product identifier that has been purchased
|
||||
* @property {PurchaserInfo} purchaserInfo - The new PurchaserInfo after the successful purchase
|
||||
*/
|
||||
|
||||
/**
|
||||
* Make a purchase
|
||||
*
|
||||
* @deprecated Use purchaseProduct instead.
|
||||
*
|
||||
* @param {string} productIdentifier The product identifier of the product you want to purchase.
|
||||
* @param {string?} oldSKU Optional sku you wish to upgrade from.
|
||||
* @param {PURCHASE_TYPE} type Optional type of product, can be inapp or subs. Subs by default
|
||||
*
|
||||
* @return {Promise<MakePurchaseResponse>} A [PurchasesError] is triggered after an error or when the user cancels the purchase.
|
||||
* If user cancelled, userCancelled will be true
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2,
|
||||
observable: true
|
||||
})
|
||||
makePurchase(
|
||||
productIdentifier: string,
|
||||
oldSKU?: string | null,
|
||||
type: PURCHASE_TYPE = PURCHASE_TYPE.SUBS
|
||||
): Promise<{ productIdentifier: string; purchaserInfo: PurchaserInfo; }> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make a purchase
|
||||
*
|
||||
* @param {string} productIdentifier The product identifier of the product you want to purchase.
|
||||
* @param {UpgradeInfo} upgradeInfo Android only. Optional UpgradeInfo you wish to upgrade from containing the oldSKU
|
||||
* and the optional prorationMode.
|
||||
* @param {PURCHASE_TYPE} type Optional type of product, can be inapp or subs. Subs by default
|
||||
*
|
||||
* @return {Promise<MakePurchaseResponse>} A [PurchasesError] is triggered after an error or when the user cancels the purchase.
|
||||
* If user cancelled, userCancelled will be true
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
})
|
||||
purchaseProduct(
|
||||
productIdentifier: string,
|
||||
upgradeInfo?: UpgradeInfo | null,
|
||||
type: PURCHASE_TYPE = PURCHASE_TYPE.SUBS
|
||||
): Promise<{ productIdentifier: string; purchaserInfo: PurchaserInfo; }> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make a purchase
|
||||
*
|
||||
* @param {PurchasesPackage} aPackage The Package you wish to purchase. You can get the Packages by calling getOfferings
|
||||
* @param {UpgradeInfo} upgradeInfo Android only. Optional UpgradeInfo you wish to upgrade from containing the oldSKU
|
||||
* and the optional prorationMode.
|
||||
*
|
||||
* @return {Promise<MakePurchaseResponse>} A [PurchasesError] is triggered after an error or when the user cancels the purchase.
|
||||
* If user cancelled, userCancelled will be true
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
})
|
||||
purchasePackage(
|
||||
aPackage: PurchasesPackage,
|
||||
upgradeInfo?: UpgradeInfo | null
|
||||
): Promise<{ productIdentifier: string; purchaserInfo: PurchaserInfo; }> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Restores a user's previous purchases and links their appUserIDs to any user's also using those purchases.
|
||||
*
|
||||
* @return {Promise<PurchaserInfo>} Errors are of type [PurchasesError]
|
||||
*/
|
||||
@Cordova()
|
||||
restoreTransactions(): Promise<PurchaserInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the appUserID that is currently in placed in the SDK
|
||||
*
|
||||
* @return {string}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
getAppUserID(): string {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function will alias two appUserIDs together.
|
||||
* @param newAppUserID {String} The new appUserID that should be linked to the currently identified appUserID. Needs to be a string.
|
||||
*
|
||||
* @return {Promise<PurchaserInfo>} Errors are of type [PurchasesError] and get normally triggered if there
|
||||
* is an error retrieving the new purchaser info for the new user or if there is an error creating the alias.
|
||||
*/
|
||||
@Cordova()
|
||||
createAlias(newAppUserID: string): Promise<PurchaserInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function will identify the current user with an appUserID. Typically this would be used after a logout to identify a new user without calling configure
|
||||
* @param newAppUserID {String} The new appUserID that should be linked to the currently identified appUserID. Needs to be a string.
|
||||
*
|
||||
* @return {Promise<PurchaserInfo>} Errors are of type [PurchasesError] and get normally triggered if there
|
||||
* is an error retrieving the new purchaser info for the new user.
|
||||
*/
|
||||
@Cordova()
|
||||
identify(newAppUserID: string): Promise<PurchaserInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resets the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.
|
||||
*
|
||||
* @return {Promise<PurchaserInfo>} Errors are of type [PurchasesError] and get normally triggered if there
|
||||
* is an error retrieving the new purchaser info for the new user.
|
||||
*/
|
||||
@Cordova()
|
||||
reset(): Promise<PurchaserInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the current purchaser info. This call will return the cached purchaser info unless the cache is stale, in which case,
|
||||
* it will make a network call to retrieve it from the servers.
|
||||
*
|
||||
* @return {Promise<PurchaserInfo>} Errors are of type [PurchasesError] and get normally triggered if there
|
||||
* is an error retrieving the purchaser info.
|
||||
*/
|
||||
@Cordova()
|
||||
getPurchaserInfo(): Promise<PurchaserInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an observable that can be used to receive updates on the purchaser info
|
||||
*
|
||||
* @return {Observable<PurchaserInfo>}
|
||||
*/
|
||||
@Cordova({
|
||||
eventObservable: true,
|
||||
event: 'onPurchaserInfoUpdated',
|
||||
element: 'window'
|
||||
})
|
||||
onPurchaserInfoUpdated(): Observable<PurchaserInfo> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables/Disables debugs logs
|
||||
* @param {boolean} enabled true to enable debug logs, false to disable
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setDebugLogsEnabled(enabled: boolean): void {}
|
||||
|
||||
/**
|
||||
* This method will send all the purchases to the RevenueCat backend. Call this when using your own implementation
|
||||
* for subscriptions anytime a sync is needed, like after a successful purchase.
|
||||
*
|
||||
* @warning This function should only be called if you're not calling makePurchase.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
syncPurchases(): void {}
|
||||
|
||||
/**
|
||||
* Enable automatic collection of Apple Search Ads attribution. Disabled by default.
|
||||
* @param {Boolean} enabled Enable or not automatic collection
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setAutomaticAppleSearchAdsAttributionCollection(enabled: boolean): void {}
|
||||
|
||||
/**
|
||||
* @return {Promise<boolean>} A boolean indicating if the `appUserID` has been generated
|
||||
* by RevenueCat or not.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
isAnonymous(): boolean {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* iOS only. Computes whether or not a user is eligible for the introductory pricing period of a given product.
|
||||
* You should use this method to determine whether or not you show the user the normal product price or the
|
||||
* introductory price. This also applies to trials (trials are considered a type of introductory pricing).
|
||||
*
|
||||
* @note Subscription groups are automatically collected for determining eligibility. If RevenueCat can't
|
||||
* definitively compute the eligibility, most likely because of missing group information, it will return
|
||||
* `INTRO_ELIGIBILITY_STATUS_UNKNOWN`. The best course of action on unknown status is to display the non-intro
|
||||
* pricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of
|
||||
* iOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN.
|
||||
*
|
||||
* @param productIdentifiers Array of product identifiers for which you want to compute eligibility
|
||||
* @returns { Promise<Object.<string, IntroEligibility>> } Map of IntroEligibility per productId
|
||||
*/
|
||||
@Cordova()
|
||||
checkTrialOrIntroductoryPriceEligibility(
|
||||
productIdentifiers: string[]
|
||||
): Promise<{ [productId: string]: IntroEligibility; }> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use PurchasesProduct instead
|
||||
*/
|
||||
export interface RCProduct {
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use PurchaserInfo instead
|
||||
*/
|
||||
export interface RCPurchaserInfo {
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated use PurchasesError instead
|
||||
*/
|
||||
export interface RCError {
|
||||
}
|
||||
/**
|
||||
* The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.
|
||||
*/
|
||||
export interface PurchasesEntitlementInfo {
|
||||
/**
|
||||
* The entitlement identifier configured in the RevenueCat dashboard
|
||||
*/
|
||||
readonly identifier: string;
|
||||
/**
|
||||
* True if the user has access to this entitlement
|
||||
*/
|
||||
readonly isActive: boolean;
|
||||
/**
|
||||
* True if the underlying subscription is set to renew at the end of the billing period (expirationDate).
|
||||
* Will always be True if entitlement is for lifetime access.
|
||||
*/
|
||||
readonly willRenew: boolean;
|
||||
/**
|
||||
* The last period type this entitlement was in. Either: NORMAL, INTRO, TRIAL.
|
||||
*/
|
||||
readonly periodType: string;
|
||||
/**
|
||||
* The latest purchase or renewal date for the entitlement.
|
||||
*/
|
||||
readonly latestPurchaseDate: string;
|
||||
/**
|
||||
* The first date this entitlement was purchased.
|
||||
*/
|
||||
readonly originalPurchaseDate: string;
|
||||
/**
|
||||
* The expiration date for the entitlement, can be `null` for lifetime access. If the `periodType` is `trial`,
|
||||
* this is the trial expiration date.
|
||||
*/
|
||||
readonly expirationDate: string | null;
|
||||
/**
|
||||
* The store where this entitlement was unlocked from. Either: appStore, macAppStore, playStore, stripe,
|
||||
* promotional, unknownStore
|
||||
*/
|
||||
readonly store: string;
|
||||
/**
|
||||
* The product identifier that unlocked this entitlement
|
||||
*/
|
||||
readonly productIdentifier: string;
|
||||
/**
|
||||
* False if this entitlement is unlocked via a production purchase
|
||||
*/
|
||||
readonly isSandbox: boolean;
|
||||
/**
|
||||
* The date an unsubscribe was detected. Can be `null`.
|
||||
*
|
||||
* @note: Entitlement may still be active even if user has unsubscribed. Check the `isActive` property.
|
||||
*/
|
||||
readonly unsubscribeDetectedAt: string | null;
|
||||
/**
|
||||
* The date a billing issue was detected. Can be `null` if there is no billing issue or an issue has been resolved
|
||||
*
|
||||
* @note: Entitlement may still be active even if there is a billing issue. Check the `isActive` property.
|
||||
*/
|
||||
readonly billingIssueDetectedAt: string | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Contains all the entitlements associated to the user.
|
||||
*/
|
||||
export interface PurchasesEntitlementInfos {
|
||||
/**
|
||||
* Map of all EntitlementInfo (`PurchasesEntitlementInfo`) objects (active and inactive) keyed by entitlement identifier.
|
||||
*/
|
||||
readonly all: { [key: string]: PurchasesEntitlementInfo };
|
||||
/**
|
||||
* Map of active EntitlementInfo (`PurchasesEntitlementInfo`) objects keyed by entitlement identifier.
|
||||
*/
|
||||
readonly active: { [key: string]: PurchasesEntitlementInfo };
|
||||
}
|
||||
|
||||
export interface PurchaserInfo {
|
||||
/**
|
||||
* Entitlements attached to this purchaser info
|
||||
*/
|
||||
readonly entitlements: PurchasesEntitlementInfos;
|
||||
/**
|
||||
* Set of active subscription skus
|
||||
*/
|
||||
readonly activeSubscriptions: [string];
|
||||
/**
|
||||
* Set of purchased skus, active and inactive
|
||||
*/
|
||||
readonly allPurchasedProductIdentifiers: [string];
|
||||
/**
|
||||
* The latest expiration date of all purchased skus
|
||||
*/
|
||||
readonly latestExpirationDate: string | null;
|
||||
/**
|
||||
* The date this user was first seen in RevenueCat.
|
||||
*/
|
||||
readonly firstSeen: string;
|
||||
/**
|
||||
* The original App User Id recorded for this user.
|
||||
*/
|
||||
readonly originalAppUserId: string;
|
||||
/**
|
||||
* Date when this info was requested
|
||||
*/
|
||||
readonly requestDate: string;
|
||||
/**
|
||||
* Map of skus to expiration dates
|
||||
*/
|
||||
readonly allExpirationDates: { [key: string]: string | null };
|
||||
/**
|
||||
* Map of skus to purchase dates
|
||||
*/
|
||||
readonly allPurchaseDates: { [key: string]: string | null };
|
||||
/**
|
||||
* Returns the version number for the version of the application when the
|
||||
* user bought the app. Use this for grandfathering users when migrating
|
||||
* to subscriptions.
|
||||
*
|
||||
* This corresponds to the value of CFBundleVersion (in iOS) in the
|
||||
* Info.plist file when the purchase was originally made. This is always null
|
||||
* in Android
|
||||
*/
|
||||
readonly originalApplicationVersion: string | null;
|
||||
}
|
||||
|
||||
export interface PurchasesProduct {
|
||||
/**
|
||||
* Product Id.
|
||||
*/
|
||||
readonly identifier: string;
|
||||
/**
|
||||
* Description of the product.
|
||||
*/
|
||||
readonly description: string;
|
||||
/**
|
||||
* Title of the product.
|
||||
*/
|
||||
readonly title: string;
|
||||
/**
|
||||
* Price of the product in the local currency.
|
||||
*/
|
||||
readonly price: number;
|
||||
/**
|
||||
* Formatted price of the item, including its currency sign, such as €3.99.
|
||||
*/
|
||||
readonly price_string: string;
|
||||
/**
|
||||
* Currency code for price and original price.
|
||||
*/
|
||||
readonly currency_code: string;
|
||||
/**
|
||||
* Introductory price of a subscription in the local currency.
|
||||
*/
|
||||
readonly intro_price: number | null;
|
||||
/**
|
||||
* Formatted introductory price of a subscription, including its currency sign, such as €3.99.
|
||||
*/
|
||||
readonly intro_price_string: string | null;
|
||||
/**
|
||||
* Billing period of the introductory price, specified in ISO 8601 format.
|
||||
*/
|
||||
readonly intro_price_period: string | null;
|
||||
/**
|
||||
* Number of subscription billing periods for which the user will be given the introductory price, such as 3.
|
||||
*/
|
||||
readonly intro_price_cycles: number | null;
|
||||
/**
|
||||
* Unit for the billing period of the introductory price, can be DAY, WEEK, MONTH or YEAR.
|
||||
*/
|
||||
readonly intro_price_period_unit: string | null;
|
||||
/**
|
||||
* Number of units for the billing period of the introductory price.
|
||||
*/
|
||||
readonly intro_price_period_number_of_units: number | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Contains information about the product available for the user to purchase.
|
||||
* For more info see https://docs.revenuecat.com/docs/entitlements
|
||||
*/
|
||||
export interface PurchasesPackage {
|
||||
/**
|
||||
* Unique identifier for this package. Can be one a predefined package type or a custom one.
|
||||
*/
|
||||
readonly identifier: string;
|
||||
/**
|
||||
* Package type for the product. Will be one of [PACKAGE_TYPE].
|
||||
*/
|
||||
readonly packageType: PACKAGE_TYPE;
|
||||
/**
|
||||
* Product assigned to this package.
|
||||
*/
|
||||
readonly product: PurchasesProduct;
|
||||
/**
|
||||
* Offering this package belongs to.
|
||||
*/
|
||||
readonly offeringIdentifier: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* An offering is a collection of Packages (`PurchasesPackage`) available for the user to purchase.
|
||||
* For more info see https://docs.revenuecat.com/docs/entitlements
|
||||
*/
|
||||
export interface PurchasesOffering {
|
||||
/**
|
||||
* Unique identifier defined in RevenueCat dashboard.
|
||||
*/
|
||||
readonly identifier: string;
|
||||
/**
|
||||
* Offering description defined in RevenueCat dashboard.
|
||||
*/
|
||||
readonly serverDescription: string;
|
||||
/**
|
||||
* Array of `Package` objects available for purchase.
|
||||
*/
|
||||
readonly availablePackages: [PurchasesPackage];
|
||||
/**
|
||||
* Lifetime package type configured in the RevenueCat dashboard, if available.
|
||||
*/
|
||||
readonly lifetime: PurchasesPackage | null;
|
||||
/**
|
||||
* Annual package type configured in the RevenueCat dashboard, if available.
|
||||
*/
|
||||
readonly annual: PurchasesPackage | null;
|
||||
/**
|
||||
* Six month package type configured in the RevenueCat dashboard, if available.
|
||||
*/
|
||||
readonly sixMonth: PurchasesPackage | null;
|
||||
/**
|
||||
* Three month package type configured in the RevenueCat dashboard, if available.
|
||||
*/
|
||||
readonly threeMonth: PurchasesPackage | null;
|
||||
/**
|
||||
* Two month package type configured in the RevenueCat dashboard, if available.
|
||||
*/
|
||||
readonly twoMonth: PurchasesPackage | null;
|
||||
/**
|
||||
* Monthly package type configured in the RevenueCat dashboard, if available.
|
||||
*/
|
||||
readonly monthly: PurchasesPackage | null;
|
||||
/**
|
||||
* Weekly package type configured in the RevenueCat dashboard, if available.
|
||||
*/
|
||||
readonly weekly: PurchasesPackage | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Contains all the offerings configured in RevenueCat dashboard.
|
||||
* For more info see https://docs.revenuecat.com/docs/entitlements
|
||||
*/
|
||||
export interface PurchasesOfferings {
|
||||
/**
|
||||
* Map of all Offerings [PurchasesOffering] objects keyed by their identifier.
|
||||
*/
|
||||
readonly all: { [key: string]: PurchasesOffering };
|
||||
/**
|
||||
* Current offering configured in the RevenueCat dashboard.
|
||||
*/
|
||||
readonly current: PurchasesOffering | null;
|
||||
}
|
||||
|
||||
export interface PurchasesError {
|
||||
code: number;
|
||||
message: string;
|
||||
readableErrorCode: string;
|
||||
underlyingErrorMessage?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Holds the information used when upgrading from another sku. For Android use only.
|
||||
*/
|
||||
export interface UpgradeInfo {
|
||||
/**
|
||||
* The oldSKU to upgrade from.
|
||||
*/
|
||||
readonly oldSKU: string;
|
||||
/**
|
||||
* The [PRORATION_MODE] to use when upgrading the given oldSKU.
|
||||
*/
|
||||
readonly prorationMode?: PRORATION_MODE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Holds the introductory price status
|
||||
*/
|
||||
export interface IntroEligibility {
|
||||
/**
|
||||
* The introductory price eligibility status
|
||||
*/
|
||||
readonly status: INTRO_ELIGIBILITY_STATUS;
|
||||
/**
|
||||
* Description of the status
|
||||
*/
|
||||
readonly description: string;
|
||||
}
|
||||
@@ -136,6 +136,7 @@ export interface CategoryActionData {
|
||||
title: string;
|
||||
foreground: boolean;
|
||||
destructive: boolean;
|
||||
inline?: boolean;
|
||||
}
|
||||
|
||||
export interface AndroidPushOptions {
|
||||
@@ -230,6 +231,7 @@ export interface Channel {
|
||||
sound?: string;
|
||||
vibration?: boolean | number[];
|
||||
visibility?: Visibility;
|
||||
badge?: boolean;
|
||||
}
|
||||
|
||||
export type PushEvent = string;
|
||||
@@ -269,7 +271,11 @@ export type PushEvent = string;
|
||||
* id: "testchannel1",
|
||||
* description: "My first test channel",
|
||||
* // The importance property goes from 1 = Lowest, 2 = Low, 3 = Normal, 4 = High and 5 = Highest.
|
||||
* importance: 3
|
||||
* importance: 3,
|
||||
* //badge is used to if badge appears on the app icon see https://developer.android.com/reference/android/app/NotificationChannel.html#setShowBadge(boolean).
|
||||
* //false = no badge on app icon.
|
||||
* //true = badge on app icon
|
||||
* badge: false
|
||||
* }).then(() => console.log('Channel created'));
|
||||
*
|
||||
* // Delete a channel (Android O and above)
|
||||
|
||||
@@ -5,7 +5,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
* @beta
|
||||
* @name Rollbar
|
||||
* @description
|
||||
* This plugin adds Rollbar App monitoring to your application
|
||||
* This plugin adds [Rollbar](https://rollbar.com/) App monitoring to your application
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
|
||||
@@ -82,7 +82,8 @@ export class ScreenOrientation extends IonicNativePlugin {
|
||||
*/
|
||||
@Cordova({
|
||||
eventObservable: true,
|
||||
event: 'orientationchange'
|
||||
event: 'orientationchange',
|
||||
element: 'window'
|
||||
})
|
||||
onChange(): Observable<void> {
|
||||
return;
|
||||
|
||||
173
src/@ionic-native/plugins/secure-storage-echo/index.ts
Normal file
173
src/@ionic-native/plugins/secure-storage-echo/index.ts
Normal file
@@ -0,0 +1,173 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { CordovaCheck, CordovaInstance, getPromise, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export interface SecureStorageEchoOptions {
|
||||
android: {
|
||||
/**
|
||||
* See https://github.com/mibrito707/cordova-plugin-secure-storage-echo#sharing-data-android
|
||||
*/
|
||||
packageName?: string;
|
||||
/**
|
||||
* Sets the duration of time (seconds) for which the Private Encryption Key is authorized to be used after the user is successfully authenticated.
|
||||
* See https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.Builder.html#setUserAuthenticationValidityDurationSeconds(int)
|
||||
*/
|
||||
userAuthenticationValidityDuration?: number;
|
||||
/**
|
||||
* Custom title for Confirm Credentials screen.
|
||||
* See https://developer.android.com/reference/android/app/KeyguardManager.html#createConfirmDeviceCredentialIntent(java.lang.CharSequence,%20java.lang.CharSequence)
|
||||
*/
|
||||
unlockCredentialsTitle?: string;
|
||||
/**
|
||||
* Custom description for Confirm Credentials screen.
|
||||
*/
|
||||
unlockCredentialsDescription?: string;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @hidden
|
||||
*/
|
||||
export class SecureStorageEchoObject {
|
||||
constructor(private _objectInstance: any) {}
|
||||
|
||||
/**
|
||||
* Gets a stored item
|
||||
* @param key {string}
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@CordovaInstance({
|
||||
callbackOrder: 'reverse'
|
||||
})
|
||||
get(key: string): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stores a value
|
||||
* @param key {string}
|
||||
* @param value {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@CordovaInstance({
|
||||
callbackOrder: 'reverse'
|
||||
})
|
||||
set(key: string, value: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a single stored item
|
||||
* @param key {string}
|
||||
* @returns {Promise<string>} returns a promise that resolves with the key that was removed
|
||||
*/
|
||||
@CordovaInstance({
|
||||
callbackOrder: 'reverse'
|
||||
})
|
||||
remove(key: string): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all references from the storage.
|
||||
* @returns {Promise<string[]>} returns a promise that resolves with array of keys storage
|
||||
*/
|
||||
@CordovaInstance({
|
||||
callbackOrder: 'reverse'
|
||||
})
|
||||
keys(): Promise<string[]> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all references from the storage.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@CordovaInstance({
|
||||
callbackOrder: 'reverse'
|
||||
})
|
||||
clear(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Brings up the screen-lock settings
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@CordovaInstance()
|
||||
secureDevice(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Secure Storage Echo
|
||||
* @description
|
||||
* This plugin gets, sets and removes key,value pairs from a device's secure storage.
|
||||
*
|
||||
* Requires Cordova plugin: `cordova-plugin-secure-storage-echo`. For more info, please see the [Cordova Secure Storage docs](https://github.com/mibrito707/cordova-plugin-secure-storage-echo).
|
||||
*
|
||||
* The browser platform is supported as a mock only. Key/values are stored unencrypted in localStorage.
|
||||
*
|
||||
* @usage
|
||||
*
|
||||
* ```typescript
|
||||
* import { SecureStorageEcho, SecureStorageEchoObject } from '@ionic-native/secure-storage-echo/ngx';
|
||||
*
|
||||
* constructor(private secureStorageEcho: SecureStorageEcho) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.secureStorageEcho.create('my_store_name')
|
||||
* .then((storage: SecureStorageEchoObject) => {
|
||||
*
|
||||
* storage.get('key')
|
||||
* .then(
|
||||
* data => console.log(data),
|
||||
* error => console.log(error)
|
||||
* );
|
||||
*
|
||||
* storage.set('key', 'value')
|
||||
* .then(
|
||||
* data => console.log(data),
|
||||
* error => console.log(error)
|
||||
* );
|
||||
*
|
||||
* storage.remove('key')
|
||||
* .then(
|
||||
* data => console.log(data),
|
||||
* error => console.log(error)
|
||||
* );
|
||||
*
|
||||
* });
|
||||
*
|
||||
*
|
||||
* ```
|
||||
* @classes
|
||||
* SecureStorageEchoObject
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'SecureStorageEcho',
|
||||
plugin: 'cordova-plugin-secure-storage-echo',
|
||||
pluginRef: 'cordova.plugins.SecureStorage',
|
||||
repo: 'https://github.com/mibrito707/cordova-plugin-secure-storage-echo',
|
||||
platforms: ['Android', 'Browser', 'iOS', 'Windows']
|
||||
})
|
||||
@Injectable()
|
||||
export class SecureStorageEcho extends IonicNativePlugin {
|
||||
/**
|
||||
* Creates a namespaced storage.
|
||||
* @param store {string}
|
||||
* @returns {Promise<SecureStorageEchoObject>}
|
||||
*/
|
||||
@CordovaCheck()
|
||||
create(store: string, options?: SecureStorageEchoOptions): Promise<SecureStorageEchoObject> {
|
||||
return getPromise<SecureStorageEchoObject>((res: Function, rej: Function) => {
|
||||
const instance = new (SecureStorageEcho.getPlugin())(
|
||||
() => res(new SecureStorageEchoObject(instance)),
|
||||
rej,
|
||||
store,
|
||||
options
|
||||
);
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -124,9 +124,9 @@ export class SecureStorageObject {
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'SecureStorage',
|
||||
plugin: 'cordova-plugin-secure-storage',
|
||||
plugin: 'cordova-plugin-secure-storage-echo',
|
||||
pluginRef: 'cordova.plugins.SecureStorage',
|
||||
repo: 'https://github.com/Crypho/cordova-plugin-secure-storage',
|
||||
repo: 'https://github.com/mibrito707/cordova-plugin-secure-storage-echo',
|
||||
platforms: ['Android', 'Browser', 'iOS', 'Windows']
|
||||
})
|
||||
@Injectable()
|
||||
|
||||
45
src/@ionic-native/plugins/service-discovery/index.ts
Normal file
45
src/@ionic-native/plugins/service-discovery/index.ts
Normal file
@@ -0,0 +1,45 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name ServiceDiscovery
|
||||
* @description
|
||||
* Simple plugin to get any SSDP / UPnP / DLNA service on a local network
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { ServiceDiscovery } from '@ionic-native/service-discovery';
|
||||
*
|
||||
*
|
||||
* constructor(private serviceDiscovery: ServiceDiscovery) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.serviceDiscovery.getNetworkServices('ssdp:all')
|
||||
* .then(devices => console.log(devices))
|
||||
* .catch(error => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'ServiceDiscovery',
|
||||
plugin: 'cordova-plugin-discovery',
|
||||
pluginRef: 'serviceDiscovery',
|
||||
repo: 'https://github.com/scottdermott/cordova-plugin-discovery',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class ServiceDiscovery extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Finds and returns metadata about devices discovered on the network via SSDP / UPnP / DLNA
|
||||
* @param service {string} The service name to discover
|
||||
* @return {Promise<any>} Returns a promise that resolves when something happens
|
||||
*/
|
||||
@Cordova()
|
||||
getNetworkServices(service: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
177
src/@ionic-native/plugins/sign-in-with-apple/index.ts
Normal file
177
src/@ionic-native/plugins/sign-in-with-apple/index.ts
Normal file
@@ -0,0 +1,177 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @see https://developer.apple.com/documentation/authenticationservices/asauthorizationappleidrequest
|
||||
*/
|
||||
export class ASAuthorizationAppleIDRequest {
|
||||
static readonly ASAuthorizationScopeFullName = 0;
|
||||
static readonly ASAuthorizationScopeEmail = 1;
|
||||
|
||||
requestedScopes?: number[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see https://developer.apple.com/documentation/foundation/nspersonnamecomponents/1412193-phoneticrepresentation
|
||||
*/
|
||||
export interface NSPersonNameComponents {
|
||||
/**
|
||||
* The portion of a name’s full form of address that precedes the name itself (for example, "Dr.," "Mr.," "Ms.")
|
||||
*/
|
||||
namePrefix?: string;
|
||||
|
||||
/**
|
||||
* Name bestowed upon an individual to differentiate them from other members of a group that share a family name (for example, "Johnathan")
|
||||
*/
|
||||
givenName?: string;
|
||||
|
||||
/**
|
||||
* Secondary name bestowed upon an individual to differentiate them from others that have the same given name (for example, "Maple")
|
||||
*/
|
||||
middleName?: string;
|
||||
|
||||
/**
|
||||
* Name bestowed upon an individual to denote membership in a group or family. (for example, "Appleseed")
|
||||
*/
|
||||
familyName?: string;
|
||||
|
||||
/**
|
||||
* The portion of a name’s full form of address that follows the name itself (for example, "Esq.," "Jr.," "Ph.D.")
|
||||
*/
|
||||
nameSuffix?: string;
|
||||
|
||||
/**
|
||||
* Name substituted for the purposes of familiarity (for example, "Johnny")
|
||||
*/
|
||||
nickname?: string;
|
||||
|
||||
/**
|
||||
* The phonetic representation name components of the receiver
|
||||
*/
|
||||
phoneticRepresentation?: NSPersonNameComponents;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see https://developer.apple.com/documentation/authenticationservices/asauthorizationappleidcredential
|
||||
*/
|
||||
export interface AppleSignInResponse {
|
||||
/**
|
||||
* The user’s email address i.e. abc@privaterelay.appleid.com
|
||||
*/
|
||||
email?: string;
|
||||
|
||||
/**
|
||||
* An arbitrary string that your app provided to the request that generated the credential
|
||||
*/
|
||||
state?: string;
|
||||
|
||||
/**
|
||||
* A JSON Web Token (JWT) that securely communicates information about the user to your app
|
||||
*/
|
||||
identityToken: string;
|
||||
|
||||
/**
|
||||
* A short-lived token used by your app for proof of authorization when interacting with the app's server counterpart
|
||||
*/
|
||||
authorizationCode: string;
|
||||
|
||||
/**
|
||||
* The user's name
|
||||
* @see https://developer.apple.com/documentation/foundation/nspersonnamecomponents?language=objc
|
||||
*/
|
||||
fullName?: NSPersonNameComponents;
|
||||
|
||||
/**
|
||||
* An identifier associated with the authenticated user
|
||||
*/
|
||||
user?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see https://developer.apple.com/documentation/foundation/nserror
|
||||
*/
|
||||
export interface NSError {
|
||||
/**
|
||||
* The error code
|
||||
*/
|
||||
code?: number;
|
||||
|
||||
/**
|
||||
* A string containing the localized description of the error
|
||||
*/
|
||||
localizedDescription?: string;
|
||||
|
||||
/**
|
||||
* A string containing the localized explanation of the reason for the error
|
||||
*/
|
||||
localizedFailureReason?: string;
|
||||
}
|
||||
|
||||
export interface AppleSignInErrorResponse extends NSError {
|
||||
/**
|
||||
* The error i.e. "ASAUTHORIZATION_ERROR"
|
||||
*/
|
||||
error?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Sign In With Apple
|
||||
* @description
|
||||
* Sign in with Apple makes it easy for users to sign in to your apps and websites using their Apple ID.
|
||||
* Instead of filling out forms, verifying email addresses, and choosing new passwords,
|
||||
* they can use Sign in with Apple to set up an account and start using your app right away.
|
||||
* All accounts are protected with two-factor authentication for superior security,
|
||||
* and Apple will not track users’ activity in your app or website.
|
||||
* *Source:* https://developer.apple.com/sign-in-with-apple/
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { SignInWithApple, AppleSignInResponse, AppleSignInErrorResponse, ASAuthorizationAppleIDRequest } from '@ionic-native/sign-in-with-apple/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private signInWithApple: SignInWithApple) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.signInWithApple.signin({
|
||||
* requestedScopes: [
|
||||
* ASAuthorizationAppleIDRequest.ASAuthorizationScopeFullName,
|
||||
* ASAuthorizationAppleIDRequest.ASAuthorizationScopeEmail
|
||||
* ]
|
||||
* })
|
||||
* .then((res: AppleSignInResponse) => {
|
||||
* // https://developer.apple.com/documentation/signinwithapplerestapi/verifying_a_user
|
||||
* alert('Send token to apple for verification: ' + res.identityToken);
|
||||
* console.log(res);
|
||||
* })
|
||||
* .catch((error: AppleSignInErrorResponse) => {
|
||||
* alert(error.code + ' ' + error.localizedDescription);
|
||||
* console.error(error);
|
||||
* });
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'Sign in with Apple',
|
||||
plugin: 'cordova-plugin-sign-in-with-apple',
|
||||
pluginRef: 'cordova.plugins.SignInWithApple',
|
||||
repo: 'https://github.com/twogate/cordova-plugin-sign-in-with-apple',
|
||||
platforms: ['iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class SignInWithApple extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Starts the authorization flows named during controller initialization
|
||||
* @see https://developer.apple.com/documentation/authenticationservices/asauthorizationcontroller/3153047-performrequests
|
||||
* @return {Promise<AppleSignInResponse>} Returns a promise when authorization succeeds
|
||||
* @param {ASAuthorizationAppleIDRequest} options
|
||||
* @throws AppleSignInErrorResponse
|
||||
*/
|
||||
@Cordova()
|
||||
signin(options: ASAuthorizationAppleIDRequest = {}): Promise<AppleSignInResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
252
src/@ionic-native/plugins/smartlook/index.ts
Normal file
252
src/@ionic-native/plugins/smartlook/index.ts
Normal file
@@ -0,0 +1,252 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
export class SmartlookSetupConfig {
|
||||
private smartlookAPIKey: string;
|
||||
private fps: number;
|
||||
|
||||
constructor(smartlookAPIKey: string, fps?: number) {
|
||||
this.smartlookAPIKey = smartlookAPIKey;
|
||||
this.fps = fps;
|
||||
}
|
||||
}
|
||||
|
||||
export class SmartlookUserIdentifier {
|
||||
private identifier: string;
|
||||
private sessionProperties: {};
|
||||
|
||||
constructor(identifier: string, sessionProperties?: {}) {
|
||||
this.identifier = identifier;
|
||||
this.sessionProperties = sessionProperties;
|
||||
}
|
||||
}
|
||||
|
||||
export class SmartlookCustomEvent {
|
||||
private name: string;
|
||||
private eventProperties: {};
|
||||
|
||||
constructor(name: string, eventProperties?: {}) {
|
||||
this.name = name;
|
||||
this.eventProperties = eventProperties;
|
||||
}
|
||||
}
|
||||
|
||||
export class SmartlookGlobalEventProperties {
|
||||
private globalEventProperties: {};
|
||||
private immutable: boolean;
|
||||
|
||||
constructor(globalEventProperties: {}, immutable: boolean) {
|
||||
this.globalEventProperties = globalEventProperties;
|
||||
this.immutable = immutable;
|
||||
}
|
||||
}
|
||||
|
||||
export class SmartlookGlobalEventProperty {
|
||||
private key: string;
|
||||
private value: string;
|
||||
private immutable: boolean;
|
||||
|
||||
constructor(key: string, value: string, immutable: boolean) {
|
||||
this.key = key;
|
||||
this.value = value;
|
||||
this.immutable = immutable;
|
||||
}
|
||||
}
|
||||
|
||||
export class SmartlookGlobalEventPropertyKey {
|
||||
private key: string;
|
||||
|
||||
constructor(key: string) {
|
||||
this.key = key;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Smartlook
|
||||
* @description
|
||||
* Official Smartlook SDK plugin.
|
||||
* Full documentation can be found here: https://smartlook.github.io/docs/sdk/ionic/
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { Smartlook, SmartlookSetupConfig } from '@ionic-native/smartlook/ngx';
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* @Component( ... )
|
||||
* export class AppComponent {
|
||||
* constructor(private smartlook: Smartlook) {
|
||||
* this.platform.ready().then(() => {
|
||||
* this.smartlook.setupAndStartRecording(new SmartlookSetupConfig("YOUR API KEY"));
|
||||
* }
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
* @classes
|
||||
* SmartlookSetupConfig
|
||||
* SmartlookUserIdentifier
|
||||
* SmartlookCustomEvent
|
||||
* SmartlookGlobalEventProperties
|
||||
* SmartlookGlobalEventProperty
|
||||
* SmartlookGlobalEventPropertyKey
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'Smartlook',
|
||||
plugin: 'https://github.com/smartlook/cordova-smartlook.git',
|
||||
pluginRef: 'cordova.plugins.SmartlookPlugin',
|
||||
repo: 'https://github.com/smartlook/cordova-smartlook.git',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class Smartlook extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Setup and start Smartlook SDK recording.
|
||||
* @param config SmartlookSetupConfig object.
|
||||
* @param config.smartlookAPIKey (required) Smartlook API key (you can obtain it in your dashboard).
|
||||
* @param config.fps (optional) recorded video framerate (allowed values 2-10 fps).
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setupAndStartRecording(config: SmartlookSetupConfig): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Setup/initialize Smartlook SDK. This method DOESN'T start the recording (@see start())
|
||||
* @param config SmartlookSetupConfig object.
|
||||
* @param config.smartlookAPIKey (required) Smartlook API key (you can obtain it in your dashboard).
|
||||
* @param config.fps (optional) recorded video framerate (allowed values 2-10 fps).
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setup(config: SmartlookSetupConfig): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Start SDK recording.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
startRecording(): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop SDK recording. Recording will start again when you call start().
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
stopRecording(): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if SDK is currently recording.
|
||||
* @return {Promise<boolean>} Returns a promise with isRecording boolean.
|
||||
*/
|
||||
@Cordova()
|
||||
isRecording(): Promise<boolean> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* When you start sensitive mode SDK records blank videos (single color) but SDK still sends analytic events.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
startFullscreenSensitiveMode(): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop sensitive mode -> SDK records video.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
stopFullscreenSensitiveMode(): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if fullscreen sensitive mode is active.
|
||||
* @return {Promise<boolean>} Returns a promise with isFullscreenSensitiveModeActive boolean.
|
||||
*/
|
||||
@Cordova()
|
||||
isFullscreenSensitiveModeActive(): Promise<boolean> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Identify user.
|
||||
* @param identifier SmartlookUserIdentifier object.
|
||||
* @param identifier.idenfier (required) id that can be used to identify user and his records.
|
||||
* You will see this Id in Smartlook dashboard so you can pair records with concrete user.
|
||||
* @param identifier.sessionProperties (optional) custom session properties object.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setUserIdentifier(identifier: SmartlookUserIdentifier): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Track custom event.
|
||||
* @param event SmartlookCustomEvent object.
|
||||
* @param event.name (required) string used to identify event.
|
||||
* @param event.eventProperties (optional) event properties object.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
trackCustomEvent(event: SmartlookCustomEvent): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Track custom event.
|
||||
* @param timedEvent SmartlookCustomEvent object.
|
||||
* @param timedEvent.name (required) string used to identify timed event.
|
||||
* @param timedEvent.eventProperties (optional) timed event properties object. These properties will
|
||||
* be merged with properties of tracked event (with lower priority).
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
startTimedCustomEvent(timedEvent: SmartlookCustomEvent): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set global event properties that will be added to every tracked event.
|
||||
* @param properties SmartlookGlobalEventProperties object.
|
||||
* @param properties.globalEventProperties (required) global event properties object.
|
||||
* @param properties.immutable (required) If set to TRUE these properties have higher priority
|
||||
* than mutable ones and also they cannot be changed (only removed).
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setGlobalEventProperties(properties: SmartlookGlobalEventProperties): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if SDK is currently recording.
|
||||
* @param property SmartlookGlobalEventProperty object.
|
||||
* @param property.key global property key.
|
||||
* @param property.value global property value.
|
||||
* @param property.immutable (required) If set to TRUE these properties have higher priority
|
||||
* than mutable ones and also they cannot be changed (only removed).
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
setGlobalEventProperty(property: SmartlookGlobalEventProperty): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove property from global event properties.
|
||||
* @param property SmartlookGlobalEventPropertyKey object.
|
||||
* @param property.key global property key.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
removeGlobalEventProperty(property: SmartlookGlobalEventPropertyKey): void {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove all properties from global event properties.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
removeAllGlobalEventProperties(): void {
|
||||
return;
|
||||
}
|
||||
}
|
||||
56
src/@ionic-native/plugins/sms-retriever/index.ts
Normal file
56
src/@ionic-native/plugins/sms-retriever/index.ts
Normal file
@@ -0,0 +1,56 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name Sms Retriever
|
||||
* @description
|
||||
* This plugin retrives the SMS which arrive without requiring READ permissions.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { SmsRetriever } from '@ionic-native/sms-retriever';
|
||||
*
|
||||
*
|
||||
* constructor(private smsRetriever: SmsRetriever) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.smsRetriever.getAppHash()
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
* this.smsRetriever.startWatching()
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'SmsRetriever',
|
||||
plugin: 'cordova-plugin-sms-retriever-manager',
|
||||
pluginRef: 'cordova.plugins.smsRetriever',
|
||||
repo: 'https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master',
|
||||
install: 'ionic cordova plugin add cordova-plugin-sms-retriever-manager --variable PLAY_SERVICES_VERSION="15.0.1"',
|
||||
installVariables: ['PLAY_SERVICES_VERSION'],
|
||||
platforms: ['Android']
|
||||
})
|
||||
@Injectable()
|
||||
export class SmsRetriever extends IonicNativePlugin {
|
||||
/**
|
||||
* This function start wathching message arrive event and retrive message text.
|
||||
* @return {Promise<string>} Returns a promise that resolves when retrives SMS text or TIMEOUT after 5 min.
|
||||
*/
|
||||
@Cordova()
|
||||
startWatching(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function is to get hash string of APP.
|
||||
* @return {Promise<string>} Returns a promise that resolves when successfully generate hash of APP.
|
||||
*/
|
||||
@Cordova()
|
||||
getAppHash(): Promise<string> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
139
src/@ionic-native/plugins/spotify-auth/index.ts
Normal file
139
src/@ionic-native/plugins/spotify-auth/index.ts
Normal file
@@ -0,0 +1,139 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* OAuth configuration data.
|
||||
*/
|
||||
export interface Config {
|
||||
/** The client ID as per the Spotify dev console. */
|
||||
clientId: string;
|
||||
|
||||
/** The redirect URI as entered in the Spotify dev console. */
|
||||
redirectUrl: string;
|
||||
|
||||
/**
|
||||
* Safety margin time (in milliseconds) for the token refresh.
|
||||
*
|
||||
* The plugin applies a safety margin to the token lifetime in order
|
||||
* to give the token user enough time to perform all operations needed.
|
||||
*
|
||||
* Otherwise the plugin might hand out a token that is already expired
|
||||
* before it could ever be used.
|
||||
*
|
||||
* The safety margin defaults to 30s.
|
||||
*/
|
||||
refreshSafetyMargin?: number;
|
||||
|
||||
/** Requested OAuth scopes. */
|
||||
scopes: string[];
|
||||
|
||||
/** The token exchange URL. */
|
||||
tokenExchangeUrl: string;
|
||||
|
||||
/** The token refresh URL. */
|
||||
tokenRefreshUrl: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* The authorization data.
|
||||
*/
|
||||
export interface AuthorizationData {
|
||||
/** A valid access token. */
|
||||
accessToken: string;
|
||||
|
||||
/** The encrypted refresh token. */
|
||||
encryptedRefreshToken: string;
|
||||
|
||||
/** The date (from UTC, in milliseconds) when the given access token expires. */
|
||||
expiresAt: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name Spotify Auth
|
||||
* @description
|
||||
* Cordova plugin for authenticating with Spotify
|
||||
* > https://github.com/Festify/cordova-spotify-oauth
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { SpotifyAuth } from '@ionic-native/spotify-auth';
|
||||
*
|
||||
* // [...]
|
||||
*
|
||||
* constructor(private spotifyAuth: SpotifyAuth) { }
|
||||
*
|
||||
* // [...]
|
||||
*
|
||||
* const config = {
|
||||
* clientId: "<SPOTIFY CLIENT ID>",
|
||||
* redirectUrl: "<REDIRECT URL, MUST MATCH WITH AUTH ENDPOINT AND SPOTIFY DEV CONSOLE>",
|
||||
* scopes: ["streaming"], // see Spotify Dev console for all scopes
|
||||
* tokenExchangeUrl: "<URL OF TOKEN EXCHANGE HTTP ENDPOINT>",
|
||||
* tokenRefreshUrl: "<URL OF TOKEN REFRESH HTTP ENDPOINT>",
|
||||
* };
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.spotifyAuth.authorize(config)
|
||||
* .then(({ accessToken, expiresAt }) => {
|
||||
* console.log(`Got an access token, its ${accessToken}!`);
|
||||
* console.log(`Its going to expire in ${expiresAt - Date.now()}ms.`);
|
||||
* });
|
||||
*
|
||||
* // [...]
|
||||
*
|
||||
* this.spotifyAuth.forget().then(() => console.log("We're logged out!"));
|
||||
*
|
||||
* // [...]
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'SpotifyAuth',
|
||||
plugin: 'cordova-spotify-oauth',
|
||||
pluginRef: 'cordova.plugins.spotifyAuth',
|
||||
repo: 'https://github.com/Festify/cordova-spotify-oauth',
|
||||
install: 'ionic cordova plugin add cordova-spotify-oauth --variable LOCAL_STORAGE_KEY="SpotifyOAuthData"',
|
||||
installVariables: ['LOCAL_STORAGE_KEY'],
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class SpotifyAuth extends IonicNativePlugin {
|
||||
/**
|
||||
* Obtains valid authorization data.
|
||||
*
|
||||
* This method performs the necessary steps in order to obtain a valid
|
||||
* access token. It performs the OAuth dance prompting the user to log in,
|
||||
* exchanges the obtained authorization code for an access and a refresh
|
||||
* token, caches those, and returns both to the developer.
|
||||
*
|
||||
* When it is invoked again, it will first check whether the cached access
|
||||
* token is still valid (including a configurable safety margin) and the
|
||||
* scopes equal, and return the token directly if that is the case. Otherwise,
|
||||
* the method will transparently refresh the token (or obtain a new one if
|
||||
* the scopes changed) and return that.
|
||||
*
|
||||
* Bottom line - always call this if you need a valid access token in your code.
|
||||
*
|
||||
* @param cfg {Config} configuration
|
||||
* @return {Promise<AuthorizationData>}
|
||||
*/
|
||||
@Cordova({
|
||||
sync: false
|
||||
})
|
||||
authorize(cfg: Config): Promise<AuthorizationData> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all cached data so that `authorize` performs the full
|
||||
* oauth dance again.
|
||||
*
|
||||
* This is akin to a "logout".
|
||||
*
|
||||
* @return {void}
|
||||
*/
|
||||
@Cordova({
|
||||
sync: true
|
||||
})
|
||||
forget(): void { }
|
||||
}
|
||||
74
src/@ionic-native/plugins/ssh-connect/index.ts
Normal file
74
src/@ionic-native/plugins/ssh-connect/index.ts
Normal file
@@ -0,0 +1,74 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
/**
|
||||
* @name SSH Connect
|
||||
* @description
|
||||
* Cordova plugin to make connections and execute commands through SSH
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { SSHConnect } from '@ionic-native/ssh-connect/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private sshConnect: SSHConnect) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.sshConnect.connect('user', 'password', 'host', port)
|
||||
* .then(resp => console.log(resp))
|
||||
* .catch(error => console.error(error));
|
||||
*
|
||||
* this.sshConnect.executeCommand('command')
|
||||
* .then(resp => console.log(resp))
|
||||
* .catch(error => console.error(error));
|
||||
*
|
||||
* this.sshConnect.disconnect()
|
||||
* .then(resp => console.log(resp))
|
||||
* .catch(error => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'SSHConnect',
|
||||
plugin: 'cordova-plugin-ssh-connect',
|
||||
pluginRef: 'cordova.plugins.sshConnect',
|
||||
repo: 'https://github.com/JosePerez27/cordova-plugin-ssh-connect',
|
||||
platforms: ['Android']
|
||||
})
|
||||
@Injectable()
|
||||
export class SSHConnect extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Establish a remote ssh connection
|
||||
* @param {user} user The remote host user
|
||||
* @param {password} password The remote host password
|
||||
* @param {host} host The remote device to connect
|
||||
* @param {port} port The SSH port for connection (usually port 22)
|
||||
* @return {Promise<any>} Returns an promise that resolves with the success of the connection
|
||||
*/
|
||||
@Cordova()
|
||||
connect(user: string, password: string, host: string, port: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a command on the remote host connected by ssh
|
||||
* @param {command} command The command to execute
|
||||
* @return {Promise<any>} Returns an promise that resolves with the printed text on the remote console
|
||||
*/
|
||||
@Cordova()
|
||||
executeCommand(command: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Disconnect the SSH session
|
||||
* @return {Promise<any>} Returns an promise that resolves with the success of the disconnection
|
||||
*/
|
||||
@Cordova()
|
||||
disconnect(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
213
src/@ionic-native/plugins/sum-up/index.ts
Normal file
213
src/@ionic-native/plugins/sum-up/index.ts
Normal file
@@ -0,0 +1,213 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
export interface SumUpResponse {
|
||||
// Code to identify the message
|
||||
code: number;
|
||||
|
||||
// Message for readable usage
|
||||
message: string;
|
||||
}
|
||||
|
||||
export interface SumUpLoginStatus {
|
||||
// Code, to check if an error occured
|
||||
code: number;
|
||||
|
||||
// Booleand value whether the user is logged in or not
|
||||
isLoggedIn: boolean;
|
||||
}
|
||||
|
||||
export interface SumUpPayment {
|
||||
// Unique transaction code
|
||||
transaction_code: string;
|
||||
|
||||
// Card type -> like MAESTRO
|
||||
card_type: string;
|
||||
|
||||
// Merchant code for identification
|
||||
merchant_code: string;
|
||||
|
||||
// Amount of the payment
|
||||
amount: number;
|
||||
|
||||
// Tip amount -> default 0
|
||||
tip_amount: number;
|
||||
|
||||
// Vat amount -> default 0
|
||||
vat_amount: number;
|
||||
|
||||
// Currency code -> like EUR
|
||||
currency: string;
|
||||
|
||||
// Payment status -> successful or error
|
||||
status: string;
|
||||
|
||||
// Type -> Card or nfc
|
||||
payment_type: string;
|
||||
|
||||
// Entry mode -> Like chip or contactless
|
||||
entry_mode: string;
|
||||
|
||||
// Number of installments -> default 1
|
||||
installments: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @hidden
|
||||
*/
|
||||
export class SumUpKeys {
|
||||
|
||||
// The generated accessToken, to automate the login process
|
||||
accessToken: string;
|
||||
|
||||
// affiliateKey can also be set in the object, if it has to be changed on runtime
|
||||
affiliateKey: string;
|
||||
|
||||
constructor() {
|
||||
this.accessToken = '';
|
||||
this.affiliateKey = '';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @name SumUp
|
||||
* @description
|
||||
* Plugin to communicate with a SumUp payment terminal
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { SumUp } from '@ionic-native/sum-up';
|
||||
*
|
||||
*
|
||||
* constructor(private sumUp: SumUp) { }
|
||||
*
|
||||
* const sumUpKeys: SumUpKeys = new SumUpKeys();
|
||||
* sumUpKeys.affiliateKey = 'YOUR_API_KEY'; // if not provided in installation
|
||||
* sumUpKeys.accessToken = 'YOUR_ACCESS_TOKEN';
|
||||
*
|
||||
* this.sumUp.login(sumUpKeys)
|
||||
* .then((res: SumUpResponse) => console.log(res))
|
||||
* .catch((error: SumUpResponse) => console.error(error));
|
||||
*
|
||||
* this.sumUp.auth('YOUR_ACCESS_TOKEN')
|
||||
* .then((res: SumUpResponse) => console.log(res))
|
||||
* .catch((error: SumUpResponse) => console.error(error));
|
||||
*
|
||||
* this.sumUp.getSettings()
|
||||
* .then((res: SumUpResponse) => console.log(res))
|
||||
* .catch((error: SumUpResponse) => console.error(error));
|
||||
*
|
||||
* this.sumUp.logout()
|
||||
* .then((res: SumUpResponse) => console.log(res))
|
||||
* .catch((error: SumUpResponse) => console.error(error));
|
||||
*
|
||||
* this.sumUp.isLoggedIn()
|
||||
* .then((res: SumUpLoginStatus) => console.log(res))
|
||||
* .catch((error: SumUpLoginStatus) => console.error(error));
|
||||
*
|
||||
* this.sumUp.prepare()
|
||||
* .then((res: SumUpResponse) => console.log(res))
|
||||
* .catch((error: SumUpResponse) => console.error(error));
|
||||
*
|
||||
* this.sumUp.closeConnection()
|
||||
* .then((res: SumUpResponse) => console.log(res))
|
||||
* .catch((error: SumUpResponse) => console.error(error));
|
||||
*
|
||||
* this.sumUp.pay(10.0, 'EUR')
|
||||
* .then((res: SumUpPayment) => console.log(res))
|
||||
* .catch((error: SumUpPayment) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'SumUp',
|
||||
plugin: 'cordova-sumup-plugin',
|
||||
pluginRef: 'window.SumUp',
|
||||
repo: 'https://github.com/mariusbackes/cordova-plugin-sumup',
|
||||
install:
|
||||
'cordova plugin add cordova-sumup-plugin --variable SUMUP_API_KEY=INSERT_YOUR_KEY',
|
||||
installVariables: ['SUMUP_API_KEY'],
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class SumUp extends IonicNativePlugin {
|
||||
/**
|
||||
* Login a user with an optional access token.
|
||||
* If the access token is provided and valid, the user is logged in autmatically.
|
||||
* Otherwise the user has to type in the credentials
|
||||
* @param sumUpKeys {SumUpKeys}
|
||||
* @return {Promise<SumUpResponse>} Return a SumUpResponse object
|
||||
*/
|
||||
@Cordova()
|
||||
login(sumUpKeys: SumUpKeys): Promise<SumUpResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authenticates the account with the given access token. Parameter accessToken is required.
|
||||
* @param accessToken {string}
|
||||
* @return {Promise<SumUpResponse>} Return a SumUpResponse object
|
||||
*/
|
||||
@Cordova()
|
||||
auth(accessToken: string): Promise<SumUpResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens a new window with the all account settings of an logged in user.
|
||||
* @return {Promise<SumUpResponse>} Return a SumUpResponse object
|
||||
*/
|
||||
@Cordova()
|
||||
getSettings(): Promise<SumUpResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Logout a user from the account.
|
||||
* @return {Promise<SumUpResponse>} Return a SumUpResponse object
|
||||
*/
|
||||
@Cordova()
|
||||
logout(): Promise<SumUpResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the user is logged in or not and returns an object with the field isLoggedIn which is a boolean value.
|
||||
* @return {Promise<SumUpResponse>} Return a SumUpResponse object
|
||||
*/
|
||||
@Cordova()
|
||||
isLoggedIn(): Promise<SumUpLoginStatus> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepares the terminal for a payment. Checks whether the CardReader is ready to transmit and
|
||||
* if an instance of the CardReaderManager is available.
|
||||
* @return {Promise<SumUpResponse>} Return a SumUpResponse object
|
||||
*/
|
||||
@Cordova()
|
||||
prepare(): Promise<SumUpResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tries to close the connection to the card terminal.
|
||||
* @return {Promise<SumUpResponse>} Return a SumUpResponse object
|
||||
*/
|
||||
@Cordova()
|
||||
closeConnection(): Promise<SumUpResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens a native SumUp window to proceed a payment. Parameter amount and currencycode are required.
|
||||
* If the Payment was successful it returns an SumUpPayment object with information about the payment.
|
||||
* @param amount {number}
|
||||
* @param currencycode {string}
|
||||
* @return {Promise<SumUpResponse>} Return a SumUpResponse object
|
||||
*/
|
||||
@Cordova()
|
||||
pay(amount: number, currencycode: string): Promise<SumUpPayment> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
72
src/@ionic-native/plugins/theme-detection/index.ts
Normal file
72
src/@ionic-native/plugins/theme-detection/index.ts
Normal file
@@ -0,0 +1,72 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
export interface ThemeDetectionResponse {
|
||||
// Boolean value about the status of the request
|
||||
value: boolean;
|
||||
|
||||
// Message for readable usage
|
||||
message: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @beta
|
||||
* @name Theme Detection
|
||||
* @description
|
||||
* Cordova plugin to detect whether dark mode is enabled or not
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { ThemeDetection } from '@ionic-native/theme-detection';
|
||||
*
|
||||
*
|
||||
* constructor(private themeDetection: ThemeDetection) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.themeDetection.isAvailable()
|
||||
* .then((res: ThemeDetectionResponse) => {
|
||||
* if(res.value) {
|
||||
* this.themeDetection.isDarkModeEnabled().then((res: ThemeDetectionResponse) => {
|
||||
* console.log(res);
|
||||
* })
|
||||
* .catch((error: any) => console.error(error));
|
||||
* }
|
||||
* })
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'ThemeDetection',
|
||||
plugin: 'cordova-plugin-theme-detection',
|
||||
pluginRef: 'cordova.plugins.ThemeDetection',
|
||||
repo: 'https://github.com/mariusbackes/cordova-plugin-theme-detection',
|
||||
install: 'cordova plugin add cordova-plugin-theme-detection',
|
||||
installVariables: [],
|
||||
platforms: ['iOS', 'Android']
|
||||
})
|
||||
@Injectable()
|
||||
export class ThemeDetection extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<ThemeDetectionResponse>}
|
||||
* Returns a promise with an object that has a boolean property which gives information if the detection is available or not
|
||||
*/
|
||||
@Cordova()
|
||||
isAvailable(): Promise<ThemeDetectionResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<ThemeDetectionResponse>}
|
||||
* Returns a promise with an object that has a boolean property which gives information if dark mode is enabled or not
|
||||
*/
|
||||
@Cordova()
|
||||
isDarkModeEnabled(): Promise<ThemeDetectionResponse> {
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
1331
src/@ionic-native/plugins/unvired-cordova-sdk/index.ts
Normal file
1331
src/@ionic-native/plugins/unvired-cordova-sdk/index.ts
Normal file
File diff suppressed because it is too large
Load Diff
819
src/@ionic-native/plugins/urbanairship/index.ts
Normal file
819
src/@ionic-native/plugins/urbanairship/index.ts
Normal file
@@ -0,0 +1,819 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
export interface TagGroupEditor {
|
||||
addTags(): void;
|
||||
removeTags(): void;
|
||||
apply(): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enum for notification types.
|
||||
* @readonly
|
||||
* @enum {number}
|
||||
*/
|
||||
export enum NotificationType {
|
||||
none = 0,
|
||||
badge = 1,
|
||||
sound = 2,
|
||||
alert = 4
|
||||
}
|
||||
|
||||
/**
|
||||
* Enum for presentation options.
|
||||
* @readonly
|
||||
* @enum {number}
|
||||
*/
|
||||
export enum PresentationOptions {
|
||||
none = 0,
|
||||
badge = 1,
|
||||
sound = 2,
|
||||
alert = 4
|
||||
}
|
||||
|
||||
/**
|
||||
* @name UrbanAirShip
|
||||
* @description
|
||||
* This plugin does something
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { UrbanAirShip } from '@ionic-native/urbanairship/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private urbanAirShip: UrbanAirShip) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
*
|
||||
* this.urbanAirShip.takeOff(config)
|
||||
* .then((res: any) => console.log(res))
|
||||
* .catch((error: any) => console.error(error));
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'UrbanAirShip',
|
||||
plugin: 'urbanairship-cordova',
|
||||
pluginRef: 'window.UAirship',
|
||||
repo: 'https://www.npmjs.com/package/urbanairship-cordova',
|
||||
install: 'ionic cordova plugin add urbanairship-cordova',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class UrbanAirShip extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Re-attaches document event listeners in this webview
|
||||
*/
|
||||
@Cordova()
|
||||
reattach(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initailizes Urban Airship.
|
||||
*
|
||||
* The plugin will automatically call takeOff during the next app init in
|
||||
* order to properly handle incoming push. If takeOff is called multiple times
|
||||
* in a session, or if the config is different than the previous sesssion, the
|
||||
* new config will not be used until the next app start.
|
||||
*
|
||||
* @param {object} config The Urban Airship config.
|
||||
* @param {object} config.development The Urban Airship development config.
|
||||
* @param {string} config.development.appKey The development appKey.
|
||||
* @param {string} config.development.appSecret The development appSecret.
|
||||
* @param {object} config.production The Urban Airship production config.
|
||||
* @param {string} config.production.appKey The production appKey.
|
||||
* @param {string} config.production.appSecret The production appSecret.
|
||||
*/
|
||||
@Cordova()
|
||||
takeOff(config: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the Android notification config. Values not set will fallback to any values set in the config.xml.
|
||||
*
|
||||
* @param {object} config The notification config.
|
||||
* @param {string} [config.icon] The name of the drawable resource to use as the notification icon.
|
||||
* @param {string} [config.largeIcon] The name of the drawable resource to use as the notification large icon.
|
||||
* @param {string} [config.accentColor] The notification accent color. Format is #AARRGGBB.
|
||||
*/
|
||||
@Cordova()
|
||||
setAndroidNotificationConfig(config: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the default behavior when the message center is launched from a push
|
||||
* notification. If set to false the message center must be manually launched.
|
||||
*
|
||||
* @param {boolean} enabled true to automatically launch the default message center, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setAutoLaunchDefaultMessageCenter(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables or disables user notifications.
|
||||
*
|
||||
* @param {boolean} enabled true to enable notifications, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setUserNotificationsEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if user notifications are enabled or not.
|
||||
*
|
||||
* @param {function(enabled)} success Success callback.
|
||||
* @param {boolean} success.enabled Flag indicating if user notifications is enabled or not.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isUserNotificationsEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if app notifications are enabled or not. Its possible to have `userNotificationsEnabled`
|
||||
* but app notifications being disabled if the user opted out of notifications.
|
||||
*
|
||||
* @param {function(enabled)} success Success callback.
|
||||
* @param {boolean} success.enabled Flag indicating if app notifications is enabled or not.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isAppNotificationsEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the channel ID.
|
||||
*
|
||||
* @param {function(ID)} success The function to call on success.
|
||||
* @param {string} success.ID The channel ID string
|
||||
* @param {failureCallback} [failure] The function to call on failure.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getChannelID(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the last notification that launched the application.
|
||||
*
|
||||
* @param {Boolean} clear true to clear the notification.
|
||||
* @param {function(push)} success The function to call on success.
|
||||
* @param {object} success.push The push message object containing data associated with a push notification.
|
||||
* @param {string} success.push.message The push alert message.
|
||||
* @param {object} success.push.extras Any push extras.
|
||||
* @param {number} [success.push.notification_id] The Android notification ID.
|
||||
* @param {failureCallback} [failure] The function to call on failure.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getLaunchNotification(clear: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the last received deep link.
|
||||
*
|
||||
* @param {Boolean} clear true to clear the deep link.
|
||||
* @param {function(push)} success The function to call on success.
|
||||
* @param {string} success.deepLink The deep link.
|
||||
* @param {failureCallback} [failure] The function to call on failure.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getDeepLink(clear: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the tags as an array.
|
||||
*
|
||||
* @param {function(tags)} success The function to call on success.
|
||||
* @param {array} success.tags The tags as an array.
|
||||
* @param {failureCallback} [failure] The function to call on failure.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getTags(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the tags.
|
||||
*
|
||||
* @param {Array} tags an array of strings.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setTags(tags: string[]): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the alias.
|
||||
*
|
||||
* @deprecated Deprecated since 6.7.0 - to be removed in a future version of the plugin - please use getNamedUser
|
||||
*
|
||||
* @param {function(currentAlias)} success The function to call on success.
|
||||
* @param {string} success.currentAlias The alias as a string.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getAlias(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the alias.
|
||||
*
|
||||
* @deprecated Deprecated since 6.7.0 - to be removed in a future version of the plugin - please use setNamedUser
|
||||
*
|
||||
* @param {String} alias string
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setAlias(alias: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if quiet time is enabled or not.
|
||||
*
|
||||
* @param {function(enabled)} success Success callback.
|
||||
* @param {boolean} success.enabled Flag indicating if quiet time is enabled or not.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isQuietTimeEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables or disables quiet time.
|
||||
*
|
||||
* @param {Boolean} enabled true to enable quiet time, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setQuietTimeEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the device is currently in quiet time.
|
||||
*
|
||||
* @param {function(inQuietTime)} success Success callback.
|
||||
* @param {boolean} success.inQuietTime Flag indicating if quiet time is currently in effect.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isInQuietTime(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the quiet time as an object with the following:
|
||||
* "startHour": Number,
|
||||
* "startMinute": Number,
|
||||
* "endHour": Number,
|
||||
* "endMinute": Number
|
||||
*
|
||||
* @param {function(quietTime)} success The function to call on success.
|
||||
* @param {object} success.quietTime The quietTime object represents a timespan during
|
||||
* which notifications should be silenced.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getQuietTime(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the quiet time.
|
||||
*
|
||||
* @param {Number} startHour for quiet time.
|
||||
* @param {Number} startMinute for quiet time.
|
||||
* @param {Number} endHour for quiet time.
|
||||
* @param {Number} endMinute for quiet time.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setQuietTime(startHour: number, startMinute: number, endHour: number, endMinute: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables or disables analytics.
|
||||
*
|
||||
* Disabling analytics will delete any locally stored events
|
||||
* and prevent any events from uploading. Features that depend on analytics being
|
||||
* enabled may not work properly if it's disabled (reports, region triggers,
|
||||
* location segmentation, push to local time).
|
||||
*
|
||||
* @param {Boolean} enabled true to enable analytics, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setAnalyticsEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if analytics is enabled or not.
|
||||
*
|
||||
* @param {function(enabled)} success Success callback.
|
||||
* @param {boolean} success.enabled Flag indicating if analytics is enabled or not.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isAnalyticsEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the named user ID.
|
||||
*
|
||||
* @param {function(namedUser)} success The function to call on success.
|
||||
* @param {string} success.namedUser The named user ID as a string.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getNamedUser(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the named user ID.
|
||||
*
|
||||
* @param {String} namedUser identifier string.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setNamedUser(namedUser: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs an Urban Airship action.
|
||||
*
|
||||
* @param {String} actionName action as a string.
|
||||
* @param {*} actionValue
|
||||
* @param {function(result)} [success] The function to call on success.
|
||||
* @param {object} success.result The result's value.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
runAction(actionName: string, actionValue: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an editor to modify the named user tag groups.
|
||||
*
|
||||
* @return {TagGroupEditor} A tag group editor instance.
|
||||
*/
|
||||
@Cordova()
|
||||
editNamedUserTagGroups(): TagGroupEditor {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an editor to modify the channel tag groups.
|
||||
*
|
||||
* @return {TagGroupEditor} A tag group editor instance.
|
||||
*/
|
||||
@Cordova()
|
||||
editChannelTagGroups(): TagGroupEditor {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets an associated identifier for the Connect data stream.
|
||||
*
|
||||
* @param key Custom key for identifier.
|
||||
* @param identifier The identifier value.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setAssociatedIdentifier(key: string, identifier: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
// Location
|
||||
|
||||
/**
|
||||
* Enables or disables Urban Airship location services.
|
||||
*
|
||||
* @param {Boolean} enabled true to enable location, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setLocationEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if location is enabled or not.
|
||||
*
|
||||
* @param {function(enabled)} success Success callback.
|
||||
* @param {boolean} success.enabled Flag indicating if location is enabled or not.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isLocationEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables or disables background location.
|
||||
*
|
||||
* @param {Boolean} enabled true to enable background location, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setBackgroundLocationEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if background location is enabled or not.
|
||||
*
|
||||
* @param {function(enabled)} success Success callback.
|
||||
* @param {boolean} success.enabled Flag indicating if background location updates are enabled or not.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isBackgroundLocationEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays the message center.
|
||||
*
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
displayMessageCenter(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dismiss the message center.
|
||||
*
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
dismissMessageCenter(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dismiss the inbox message.
|
||||
*
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
dismissInboxMessage(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dismiss the inbox message in the overlay.
|
||||
*
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
dismissOverlayInboxMessage(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the array of inbox messages. Each message will have the following properties:
|
||||
* "id": string - The messages ID. Needed to display, mark as read, or delete the message.
|
||||
* "title": string - The message title.
|
||||
* "sentDate": number - The message sent date in milliseconds.
|
||||
* "listIconUrl": string, optional - The icon url for the message.
|
||||
* "isRead": boolean - The unread/read status of the message.
|
||||
* "extras": object - String to String map of any message extras.
|
||||
*
|
||||
* @param {function(messages)} success The function to call on success.
|
||||
* @param {array} success.messages The array of inbox messages.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getInboxMessages(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Marks an inbox message read.
|
||||
*
|
||||
* @param {String} messageId The ID of the message to mark as read.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
markInboxMessageRead(messageId: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes an inbox message.
|
||||
*
|
||||
* @param {String} messageId The ID of the message to delete.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
deleteInboxMessage(messageId: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays the inbox message using a full screen view.
|
||||
*
|
||||
* @param {String} messageId The ID of the message to display.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
displayInboxMessage(messageId: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Forces the inbox to refresh. This is normally not needed as the inbox
|
||||
* will automatically refresh on foreground or when a push arrives thats
|
||||
* associated with a message, but it can be useful when providing a refresh
|
||||
* button for the message listing.
|
||||
*
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
refreshInbox(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays the inbox message using an overlay display.
|
||||
*
|
||||
* @param {String} messageId The ID of the message to display.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
overlayInboxMessage(messageId: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears a notification by identifier.
|
||||
*
|
||||
* @param {string} identifier The notification identifier.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
*/
|
||||
@Cordova()
|
||||
clearNotification(identifier: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all notifications posted by the application.
|
||||
*
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
clearNotifications(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets currently active notifications.
|
||||
*
|
||||
* Note: On Android this functionality is only supported on Android M or higher.
|
||||
*
|
||||
* @param {function(messages)} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
*/
|
||||
@Cordova()
|
||||
getActiveNotifications(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
// iOS only
|
||||
|
||||
/**
|
||||
* Enables or disables auto badge. Defaults to `NO`.
|
||||
*
|
||||
* @param {Boolean} enabled true to enable auto badge, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setAutobadgeEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the badge number.
|
||||
*
|
||||
* @param count number specified badge to set.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setBadgeNumber(count: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current badge number.
|
||||
*
|
||||
* @param {function(badgeNumber)} success The function to call on success.
|
||||
* @param {int} success.badgeNumber The current application badge number.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
getBadgeNumber(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears the badge.
|
||||
*
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
resetBadge(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the iOS notification types. Specify the combination of
|
||||
* badges, sound and alerts that are desired.
|
||||
*
|
||||
* @param types specified notification types.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setNotificationTypes(types: NotificationType): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the iOS presentation options. Specify the combination of
|
||||
* badges, sound and alerts that are desired.
|
||||
*
|
||||
* @param options types specified presentation options.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setPresentationOptions(options: PresentationOptions): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
// Android only
|
||||
|
||||
/**
|
||||
* Checks if notification sound is enabled or not.
|
||||
*
|
||||
* @param {function(enabled)} success Success callback.
|
||||
* @param {boolean} success.enabled Flag indicating if sound is enabled or not.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isSoundEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables or disables notification sound.
|
||||
*
|
||||
* @param {Boolean} enabled true to enable sound, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setSoundEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if notification vibration is enabled or not.
|
||||
*
|
||||
* @param {function(enabled)} success Success callback.
|
||||
* @param {boolean} success.enabled Flag indicating if vibration is enabled or not.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
isVibrateEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables or disables notification vibration.
|
||||
*
|
||||
* @param {Boolean} enabled true to enable vibration, false to disable.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
setVibrateEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a custom event.
|
||||
*
|
||||
* @param {object} event The custom event object.
|
||||
* @param {string} event.name The event's name.
|
||||
* @param {number} [event.value] The event's value.
|
||||
* @param {string} [event.transactionId] The event's transaction ID.
|
||||
* @param {object} [event.properties] The event's properties. Only numbers, booleans, strings, and array of strings are supported.
|
||||
* @param {function} [success] Success callback.
|
||||
* @param {function(message)} [failure] Failure callback.
|
||||
* @param {string} failure.message The error message.
|
||||
*/
|
||||
@Cordova()
|
||||
addCustomEvent(event: object): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -4,7 +4,8 @@ import { Observable } from 'rxjs';
|
||||
|
||||
export interface Response {
|
||||
status: number;
|
||||
body: string;
|
||||
body?: string;
|
||||
path?: string;
|
||||
headers: { [key: string]: string};
|
||||
}
|
||||
|
||||
|
||||
210
src/@ionic-native/plugins/web-socket-server/index.ts
Normal file
210
src/@ionic-native/plugins/web-socket-server/index.ts
Normal file
@@ -0,0 +1,210 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
declare const window: any;
|
||||
|
||||
export interface WebSocketInterfaces {
|
||||
[key: string]: WebSocketInterface;
|
||||
}
|
||||
|
||||
export interface WebSocketInterface {
|
||||
ipv4Addresses: string[];
|
||||
ipv6Addresses: string[];
|
||||
}
|
||||
|
||||
export interface WebSocketOptions {
|
||||
origins?: string[];
|
||||
protocols?: string[];
|
||||
tcpNoDelay?: boolean;
|
||||
}
|
||||
|
||||
export interface WebSocketIdentifier {
|
||||
uuid: string;
|
||||
}
|
||||
|
||||
export interface WebSocketServerDetails {
|
||||
addr: string;
|
||||
port: number;
|
||||
}
|
||||
|
||||
export interface WebSocketFailure extends WebSocketServerDetails {
|
||||
reason: string;
|
||||
}
|
||||
|
||||
export interface WebSocketMessage {
|
||||
conn: WebSocketConnection;
|
||||
msg: string;
|
||||
}
|
||||
|
||||
export interface WebSocketClose {
|
||||
conn: WebSocketConnection;
|
||||
code: number;
|
||||
reason: string;
|
||||
wasClean: boolean;
|
||||
}
|
||||
|
||||
export interface WebSocketConnection extends WebSocketIdentifier {
|
||||
remoteAttr: string;
|
||||
state: 'open' | 'closed';
|
||||
httpFields: HttpFields;
|
||||
resource: string;
|
||||
}
|
||||
|
||||
export interface HttpFields {
|
||||
'Accept-Encoding': string;
|
||||
'Accept-Language': string;
|
||||
'Cache-Control': string;
|
||||
Connection: string;
|
||||
Host: string;
|
||||
Origin: string;
|
||||
Pragma: string;
|
||||
'Sec-WebSocket-Extensions': string;
|
||||
'Sec-WebSocket-Key': string;
|
||||
'Sec-WebSocket-Version': string;
|
||||
Upgrade: string;
|
||||
'User-Agent': string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name WebSocket Server
|
||||
* @description
|
||||
* This plugin allows you to run a single, lightweight, barebone WebSocket Server.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { WebSocketServer } from '@ionic-native/web-socket-server';
|
||||
*
|
||||
* constructor(private wsserver: WebSocketServer) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* // start websocket server
|
||||
* this.wsserver.start(8888, {}).subscribe({
|
||||
* next: server => console.log(`Listening on ${server.addr}:${server.port}`),
|
||||
* error: error => console.log(`Unexpected error`, error);
|
||||
* });
|
||||
*
|
||||
* // watch for any messages
|
||||
* this.wsserver.watchMessage().subscribe(result => {
|
||||
* console.log(`Received message ${result.msg} from ${result.conn.uuid}`);
|
||||
* });
|
||||
*
|
||||
* // send message to connection with specified uuid
|
||||
* this.wsserver.send({ uuid: '8e7c4f48-de68-4b6f-8fca-1067a353968d' }, 'Hello World');
|
||||
*
|
||||
* // stop websocket server
|
||||
* this.wsserver.stop().then(server => {
|
||||
* console.log(`Stop listening on ${server.addr}:${server.port}`);
|
||||
* });
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'WebSocketServer',
|
||||
plugin: 'cordova-plugin-websocket-server',
|
||||
pluginRef: 'cordova.plugins.wsserver',
|
||||
repo: 'https://github.com/becvert/cordova-plugin-websocket-server',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class WebSocketServer extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Return this device's interfaces
|
||||
* @return {Promise<WebSocketInterfaces>}
|
||||
*/
|
||||
@Cordova()
|
||||
getInterfaces(): Promise<WebSocketInterfaces> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Start websocket server
|
||||
* @param port {number} Local port on which the service runs. (0 means any free port)
|
||||
* @param options {WebSocketOptions} Additional options for websocket
|
||||
* @return {Observable<WebSocketServerDetails>} Returns Observable where all generic error can be catched (mostly JSONExceptions)
|
||||
*/
|
||||
@Cordova({
|
||||
observable: true,
|
||||
clearFunction: 'stop'
|
||||
})
|
||||
start(port: number, options: WebSocketOptions): Observable<WebSocketServerDetails> {
|
||||
return;
|
||||
}
|
||||
|
||||
private onFunctionToObservable<T>(fnName: string) {
|
||||
return new Observable<T>(observer => {
|
||||
const id = window.cordova.plugins.wsserver[fnName](
|
||||
observer.next.bind(observer),
|
||||
observer.error.bind(observer)
|
||||
);
|
||||
|
||||
return () => window.cordova.plugins.wsserver.removeCallback(id);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Watches for new messages
|
||||
* @return {Observable<WebSocketMessage>}
|
||||
*/
|
||||
watchMessage(): Observable<WebSocketMessage> {
|
||||
return this.onFunctionToObservable('onMessage');
|
||||
}
|
||||
|
||||
/**
|
||||
* Watches for new opened connections
|
||||
* @return {Observable<WebSocketConnection>}
|
||||
*/
|
||||
watchOpen(): Observable<WebSocketConnection> {
|
||||
return this.onFunctionToObservable('onOpen');
|
||||
}
|
||||
|
||||
/**
|
||||
* Watches for closed connections
|
||||
* @return {Observable<WebSocketClose>}
|
||||
*/
|
||||
watchClose(): Observable<WebSocketClose> {
|
||||
return this.onFunctionToObservable('onClose');
|
||||
}
|
||||
|
||||
/**
|
||||
* Watches for any websocket failures
|
||||
* @return {Observable<WebSocketFailure>}
|
||||
*/
|
||||
watchFailure(): Observable<WebSocketFailure> {
|
||||
return this.onFunctionToObservable('onFailure');
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop websocket server and closes all connections
|
||||
* @return {Promise<WebSocketServerDetails>}
|
||||
*/
|
||||
@Cordova()
|
||||
stop(): Promise<WebSocketServerDetails> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Send Message to a connected device
|
||||
* @param conn {WebSocketIdentifier} Connection to send message to
|
||||
* @param msg {string} Message to send
|
||||
* @return {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
send(conn: WebSocketIdentifier, msg: string): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Close specific connection using uuid
|
||||
* @param conn {WebSocketIdentifier} Connection to close
|
||||
* @param code {number} Close code, determines if it was clean
|
||||
* @param reason {string} Reason for closing
|
||||
* @return {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
close(conn: WebSocketIdentifier, code: number, reason: string): Promise<void> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -92,6 +92,7 @@ export class Wechat extends IonicNativePlugin {
|
||||
* this.wechat.auth.then((res) => { alert(res.code); });
|
||||
* </code>
|
||||
*/
|
||||
@Cordova()
|
||||
auth(scope: any, state: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
@@ -116,6 +117,7 @@ export class Wechat extends IonicNativePlugin {
|
||||
* });
|
||||
* </code>
|
||||
*/
|
||||
@Cordova()
|
||||
sendPaymentRequest(params: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
@@ -143,6 +145,7 @@ export class Wechat extends IonicNativePlugin {
|
||||
* });
|
||||
* </code>
|
||||
*/
|
||||
@Cordova()
|
||||
jumpToWechat(url: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
@@ -160,6 +163,7 @@ export class Wechat extends IonicNativePlugin {
|
||||
* });
|
||||
* </code>
|
||||
*/
|
||||
@Cordova()
|
||||
chooseInvoiceFromWX(params: any): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
878
src/@ionic-native/plugins/wifi-wizard-2/index.ts
Normal file
878
src/@ionic-native/plugins/wifi-wizard-2/index.ts
Normal file
@@ -0,0 +1,878 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, CordovaFunctionOverride, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||||
|
||||
export interface WifiConfig {
|
||||
SSID: string;
|
||||
isHiddenSSID: boolean;
|
||||
auth: {
|
||||
algorithm: string;
|
||||
password?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface WifiScanResultsOptions {
|
||||
numLevels: number;
|
||||
}
|
||||
|
||||
export interface WifiScanOptions extends WifiScanResultsOptions {
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name WifiWizard2
|
||||
* @description
|
||||
* WifiWizard2 enables Wifi management for both Android and iOS applications within Cordova/Phonegap projects.
|
||||
*
|
||||
* This project is a fork of the WifiWizard plugin with fixes and updates, as well as patches taken from the Cordova Network Manager plugin.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { WifiWizard2 } from '@ionic-native/wifi-wizard-2/ngx';
|
||||
*
|
||||
*
|
||||
* constructor(private wifiWizard2: WifiWizard2) { }
|
||||
*
|
||||
*
|
||||
* # Global Functions
|
||||
* These are functions that can be used by both Android and iOS applications
|
||||
* ```typescript
|
||||
* this.wifiWizard2.getConnectedSSID()
|
||||
* ```
|
||||
* - Returns connected network SSID (only if connected) in success callback, otherwise fail callback will be called (if not connected or unable to retrieve)
|
||||
* - This does **NOT** return the BSSID if unable to obtain SSID (like original WifiWizard did)
|
||||
* ```typescript
|
||||
* this.wifiWizard2.getConnectedBSSID()
|
||||
* ```
|
||||
* - Same as above, except BSSID (mac) is returned
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.timeout(delay)
|
||||
* ```
|
||||
* - `delay` should be time in milliseconds to delay
|
||||
* - Helper async timeout delay, `delay` is optional, default is 2000ms = 2 seconds
|
||||
* - This method always returns a resolved promise after the delay, it will never reject or throw an error
|
||||
*
|
||||
* **Example inside async function**
|
||||
* ```typescript
|
||||
* async function example(){
|
||||
* await this.wifiWizard2.timeout(4000);
|
||||
* // do something after 4 seconds
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* **Example inside standard non-async function**
|
||||
* ```typescript
|
||||
* function example(){
|
||||
* this.wifiWizard2.timeout(4000).then( function(){
|
||||
* // do something after waiting 4 seconds
|
||||
* }):
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `TIMEOUT_WAITING_FOR_SCAN` on timeout waiting for scan 10 seconds +
|
||||
* - `SCAN_FAILED` if unable to start scan
|
||||
*
|
||||
* # iOS Functions
|
||||
* For functionality, you need to note the following:
|
||||
* - Connect/Disconnect only works for iOS11+
|
||||
* - Can't run in the simulator so you need to attach an actual device when building with xCode
|
||||
* - Will ensure 'HotspotConfiguration' and 'NetworkExtensions' capabilities are added to your xCode project
|
||||
* - To connect to open network omit `ssidPassword` or call with `false`
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.iOSConnectNetwork(ssid, ssidPassword)
|
||||
* ```
|
||||
* ```typescript
|
||||
* this.wifiWizard2.iOSDisconnectNetwork(ssid)
|
||||
* ```
|
||||
*
|
||||
* # Android Functions
|
||||
* - **WifiWizard2** *will automagically try to enable WiFi if it's disabled when calling any android related methods that require WiFi to be enabled*
|
||||
*
|
||||
* ## Connect vs Enable
|
||||
* When writing Android Java code, there is no `connect` methods, you basically either `enable` or `disable` a network. In the original versions of WifiWizard the `connect` method would basically just call `enable` in Android.
|
||||
* I have changed the way this works in WifiWizard2 version 3.0.0+, converting it to a helper method to eliminate having to call `formatWifiConfig` then `add` and then `enable` ... the `connect` method will now automatically call `formatWifiConfig`, then call `add` to either add or update the network configuration, and then call `enable`.
|
||||
* If the connect method is unable to update existing network configuration (added by user or other apps), but there is a valid network ID, it will still attempt to enable that network ID.
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.connect(ssid, bindAll, password, algorithm, isHiddenSSID)
|
||||
* ```
|
||||
* - `ssid` should be the SSID to connect to *required*
|
||||
* - `bindAll` should be set to `true` to tell Android to route all connections from your Android app, through the wifi connection (default is `false`) *optional*
|
||||
* - See `WifiWizard2.enable` for more details regarding `bindAll` feature
|
||||
* - `algorithm` and `password` is not required if connecting to an open network
|
||||
* - Currently `WPA` and `WEP` are only supported algorithms
|
||||
* - For `WPA2` just pass `WPA` as the algorithm
|
||||
* - Set `isHiddenSSID` to `true` if the network you're connecting to is hidden
|
||||
* - These arguments are the same as for `formatWifiConfig`
|
||||
* - This method essentially calls `formatWifiConfig` then `add` then `enable`
|
||||
* - If unable to update network configuration (was added by user or other app), but a valid network ID exists, this method will still attempt to enable the network
|
||||
* - Promise will not be returned until method has verified that connection to WiFi was in completed state (waits up to 60 seconds)
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
*
|
||||
* - `CONNECT_FAILED_TIMEOUT` unable to verify connection, timed out after 60 seconds
|
||||
* - `INVALID_NETWORK_ID_TO_CONNECT` Unable to connect based on generated wifi config
|
||||
* - `INTERPUT_EXCEPT_WHILE_CONNECTING` Interupt exception while waiting for connection
|
||||
*
|
||||
*
|
||||
*
|
||||
* ## Disconnect vs Disable
|
||||
* Same as above for Connect vs Enable, except in this situation, `disconnect` will first disable the network, and then attempt to remove it (if SSID is passed)
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.disconnect(ssid)
|
||||
* ```
|
||||
* - `ssid` can either be an SSID (string) or a network ID (integer)
|
||||
* - `ssid` is **OPTIONAL** .. if not passed, will disconnect current WiFi (almost all Android versions now will just automatically reconnect to last wifi after disconnecting)
|
||||
* - If `ssid` is provided, this method will first attempt to `disable` and then `remove` the network
|
||||
* - If you do not want to remove network configuration, use `disable` instead
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `DISCONNECT_NET_REMOVE_ERROR` Android returned error when removing wifi configuration
|
||||
* - `DISCONNECT_NET_DISABLE_ERROR` Unable to connect based on generated wifi config
|
||||
* - `DISCONNECT_NET_ID_NOT_FOUND` Unable to determine network ID to disconnect/remove (from passed SSID)
|
||||
* - `ERROR_DISCONNECT` - Android error disconnecting wifi (only when SSID is not passed)
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.formatWifiConfig(ssid, password, algorithm, isHiddenSSID)
|
||||
* ```
|
||||
* - `algorithm` and `password` is not required if connecting to an open network
|
||||
* - Currently `WPA` and `WEP` are only supported algorithms
|
||||
* - For `WPA2` just pass `WPA` as the algorithm
|
||||
* - Set `isHiddenSSID` to `true` if the network you're connecting to is hidden
|
||||
* ```typescript
|
||||
* this.wifiWizard2.formatWPAConfig(ssid, password, isHiddenSSID)
|
||||
* ```
|
||||
* - This is just a helper method that calls `WifiWizard2.formatWifiConfig( ssid, password, 'WPA', isHiddenSSID );`
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.add(wifi)
|
||||
* ```
|
||||
* - `wifi` must be an object formatted by `formatWifiConfig`, this **must** be done before calling `enable`
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `AUTH_TYPE_NOT_SUPPORTED` - Invalid auth type specified
|
||||
* - `ERROR_ADDING_NETWORK` - Android returned `-1` specifying error adding network
|
||||
* - `ERROR_UPDATING_NETWORK` - Same as above, except an existing network ID was found, and unable to update it
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.remove(ssid)
|
||||
* ```
|
||||
* - `ssid` can either be an SSID (string) or a network ID (integer)
|
||||
* - Please note, most newer versions of Android will only allow wifi to be removed if created by your application
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `UNABLE_TO_REMOVE` Android returned failure in removing network
|
||||
* - `REMOVE_NETWORK_NOT_FOUND` Unable to determine network ID from passed SSID
|
||||
*
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.listNetworks()
|
||||
* ```
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.scan([options])
|
||||
* ```
|
||||
* - Same as calling `startScan` and then `getScanResults`, except this method will only resolve the promise after the scan completes and returns the results.
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.startScan()
|
||||
* ```
|
||||
* - It is recommended to just use the `scan` method instead of `startScan`
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `STARTSCAN_FAILED` Android returned failure in starting scan
|
||||
*
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.getScanResults([options])
|
||||
* ```
|
||||
* - `getScanResults` should only be called after calling `startScan` (it is recommended to use `scan` instead as this starts the scan, then returns the results)
|
||||
* - `[options]` is optional, if you do not want to specify, just pass `success` callback as first parameter, and `fail` callback as second parameter
|
||||
* - Retrieves a list of the available networks as an array of objects and passes them to the function listHandler. The format of the array is:
|
||||
* ```typescript
|
||||
* networks = [
|
||||
* { "level": signal_level, // raw RSSI value
|
||||
* "SSID": ssid, // SSID as string, with escaped double quotes: "\"ssid name\""
|
||||
* "BSSID": bssid // MAC address of WiFi router as string
|
||||
* "frequency": frequency of the access point channel in MHz
|
||||
* "capabilities": capabilities // Describes the authentication, key management, and encryption schemes supported by the access point.
|
||||
* "timestamp": timestamp // timestamp of when the scan was completed
|
||||
* "channelWidth":
|
||||
* "centerFreq0":
|
||||
* "centerFreq1":
|
||||
* }
|
||||
* ]
|
||||
* ```
|
||||
* - `channelWidth` `centerFreq0` and `centerFreq1` are only supported on API > 23 (Marshmallow), any older API will return null for these values
|
||||
*
|
||||
* An options object may be passed. Currently, the only supported option is `numLevels`, and it has the following behavior:
|
||||
*
|
||||
* - if `(n == true || n < 2)`, `*.getScanResults({numLevels: n})` will return data as before, split in 5 levels;
|
||||
* - if `(n > 1)`, `*.getScanResults({numLevels: n})` will calculate the signal level, split in n levels;
|
||||
* - if `(n == false)`, `*.getScanResults({numLevels: n})` will use the raw signal level;
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.isWifiEnabled()
|
||||
* ```
|
||||
* - Returns boolean value of whether Wifi is enabled or not
|
||||
* ```typescript
|
||||
* this.wifiWizard2.setWifiEnabled(enabled)
|
||||
* ```
|
||||
* - Pass `true` for `enabled` parameter to set Wifi enabled
|
||||
* - You do not need to call this function to set WiFi enabled to call other methods that require wifi enabled. This plugin will automagically enable WiFi if a method is called that requires WiFi to be enabled.
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `ERROR_SETWIFIENABLED` wifi state does not match call (enable or disable)
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.getConnectedNetworkID()
|
||||
* ```
|
||||
* - Returns currently connected network ID in success callback (only if connected), otherwise fail callback will be called
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `GET_CONNECTED_NET_ID_ERROR` Unable to determine currently connected network ID (may not be connected)
|
||||
*
|
||||
* ## New to 3.1.1+
|
||||
* ```typescript
|
||||
* this.wifiWizard2.resetBindAll()
|
||||
* ```
|
||||
* - Disable bindAll to WiFi network without disconnecting from WiFi
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.setBindAll()
|
||||
* ```
|
||||
* - Enable bindAll to WiFi network without disconnecting from WiFi
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.canConnectToInternet()
|
||||
* ```
|
||||
*
|
||||
* - Returns boolean, true or false, if device is able to connect to https://www.google.com via HTTP connection (since ping is unreliable)
|
||||
* - Unknown errors will still be thrown like all other async functions
|
||||
* - If you called `connect` or `enable` and passed `true` for `bindAll`, your application will force the ping through wifi connection.
|
||||
* - If you did not pass `true` (or passed `false`) for `bindAll`, and the wifi does not have internet connection, Android Lollipop+ (API 21+) will use cell connection to ping (due to Android using cell connection when wifi does not have internet) [More Details](https://android-developers.googleblog.com/2016/07/connecting-your-app-to-wi-fi-device.html)
|
||||
*
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.canConnectToRouter()
|
||||
* ```
|
||||
* - As `canPingWifiRouter` is notoriously unreliable, this method uses HTTP connection to test if able to connect to router (as most routers should have web server running on port 80)
|
||||
* - Unknown errors will still be thrown like all other async functions
|
||||
* - This is useful for testing to make sure that your Android app is able to connect to the private network after connecting to WiFi
|
||||
* - This was added for testing the `bindAll` feature to support issues with Android Lollipop+ (API 21+) not routing calls through WiFi if WiFi does not have internet connection [See Android Blog](https://android-developers.googleblog.com/2016/07/connecting-your-app-to-wi-fi-device.html)
|
||||
* - Attempts to connect router IP HTTP server on port 80 (example: `http://192.168.0.1/` where `192.168.0.1` is the automatically detected IP address)
|
||||
*
|
||||
* ## New to 3.0.0+
|
||||
* ```typescript
|
||||
* this.wifiWizard2.isConnectedToInternet()
|
||||
* ```
|
||||
*
|
||||
* - Returns boolean, true or false, if device is able to ping 8.8.8.8
|
||||
* - Unknown errors will still be thrown like all other async functions
|
||||
* - If you called `connect` or `enable` and passed `true` for `bindAll`, your application will force the ping through wifi connection.
|
||||
* - If you did not pass `true` (or passed `false`) for `bindAll`, and the wifi does not have internet connection, Android Lollipop+ (API 21+) will use cell connection to ping (due to Android using cell connection when wifi does not have internet) [More Details](https://android-developers.googleblog.com/2016/07/connecting-your-app-to-wi-fi-device.html)
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.canPingWifiRouter()
|
||||
* ```
|
||||
*
|
||||
* - Returns boolean, true or false, if device is able to ping the connected WiFi router IP (obtained from DHCP info)
|
||||
* - Version 3.1.1+ uses HTTP connection to test if able to connect to router (as ping previous did not work)
|
||||
* - Unknown errors will still be thrown like all other async functions
|
||||
* - This is useful for testing to make sure that your Android app is able to connect to the private network after connecting to WiFi
|
||||
* - This was added for testing the `bindAll` feature to support issues with Android Lollipop+ (API 21+) not routing calls through WiFi if WiFi does not have internet connection [See Android Blog](https://android-developers.googleblog.com/2016/07/connecting-your-app-to-wi-fi-device.html)
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.enableWifi()
|
||||
* ```
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.disableWifi()
|
||||
* ```
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.getWifiIP()
|
||||
* ```
|
||||
* - Returns IPv4 address of currently connected WiFi, or rejects promise if IP not found or wifi not connected
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.getWifiRouterIP()
|
||||
* ```
|
||||
* - Returns IPv4 WiFi router IP from currently connected WiFi, or rejects promise if unable to determine, or wifi not connected
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `NO_VALID_IP_IDENTIFIED` if unable to determine a valid IP (ip returned from device is `0.0.0.0`)
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.getWifiIPInfo()
|
||||
* ```
|
||||
* - Returns a JSON object with IPv4 address and subnet `{"ip": "192.168.1.2", "subnet": "255.255.255.0" }` or rejected promise if not found or not connected
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `NO_VALID_IP_IDENTIFIED` if unable to determine a valid IP (ip returned from device is `0.0.0.0`)
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.reconnect()
|
||||
* ```
|
||||
* - Reconnect to the currently active access point, **if we are currently disconnected.**
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `ERROR_RECONNECT` Android returned error when reconnecting
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.reassociate()
|
||||
* ```
|
||||
* - Reconnect to the currently active access point, **even if we are already connected.**
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `ERROR_REASSOCIATE` Android returned error when reassociating
|
||||
*
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.getSSIDNetworkID(ssid)
|
||||
* ```
|
||||
* - Get Android Network ID from passed SSID
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.disable(ssid)
|
||||
* ```
|
||||
* - `ssid` can either be an SSID (string) or a network ID (integer)
|
||||
* - Disable the passed SSID network
|
||||
* - Please note that most newer versions of Android will only allow you to disable networks created by your application
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `UNABLE_TO_DISABLE` Android returned failure in disabling network
|
||||
* - `DISABLE_NETWORK_NOT_FOUND` Unable to determine network ID from passed SSID to disable
|
||||
*
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.requestPermission()
|
||||
* ```
|
||||
* - Request `ACCESS_FINE_LOCATION` permssion
|
||||
* - This Android permission is required to run `scan`, `startStart` and `getScanResults`
|
||||
* - You can request permission by running this function manually, or WifiWizard2 will automagically request permission when one of the functions above is called
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* - `PERMISSION_DENIED` user denied permission on device
|
||||
*
|
||||
*
|
||||
* ```typescript
|
||||
* this.wifiWizard2.enable(ssid, bindAll, waitForConnection)
|
||||
* ```
|
||||
* - `ssid` can either be an SSID (string) or a network ID (integer)
|
||||
* - `bindAll` should be set to `true` to tell Android to route all connections from your Android app, through the wifi connection
|
||||
* - Android Lollipop+ (API 21+) will not route connections to the WiFi device if it does not have internet connection. Passing `true` to `bindAll` will force Android to route connections from your Android app through Wifi, regardless of internet connection.
|
||||
* - If you are having problems connecting to a local IP through WiFi because it does not have internet, try enabling `bindAll` and this should fix the problem.
|
||||
* - During my testing, some versions of Android (5.0 - 7.1.2) would still route connections through WiFi without internet, but it was random that some versions would and would not work.
|
||||
* - Testing Android Oreo+ (8.0.0+) if wifi does not have internet, 100% of the time it would NOT route connections through WiFi, so you *must* enable this for Oreo or newer to route connections from your application through wifi without internet.
|
||||
* - When `bindAll` is enabled, *ALL* connections from your app will be routed through WiFi, until you call `disconnect` or `disable`
|
||||
* - See the Google Android Blog for [More Details](https://android-developers.googleblog.com/2016/07/connecting-your-app-to-wi-fi-device.html)
|
||||
* - This feature *ONLY* works for Android Lollipop+ (API 21+), if device is running API older than 21, `bindall` will be ignored (as API older than 21 does this by default)
|
||||
* - Enable the passed SSID network
|
||||
* - You **MUST** call `WifiWizard2.add(wifi)` before calling `enable` as the wifi configuration must exist before you can enable it (or previously used `connect` without calling `disconnect`)
|
||||
* - This method does NOT wait or verify connection to wifi network, pass `true` to `waitForConnection` to only return promise once connection is verified in COMPLETED state to specific `ssid`
|
||||
*
|
||||
* **Thrown Errors**
|
||||
*
|
||||
* `UNABLE_TO_ENABLE` - Android returned `-1` signifying failure enabling
|
||||
*
|
||||
* # Installation
|
||||
*
|
||||
* ## Master
|
||||
*
|
||||
* Run ```cordova plugin add https://github.com/tripflex/wifiwizard2```
|
||||
*
|
||||
* To install from the master branch (latest on GitHub)
|
||||
*
|
||||
* To install a specific branch (add `#tag` replacing `tag` with tag from this repo, example:
|
||||
* ```cordova plugin add https://github.com/tripflex/wifiwizard2#v3.1.1```
|
||||
*
|
||||
* Find available tags here:
|
||||
* https://github.com/tripflex/WifiWizard2/tags
|
||||
*
|
||||
*
|
||||
* If you are wanting to have the latest and greatest stable version, then run the 'Releases' command below.
|
||||
*
|
||||
* ## Releases
|
||||
* Run ```cordova plugin add cordova-plugin-wifiwizard2```
|
||||
*
|
||||
* ## Meteor
|
||||
* To install and use this plugin in a Meteor project, you have to specify the exact version from NPM repository:
|
||||
* [https://www.npmjs.com/package/cordova-plugin-wifiwizard2](https://www.npmjs.com/package/cordova-plugin-wifiwizard2)
|
||||
*
|
||||
* As of April 4th 2019, the latest version is 3.1.1:
|
||||
*
|
||||
* ```meteor add cordova:cordova-plugin-wifiwizard2@3.1.1```
|
||||
*
|
||||
* # Errors/Rejections
|
||||
* Methods now return formatted string errors as detailed below, instead of returning generic error messages. This allows you to check yourself what specific error was returned, and customize the error message.
|
||||
* In an upcoming release I may add easy ways to override generic messages, or set your own, but for now, errors returned can be found below each method/function.
|
||||
*
|
||||
* ## Generic **Thrown Errors**
|
||||
* `WIFI_NOT_ENABLED`
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'WifiWizard2',
|
||||
plugin: 'cordova-plugin-wifiwizard2',
|
||||
pluginRef: 'WifiWizard2',
|
||||
repo: 'https://github.com/tripflex/WifiWizard2',
|
||||
platforms: ['Android', 'iOS']
|
||||
})
|
||||
@Injectable()
|
||||
export class WifiWizard2 extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Connect to network on iOS device
|
||||
* @param ssid
|
||||
* @param ssidPassword Password if connecting to WPA/WPA2 network (omit or use false to connect to open network)
|
||||
* @returns {Promise}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['iOS']
|
||||
})
|
||||
iOSConnectNetwork(ssid: string, ssidPassword: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Disconnect from SSID on iOS device
|
||||
* @param ssid
|
||||
* @returns {Promise}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['iOS']
|
||||
})
|
||||
iOSDisconnectNetwork(ssid: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add wifi network configuration
|
||||
* @param wifiConfig Must be object created by formatWifiConfig()
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
add(wifiConfig: WifiConfig): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove wifi network configuration
|
||||
* @param {string|number} [ssid]
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
remove(ssid: string | number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Connect network with specified SSID
|
||||
*
|
||||
* This method will first add the wifi configuration, then enable the network, returning promise when connection is verified.
|
||||
*
|
||||
* @param {string|number} [ssid]
|
||||
* @param {boolean} [bindAll=false] - Whether or not to bind all connections from app, through WiFi connection
|
||||
* @param {string} [password=]
|
||||
* @param {string} [algorithm=NONE] - WPA, WPA (for WPA2), WEP or NONE (NONE by default)
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
connect(ssid: string | number, bindAll?: boolean, password?: string, algorithm?: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Disconnect (current if SSID not supplied)
|
||||
*
|
||||
* This method, if passed an SSID, will first disable the network, and then remove it from the device. To only "disconnect" (ie disable in android),
|
||||
* call WifiWizard2.disable() instead of disconnect.
|
||||
*
|
||||
* @param {string|number} [ssid=all]
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
disconnect(ssid: string | number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable Network
|
||||
* @param {string|number} [ssid]
|
||||
* @param {boolean} [bindAll=false] - Whether or not to bind all network requests to this wifi network
|
||||
* @param {boolean} [waitForConnection=false] - Whether or not to wait before resolving promise until connection to wifi is verified
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
enable(ssid: string | number, bindAll?: boolean, waitForConnection?: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable Network
|
||||
* @param {string|number} [ssid]
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
disable(ssid: string | number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reconnect to the currently active access point, even if we are already connected.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
reassociate(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reconnect to the currently active access point, if we are currently disconnected.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
reconnect(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns currently configured networks
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
listNetworks(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Start network scan and return results
|
||||
* @param options
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
scan(options?: WifiScanOptions): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Start wifi network scan (results can be retrieved with getScanResults)
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
startScan(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get wifi scan results (must call startScan first, or just use scan())
|
||||
* @param options
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
getScanResults(options: WifiScanResultsOptions): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if WiFi is enabled
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
isWifiEnabled(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable or Disable WiFi
|
||||
* @param enabled
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
setWifiEnabled(enabled: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable WiFi
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
enableWifi(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable WiFi
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true,
|
||||
platforms: ['Android']
|
||||
})
|
||||
disableWifi(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unbind Network
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
resetBindAll(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Bind Network
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
setBindAll(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Wifi Router IP from DHCP
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
getWifiRouterIP(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Wifi IP
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
getWifiIP(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Wifi IP and Subnet Address
|
||||
*
|
||||
* This method returns a JSON object similar to: { "ip": "0.0.0.0", "subnet": "0.0.0.0" }
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
getWifiIPInfo(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Network ID from SSID
|
||||
* @param {string|number} [ssid]
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
getSSIDNetworkID(ssid: string | number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get currently connected network ID
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
getConnectedNetworkID(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get currently connected network SSID
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
getConnectedSSID(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get currently connected network BSSID/MAC
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
getConnectedBSSID(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if current WiFi connection has connection to the internet
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
isConnectedToInternet(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if we can ping current WiFi router IP address
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
canPingWifiRouter(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if we can connect via HTTP current WiFi router IP address
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
canConnectToRouter(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if current WiFi connection can connect to internet (checks connection to google.com)
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
canConnectToInternet(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Request ACCESS_FINE_LOCATION permission
|
||||
*
|
||||
* This permission is required by Android to return scan results, you can manually request it prior to running `scan`
|
||||
* or this plugin will automatically do it when the scan is ran.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
otherPromise: true
|
||||
})
|
||||
requestPermission(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format WiFi configuration for Android Devices
|
||||
* @param {string|number} [ssid]
|
||||
* @param {string} [password]
|
||||
* @param {string} [algorithm]
|
||||
* @param {boolean} [isHiddenSSID]
|
||||
* @returns {WifiConfig|boolean}
|
||||
*/
|
||||
@CordovaFunctionOverride()
|
||||
formatWifiConfig(ssid: string | number, password: string, algorithm: string, isHiddenSSID: boolean): WifiConfig | boolean {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format WPA WiFi configuration for Android Devices
|
||||
* @param {string|number} [ssid]
|
||||
* @param {string} password
|
||||
* @param {boolean} isHiddenSSID
|
||||
* @returns {WifiConfig|boolean}
|
||||
*/
|
||||
@CordovaFunctionOverride()
|
||||
formatWPAConfig(ssid: string | number, password: string, isHiddenSSID: boolean): WifiConfig | boolean {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format WiFi SSID String
|
||||
* @param ssid
|
||||
* @returns {*}
|
||||
*/
|
||||
@CordovaFunctionOverride()
|
||||
formatWifiString(ssid: string | number): string | number {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Synchronous Sleep/Timeout `await this.timeout()`
|
||||
* @param delay the amount of time to wait (default 2 seconds)
|
||||
*/
|
||||
@CordovaFunctionOverride()
|
||||
timeout(delay?: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user