Compare commits

..

1 Commits

Author SHA1 Message Date
Matt Netkow
1f678a0ad8 Add premier and capIncompat metadata to plugins 2020-06-10 16:51:33 -05:00
25 changed files with 1056 additions and 2969 deletions

View File

@@ -17,17 +17,6 @@ jobs:
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Cache ionic site
id: ionic-site
uses: actions/cache@v2
with:
path: ~/ionic-site/
key: ionic-site-${{ hashFiles('**/package-lock.json') }}
- name: Setup git
run: bash ./scripts/git/config.sh
- name: Prepare ionic-site repo
if: github.ref == 'refs/heads/master'
run: bash ./scripts/docs/prepare.sh
- name: Install dependencies
run: npm ci
- name: Lint
@@ -38,9 +27,5 @@ jobs:
run: npm run test
- name: Readmes
run: npm run readmes
- name: Deploy doc
if: github.ref == 'refs/heads/master'
run: bash ./scripts/docs/update_docs.sh
env:
GITHUB_PROJECT_REPONAME: ${{ github.repository }}
GITHUB_SHA1: ${{ github.sha }}
CI: true

View File

@@ -1,33 +1,3 @@
# [5.27.0](https://github.com/ionic-team/ionic-native/compare/v5.26.0...v5.27.0) (2020-06-23)
### Bug Fixes
* **app-rate:** Add missing "openUrl" property to AppRatePreferences object ([#3456](https://github.com/ionic-team/ionic-native/issues/3456)) ([fe21b5b](https://github.com/ionic-team/ionic-native/commit/fe21b5b97c150e16740b91bf958f7110b2e35664))
* **camera-preview:** tapFocus ([#3467](https://github.com/ionic-team/ionic-native/issues/3467)) ([7c95e66](https://github.com/ionic-team/ionic-native/commit/7c95e660215e96ce238c0194bbe91ba16886a78a))
* **firebase-x:** add fakeVerificationCode param to verifyPhoneNumber ([#3451](https://github.com/ionic-team/ionic-native/issues/3451)) ([191c7a0](https://github.com/ionic-team/ionic-native/commit/191c7a044d15c31a4bba4c23010cdd728398eb89))
* **firebase-x:** indicate callback methods to verifyPhoneNumber ([#3457](https://github.com/ionic-team/ionic-native/issues/3457)) ([66896b2](https://github.com/ionic-team/ionic-native/commit/66896b2632250ee8a33af909f7c0e008c6abc872))
* **jumio:** update plugin reference and source ([#3428](https://github.com/ionic-team/ionic-native/issues/3428)) ([389a3fb](https://github.com/ionic-team/ionic-native/commit/389a3fb215711deb5e5404fd5b268b20825af958))
* **launch-review:** Allow rating() callback to be invoked multiple times ([#3455](https://github.com/ionic-team/ionic-native/issues/3455)) ([40b9295](https://github.com/ionic-team/ionic-native/commit/40b9295de64e27c652f58fa37a4bb50c6bc2cdc4))
### Features
* **admob:** add interfaces and method typings ([#3461](https://github.com/ionic-team/ionic-native/issues/3461)) ([b2afc13](https://github.com/ionic-team/ionic-native/commit/b2afc131caeea56b9e01edc6169fdce9b57e9569))
* **broadcaster:** align plugin API to version 4.1.0 ([#3432](https://github.com/ionic-team/ionic-native/issues/3432)) ([324334e](https://github.com/ionic-team/ionic-native/commit/324334eb287dd8e3e82b2d5d64e8fb06b496a1f0))
* **build-info:** add plugin ([#3465](https://github.com/ionic-team/ionic-native/issues/3465)) ([7b998b9](https://github.com/ionic-team/ionic-native/commit/7b998b96449cdc1abf90548115caa0435ee89a84))
* **camera-preview:** add record video functions ([#3463](https://github.com/ionic-team/ionic-native/issues/3463)) ([7ae1df2](https://github.com/ionic-team/ionic-native/commit/7ae1df2489b8ff524c1ba1bfa7624dcb50247905))
* **chooser:** add getFileMetadata ([#3425](https://github.com/ionic-team/ionic-native/issues/3425)) ([79c3284](https://github.com/ionic-team/ionic-native/commit/79c3284434fbb580642b44d3d91cf01c82e52d0f))
* **CleverTap:** Update Plugin for Parity Support ([#3435](https://github.com/ionic-team/ionic-native/issues/3435)) ([3df35b4](https://github.com/ionic-team/ionic-native/commit/3df35b40ce49b1a176ae03a3516df37ceb7cdec6))
* **fcm:** add requestPushPermissionIOS and createNotificationChannelAndroid functions ([#3430](https://github.com/ionic-team/ionic-native/issues/3430)) ([ef17dc5](https://github.com/ionic-team/ionic-native/commit/ef17dc5d07e401369fa8353913a80b36f3cfdc4c))
* **firebase-dynamic-links:** Update plugin for parity ([#3437](https://github.com/ionic-team/ionic-native/issues/3437)) ([7f09758](https://github.com/ionic-team/ionic-native/commit/7f0975803f2e84ed536922dde542e4d50549f919))
* **firebase-vision:** add barcodeDetector ([#3426](https://github.com/ionic-team/ionic-native/issues/3426)) ([1aacb48](https://github.com/ionic-team/ionic-native/commit/1aacb487a4577e2f6854e59f30f215c301ad60ee))
* **firebase-x:** add missing methods from plugin, incl. authenticateUserWithApple ([#3458](https://github.com/ionic-team/ionic-native/issues/3458)) ([32203e9](https://github.com/ionic-team/ionic-native/commit/32203e9ac1a0ca5368b320d1b05f44da3addd2bf))
* **ios-aswebauthenticationsession:** add plugin ([#3421](https://github.com/ionic-team/ionic-native/issues/3421)) ([742ff65](https://github.com/ionic-team/ionic-native/commit/742ff655968c908911b3174d8a9893c6716b20d8))
* **vibes:** add support for inbox messaging ([#3466](https://github.com/ionic-team/ionic-native/issues/3466)) ([9bf1eaf](https://github.com/ionic-team/ionic-native/commit/9bf1eafc4eb1e3562dfeff54f87f1da95d0a9fe4))
# [5.26.0](https://github.com/ionic-team/ionic-native/compare/v5.25.0...v5.26.0) (2020-05-16)

1925
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "ionic-native",
"version": "5.27.0",
"version": "5.26.0",
"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)",
@@ -23,39 +23,39 @@
"prettier": "prettier --write \"**/*.{js,json,css,scss,less,md,ts,html,component.html}\""
},
"devDependencies": {
"@angular/common": "^9.1.11",
"@angular/compiler": "^9.1.11",
"@angular/compiler-cli": "^9.1.11",
"@angular/core": "^9.1.11",
"@angular/common": "^9.1.7",
"@angular/compiler": "^9.1.7",
"@angular/compiler-cli": "^9.1.7",
"@angular/core": "^9.1.7",
"@types/cordova": "0.0.34",
"@types/fs-extra": "^9.0.1",
"@types/jest": "^26.0.0",
"@types/lodash": "^4.14.156",
"@types/node": "^12.12.47",
"@types/jest": "^25.2.3",
"@types/lodash": "^4.14.152",
"@types/node": "^12.12.41",
"@types/rimraf": "^3.0.0",
"@types/webpack": "^4.41.17",
"@types/webpack": "^4.41.13",
"ajv": "^6.12.2",
"async-promise-queue": "^1.0.5",
"conventional-changelog-cli": "^2.0.34",
"cz-conventional-changelog": "^3.2.0",
"dgeni": "^0.4.12",
"dgeni-packages": "0.16.10",
"fs-extra": "^9.0.1",
"fs-extra": "^9.0.0",
"gulp": "^4.0.2",
"gulp-rename": "^2.0.0",
"gulp-replace": "^1.0.0",
"gulp-tslint": "^8.1.4",
"husky": "^4.2.5",
"jest": "^26.1.0",
"lint-staged": "^10.2.11",
"jest": "^26.0.1",
"lint-staged": "^10.2.4",
"lodash": "^4.17.15",
"minimist": "^1.2.5",
"natives": "^1.1.6",
"prettier": "^2.0.5",
"rimraf": "^3.0.2",
"rxjs": "^6.5.5",
"ts-jest": "^26.1.1",
"ts-node": "^8.10.2",
"ts-jest": "^26.0.0",
"ts-node": "^8.10.1",
"tslint": "^5.20.1",
"tslint-config-prettier": "^1.18.0",
"tslint-ionic-rules": "0.0.21",
@@ -65,7 +65,7 @@
"uglifyjs-webpack-plugin": "^2.2.0",
"unminified-webpack-plugin": "^2.0.0",
"webpack": "^4.43.0",
"winston": "^3.3.2",
"winston": "^3.2.1",
"zone.js": "^0.10.3"
},
"jest": {

View File

@@ -31,11 +31,11 @@ function run {
if [ $CHANGED -eq 0 ];
then
echo "-- No changes detected for the following commit, docs not updated."
echo "https://github.com/ionic-team/$GITHUB_PROJECT_REPONAME/commit/$GITHUB_SHA1"
echo "https://github.com/ionic-team/$CIRCLE_PROJECT_REPONAME/commit/$CIRCLE_SHA1"
else
git config --global user.email "hi@ionicframework.com"
git config --global user.name "Ionitron"
git commit -am "Automated build of native docs ionic-team/$GITHUB_PROJECT_REPONAME@$GITHUB_SHA1"
git commit -am "Automated build of native docs ionic-team/$CIRCLE_PROJECT_REPONAME@$CIRCLE_SHA1"
# in case a different commit was pushed to ionic-site during doc/demo gen,
# try to rebase around it before pushing
git fetch

View File

@@ -2,42 +2,41 @@ import { Injectable } from '@angular/core';
import { Cordova, CordovaProperty, IonicNativePlugin, Plugin } from '@ionic-native/core';
import { Observable } from 'rxjs';
export interface AdmobBaseOptions {
export interface AdmobOptions {
/**
* (Optional) Your interstitial id code from your AdMob account. Defaults to bannerAdId
* Your publisher id code from your AdMob account
*/
interstitialAdId?: string;
publisherId: string;
/**
* (Optional) Indicates whether to put banner ads at top when set to true or at bottom when set to false. Defaults to false
* (Optional) Your interstitial id code from your AdMob account. Defaults to publisherId
*/
bannerAtTop?: boolean;
interstitiaAdlId?: string;
/**
* (Optional) Set to true to receive test ads (do not test with real ads as your account may be banned). Defaults to false
* (Optional) Your rewarded id code from your AdMob account. Defaults to publisherId
*/
isTesting?: boolean;
rewardedAdId?: string;
/**
* (Optional) Auto show banner ads when available (onAdLoaded event is called). Defaults to true
* (Optional) Your ad slot code from your AdSense account. Only for browser platform
*/
autoShowBanner?: boolean;
adSlot?: string;
/**
* (Optional) Auto show interstitial ads when available (onAdLoaded event is called). Defaults to true
* (Optional) Indicates if show a close button on interstitial browser ads. Only for browser platform
*/
autoShowInterstitial?: boolean;
}
export interface AdmobOptions extends AdmobBaseOptions {
/**
* Your banner id code from your AdMob account (https://support.google.com/admob/answer/7356431?hl=en)
*/
bannerAdId: string;
interstitialShowCloseButton?: boolean;
/**
* Deprecated. Now is only used in web. It will be used as a bannerAdId only in case it is undefined.
* (Optional) Indicates the number of seconds that the interstitial ad waits before show the close button. Only for browser platform
*/
publisherId?: string;
secondsToShowCloseButton?: number;
/**
* (Optional) Indicates the number of seconds that the interstitial ad waits before close the ad. Only for browser platform
*/
secondsToCloseInterstitial?: number;
/**
* (Optional) Your tappx id for iOS apps. If Admob is configured, it is also used to backfill your lost inventory (when there are no Admob ads available)
@@ -49,21 +48,16 @@ export interface AdmobOptions extends AdmobBaseOptions {
*/
tappxIdAndroid?: string;
/**
* AdMob rewarded id (https://support.google.com/admob/answer/7356431?hl=en)
*/
rewardedAdId?: string;
/**
* (Optional) Auto show rewarded ads when available (onAdLoaded event is called). Defaults to true
*/
autoShowRewarded?: boolean;
/**
* (Optional) If any of tappxId is present, it tells the percentage of traffic diverted to tappx. Defaults to 0.5 (50% of the traffic will be requested to Tappx)
*/
tappxShare?: number;
/**
* (Optional) Indicates whether to put banner ads at top when set to true or at bottom when set to false. Defaults to false
*/
bannerAtTop?: boolean;
/**
* (Optional) Indicates the size of banner ads
*/
@@ -79,58 +73,34 @@ export interface AdmobOptions extends AdmobBaseOptions {
*/
offsetStatusBar?: boolean;
/**
* (Optional) Set to true to receive test ads (do not test with real ads as your account may be banned). Defaults to false
*/
isTesting?: boolean;
/**
* (Options) A JSON object with additional {key: value} pairs
*/
adExtras?: any;
}
export interface AdmobWebOptions extends AdmobBaseOptions {
/**
* (Required) AdSense Publisher ID (https://support.google.com/adsense/answer/105516)
*/
publisherId: string;
/**
* (Required) Your ad slot code from your AdSense account. Only for browser platform https://support.google.com/adsense/answer/105516
* (Optional) Auto show banner ads when available (onAdLoaded event is called). Defaults to true
*/
adSlot: string;
autoShowBanner?: boolean;
/**
* (Optional) Indicates if show a close button on interstitial browser ads. Only for browser platform
* (Optional) Auto show interstitial asd when available (onAdLoaded event is called). Defaults to true
*/
interstitialShowCloseButton?: boolean;
autoShowInterstitial?: boolean;
/**
* (Optional) Indicates the number of seconds that the interstitial ad waits before show the close button. Only for browser platform
* (Optional) Auto show rewarded ads when available (onAdLoaded event is called). Defaults to true
*/
secondsToShowCloseButton?: number;
/**
* (Optional) Indicates the number of seconds that the interstitial ad waits before close the ad. Only for browser platform
*/
secondsToCloseInterstitial?: number;
}
export interface AdMobEvent {
/**
* (Optional) AdMob supported type as seen in AD_TYPE
*/
adType?: string;
/**
* (Optional) AdMob error code
*/
error?: number;
/**
* (Optional) AdMob error reason
*/
reason?: string;
autoShowRewarded?: boolean;
}
/**
* @name AdMob
* @name Admob
* @description
* Most complete Admob plugin with support for [Tappx](http://www.tappx.com/?h=dec334d63287772de859bdb4e977fce6) ads.
* Monetize your apps and games with AdMob ads, using latest Google AdMob SDK. With this plugin you can show AdMob ads easily!
@@ -142,16 +112,15 @@ export interface AdMobEvent {
* - [Tappx](http://www.tappx.com/?h=dec334d63287772de859bdb4e977fce6) ads
*
* @usage
* **Note:** No ads will be served on apps with package name `io.ionic.starter`. This is the default package name for new `ionic` apps. Make sure to rename the package name so ads can be displayed.
* ```typescript
* import { Admob, AdmobOptions } from '@ionic-native/admob';
* import { Admob, AdmobOptions } from '@ionic-native/admob/ngx';
*
*
* constructor(private admob: Admob) {
* // Admob options config
* const admobOptions: AdmobOptions = {
* bannerAdId: 'XXX-XXXX-XXXX',
* interstitialAdId: 'XXX-XXXX-XXXX',
* publisherId: 'XXX-XXXX-XXXX',
* interstitialId: 'XXX-XXXX-XXXX',
* rewardedAdId: 'XXX-XXXX-XXXX',
* isTesting: true,
* autoShowBanner: false,
@@ -284,11 +253,11 @@ export interface AdMobEvent {
* ```
*/
@Plugin({
pluginName: 'AdMob',
pluginName: 'Admob',
plugin: 'cordova-admob',
pluginRef: 'admob',
repo: 'https://github.com/appfeel/admob-google-cordova',
platforms: ['Android', 'iOS', 'Browser'],
platforms: ['Android', 'iOS'],
})
@Injectable()
export class Admob extends IonicNativePlugin {
@@ -324,7 +293,7 @@ export class Admob extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when the options are set
*/
@Cordova()
setOptions(options: AdmobOptions | AdmobWebOptions): Promise<any> {
setOptions(options: AdmobOptions): Promise<any> {
return;
}
@@ -334,7 +303,7 @@ export class Admob extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when the banner view is created
*/
@Cordova()
createBannerView(options?: AdmobOptions | AdmobWebOptions): Promise<any> {
createBannerView(options?: AdmobOptions): Promise<any> {
return;
}
@@ -364,7 +333,7 @@ export class Admob extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when the interstitial ad is loaded
*/
@Cordova()
requestInterstitialAd(options?: AdmobOptions | AdmobWebOptions): Promise<any> {
requestInterstitialAd(options?: AdmobOptions): Promise<any> {
return;
}
@@ -386,7 +355,7 @@ export class Admob extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when the rewarded ad is loaded
*/
@Cordova()
requestRewardedAd(options?: AdmobOptions | AdmobWebOptions): Promise<any> {
requestRewardedAd(options?: AdmobOptions): Promise<any> {
return;
}
@@ -400,173 +369,108 @@ export class Admob extends IonicNativePlugin {
}
/**
* Called when an ad is received.
*
* *WARNING*: only **ionic^4**. Older versions of ionic, use:
*
* ```js
* document.addEventListener(window.admob.events.onAdLoaded, () => { });
* ```
*
* Please refer to the documentation on https://admob-ionic.com/Events.
* @returns {Observable<AdMobEvent>} Returns an observable when an ad is received
* Called when an ad is received
* @returns {Observable<any>} Returns an observable when an ad is received
*/
@Cordova({
eventObservable: true,
event: 'appfeel.cordova.admob.onAdLoaded',
element: document,
})
onAdLoaded(): Observable<AdMobEvent> {
onAdLoaded(): Observable<any> {
return;
}
/**
* Called when an ad request failed.
*
* *WARNING*: only **ionic^4**. Older versions of ionic, use:
*
* ```js
* document.addEventListener(window.admob.events.onAdFailedToLoad, () => { });
* ```
*
* Please refer to the documentation on https://admob-ionic.com/Events.
* @returns {Observable<AdMobEvent>} Returns an observable when an ad request is failed
* Called when an ad request failed
* @returns {Observable<any>} Returns an observable when an ad request is failed
*/
@Cordova({
eventObservable: true,
event: 'appfeel.cordova.admob.onAdFailedToLoad',
element: document,
})
onAdFailedToLoad(): Observable<AdMobEvent> {
onAdFailedToLoad(): Observable<any> {
return;
}
/**
* Called when an ad opens an overlay that covers the screen.
* Please note that onPause cordova event is raised when an interstitial is shown.
*
* *WARNING*: only **ionic^4**. Older versions of ionic, use:
*
* ```js
* document.addEventListener(window.admob.events.onAdOpened, () => { });
* ```
*
* Please refer to the documentation on https://admob-ionic.com/Events.
* @returns {Observable<AdMobEvent>} Returns an observable when an ad is opened
* Please note that onPause cordova event is raised when an interstitial is shown
* @returns {Observable<any>} Returns an observable when an ad is opened
*/
@Cordova({
eventObservable: true,
event: 'appfeel.cordova.admob.onAdOpened',
element: document,
})
onAdOpened(): Observable<AdMobEvent> {
onAdOpened(): Observable<any> {
return;
}
/**
* Called when the user is about to return to the application after clicking on an ad.
* Please note that onResume cordova event is raised when an interstitial is closed.
*
* *WARNING*: only **ionic^4**. Older versions of ionic, use:
*
* ```js
* document.addEventListener(window.admob.events.onAdClosed, () => { });
* ```
*
* Please refer to the documentation on https://admob-ionic.com/Events.
* @returns {Observable<AdMobEvent>} Returns an observable when an ad is closed
* Please note that onResume cordova event is raised when an interstitial is closed
* @returns {Observable<any>} Returns an observable when an ad is closed
*/
@Cordova({
eventObservable: true,
event: 'appfeel.cordova.admob.onAdClosed',
element: document,
})
onAdClosed(): Observable<AdMobEvent> {
onAdClosed(): Observable<any> {
return;
}
/**
* Called when the user leaves the application after clicking an ad (e.g., to go to the browser)
* @returns {Observable<AdMobEvent>} Returns an observable when an ad leaves the application.
*
* *WARNING*: only **ionic^4**. Older versions of ionic, use:
*
* ```js
* document.addEventListener(window.admob.events.onAdLeftApplication, () => { });
* ```
*
* Please refer to the documentation on https://admob-ionic.com/Events.
* @returns {Observable<AdMobEvent>} Returns an observable when application is left due to an ad click
* @returns {Observable<any>} Returns an observable when an ad leaves the application
*/
@Cordova({
eventObservable: true,
event: 'appfeel.cordova.admob.onAdLeftApplication',
element: document,
})
onAdLeftApplication(): Observable<AdMobEvent> {
onAdLeftApplication(): Observable<any> {
return;
}
/**
* Called when the user has been rewarded by an ad.
*
* *WARNING*: only **ionic^4**. Older versions of ionic, use:
*
* ```js
* document.addEventListener(window.admob.events.onRewardedAd, () => { });
* ```
*
* Please refer to the documentation on https://admob-ionic.com/Events.
* @returns {Observable<AdMobEvent>} Returns an observable when the user rewards an ad
* Called when the user has been rewarded by an ad
* @returns {Observable<any>} Returns an observable when the user rewards an ad
*/
@Cordova({
eventObservable: true,
event: 'appfeel.cordova.admob.onRewardedAd',
element: document,
})
onRewardedAd(): Observable<AdMobEvent> {
onRewardedAd(): Observable<any> {
return;
}
/**
* Called when the video of a rewarded ad started.
*
* *WARNING*: only **ionic^4**. Older versions of ionic, use:
*
* ```js
* document.addEventListener(window.admob.events.onRewardedAdVideoStarted, () => { });
* ```
*
* Please refer to the documentation on https://admob-ionic.com/Events.
* @returns {Observable<AdMobEvent>} Returns an observable when the video is started
* Called when the video of a rewarded ad started
* @returns {Observable<any>} Returns an observable when the video is started
*/
@Cordova({
eventObservable: true,
event: 'appfeel.cordova.admob.onRewardedAdVideoStarted',
element: document,
})
onRewardedAdVideoStarted(): Observable<AdMobEvent> {
onRewardedAdVideoStarted(): Observable<any> {
return;
}
/**
* Called when the video of a rewarded ad has completed.
*
* *WARNING*: only **ionic^4**. Older versions of ionic, use:
*
* ```js
* document.addEventListener(window.admob.events.onRewardedAdVideoCompleted, () => { });
* ```
*
* Please refer to the documentation on https://admob-ionic.com/Events.
* @returns {Observable<AdMobEvent>} Returns an observable when the video is completed
* Called when the video of a rewarded ad has completed
* @returns {Observable<any>} Returns an observable when the video is completed
*/
@Cordova({
eventObservable: true,
event: 'appfeel.cordova.admob.onRewardedAdVideoCompleted',
element: document,
})
onRewardedAdVideoCompleted(): Observable<AdMobEvent> {
onRewardedAdVideoCompleted(): Observable<any> {
return;
}
}

View File

@@ -51,11 +51,6 @@ export interface AppRatePreferences {
* App Store URLS
*/
storeAppURL?: AppUrls;
/**
* Open URL function
*/
openUrl?: (url: string) => void;
}
export interface AppRateCustomLocale {

View File

@@ -0,0 +1,66 @@
import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
export interface AppUpdateOptions {
authType?: string;
username?: string;
password?: string;
skipPromptDialog?: boolean;
skipProgressDialog?: boolean;
}
/**
* @name App Update
* @description
* This plugin does self-update for android
*
* @usage
*
* You should first host an XML file on your server with the following data in it:
* ```xml
* <update>
* <version>302048</version>
* <name>APK Name</name>
* <url>https://your-remote-api.com/YourApp.apk</url>
* </update>
* ```
*
* Then use the following code:
*
* ```typescript
* import { AppUpdate } from '@ionic-native/app-update/ngx';
*
* constructor(private appUpdate: AppUpdate) {
*
* const updateUrl = 'https://your-remote-api.com/update.xml';
* this.appUpdate.checkAppUpdate(updateUrl).then(() => { console.log('Update available') });
*
* }
* ```
*
* The plugin will compare the app version and update it automatically if the API has a newer version to install.
* @interfaces
* AppUpdateOptions
*/
@Plugin({
pluginName: 'AppUpdate',
plugin: 'cordova-plugin-app-update',
pluginRef: 'AppUpdate',
repo: 'https://github.com/vaenow/cordova-plugin-app-update',
platforms: ['Android'],
})
@Injectable()
export class AppUpdate extends IonicNativePlugin {
/**
* Check and update
* @param {string} updateUrl update api url
* @param {AppUpdateOptions} [options] options
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova({
callbackOrder: 'reverse',
})
checkAppUpdate(updateUrl: string, options?: AppUpdateOptions): Promise<any> {
return;
}
}

View File

@@ -2,20 +2,6 @@ import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
import { Observable } from 'rxjs';
/**
* Specific data for Android implementation
*/
export interface AndroidData {
extras: object;
flags: number;
category: string;
}
/**
* Possibly Event Data types
*/
export type EventData = object | AndroidData | null;
/**
* @name Broadcaster
* @description
@@ -49,7 +35,6 @@ export class Broadcaster extends IonicNativePlugin {
/**
* This function listen to an event sent from the native code
* @param {string} eventName
* @param {boolean} isGlobal Valid only for Android. It allows to listen for global messages(i.e. intents)
* @return {Observable<any>} Returns an observable to watch when an event is received
*/
@Cordova({
@@ -57,22 +42,18 @@ export class Broadcaster extends IonicNativePlugin {
clearFunction: 'removeEventListener',
clearWithArgs: true,
})
addEventListener(eventName: string, isGlobal = false): Observable<any> {
addEventListener(eventName: string): Observable<any> {
return;
}
/**
* This function sends data to the native code
* @param {string} eventName
* @param {boolean} isGlobalOrEventData means that message is global (valid only on Android)
* @param {AndroidData} isGlobalOrEventData allows to specify 'flags` and 'category' (valid only on Android)
* @param {object} isGlobalOrEventData allows to specify a generic object containing custom event data (all platform)
* @param {AndroidData} [data] if isGlobal is set, allows to specify 'flags` and 'category' if isGlobal is set (valid only on Android)
* @param {object} [data] if isGlobal is set, allows to specify a generic object containing custom event data (all platform)
* @param {any} eventData
* @return {Promise<any>} Returns a promise that resolves when an event is successfully fired
*/
@Cordova()
fireNativeEvent(eventName: string, isGlobalOrEventData: boolean | EventData, data?: EventData): Promise<any> {
fireNativeEvent(eventName: string, eventData: any): Promise<any> {
return;
}
}

View File

@@ -1,330 +0,0 @@
import { Injectable } from '@angular/core';
import { Plugin, CordovaProperty, IonicNativePlugin } from '@ionic-native/core';
/**
* @name Build Info
* @description
* This plugin provides build information.
*
* @usage
* ```
* import { BuildInfo } from '@ionic-native/build-info/ngx';
*
* this.platform.ready().then(() => {
* console.log('BuildInfo.baseUrl =' + BuildInfo.baseUrl)
* console.log('BuildInfo.packageName =' + BuildInfo.packageName)
* console.log('BuildInfo.basePackageName=' + BuildInfo.basePackageName)
* console.log('BuildInfo.displayName =' + BuildInfo.displayName)
* console.log('BuildInfo.name =' + BuildInfo.name)
* console.log('BuildInfo.version =' + BuildInfo.version)
* console.log('BuildInfo.versionCode =' + BuildInfo.versionCode)
* console.log('BuildInfo.debug =' + BuildInfo.debug)
* console.log('BuildInfo.buildType =' + BuildInfo.buildType)
* console.log('BuildInfo.flavor =' + BuildInfo.flavor)
* console.log('BuildInfo.buildDate =' + BuildInfo.buildDate)
* console.log('BuildInfo.installDate =' + BuildInfo.installDate)
* })
* ```
*/
@Plugin({
pluginName: 'BuildInfo',
plugin: 'cordova-plugin-buildinfo',
pluginRef: 'BuildInfo',
repo: 'https://github.com/lynrin/cordova-plugin-buildinfo',
platforms: ['Android', 'iOS', 'Windows', 'macOS', 'browser', 'Electron'],
})
@Injectable()
export class BuildInfo extends IonicNativePlugin {
/**
* The baseUrl where cordova.js was loaded.
*/
@CordovaProperty()
baseUrl: string;
/**
* Get the packageName of Application ID.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|Package Name|String|
* |iOS|Bundle Identifier|String|
* |Windows|Identity name|String|
* |macOS(OS X)|Bundle Identifier|String|
* |Browser|Get the id attribute of the widget element in config.xml file.|String|
* |Electron|Get the id attribute of the widget element in config.xml file.|String|
*/
@CordovaProperty()
packageName: string;
/**
* Android only.
*
* Get the packageName of BuildConfig class.
*
* If you use the configure of "build types" or "product flavors", because you can specify a different package name is the id attribute of the widget element of config.xml, is the property to get the package name that BuildConfig class belongs.
* (ought be the same as the id attribute of the widget element of config.xml)
*
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|Package name of BuildConfig class|String|
* |iOS|Bundle Identifier(equals BuildInfo.packageName)|String|
* |Windows|Identity name(equals BuildInfo.packageName)|String|
* |macOS(OS X)|Bundle Identifier(equals BuildInfo.packageName)|String|
* |Browser|equals BuildInfo.packageName|String|
* |Electron|equals BuildInfo.packageName|String|
*/
@CordovaProperty()
basePackageName: string;
/**
* Get the displayName.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|Application Label|String|
* |iOS|CFBundleDisplayName (CFBundleName if not present)|String|
* |Windows|Get the DisplayName attribute of the VisualElements element in AppxManifest.xml file.|String|
* |macOS(OS X)|CFBundleDisplayName (CFBundleName if not present)|String|
* |Browser|Get the short attribute of the name element in config.xml file.|String|
* |Electron|Get the short attribute of the name element in config.xml file.|String|
*/
@CordovaProperty()
displayName: string;
/**
* Get the name.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|Application Label(equal BuildInfo.displayName)|String|
* |iOS|CFBundleName|String|
* |Windows|Windows Store display name|String|
* |macOS(OS X)|CFBundleName|String|
* |Browser|Get value of the name element in config.xml file.|String|
* |Electron|Get value of the name element in config.xml file.|String|
*/
@CordovaProperty()
name: string;
/**
* Get the version.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|BuildConfig.VERSION_NAME|String|
* |iOS|CFBundleShortVersionString|String|
* |Windows|Major.Minor.Build ex) "1.2.3"|String|
* |macOS(OS X)|CFBundleShortVersionString|String|
* |Browser|Get the version attribute of the widget element in config.xml file.|String|
* |Electron|Get the version attribute of the widget element in config.xml file.|String|
*/
@CordovaProperty()
version: string;
/**
* Get the version code.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|BuildConfig.VERSION_CODE|integer|
* |iOS|CFBundleVersion|String|
* |Windows|Major.Minor.Build.Revision ex) "1.2.3.4"|String|
* |macOS(OS X)|CFBundleVersion|String|
* |Browser|equals BuildInfo.version|String|
* |Electron|equals BuildInfo.version|String|
*/
@CordovaProperty()
versionCode: string | number;
/**
* Get the debug flag.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|BuildConfig.DEBUG|Boolean|
* |iOS|defined "DEBUG" is true|Boolean|
* |Windows|isDevelopmentMode is true|Boolean|
* |macOS(OS X)|defined "DEBUG" is true|Boolean|
* |Browser|Always false|Boolean|
* |Electron|True when ```cordova build electron --debug``` is executed with the "--debug" flag.|Boolean|
*/
@CordovaProperty()
debug: boolean;
/**
* Android , Windows Only.
*
* Get the build type.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|BuildConfig.BUILD_TYPE|String|
* |iOS|empty string|String|
* |Windows|"release" or "debug"|String|
* |macOS(OS X)|empty string|String|
* |Browser|empty string|String|
* |Electron|empty string|String|
*
*/
@CordovaProperty()
buildType: string;
/**
* Android Only.
*
* Get the flavor.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|BuildConfig.FLAVOR|String|
* |iOS|empty string|String|
* |Windows|empty string|String|
* |macOS(OS X)|empty string|String|
* |Browser|empty string|String|
* |Electron|empty string|String|
*/
@CordovaProperty()
flavor: string;
/**
* Get the build date and time in the Date object returns.
*
* Attention:
* - Android: Add the BuildInfo.gradle file to your Android project.
* The BuildInfo.gradle file contains the setting to add the _BUILDINFO_TIMESTAMP field to the BuildConfig class.
* - Windows: Add the buildinfo.resjson file to your Windows project.
* The buildinfo.resjson file into the "strings" folder.
* And also add a task to rewrite buildinfo.resjson in the CordovaApp.projitems file.
* - Browser and Electron: When ```cordova prepare``` is executed Build date and time is embedded in
* platforms/**browser**\/www/plugins/cordova-plugin-buildinfo/src/browser/BuildInfoProxy.js file.
* (Or platforms/**electron**\/www/plugins/cordova-plugin-buildinfo/src/browser/BuildInfoProxy.js file.)
* ```cordova prepare``` is also executed for ```cordova build```, ```cordova run``` and ```cordova platform add```.
* (Reference: [Hooks Guide - Apache Cordova](https://cordova.apache.org/docs/en/9.x/guide/appdev/hooks/index.html))
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|BuildConfig.\_BUILDINFO\_TIMESTAMP value|Date|
* |iOS|Get the modification date and time of the Info.plist file acquired from the executionPath property of the main bundle.|Date|
* |Windows|Resource value of "/buildinfo/Timestamp" string.|Date|
* |macOS(OS X)|Get the modification date and time of the config.xml file acquired from the resource of the main bundle.|Date|
* |Browser|The date and time when ```cordova prepare``` was executed.|Date|
* |Electron|The date and time when ```cordova prepare``` was executed.|Date|
*
*/
@CordovaProperty()
buildDate: Date;
/**
* Get the install date and time in the Date object returns.
*
* Attention:
* - Browser and Electron: Installation date and time is unknown.
*
* |Platform|Value|Type|
* |--------|-----|----|
* |Android|The firstInstallTime property of PackageInfo|Date|
* |iOS|Get the creation date and time of the document directory.|Date|
* |Windows|The installedDate property of Windows.ApplicatinoModel.Package.current|Date|
* |macOS(OS X)|Date and time of kMDItemDateAdded recorded in File Metadata of application package.|Date|
* |Browser|Not available.|null|
* |Electron|Not available.|null|
*/
@CordovaProperty()
installDate: Date | null;
/**
* Windows Only.
*
* Get the windows extra information.
*/
@CordovaProperty()
windows?: {
/**
* indows.ApplicationModel.Package.current.id.architecture|
*/
architecture: number;
/**
* Windows.ApplicationModel.Package.current.description|
*/
description: string;
/**
* Windows.ApplicationModel.Package.current.displayName|
*/
displayName: string;
/**
* Windows.ApplicationModel.Package.current.id.familyName|
*/
familyName: string;
/**
* Windows.ApplicationModel.Package.current.id.fullName|
*/
fullName: string;
logo: WindowsLogo;
/**
* Windows.ApplicationModel.Package.current.id.publisher|
*/
publisher: string;
/**
* Windows.ApplicationModel.Package.current.id.publisherId|
*/
publisherId: string;
/**
* Windows.ApplicationModel.Package.current.publisherDisplayName|
*/
publisherDisplayName: string;
/**
* Windows.ApplicationModel.Package.current.id.resourceId|
*/
resourceId: string;
/**
* Windows.ApplicationModel.Package.current.id.version|
*/
version: WindowsVersionInfo;
};
}
export interface WindowsLogo {
/**
* Windows.ApplicationModel.Package.logo.absoluteCanonicalUri
*/
absoluteCannonicalUri: string;
/**
* Windows.ApplicationModel.Package.logo.absoluteUri
*/
absoluteUri: string;
/**
* Windows.ApplicationModel.Package.logo.displayIri
*/
displayIri: string;
/**
* Windows.ApplicationModel.Package.logo.displayUri
*/
displayUri: string;
/**
* Windows.ApplicationModel.Package.logo.path
*/
path: string;
/**
* Windows.ApplicationModel.Package.logo.rawUri
*/
rawUri: string;
}
export interface WindowsVersionInfo {
/**
* Windows.ApplicationModel.Package.current.id.version.major
*/
major: number;
/**
* Windows.ApplicationModel.Package.current.id.version.minor
*/
minor: number;
/**
* Windows.ApplicationModel.Package.current.id.version.build
*/
build: number;
/**
* Windows.ApplicationModel.Package.current.id.version.revision
*/
revision: number;
}

View File

@@ -38,7 +38,7 @@ export interface CameraPreviewOptions {
alpha?: number;
/** Tap to set specific focus point. Note, this assumes the camera is full-screen. default false */
tapFocus?: boolean;
tapToFocus?: boolean;
/** On Android disable automatic rotation of the image and stripping of Exit header. default false */
disableExifHeaderStripping?: boolean;
@@ -202,20 +202,6 @@ export class CameraPreview extends IonicNativePlugin {
startCamera(options: CameraPreviewOptions): Promise<any> {
return;
}
/**
* Starts the camera video instance.
* @param {any} options
* @return {Promise<any>}
*/
@Cordova({
successIndex: 1,
errorIndex: 2,
})
startRecordVideo(options: any): Promise<any> {
return;
}
/**
* Stops the camera preview instance. (iOS & Android)
@@ -225,15 +211,6 @@ export class CameraPreview extends IonicNativePlugin {
stopCamera(): Promise<any> {
return;
}
/**
* Stops the camera video instance. (iOS & Android)
* @return {Promise<any>}
*/
@Cordova()
stopRecordVideo(): Promise<any> {
return;
}
/**
* Switch from the rear camera and front camera, if available.

View File

@@ -2,8 +2,8 @@ import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
export interface ChooserResult {
data?: Uint8Array;
dataURI?: string;
data: Uint8Array;
dataURI: string;
mediaType: string;
name: string;
uri: string;
@@ -64,15 +64,4 @@ export class Chooser extends IonicNativePlugin {
getFile(accept?: string): Promise<ChooserResult | undefined> {
return;
}
/**
* Displays native prompt for user to select a file.
* @param {string} [accept] Optional MIME type filter (e.g. 'image/gif,video/*').
* @returns {Promise<any>} Promise containing selected file's MIME type, display name, and original URI.
* If user cancels, promise will be resolved as undefined.
* If error occurs, promise will be rejected.
*/
@Cordova()
getFileMetadata(accept?: string): Promise<ChooserResult | undefined> {
return;
}
}

View File

@@ -50,16 +50,6 @@ export class CleverTap extends IonicNativePlugin {
return;
}
/**
* Personalization
* Disables the Personalization API
* @returns {Promise<any>}
*/
@Cordova()
disablePersonalization(): Promise<any> {
return;
}
/**
* Enables tracking opt out for the currently active user.
* @param optOut {boolean}
@@ -70,16 +60,6 @@ export class CleverTap extends IonicNativePlugin {
return;
}
/**
* Sets CleverTap SDK to offline mode.
* @param offline {boolean}
* @returns {Promise<any>}
*/
@Cordova()
setOffline(offline: boolean): Promise<any> {
return;
}
/**
* Enables the reporting of device network related information, including IP address. This reporting is disabled by default.
* @param enable {boolean}
@@ -113,48 +93,6 @@ export class CleverTap extends IonicNativePlugin {
return;
}
/**
* Sets the device's Xiaomi push token
* @param token {string}
* @returns {Promise<any>}
*/
@Cordova()
setPushXiaomiToken(token: string): Promise<any> {
return;
}
/**
* Sets the device's Baidu push token
* @param token {string}
* @returns {Promise<any>}
*/
@Cordova()
setPushBaiduToken(token: string): Promise<any> {
return;
}
/**
* Sets the device's Huawei push token
* @param token {string}
* @returns {Promise<any>}
*/
@Cordova()
setPushHuaweiToken(token: string): Promise<any> {
return;
}
/**
* Create Notification Channel for Android O+
* @param extras {any}
* @returns {Promise<any>}
*/
@Cordova()
createNotification(
extras: any
): Promise<any> {
return;
}
/**
* Create Notification Channel for Android O+
* @param channelID {string}
@@ -662,580 +600,6 @@ export class CleverTap extends IonicNativePlugin {
return;
}
/****************************
* Notification Inbox methods
****************************/
/**
* Call this method to initialize the App Inbox
*/
@Cordova()
initializeInbox(): Promise<any> {
return;
}
/**
* Call this method to get the count of unread Inbox messages
*/
@Cordova()
getInboxMessageUnreadCount(): Promise<any> {
return;
}
/**
* Call this method to get the count of total Inbox messages
*/
@Cordova()
getInboxMessageCount(): Promise<any> {
return;
}
/**
* Call this method to open the App Inbox
* @param styleConfig : any or empty object
*/
@Cordova()
showInbox(styleConfig: any): Promise<any> {
return;
}
/**
* Call this to Fetch all Inbox Messages
* @returns {Promise<any>}
*/
@Cordova()
getAllInboxMessages(): Promise<any> {
return;
}
/**
* Call this to Fetch all Unread Inbox Messages
* @returns {Promise<any>}
*/
@Cordova()
getUnreadInboxMessages(): Promise<any> {
return;
}
/**
* Call this to Fetch Inbox Message For Id
* @param messageId {string}
* @returns {Promise<any>}
*/
@Cordova()
getInboxMessageForId(messageId: string): Promise<any> {
return;
}
/**
* Call this to Delete Inbox Message For Id
* @param messageId {string}
* @returns {Promise<any>}
*/
@Cordova()
deleteInboxMessageForId(messageId: string): Promise<any> {
return;
}
/**
* Call this to Mark Read Inbox Message For Id
* @param messageId {string}
* @returns {Promise<any>}
*/
@Cordova()
markReadInboxMessageForId(messageId: string): Promise<any> {
return;
}
/**
* Call this to Mark Push Inbox Notification Viewed Event for Id
* @param messageId {string}
* @returns {Promise<any>}
*/
@Cordova()
pushInboxNotificationViewedEventForId(messageId: string): Promise<any> {
return;
}
/**
* Call this to Mark Push Inbox Notification Clicked Event for Id
* @param messageId {string}
* @returns {Promise<any>}
*/
@Cordova()
pushInboxNotificationClickedEventForId(messageId: string): Promise<any> {
return;
}
/**
* Call this to SetUIEditor Connection
* @param enabled {boolean}
* @returns {Promise<any>}
*/
@Cordova()
setUIEditorConnectionEnabled(enabled: boolean): Promise<any> {
return;
}
/**
* Call this to Register Boolean Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerBooleanVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register Double Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerDoubleVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register Integer Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerIntegerVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register String Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerStringVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register List of Boolean Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerListOfBooleanVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register List of Double Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerListOfDoubleVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register List of Integer Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerListOfIntegerVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register List of String Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerListOfStringVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register Map of Boolean Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerMapOfBooleanVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register Map of Double Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerMapOfDoubleVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register Map of Integer Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerMapOfIntegerVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Register Map of String Variable
* @param varName {string}
* @returns {Promise<any>}
*/
@Cordova()
registerMapOfStringVariable(varName: string): Promise<any> {
return;
}
/**
* Call this to Get Boolean Variable
* @param varName {string}
* @param defaultValue {boolean}
* @returns {Promise<any>}
*/
@Cordova()
getBooleanVariable(
varName: string,
defaultValue: boolean
): Promise<any> {
return;
}
/**
* Call this to Get Double Variable
* @param varName {string}
* @param defaultValue {number}
* @returns {Promise<any>}
*/
@Cordova()
getDoubleVariable(
varName: string,
defaultValue: number
): Promise<any> {
return;
}
/**
* Call this to Get Integer Variable
* @param varName {string}
* @param defaultValue {number}
* @returns {Promise<any>}
*/
@Cordova()
getIntegerVariable(
varName: string,
defaultValue: number
): Promise<any> {
return;
}
/**
* Call this to Get String Variable
* @param varName {string}
* @param defaultValue {string}
* @returns {Promise<any>}
*/
@Cordova()
getStringVariable(
varName: string,
defaultValue: string
): Promise<any> {
return;
}
/**
* Call this to Get List of Boolean Variable
* @param varName {string}
* @param defaultValue {any}
* @returns {Promise<any>}
*/
@Cordova()
getListOfBooleanVariable(
varName: string,
defaultValue: any
): Promise<any> {
return;
}
/**
* Call this to Get List of Double Variable
* @param varName {string}
* @param defaultValue {any}
* @returns {Promise<any>}
*/
@Cordova()
getListOfDoubleVariable(
varName: string,
defaultValue: any
): Promise<any> {
return;
}
/**
* Call this to Get List of Integer Variable
* @param varName {string}
* @param defaultValue {any}
* @returns {Promise<any>}
*/
@Cordova()
getListOfIntegerVariable(
varName: string,
defaultValue: any
): Promise<any> {
return;
}
/**
* Call this to Get List of String Variable
* @param varName {string}
* @param defaultValue {any}
* @returns {Promise<any>}
*/
@Cordova()
getListOfStringVariable(
varName: string,
defaultValue: any
): Promise<any> {
return;
}
/**
* Call this to get Map of Boolean Variable
* @param varName {string}
* @param defaultValue {any}
* @returns {Promise<any>}
*/
@Cordova()
getMapOfBooleanVariable(
varName: string,
defaultValue: any
): Promise<any> {
return;
}
/**
* Call this to Get Map of Double Variable
* @param varName {string}
* @param defaultValue {any}
* @returns {Promise<any>}
*/
@Cordova()
getMapOfDoubleVariable(
varName: string,
defaultValue: any
): Promise<any> {
return;
}
/**
* Call this to Get Map of Integer Variable
* @param varName {string}
* @param defaultValue {any}
* @returns {Promise<any>}
*/
@Cordova()
getMapOfIntegerVariable(
varName: string,
defaultValue: any
): Promise<any> {
return;
}
/**
* Call this to Get Map of String Variable
* @param varName {string}
* @param defaultValue {any}
* @returns {Promise<any>}
*/
@Cordova()
getMapOfStringVariable(
varName: string,
defaultValue: any
): Promise<any> {
return;
}
/**
* Call this to Get All Display Units
* @returns {Promise<any>}
*/
@Cordova()
getAllDisplayUnits(): Promise<any> {
return;
}
/**
* Call this to Get Display Unit For Id
* @param id {string}
* @returns {Promise<any>}
*/
@Cordova()
getDisplayUnitForId(id: string): Promise<any> {
return;
}
/**
* Call this to Push DisplayUnit Viewed Event for ID
* @param id {string}
* @returns {Promise<any>}
*/
@Cordova()
pushDisplayUnitViewedEventForID(id: string): Promise<any> {
return;
}
/**
* Call this to Push DisplayUnit Clicked Event for ID
* @param id {string}
* @returns {Promise<any>}
*/
@Cordova()
pushDisplayUnitClickedEventForID(id: string): Promise<any> {
return;
}
/**
* Call this to Get Feature Flag for key
* @param key {string}
* @param defaultValue {string}
* @returns {Promise<any>}
*/
@Cordova()
getFeatureFlag(
key: string,
defaultValue: string
): Promise<any> {
return;
}
/**
* Call this to Set Defaults for Product Config
* @param defaults {any}
* @returns {Promise<any>}
*/
@Cordova()
setDefaultsMap(
defaults: any
): Promise<any> {
return;
}
/**
* Call this for Product Config Fetch
* @param defaults {any}
* @returns {Promise<any>}
*/
@Cordova()
fetch(): Promise<any> {
return;
}
/**
* Call this for Product Config Fetch with Min Interval
* @param timeInterval {number}
* @returns {Promise<any>}
*/
@Cordova()
fetchWithMinimumFetchIntervalInSeconds(timeInterval: number): Promise<any> {
return;
}
/**
* Call this for Product Config Activate
* @returns {Promise<any>}
*/
@Cordova()
activate(): Promise<any> {
return;
}
/**
* Call this for Product Config Fetch and Activate
* @returns {Promise<any>}
*/
@Cordova()
fetchAndActivate(): Promise<any> {
return;
}
/**
* Call this to set Product Config Fetch with Min Interval
* @param timeInterval {number}
* @returns {Promise<any>}
*/
@Cordova()
setMinimumFetchIntervalInSeconds(timeInterval: number): Promise<any> {
return;
}
/**
* Call this to Get Last Fetch Time Interval
* @returns {Promise<any>}
*/
@Cordova()
getLastFetchTimeStampInMillis(): Promise<any> {
return;
}
/**
* Call this to Get String
* @param key {string}
* @returns {Promise<any>}
*/
@Cordova()
getString(): Promise<any> {
return;
}
/**
* Call this to Get Boolean
* @param key {string}
* @returns {Promise<any>}
*/
@Cordova()
getBoolean(): Promise<any> {
return;
}
/**
* Call this to Get Long
* @param key {string}
* @returns {Promise<any>}
*/
@Cordova()
getLong(): Promise<any> {
return;
}
/**
* Call this to Get Double
* @param key {string}
* @returns {Promise<any>}
*/
@Cordova()
getDouble(): Promise<any> {
return;
}
/**
* Call this to Reset Product Config
* @returns {Promise<any>}
*/
@Cordova()
reset(): Promise<any> {
return;
}
/*******************
* Developer Options
******************/

View File

@@ -16,60 +16,6 @@ export interface NotificationData {
[name: string]: any;
}
export interface IRequestPushPermissionIOSOptions {
/**
* Options exclusive for iOS 9 support
*/
ios9Support?: {
/**
* How long it will wait for a decision from the user before returning `false`, defaults to 10
*/
timeout?: number;
/**
* How long between each permission verification, defaults to 0.3
*/
interval?: number;
};
}
export interface IChannelConfiguration {
/**
* Channel id, used in the android_channel_id push payload key
*/
id: string;
/**
* Channel name, visible for the user
*/
name: string;
/**
* Channel description, visible for the user
*/
description?: string;
/**
* Importance for notifications of this channel
* https://developer.android.com/guide/topics/ui/notifiers/notifications#importance
*/
importance?: 'none' | 'min' | 'low' | 'default' | 'high';
/**
* Visibility for notifications of this channel
* https://developer.android.com/training/notify-user/build-notification#lockscreenNotification
*/
visibility?: 'public' | 'private' | 'secret';
/**
* Default sound resource for notifications of this channel
* The file should located as resources/raw/[resource name].mp3
*/
sound?: string;
/**
* Enable lights for notifications of this channel
*/
lights?: boolean;
/**
* Enable vibration for notifications of this channel
*/
vibration?: boolean;
}
/**
* @name FCM
* @capacitorincompatible true
@@ -115,8 +61,6 @@ export interface IChannelConfiguration {
* ```
* @interfaces
* NotificationData
* IRequestPushPermissionIOSOptions
* IChannelConfiguration
*/
@Plugin({
pluginName: 'FCM',
@@ -219,32 +163,4 @@ export class FCM extends IonicNativePlugin {
clearAllNotifications(): void {
return;
}
/**
* Request push notification permission, alerting the user if it not have yet decided
*
* @param {IRequestPushPermissionIOSOptions} options Options for push request
*
* @returns {Promise<boolean>} Returns a Promise that resolves with the permission status
*/
@Cordova()
requestPushPermissionIOS(options?: IRequestPushPermissionIOSOptions): Promise<boolean> {
return;
}
/**
* For Android, some notification properties are only defined programmatically.
*
* Channel can define the default behavior for notifications on Android 8.0+.
*
* Once a channel is created, it stays unchangeable until the user uninstalls the app.
*
* @param channelConfig
*
* @returns {Promise<void>}
*/
@Cordova()
createNotificationChannelAndroid(channelConfig: IChannelConfiguration): void {
return;
}
}

View File

@@ -16,7 +16,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
* ...
*
*
* const crashlytics = this.firebaseCrashlytics.initialise();
* const crashlytics = this.firebaseCrashlytics.initialize();
* crashlytics.logException('my caught exception');
*
* ```

View File

@@ -7,49 +7,6 @@ export interface IDynamicLink {
deepLink: string;
}
export interface ICreatedDynamicLink {
url: string;
}
export interface ILinkOptions {
domainUriPrefix?: string;
link?: string;
androidInfo?: {
androidPackageName?: string;
androidFallbackLink?: string;
androidMinPackageVersionCode?: number;
};
iosInfo?: {
iosBundleId?: string;
iosFallbackLink?: string;
iosIpadFallbackLink?: string;
iosIpadBundleId?: string;
iosAppStoreId?: string;
};
navigationInfo?: {
enableForcedRedirect?: boolean;
};
analyticsInfo?: {
googlePlayAnalytics?: {
utmSource?: string;
utmMedium?: string;
utmCampaign?: string;
utmTerm?: string;
utmContent?: string;
};
itunesConnectAnalytics?: {
at?: string;
ct?: string;
pt?: string;
};
};
socialMetaTagInfo?: {
socialTitle?: string;
socialDescription?: string;
socialImageLink?: string;
};
}
/**
* @beta
* @name Firebase Dynamic Links
@@ -112,40 +69,4 @@ export class FirebaseDynamicLinks extends IonicNativePlugin {
onDynamicLink(): Observable<IDynamicLink> {
return;
}
/**
* Creates a Dynamic Link from the parameters. Returns a promise fulfilled with the new dynamic link url.
* @param {ILinkOptions} opt [Dynamic Link Parameters](https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks#dynamic-link-parameters)
* @return {Promise<ICreatedDynamicLink>} Returns a promise with the url
*/
@Cordova({
otherPromise: true,
})
createDynamicLink(opts: ILinkOptions): Promise<ICreatedDynamicLink> {
return;
}
/**
* Creates a shortened Dynamic Link from the parameters. Shorten the path to a string that is only as long as needed to be unique, with a minimum length of 4 characters. Use this method if sensitive information would not be exposed if a short Dynamic Link URL were guessed.
* @param {ILinkOptions} opt [Dynamic Link Parameters](https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks#dynamic-link-parameters)
* @return {Promise<ICreatedDynamicLink>} Returns a promise with the url
*/
@Cordova({
otherPromise: true,
})
createShortDynamicLink(opts: ILinkOptions): Promise<ICreatedDynamicLink> {
return;
}
/**
* Creates a Dynamic Link from the parameters. Shorten the path to an unguessable string. Such strings are created by base62-encoding randomly generated 96-bit numbers, and consist of 17 alphanumeric characters. Use unguessable strings to prevent your Dynamic Links from being crawled, which can potentially expose sensitive information.
* @param {ILinkOptions} opt [Dynamic Link Parameters](https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks#dynamic-link-parameters)
* @return {Promise<ICreatedDynamicLink>} Returns a promise with the url
*/
@Cordova({
otherPromise: true,
})
createUnguessableDynamicLink(opts: ILinkOptions): Promise<ICreatedDynamicLink> {
return;
}
}

View File

@@ -1,185 +1,6 @@
import { Injectable } from '@angular/core';
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
export enum BarcodeFormat {
UNKNOWN = -1,
ALL_FORMATS = 0,
CODE_128 = 1,
CODE_39 = 2,
CODE_93 = 4,
CODABAR = 8,
DATA_MATRIX = 16,
EAN_13 = 32,
EAN_8 = 64,
ITF = 128,
QR_CODE = 256,
UPC_A = 512,
UPC_E = 1024,
PDF417 = 2048,
AZTEC = 4096
}
export enum BarcodeValueType {
/** Unknown Barcode value types. */
Unknown,
/** Barcode value type for contact info. */
ContactInfo,
/** Barcode value type for email addresses. */
Email,
/** Barcode value type for ISBNs. */
ISBN,
/** Barcode value type for phone numbers. */
Phone,
/** Barcode value type for product codes. */
Product,
/** Barcode value type for SMS details. */
SMS,
/** Barcode value type for plain text. */
Text,
/** Barcode value type for URLs/bookmarks. */
URL,
/** Barcode value type for Wi-Fi access point details. */
WiFi,
/** Barcode value type for geographic coordinates. */
GeographicCoordinates,
/** Barcode value type for calendar events. */
CalendarEvent,
/** Barcode value type for driver's license data. */
DriversLicense
}
export enum BarcodeEmailType {
/** Unknown email type. */
Unknown,
/** Barcode work email type. */
Work,
/** Barcode home email type. */
Home
}
export enum BarcodePhoneType {
/** Unknown phone type. */
Unknown,
/** Barcode work phone type. */
Work,
/** Barcode home phone type. */
Home,
/** Barcode fax phone type. */
Fax,
/** Barcode mobile phone type. */
Mobile
}
export enum BarcodeWiFiEncryptionType {
/** Barcode unknown Wi-Fi encryption type. */
Unknown,
/** Barcode open Wi-Fi encryption type. */
Open,
/** Barcode WPA Wi-Fi encryption type. */
WPA,
/** Barcode WEP Wi-Fi encryption type. */
WEP
}
export enum BarcodeAddressType {
/** Barcode unknown address type. */
Unknown,
/** Barcode work address type. */
Work,
/** Barcode home address type. */
Home
}
export interface Barcode {
valueType: BarcodeValueType
format: BarcodeFormat
rawValue: string
displayValue: string
cornerPoints: any
email: BarcodeEmail
phone: BarcodePhone
sms: BarcodeSms
url: BarcodeUrl
wifi: BarcodeWifi
geoPoint: BarcodeGeoPoint
calendarEvent: BarcodeCalendarEvent
contactInfo: BarcodeContactInfo
driverLicense: BarcodeDriverLicense
}
export interface BarcodeEmail {
address: string
body: string
subject: string
type: BarcodeEmailType
}
export interface BarcodePhone {
number: string
type: BarcodePhoneType
}
export interface BarcodeSms {
phoneNumber: string
message: string
}
export interface BarcodeUrl {
title: string
url: string
}
export interface BarcodeWifi {
ssid: string
password: string
type: BarcodeWiFiEncryptionType
}
export interface BarcodeGeoPoint {
latitude: number
longitude: number
}
export interface BarcodeCalendarEvent {
eventDescription: string
location: string
organizer: string
status: string
summary: string
start: any
end: any
}
export interface BarcodeContactInfo {
title: string
name: string
addresses: BarcodeAddress[]
phones: BarcodePhone[]
emails: BarcodeEmail[]
organization: string
urls: string
}
export interface BarcodeAddress {
addressLine: string
type: BarcodeAddressType
}
export interface BarcodeDriverLicense {
firstName: string
middleName: string
lastName: string
gender: string
addressCity: string
addressState: string
addressStreet: string
addressZip: string
birthDate: string
documentType: string
licenseNumber: string
expiryDate: string
issuingDate: string
issuingCountry: string
}
/**
* @name Firebase Vision
* @description
@@ -199,10 +20,6 @@ export interface BarcodeDriverLicense {
* .then((res: string) => console.log(res))
* .catch((error: string) => console.error(error));
*
* this.firebaseVision.barcodeDetector(FILE_URI)
* .then((res: Barcode[]) => console.log(res))
* .catch((error: string) => console.error(error));
*
* ```
*/
@Plugin({
@@ -223,9 +40,4 @@ export class FirebaseVision extends IonicNativePlugin {
onDeviceTextRecognizer(file_uri: string): Promise<string> {
return;
}
@Cordova()
barcodeDetector(file_uri: string): Promise<Barcode[]> {
return;
}
}

View File

@@ -304,23 +304,6 @@ export class FirebaseX extends IonicNativePlugin {
return;
}
/**
* Indicates whether autoinit is currently enabled. If so, new FCM tokens will be automatically generated.
*/
@Cordova()
isAutoInitEnabled(): Promise<boolean> {
return;
}
/**
* Sets whether to autoinit new FCM tokens. By default, a new token will be generated as soon as the old one is removed.
* To prevent a new token being generated, by sure to disable autoinit using setAutoInitEnabled() before calling unregister().
*/
@Cordova()
setAutoInitEnabled(enabled: boolean): 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
@@ -507,8 +490,10 @@ export class FirebaseX extends IonicNativePlugin {
* 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 - time to wait in seconds before timing out
* @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:
@@ -516,13 +501,12 @@ export class FirebaseX extends IonicNativePlugin {
* 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({
callbackOrder: 'reverse'
})
@Cordova()
verifyPhoneNumber(
success: (value: string | object) => void,
error: (err: string) => void,
phoneNumber: string,
timeOutDuration: number,
fakeVerificationCode?: string
timeoutDuration = 0
): Promise<any> {
return;
}
@@ -531,66 +515,11 @@ export class FirebaseX extends IonicNativePlugin {
* Signs the user into Firebase with credentials obtained using verifyPhoneNumber().
* See the Android- and iOS-specific Firebase documentation for more info.
* @param {object} credential - a credential object returned by the success callback of an authentication method
* @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(credential: object): Promise<any> {
return;
}
/**
* Creates a new email/password-based user account. If account creation is successful, user will be automatically signed in.
* @param email
* @param password
*/
@Cordova()
createUserWithEmailAndPassword(email: string, password: string): Promise<any> {
return;
}
/**
* Signs in to an email/password-based user account.
* @param email
* @param password
*/
@Cordova()
signInUserWithEmailAndPassword(email: string, password: string): Promise<any> {
return;
}
/**
* Signs in user with custom token.
* @param customToken
*/
@Cordova()
signInUserWithCustomToken(customToken: string): Promise<any> {
return;
}
/**
* Signs in user anonymously.
*/
@Cordova()
signInUserAnonymously(): Promise<any> {
return;
}
/**
* Authenticates the user with a Google account to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user.
* @param clientId
*/
@Cordova()
authenticateUserWithGoogle(clientId: string): Promise<any> {
return;
}
/**
* Authenticates the user with an Apple account using Sign In with Apple to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user.
* @param locale
*/
@Cordova({
callbackOrder: 'reverse',
})
authenticateUserWithApple(locale?: string): Promise<any> {
signInWithCredential(credential: object, success: () => void, error: (err: string) => void): Promise<any> {
return;
}
@@ -617,76 +546,6 @@ export class FirebaseX extends IonicNativePlugin {
return;
}
/**
* Checks if there is a current Firebase user signed into the app.
*/
@Cordova()
isUserSignedIn(): Promise<boolean> {
return;
}
/**
* Signs current Firebase user out of the app.
*/
@Cordova()
signOutUser(): Promise<any> {
return;
}
/**
* Updates the display name and/or photo URL of the current Firebase user signed into the app.
* @param profile
*/
@Cordova()
updateUserProfile(profile: { name: string; photoUri: string }): Promise<any> {
return;
}
/**
* Updates/sets the email address of the current Firebase user signed into the app.
* @param email
*/
@Cordova()
updateUserEmail(email: string): Promise<any> {
return;
}
/**
* Sends a verification email to the currently configured email address of the current Firebase user signed into the app.
* When the user opens the contained link, their email address will have been verified.
*/
@Cordova()
sendUserEmailVerification(): Promise<any> {
return;
}
/**
* Updates/sets the account password for the current Firebase user signed into the app.
* @param password
*/
@Cordova()
updateUserPassword(password: string): Promise<any> {
return;
}
/**
* Sends a password reset email to the specified user email address.
* Note: doesn't require the Firebase user to be signed in to the app.
* @param email
*/
@Cordova()
sendUserPasswordResetEmail(email: string): Promise<any> {
return;
}
/**
* Deletes the account of the current Firebase user signed into the app.
*/
@Cordova()
deleteUser(): Promise<any> {
return;
}
/**
* Registers a Javascript function to invoke when Firebase Authentication state changes between user signed in/signed out.
* @param {function} fn - callback function to invoke when authentication state changes

View File

@@ -1,49 +0,0 @@
import { Injectable } from '@angular/core';
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
/**
* @name ios-aswebauthenticationsession-api
* @description
* Plugin for iOS 12 ASWebAuthenticationSession API
*
* @usage
* ```typescript
* import { IosASWebauthenticationSession } from '@ionic-native/ios-aswebauthenticationsession-api/ngx';
*
*
* constructor(private IosASWebauthenticationSession: ios-aswebauthenticationsession-api) { }
*
* ...
*
*
* this.IosASWebauthenticationSession.start(callbackUrl, authorizeURL)
* .then((redirectUrl: string) => console.log(redirectUrl))
* .catch((error: any) => console.error(error));
*
* ```
*/
@Plugin({
pluginName: 'IosASWebauthenticationSession',
plugin: 'cordova-plugin-ios-aswebauthenticationsession-api',
pluginRef: 'plugins.ASWebAuthSession',
repo:
'https://github.com/jwelker110/cordova-plugin-ios-aswebauthenticationsession-api',
platforms: ['iOS'],
})
@Injectable()
export class IosASWebauthenticationSession extends IonicNativePlugin {
/**
* This function start an authentication flow in ASWebauthenticationSession
* @param callbackUrl {string} Callback URL of your App
* @param authorizeURL {number} Authorization URL
* @return {Promise<string>} Returns a promise that resolves a string containing the redirect URL after finishing ASWebauthenticationSession
*/
@Cordova()
start(
callbackUrl: string,
authorizeURL: string
): Promise<string> {
return;
}
}

View File

@@ -407,11 +407,13 @@ export class BAMCardInformation {
/**
* @name Jumio
* @description Check out [example with Angular 9.1 & Capacitor 2.1](https://github.com/zendigital/jumio-ionic-demo)
* @description
* [Jumio mobile-cordova](https://github.com/Jumio/mobile-cordova) Plugin for Ionic
*
* [Platform Customization](https://github.com/Jumio/mobile-cordova#customization) is possible
* Read this for [Platform Customization](https://github.com/Jumio/mobile-cordova#customization) is possible
*
* To get Jumio Cordova working on Android check out this [FAQ](https://github.com/Jumio/mobile-cordova#faq)
*
* Original source: [Jumio mobile-cordova](https://github.com/Jumio/mobile-cordova) Plugin for Apache Cordova
* @usage
* ```typescript
* import {
@@ -443,9 +445,10 @@ export class BAMCardInformation {
*/
@Plugin({
pluginName: 'Jumio',
plugin: 'jumio-cordova',
plugin: 'cordova-plugin-jumio-mobilesdk',
pluginRef: 'Jumio',
repo: 'https://github.com/danielzen/jumio-cordova',
repo: 'https://github.com/Jumio/mobile-cordova',
install: 'npm install git://github.com/Jumio/mobile-cordova.git',
platforms: ['Android', 'iOS'],
})
@Injectable()

View File

@@ -1,6 +1,5 @@
import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
import { Observable } from 'rxjs';
/**
* @name Launch Review
@@ -56,10 +55,10 @@ export class LaunchReview extends IonicNativePlugin {
* - First: after `LaunchReview.rating()` is called and the request to show the dialog is successful. Will be passed the value `requested`.
* - Second: if and when the Rating dialog is actually displayed. Will be passed the value `shown`.
* - Third: if and when the Rating dialog is dismissed. Will be passed the value `dismissed`.
* @returns {Observable<string>}
* @returns {Promise<string>}
*/
@Cordova({ observable: true })
rating(): Observable<string> {
@Cordova({ platforms: ['iOS'] })
rating(): Promise<string> {
return;
}

View File

@@ -188,7 +188,6 @@ export class MixpanelPeople extends IonicNativePlugin {
*
* @param distinctId {string}
* @return {Promise<any>}
* @deprecated since 2016-11-21 - Use Mixpanel.identify instead.
*/
@Cordova()
identify(distinctId: string): Promise<any> {

View File

@@ -119,9 +119,7 @@ export interface OCRResult {
* @name OCR
* @description
* This plugin attempts to identify and extract text from an image.
* Please note: This plugin depends on the GoogleMobileVision pod which is referencing UIWebview, that has been deprecated by Apple.
* Don't use this plugin in an app intended for App Store as you will get a review rejection from Apple: `Deprecated API Usage — Apple will stop accepting submissions of apps that use UIWebView APIs`
* For more info, please see the following Github issue [Google Mobile Vision relying on deprecated UIWebview](https://github.com/NeutrinosPlatform/cordova-plugin-mobile-ocr/issues/27).
*
* @usage
* ```typescript
* import { OCR, OCRSourceType } from '@ionic-native/ocr/ngx';

View File

@@ -56,7 +56,7 @@ export interface AuthorizationData {
*
* @usage
* ```typescript
* import { SpotifyAuth } from '@ionic-native/spotify-auth/ngx';
* import { SpotifyAuth } from '@ionic-native/spotify-auth';
*
* // [...]
*
@@ -82,7 +82,7 @@ export interface AuthorizationData {
*
* // [...]
*
* this.spotifyAuth.forget();
* this.spotifyAuth.forget().then(() => console.log("We're logged out!"));
*
* // [...]
* ```

View File

@@ -16,19 +16,6 @@ export interface PersonResponse {
external_person_id?: string;
}
export interface InboxMessage {
content?: string;
created_at?: string;
expires_at?: string;
message_uid?: string;
read?: boolean;
subject?: string;
detail?: string;
collapse_key?: string;
apprefdata?: any;
images?: any;
inbox_custom_data: any;
}
/**
* @name Vibes
* @description
@@ -54,11 +41,8 @@ export interface InboxMessage {
*
* this.vibes.getVibesDeviceInfo()
* .then((res: any) => console.log(res)) // retrieve the `device_id` and `push_token` from the JSON object
* .catch((error: any) => console.error('Error retrieving deviceinfo', error));
* .catch((error: any) => console.error('Error retrieving deviceinfo push', error));
*
* this.vibes.fetchInboxMessages()
* .then((res: any) => console.log(res)) // fetches inbox messages for this person.
* .catch((error: any) => console.error('Error fetching inbox messages for this person', error));
* ```
*/
@Plugin({
@@ -74,8 +58,7 @@ export interface InboxMessage {
@Injectable()
export class Vibes extends IonicNativePlugin {
/**
* Register this device with the Vibes platform
*
* Register device
* @return {Promise<DeviceResponse>}
*/
@Cordova()
@@ -84,8 +67,7 @@ export class Vibes extends IonicNativePlugin {
}
/**
* Unregister this device with the Vibes platform
*
* Unregister device
* @return {Promise<void>}
*/
@Cordova()
@@ -94,8 +76,7 @@ export class Vibes extends IonicNativePlugin {
}
/**
* Associate an external ID with the current person.
*
* Associate person
* @param {string} externalPersonId
* @return {Promise<void>}
*/
@@ -105,8 +86,7 @@ export class Vibes extends IonicNativePlugin {
}
/**
* Register this device to receive push notifications
*
* Register push
* @return {Promise<void>}
*/
@Cordova()
@@ -115,8 +95,7 @@ export class Vibes extends IonicNativePlugin {
}
/**
* Unregister the device from receiving push notifications
*
* Unregister push
* @return {Promise<void>}
*/
@Cordova()
@@ -124,8 +103,7 @@ export class Vibes extends IonicNativePlugin {
return;
}
/**
* Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token
*
* getVibesDeviceInfo
* @return {Promise<DeviceInfoResponse>}
*/
@Cordova()
@@ -134,8 +112,7 @@ export class Vibes extends IonicNativePlugin {
}
/**
* Fetches the PersonResponse associated with this device currently
*
* getPerson
* @return {Promise<PersonResponse>}
*/
@Cordova()
@@ -145,7 +122,6 @@ export class Vibes extends IonicNativePlugin {
/**
* Get notified when the user opens a notification
*
* @return {Observable<void>}
*/
@Cordova({
@@ -154,59 +130,4 @@ export class Vibes extends IonicNativePlugin {
onNotificationOpened(): Observable<void> {
return;
}
/**
* Fetches an array of inbox messages for the person associated with this device.
*
* @return {Promise<InboxMessage[]>}
*/
@Cordova()
fetchInboxMessages(): Promise<InboxMessage[]> {
return;
}
/**
* Fetches a single inbox message by it's id.
*
* @param {string} message_uid
* @return {Promise<InboxMessage>}
*/
@Cordova()
fetchInboxMessage(message_uid: string): Promise<InboxMessage> {
return;
}
/**
* Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date if null or invalid date is supplied.
*
* @param {string} message_uid
* @param {string} An ISO-8601 formatted date string.
* @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated
*/
@Cordova()
expireInboxMessage(message_uid: string, date: string): Promise<InboxMessage> {
return;
}
/**
* Marks an inbox message as read.
*
* @param {string} message_uid
* @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated
*/
@Cordova()
markInboxMessageAsRead(message_uid: string): Promise<InboxMessage> {
return;
}
/**
* Records an event for when the user opens an inbox message.
*
* @param inbox_message_stringified stringified version of the InboxMessage
* @return {Promise<void>}
*/
@Cordova()
onInboxMessageOpen(inbox_message_stringified: string): Promise<void> {
return;
}
}