mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2026-05-20 00:06:24 +08:00
refactor: upgrade eslint and prettier config
This commit is contained in:
@@ -1,4 +0,0 @@
|
||||
scripts/
|
||||
docs/
|
||||
dist/
|
||||
node_modules/
|
||||
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"plugins": ["@typescript-eslint", "jsdoc"],
|
||||
"extends": ["plugin:@typescript-eslint/recommended", "prettier", "plugin:jsdoc/recommended"],
|
||||
"rules": {
|
||||
"@typescript-eslint/no-unused-vars": ["off"],
|
||||
"@typescript-eslint/no-explicit-any": ["warn"],
|
||||
"@typescript-eslint/no-empty-function": ["off"],
|
||||
"@typescript-eslint/ban-types": ["warn"],
|
||||
"@typescript-eslint/no-empty-interface": ["warn"],
|
||||
"@typescript-eslint/no-namespace": ["off"]
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
const typescriptEslint = require('@typescript-eslint/eslint-plugin');
|
||||
const typescriptParser = require('@typescript-eslint/parser');
|
||||
const jsdoc = require('eslint-plugin-jsdoc');
|
||||
const prettier = require('eslint-config-prettier');
|
||||
|
||||
module.exports = [
|
||||
// Ignore patterns (equivalent to .eslintignore)
|
||||
{
|
||||
ignores: ['scripts/**', 'docs/**', 'dist/**', 'node_modules/**'],
|
||||
},
|
||||
|
||||
// Main configuration for TypeScript files
|
||||
{
|
||||
files: ['src/**/*.ts'],
|
||||
languageOptions: {
|
||||
parser: typescriptParser,
|
||||
ecmaVersion: 'latest',
|
||||
sourceType: 'module',
|
||||
},
|
||||
plugins: {
|
||||
'@typescript-eslint': typescriptEslint,
|
||||
jsdoc,
|
||||
},
|
||||
rules: {
|
||||
// TypeScript ESLint recommended rules (manually specified to avoid breaking changes)
|
||||
...typescriptEslint.configs.recommended.rules,
|
||||
|
||||
// JSDoc recommended rules (manually specified to avoid breaking changes)
|
||||
...jsdoc.configs.recommended.rules,
|
||||
|
||||
// Custom rules from original .eslintrc (maintained for compatibility)
|
||||
'@typescript-eslint/no-unused-vars': 'off',
|
||||
'@typescript-eslint/no-explicit-any': 'warn',
|
||||
'@typescript-eslint/no-empty-function': 'off',
|
||||
// '@typescript-eslint/ban-types': 'warn', // Deprecated in v8, removed
|
||||
'@typescript-eslint/no-empty-interface': 'warn',
|
||||
'@typescript-eslint/no-namespace': 'off',
|
||||
|
||||
// Disable rules that might cause immediate issues during migration
|
||||
'@typescript-eslint/no-require-imports': 'off',
|
||||
'@typescript-eslint/no-var-requires': 'off',
|
||||
'@typescript-eslint/no-this-alias': 'off',
|
||||
'@typescript-eslint/no-inferrable-types': 'off',
|
||||
'@typescript-eslint/no-non-null-assertion': 'off',
|
||||
'@typescript-eslint/prefer-as-const': 'off',
|
||||
'@typescript-eslint/no-unnecessary-type-constraint': 'off',
|
||||
'@typescript-eslint/ban-ts-comment': 'off',
|
||||
'@typescript-eslint/triple-slash-reference': 'off',
|
||||
'@typescript-eslint/no-wrapper-object-types': 'off',
|
||||
'@typescript-eslint/no-unsafe-function-type': 'off',
|
||||
|
||||
// JSDoc rules that might cause issues
|
||||
'jsdoc/require-returns': 'off',
|
||||
'jsdoc/require-returns-description': 'off',
|
||||
'jsdoc/require-returns-type': 'off',
|
||||
'jsdoc/require-param': 'off',
|
||||
'jsdoc/require-param-description': 'off',
|
||||
'jsdoc/require-param-type': 'off',
|
||||
'jsdoc/check-param-names': 'off',
|
||||
'jsdoc/check-tag-names': 'off',
|
||||
'jsdoc/check-types': 'off',
|
||||
'jsdoc/newline-after-description': 'off',
|
||||
'jsdoc/no-undefined-types': 'off',
|
||||
'jsdoc/valid-types': 'off',
|
||||
|
||||
'@typescript-eslint/no-empty-object-type': 'off',
|
||||
'@typescript-eslint/no-unused-expressions': 'off',
|
||||
'@typescript-eslint/no-unsafe-declaration-merging': 'off',
|
||||
'@typescript-eslint/no-duplicate-enum-values': 'off',
|
||||
},
|
||||
},
|
||||
|
||||
// Apply prettier config last to override formatting rules
|
||||
prettier,
|
||||
];
|
||||
Generated
+846
-863
File diff suppressed because it is too large
Load Diff
+6
-6
@@ -39,16 +39,16 @@
|
||||
"@types/lodash": "4.17.5",
|
||||
"@types/node": "20.14.10",
|
||||
"@types/rimraf": "4.0.5",
|
||||
"@typescript-eslint/eslint-plugin": "5.62.0",
|
||||
"@typescript-eslint/parser": "5.62.0",
|
||||
"@typescript-eslint/eslint-plugin": "^8.11.0",
|
||||
"@typescript-eslint/parser": "^8.11.0",
|
||||
"async-promise-queue": "1.0.5",
|
||||
"cz-conventional-changelog": "3.3.0",
|
||||
"dgeni": "0.4.14",
|
||||
"dgeni-packages": "0.16.10",
|
||||
"esbuild": "^0.25.5",
|
||||
"eslint": "8.57.1",
|
||||
"eslint-config-prettier": "10.1.5",
|
||||
"eslint-plugin-jsdoc": "50.6.17",
|
||||
"eslint": "^9.15.0",
|
||||
"eslint-config-prettier": "^10.1.5",
|
||||
"eslint-plugin-jsdoc": "^50.7.1",
|
||||
"fs-extra": "11.3.0",
|
||||
"gulp": "5.0.0",
|
||||
"gulp-rename": "2.0.0",
|
||||
@@ -60,7 +60,7 @@
|
||||
"lint-staged": "16.0.0",
|
||||
"lodash": "4.17.21",
|
||||
"minimist": "1.2.8",
|
||||
"prettier": "2.8.8",
|
||||
"prettier": "^3.4.2",
|
||||
"release-please": "^17.1.0",
|
||||
"rimraf": "5.0.5",
|
||||
"rollup": "4.41.0",
|
||||
|
||||
@@ -11,7 +11,6 @@ export class AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns a boolean that indicates whether the plugin is installed
|
||||
*
|
||||
* @returns {boolean}
|
||||
*/
|
||||
static installed(): boolean {
|
||||
|
||||
@@ -157,7 +157,6 @@ function wrapObservable(pluginObj: any, methodName: string, args: any[], opts: a
|
||||
|
||||
/**
|
||||
* Wrap the event with an observable
|
||||
*
|
||||
* @private
|
||||
* @param event event name
|
||||
* @param element The element to attach the event listener to
|
||||
@@ -173,7 +172,6 @@ function wrapEventObservable(event: string, element: any): Observable<any> {
|
||||
|
||||
/**
|
||||
* Checks if plugin/cordova is available
|
||||
*
|
||||
* @returns {boolean | { error: string } }
|
||||
* @private
|
||||
*/
|
||||
@@ -220,7 +218,6 @@ export function checkAvailability(plugin: any, methodName?: string, pluginName?:
|
||||
|
||||
/**
|
||||
* Checks if _objectInstance exists and has the method/property
|
||||
*
|
||||
* @param pluginObj
|
||||
* @param methodName
|
||||
* @private
|
||||
@@ -319,7 +316,7 @@ export function callCordovaPlugin(
|
||||
|
||||
if (availabilityCheck === true) {
|
||||
const pluginInstance = getPlugin(pluginObj.constructor.getPluginRef());
|
||||
// eslint-disable-next-line prefer-spread
|
||||
|
||||
return pluginInstance[methodName].apply(pluginInstance, args);
|
||||
} else {
|
||||
return availabilityCheck;
|
||||
@@ -345,7 +342,6 @@ export function callInstance(
|
||||
args = setIndex(args, opts, resolve, reject);
|
||||
|
||||
if (instanceAvailability(pluginObj, methodName)) {
|
||||
// eslint-disable-next-line prefer-spread
|
||||
return pluginObj._objectInstance[methodName].apply(pluginObj._objectInstance, args);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,6 @@ declare const window: any;
|
||||
* Initialize the ionic.native Angular module if we're running in ng1.
|
||||
* This iterates through the list of registered plugins and dynamically
|
||||
* creates Angular 1 services of the form $cordovaSERVICE, ex: $cordovaStatusBar.
|
||||
*
|
||||
* @param plugins
|
||||
*/
|
||||
export function initAngular1(plugins: any) {
|
||||
|
||||
@@ -304,7 +304,6 @@ export interface DataCaptureResult {
|
||||
export class AbbyyRTR extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Opens a modal dialog with controls for the Text Capture scenario.
|
||||
*
|
||||
* @param {TextCaptureOptions} options
|
||||
* @returns {Promise<TextCaptureResult>}
|
||||
*/
|
||||
@@ -323,7 +322,6 @@ export class AbbyyRTR extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Opens a modal dialog with controls for the Data Capture scenario.
|
||||
*
|
||||
* @param {DataCaptureOptions} options
|
||||
* @returns {Promise<DataCaptureResult>}
|
||||
*/
|
||||
|
||||
@@ -115,7 +115,6 @@ export class ActionSheet extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show a native ActionSheet component. See below for options.
|
||||
*
|
||||
* @param {ActionSheetOptions} [options] Options See table below
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with the index of the
|
||||
* button pressed (1 based, so 1, 2, 3, etc.)
|
||||
@@ -127,7 +126,6 @@ export class ActionSheet extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Programmatically hide the native ActionSheet
|
||||
*
|
||||
* @param {ActionSheetOptions} [options] Options See table below
|
||||
* @returns {Promise<any>} Returns a Promise that resolves when the actionsheet is closed
|
||||
*/
|
||||
|
||||
@@ -513,7 +513,6 @@ export enum AdjustLogLevel {
|
||||
* This is the Ionic Cordova SDK of Adjust™. You can read more about Adjust™ at adjust.com.
|
||||
*
|
||||
* Requires Cordova plugin: `com.adjust.sdk`. For more info, please see the [Adjust Cordova SDK](https://github.com/adjust/cordova_sdk)
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { Adjust, AdjustConfig, AdjustEnvironment } from '@awesome-cordova-plugins/adjust/ngx';
|
||||
@@ -561,7 +560,6 @@ export enum AdjustLogLevel {
|
||||
export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This method initializes Adjust SDK
|
||||
*
|
||||
* @param {AdjustConig} adjustConfig Adjust config object used as starting options
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -569,7 +567,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method tracks an event
|
||||
*
|
||||
* @param {AdjustEvent} adjustEvent Adjust event object to be tracked
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -577,7 +574,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method tracks App Store subscription
|
||||
*
|
||||
* @param {AdjustAppStoreSubscription} adjustAppStoreSubscription Adjust App Store subscription object to be tracked
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -585,7 +581,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method tracks Play Store subscription
|
||||
*
|
||||
* @param {AdjustPlayStoreSubscription} adjustPlayStoreSubscription Adjust Play Store subscription object to be tracked
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -593,7 +588,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method tracks third party sharing choice
|
||||
*
|
||||
* @param {AdjustThirdPartySharing} adjustThirdPartySharing Adjust third party sharing object to be tracked
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -601,7 +595,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method tracks ad revenue data
|
||||
*
|
||||
* @param {AdjustAdRevenue} adjustAdRevenue Adjust ad revenue object
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -609,7 +602,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method tracks measurement consent choice
|
||||
*
|
||||
* @param {boolean} measurementConsent set measurement consent to true or false
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -629,7 +621,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* By making this call, the Adjust SDK will try to find if there is any new attribution info inside of the deep link and if any, it will be sent to the Adjust backend.
|
||||
*
|
||||
* @param {AdjustDeeplink} adjustDeeplink AdjustDeeplink instance
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -637,7 +628,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method is used to send and potentially resolve shortened deep links
|
||||
*
|
||||
* @param {AdjustDeeplink} adjustDeeplink AdjustDeeplink instance containing shortened deep link that has opened your app
|
||||
* @returns {Promise<string>} Returns a promise with either resolved (if it was resolved) or echoed deep link
|
||||
*/
|
||||
@@ -661,7 +651,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* To send us the push notification token, add the following call to Adjust whenever you get your token in the app or when it gets updated.
|
||||
* Push tokens are used for Audience Builder and client callbacks, and they are required for the upcoming uninstall tracking feature.
|
||||
*
|
||||
* @param {string} pushToken Push token value
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -669,7 +658,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if the Adjust SDK is currently enabled by calling this function
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -686,7 +674,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Function used to get Google AdId
|
||||
*
|
||||
* @returns {Promise<string>} Returns a promise with Google advertising ID value
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -696,7 +683,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* If you need to obtain the Amazon Fire Advertising ID, you can make a call to this function.
|
||||
*
|
||||
* @returns {Promise<string>} Returns a promise with Amazon Fire advertising ID
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -706,7 +692,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* To obtain the IDFA, call this function
|
||||
*
|
||||
* @returns {Promise<string>} Returns a promise with IDFA string value
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -716,7 +701,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* To obtain the IDFV, call this function
|
||||
*
|
||||
* @returns {Promise<string>} Returns a promise with IDFV string value
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -727,7 +711,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* For every device with your app installed on it, the Adjust backend generates a unique Adjust device identifier (adid).
|
||||
* In order to obtain this identifier, call this function
|
||||
*
|
||||
* @returns {Promise<string>} Returns a promise with adid value
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -737,7 +720,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* If you want to access information about a user's current attribution whenever you need it, you can make a call to this function
|
||||
*
|
||||
* @returns {Promise<AdjustAttribution>} Returns a promise with AdjustAttribution object
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -747,7 +729,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the information about version of the SDK used
|
||||
*
|
||||
* @returns {Promise<string>} Returns a promise with SDK version information
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -757,7 +738,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method used to add global callback parameters
|
||||
*
|
||||
* @param key key
|
||||
* @param value value
|
||||
*/
|
||||
@@ -766,7 +746,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Remove a specific global callback parameter by passing the desiring key to this method
|
||||
*
|
||||
* @param key key
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -780,7 +759,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method used to add global partner parameters
|
||||
*
|
||||
* @param key key
|
||||
* @param value value
|
||||
*/
|
||||
@@ -789,7 +767,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Remove a specific global partner parameter by passing the desiring key to this method
|
||||
*
|
||||
* @param key key
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -804,7 +781,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Request Adjust SDK to show pop up dialog for asking user's consent to be tracked.
|
||||
* In order to do this, call this function
|
||||
*
|
||||
* @returns {Promise<number>} Returns a promise with user's consent value
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -814,7 +790,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* You can update SKAdNetwork conversion value with calling this method
|
||||
*
|
||||
* @param {Promise<string>} Returns a promisse with error information in case error happened
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -824,7 +799,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* To obtain the app tracking authorization status in iOS, call this function
|
||||
*
|
||||
* @returns {Promise<number>} Returns a promise with app tracking authorization status
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -834,7 +808,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* To obtain the last deep link which has opened your app, call this function
|
||||
*
|
||||
* @returns {Promise<string>} Returns a promise with last opened deep link string value
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -844,7 +817,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method is used to verify the App Store purchase
|
||||
*
|
||||
* @param {AdjustAppStorePurchase} adjustAppStorePurchase Adjust App Store purchase object to be verified
|
||||
* @returns {Promise<AdjustPurchaseVerificationResult>} Returns a promise with purchase verification outcome
|
||||
*/
|
||||
@@ -855,7 +827,6 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This method is used to verify the Play Store purchase
|
||||
*
|
||||
* @param {AdjustPlayStorePurchase} adjustPlayStorePurchase Adjust Play Store purchase object to be verified
|
||||
* @returns {Promise<AdjustPurchaseVerificationResult>} Returns a promise with purchase verification outcome
|
||||
*/
|
||||
@@ -863,4 +834,4 @@ export class Adjust extends AwesomeCordovaNativePlugin {
|
||||
verifyPlayStorePurchase(adjustPlayStorePurchase: AdjustPlayStorePurchase): Promise<AdjustPurchaseVerificationResult> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -170,7 +170,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Create a banner
|
||||
*
|
||||
* @param {string | AdMobOptions} adIdOrOptions Ad ID or Options
|
||||
* @returns {Promise<any>} Returns a Promise that resolves when the banner is created
|
||||
*/
|
||||
@@ -189,7 +188,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show banner at position
|
||||
*
|
||||
* @param {number} position Position. Use `AdMobPro.AD_POSITION` to set values.
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -199,7 +197,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show banner at custom position
|
||||
*
|
||||
* @param {number} x Offset from screen left.
|
||||
* @param {number} y Offset from screen top.
|
||||
*/
|
||||
@@ -218,7 +215,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Prepare interstitial banner
|
||||
*
|
||||
* @param {string | AdMobOptions} adIdOrOptions Ad ID or Options
|
||||
* @returns {Promise<any>} Returns a Promise that resolves when interstitial is prepared
|
||||
*/
|
||||
@@ -237,7 +233,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Prepare a reward video ad
|
||||
*
|
||||
* @param {string | AdMobOptions} adIdOrOptions Ad ID or Options
|
||||
* @returns {Promise<any>} Returns a Promise that resolves when the ad is prepared
|
||||
*/
|
||||
@@ -256,7 +251,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the values for configuration and targeting
|
||||
*
|
||||
* @param {AdMobOptions} options Options
|
||||
* @returns {Promise<any>} Returns a Promise that resolves when the options have been set
|
||||
*/
|
||||
@@ -267,7 +261,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get user ad settings
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise that resolves with the ad settings
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -277,7 +270,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Triggered when failed to receive Ad
|
||||
*
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -291,7 +283,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Triggered when Ad received
|
||||
*
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -305,7 +296,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Triggered when Ad will be showed on screen
|
||||
*
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -319,7 +309,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Triggered when user click the Ad, and will jump out of your App
|
||||
*
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -333,7 +322,6 @@ export class AdMobPro extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Triggered when dismiss the Ad and back to your App
|
||||
*
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
|
||||
@@ -294,7 +294,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This enum represents AdMob's supported ad sizes.
|
||||
* Use one of these constants as adSize option when calling createBannerView
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
@CordovaProperty()
|
||||
@@ -308,7 +307,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This enum represents AdMob's supported ad types
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
@CordovaProperty()
|
||||
@@ -321,7 +319,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Set the options to start displaying ads.
|
||||
* Although it is not required to call this method, as options can be specified in other methods, it is highly recommended
|
||||
*
|
||||
* @param options {AdmobOptions} Some param to configure something
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the options are set
|
||||
*/
|
||||
@@ -332,7 +329,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Creates a new banner ad view. Call this method in order to be able to start showing banners
|
||||
*
|
||||
* @param options {AdmobOptions} (Optional) Setup options
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the banner view is created
|
||||
*/
|
||||
@@ -343,7 +339,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show banner ads. You must call createBannerView first, otherwise it will result in failure callback and no ads will be shown
|
||||
*
|
||||
* @param show {boolean} (Optional) Indicates whether to show or hide banner ads. Defaults to `true`
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the banner shown or hidden
|
||||
*/
|
||||
@@ -364,7 +359,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* If `options.autoShowInterstitial` is set to `true` (default), the ad will automatically be displayed.
|
||||
* Otherwise you need to subscribe to `onAdLoaded()` event and call `showInterstitialAd()` after it will be raised specifying that an interstitial ad is available.
|
||||
* If you already called `requestInterstitialAd()` but the interstitial has never been shown, the successive calls to `requestInterstitialAd()` will result in the ad being inmediately available (the one that was obtained on the first call)
|
||||
*
|
||||
* @param options {AdmobOptions} (Optional) Setup options
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the interstitial ad is loaded
|
||||
*/
|
||||
@@ -375,7 +369,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show an interstitial ad. Call it after `requestInterstitialAd()` and `onAdLoaded()` event raised.
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the interstitial ad is shown
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -388,7 +381,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* If `options.autoShowRewarded` is set to `true` (default), the ad will automatically be displayed.
|
||||
* Otherwise you need to subscribe to `onAdLoaded()` enent and call `showRewardedAd()` after it will be raised specifying that a rewarded ad is available.
|
||||
* If you already called `requestRewardedAd()` but the rewarded has never been shown, the successive calls to `requestRewardedAd()` will result in the ad being inmediately available (the one that was obtained on the first call)
|
||||
*
|
||||
* @param options {AdmobOptions} (Optional) Setup options
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the rewarded ad is loaded
|
||||
*/
|
||||
@@ -399,7 +391,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show a rewarded ad
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the rewarded ad is shown
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -417,7 +408,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* ```
|
||||
*
|
||||
* Please refer to the documentation on https://admob-ionic.com/Events.
|
||||
*
|
||||
* @returns {Observable<AdMobEvent>} Returns an observable when an ad is received
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -439,7 +429,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* ```
|
||||
*
|
||||
* Please refer to the documentation on https://admob-ionic.com/Events.
|
||||
*
|
||||
* @returns {Observable<AdMobEvent>} Returns an observable when an ad request is failed
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -462,7 +451,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* ```
|
||||
*
|
||||
* Please refer to the documentation on https://admob-ionic.com/Events.
|
||||
*
|
||||
* @returns {Observable<AdMobEvent>} Returns an observable when an ad is opened
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -485,7 +473,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* ```
|
||||
*
|
||||
* Please refer to the documentation on https://admob-ionic.com/Events.
|
||||
*
|
||||
* @returns {Observable<AdMobEvent>} Returns an observable when an ad is closed
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -499,7 +486,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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:
|
||||
@@ -530,7 +516,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* ```
|
||||
*
|
||||
* Please refer to the documentation on https://admob-ionic.com/Events.
|
||||
*
|
||||
* @returns {Observable<AdMobEvent>} Returns an observable when the user rewards an ad
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -552,7 +537,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* ```
|
||||
*
|
||||
* Please refer to the documentation on https://admob-ionic.com/Events.
|
||||
*
|
||||
* @returns {Observable<AdMobEvent>} Returns an observable when the video is started
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -574,7 +558,6 @@ export class Admob extends AwesomeCordovaNativePlugin {
|
||||
* ```
|
||||
*
|
||||
* Please refer to the documentation on https://admob-ionic.com/Events.
|
||||
*
|
||||
* @returns {Observable<AdMobEvent>} Returns an observable when the video is completed
|
||||
*/
|
||||
@Cordova({
|
||||
|
||||
@@ -116,7 +116,6 @@ interface AdvancedImagePickerError {
|
||||
* @name AdvancedImagePicker
|
||||
* @description
|
||||
* This Cordova Plugin is for a better (multiple) ImagePicker with more options.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { AdvancedImagePicker } from '@awesome-cordova-plugins/advanced-image-picker/npx';
|
||||
|
||||
@@ -57,7 +57,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class AES256 extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This function used to perform the aes256 encryption
|
||||
*
|
||||
* @param {string} secureKey A 32 bytes string, which will used as input key for AES256 encryption.
|
||||
* @param {string} secureIV A 16 bytes string, which will used as initial vector for AES256 encryption.
|
||||
* @param {string} data A string which will be encrypted
|
||||
@@ -70,7 +69,6 @@ export class AES256 extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This function used to perform the aes256 decryption
|
||||
*
|
||||
* @param {string} secureKey A 32 bytes string, which will used as input key for AES256 decryption.
|
||||
* @param {string} secureIV A 16 bytes string, which will used as initial vector for AES256 decryption.
|
||||
* @param {string} data An AES256 encrypted data which will be decrypted.
|
||||
@@ -84,7 +82,6 @@ export class AES256 extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This function used to generate a secure key based on an password. Perfect if you want to delegate the key generation for encryption to the plugin.
|
||||
* Make sure to save the return value of this function somewhere so your encrypted data can be decrypted in the future.
|
||||
*
|
||||
* @param {string} password A random string, which will be used as input for a PBKDF2 function
|
||||
* @returns {Promise<string>} Returns a promise that resolves when key is generated.
|
||||
*/
|
||||
@@ -96,7 +93,6 @@ export class AES256 extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This function used to generate a secure IV based on an password. Perfect if you want to delegate the IV generation for encryption to the plugin.
|
||||
* Make sure to save the return value of this function somewhere so your encrypted data can be decrypted in the future.
|
||||
*
|
||||
* @param {string} password A random string, which will be used as input for a PBKDF2 function
|
||||
* @returns {Promise<string>} Returns a promise that resolves when IV is generated.
|
||||
*/
|
||||
|
||||
@@ -705,7 +705,6 @@ export interface InboxMessage {
|
||||
|
||||
/**
|
||||
* A preference center definition.
|
||||
*
|
||||
* @typedef {object} PreferenceCenter
|
||||
* @property {string} id the ID of the preference center
|
||||
* @property {Array<PreferenceCenter.CommonSection>} sections a list of sections
|
||||
@@ -866,7 +865,6 @@ export interface FeatureFlag {
|
||||
export interface TagGroupEditor {
|
||||
/**
|
||||
* Adds tags to a tag group.
|
||||
*
|
||||
* @param tagGroup The tag group.
|
||||
* @param tags Tags to add.
|
||||
* @return The tag group editor instance.
|
||||
@@ -875,7 +873,6 @@ export interface TagGroupEditor {
|
||||
|
||||
/**
|
||||
* Removes tags from the tag group.
|
||||
*
|
||||
* @param tagGroup The tag group.
|
||||
* @param tags Tags to remove.
|
||||
* @return The tag group editor instance.
|
||||
@@ -884,7 +881,6 @@ export interface TagGroupEditor {
|
||||
|
||||
/**
|
||||
* Overwrite the current set of tags on the Tag Group.
|
||||
*
|
||||
* @param tagGroup The tag group.
|
||||
* @param tags Tags to set.
|
||||
* @return The tag group editor instance.
|
||||
@@ -905,7 +901,6 @@ export interface TagGroupEditor {
|
||||
export interface TagEditor {
|
||||
/**
|
||||
* Adds tags to a channel.
|
||||
*
|
||||
* @param tags Tags to add.
|
||||
* @return The tag editor instance.
|
||||
*/
|
||||
@@ -913,7 +908,6 @@ export interface TagEditor {
|
||||
|
||||
/**
|
||||
* Removes tags from the channel.
|
||||
*
|
||||
* @param tags Tags to remove.
|
||||
* @return The tag editor instance.
|
||||
*/
|
||||
@@ -933,7 +927,6 @@ export interface TagEditor {
|
||||
export interface SubscriptionListEditor {
|
||||
/**
|
||||
* Subscribes to a list.
|
||||
*
|
||||
* @param listId The subscription list identifier.
|
||||
* @return The editor.
|
||||
*/
|
||||
@@ -941,7 +934,6 @@ export interface SubscriptionListEditor {
|
||||
|
||||
/**
|
||||
* Unsubscribe from a list.
|
||||
*
|
||||
* @param listId The subscription list identifier.
|
||||
* @return The editor.
|
||||
*/
|
||||
@@ -961,7 +953,6 @@ export interface SubscriptionListEditor {
|
||||
export interface ScopedSubscriptionListEditor {
|
||||
/**
|
||||
* Subscribes to a list in the given scope.
|
||||
*
|
||||
* @param listId The subscription list identifier.
|
||||
* @param scope The subscription scope to subscribe.
|
||||
*/
|
||||
@@ -969,7 +960,6 @@ export interface ScopedSubscriptionListEditor {
|
||||
|
||||
/**
|
||||
* Unsubscribe from a list.
|
||||
*
|
||||
* @param listId The subscription list identifier.
|
||||
* @param scope The subscription scope to unsubscribe.
|
||||
*/
|
||||
@@ -989,7 +979,6 @@ export interface ScopedSubscriptionListEditor {
|
||||
export interface AttributeEditor {
|
||||
/**
|
||||
* Adds an attribute.
|
||||
*
|
||||
* @param value The attribute value.
|
||||
* @param name The attribute name.
|
||||
* @return The attribute editor instance.
|
||||
@@ -1208,7 +1197,6 @@ export interface AirshipPushIOS {
|
||||
|
||||
/**
|
||||
* Enables/disables quiet time.
|
||||
*
|
||||
* @param enabled true to enable, false to disable
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
@@ -1224,7 +1212,6 @@ export interface AirshipPushIOS {
|
||||
|
||||
/**
|
||||
* Sets quiet time.
|
||||
*
|
||||
* @param quietTime The quiet time.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
@@ -1240,7 +1227,6 @@ export interface AirshipPushIOS {
|
||||
|
||||
/**
|
||||
* An event when the authorized push settings changed.
|
||||
*
|
||||
* @param callback The callback.
|
||||
* @return A cancellable that can be used to cancel the listener.
|
||||
*/
|
||||
@@ -1368,7 +1354,6 @@ export interface AirshipPreferenceCenter {
|
||||
|
||||
/**
|
||||
* Event when the message center a preference center is requested to display.
|
||||
*
|
||||
* @param callback The callback.
|
||||
* @return A cancellable that can be used to cancel the listener.
|
||||
*/
|
||||
@@ -1430,7 +1415,6 @@ export interface AirshipMessageCenter {
|
||||
/**
|
||||
* Overlays the message view. Should be used to display the actual
|
||||
* message body in a custom Message Center.
|
||||
*
|
||||
* @param messageId The message Id.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
@@ -1453,7 +1437,6 @@ export interface AirshipMessageCenter {
|
||||
|
||||
/**
|
||||
* Event when the message center is requested to be displayed.
|
||||
*
|
||||
* @param callback The callback.
|
||||
* @return A cancellable that can be used to cancel the listener.
|
||||
*/
|
||||
@@ -1461,7 +1444,6 @@ export interface AirshipMessageCenter {
|
||||
|
||||
/**
|
||||
* Event when the message list is updated.
|
||||
*
|
||||
* @param callback The callback.
|
||||
* @return A cancellable that can be used to cancel the listener.
|
||||
*/
|
||||
@@ -1711,7 +1693,6 @@ class AirshipChannel {
|
||||
export interface AirshipAnalytics {
|
||||
/**
|
||||
* Associates an identifier.
|
||||
*
|
||||
* @param key The key.
|
||||
* @param identifier The identifier. `null` to remove.
|
||||
* @param success Success callback.
|
||||
@@ -1742,7 +1723,6 @@ export interface AirshipAnalytics {
|
||||
export interface AirshipActions {
|
||||
/**
|
||||
* Runs an Airship action.
|
||||
*
|
||||
* @param name The name of the action.
|
||||
* @param value The action's value.
|
||||
* @param success Success callback with the action result.
|
||||
|
||||
@@ -51,7 +51,6 @@ export class AllInOneSDK extends AwesomeCordovaNativePlugin {
|
||||
* This function checks if Paytm Application is available on the device.
|
||||
* If Paytm exists then it invokes Paytm Application with the parameters sent and creates an order.
|
||||
* If the Paytm Application is not available the transaction is continued on a webView within All-in-One SDK.
|
||||
*
|
||||
* @param options {PaymentIntentModel} These parameters are required and will be used to create an order.
|
||||
* @returns {Promise<PaytmResponse>} Returns a promise that resolves when a transaction completes(both failed and successful).
|
||||
*/
|
||||
|
||||
@@ -64,7 +64,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This enum represents AnalyticsFirebase default events.
|
||||
* Use one of these default events or a custom event
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
@CordovaProperty()
|
||||
@@ -105,7 +104,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This enum represents AnalyticsFirebase default params.
|
||||
* Use one of these default params or a custom param
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
@CordovaProperty()
|
||||
@@ -166,7 +164,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
* Events with the same name must have the same parameters.
|
||||
* Up to 500 event names are supported.
|
||||
* Using predefined [FirebaseAnalytics.Event](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event.html) and/or [FirebaseAnalytics.Param](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Param.html) is recommended for optimal reporting.
|
||||
*
|
||||
* @param eventName {string} The event name
|
||||
* @param eventParams {object} (Optional) The event params
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the event is logged
|
||||
@@ -178,7 +175,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Clears all analytics data for this app from the device and resets the app instance id
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the analytics data is cleared
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -188,7 +184,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets whether analytics collection is enabled for this app on this device. This setting is persisted across app sessions. By default it is enabled
|
||||
*
|
||||
* @param screenName {boolean} The value of the collection
|
||||
* @param enabled
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the collection is enabled/disabled
|
||||
@@ -201,7 +196,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Sets the current screen name, which specifies the current visual context in your app.
|
||||
* This helps identify the areas in your app where users spend their time and how they interact with your app
|
||||
*
|
||||
* @param screenName {string} The screen name
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the current screen is setted
|
||||
*/
|
||||
@@ -212,7 +206,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the minimum engagement time required before starting a session. The default value is 10000 (10 seconds)
|
||||
*
|
||||
* @param screenName {number} The duration in milliseconds
|
||||
* @param milliseconds
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the minimum session duration is set
|
||||
@@ -224,7 +217,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the duration of inactivity that terminates the current session. The default value is 1800000 (30 minutes)
|
||||
*
|
||||
* @param screenName {number} The duration in milliseconds
|
||||
* @param milliseconds
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the session timeout duration is set
|
||||
@@ -236,7 +228,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the user ID property. This feature must be used in accordance with Google's Privacy Policy
|
||||
*
|
||||
* @param userId {string} The user id
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the user id is setted
|
||||
*/
|
||||
@@ -247,7 +238,6 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets a user property to a given value. Up to 25 user property names are supported. Once set, user property values persist throughout the app lifecycle and across sessions
|
||||
*
|
||||
* @param userPropertyName {string} The user property name
|
||||
* @param userPropertyValue {string} The user property value
|
||||
* @returns {Promise<any>} Returns a promise that resolves when the user property setted
|
||||
|
||||
@@ -182,7 +182,6 @@ export interface AndroidExoPlayerControllerConfig {
|
||||
export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Show the player.
|
||||
*
|
||||
* @param {AndroidExoPlayerParams} parameters Parameters
|
||||
* @returns {Observable<AndroidExoplayerState>}
|
||||
*/
|
||||
@@ -199,7 +198,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Switch stream without disposing of the player.
|
||||
*
|
||||
* @param {string} url The url of the new stream.
|
||||
* @param {AndroidExoPlayerControllerConfig} controller Configuration of the controller.
|
||||
* @returns {Promise<void>}
|
||||
@@ -211,7 +209,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Will pause if playing and play if paused
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -221,7 +218,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stop playing.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -231,7 +227,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Jump to a particular position.
|
||||
*
|
||||
* @param {number} milliseconds Position in stream in milliseconds
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@@ -242,7 +237,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Jump to a particular time relative to the current position.
|
||||
*
|
||||
* @param {number} milliseconds Time in milliseconds
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@@ -253,7 +247,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the current player state.
|
||||
*
|
||||
* @returns {Promise<AndroidExoplayerState>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -263,7 +256,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show the controller.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -273,7 +265,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Hide the controller.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -283,7 +274,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Update the controller configuration.
|
||||
*
|
||||
* @param {AndroidExoPlayerControllerConfig} controller Configuration of the controller.
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@@ -294,7 +284,6 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Close and dispose of player, call before destroy.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -3,7 +3,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
|
||||
/**
|
||||
* Bit flag values for setSystemUiVisibility()
|
||||
*
|
||||
* @see https://developer.android.com/reference/android/view/View.html#setSystemUiVisibility(int)
|
||||
*/
|
||||
export enum AndroidSystemUiFlags {
|
||||
@@ -60,7 +59,6 @@ export enum AndroidSystemUiFlags {
|
||||
export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Is this plugin supported?
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -70,7 +68,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Is immersive mode supported?
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -80,7 +77,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* The width of the screen in immersive mode.
|
||||
*
|
||||
* @returns {Promise<number>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -90,7 +86,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* The height of the screen in immersive mode.
|
||||
*
|
||||
* @returns {Promise<number>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -100,7 +95,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Hide system UI until user interacts.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -110,7 +104,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show system UI.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -120,7 +113,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Extend your app underneath the status bar (Android 4.4+ only).
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -130,7 +122,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Extend your app underneath the system UI (Android 4.4+ only).
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -140,7 +131,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Hide system UI and keep it hidden (Android 4.4+ only).
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -150,7 +140,6 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Manually set the the system UI to a custom mode. This mirrors the Android method of the same name. (Android 4.4+ only).
|
||||
*
|
||||
* @see https://developer.android.com/reference/android/view/View.html#setSystemUiVisibility(int)
|
||||
* @param {AndroidSystemUiFlags} visibility Bitwise-OR of flags in AndroidSystemUiFlags
|
||||
* @returns {Promise<void>}
|
||||
|
||||
@@ -50,7 +50,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl
|
||||
export class AndroidNotch extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Returns true if the android device has cutout
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -60,7 +59,6 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the heigth of the top inset
|
||||
*
|
||||
* @returns {Promise<number>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -70,7 +68,6 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the heigth of the right inset
|
||||
*
|
||||
* @returns {Promise<number>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -80,7 +77,6 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the heigth of the bottom inset
|
||||
*
|
||||
* @returns {Promise<number>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -90,7 +86,6 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the heigth of the left inset
|
||||
*
|
||||
* @returns {Promise<number>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -201,7 +201,6 @@ export class AndroidPermissions extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check permission
|
||||
*
|
||||
* @param {string} permission The name of the permission
|
||||
* @returns {Promise<AndroidPermissionResponse>} Returns a promise
|
||||
*/
|
||||
@@ -212,7 +211,6 @@ export class AndroidPermissions extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Request permission
|
||||
*
|
||||
* @param {string} permission The name of the permission to request
|
||||
* @returns {Promise<AndroidPermissionResponse>}
|
||||
*/
|
||||
@@ -223,7 +221,6 @@ export class AndroidPermissions extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Request permissions
|
||||
*
|
||||
* @param {string[]} permissions An array with permissions
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
*/
|
||||
@@ -234,7 +231,6 @@ export class AndroidPermissions extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This function still works now, will not support in the future.
|
||||
*
|
||||
* @param {string} permission The name of the permission
|
||||
* @returns {Promise<AndroidPermissionResponse>} Returns a promise
|
||||
*/
|
||||
|
||||
@@ -51,7 +51,6 @@ export class Anyline extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Scan
|
||||
*
|
||||
* @param config {AnylineConfig} Scanning options
|
||||
* @returns {Promise<any>} Returns a promise that resolves when Code is captured
|
||||
*/
|
||||
|
||||
@@ -42,7 +42,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class AppAvailability extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if an app is available on device
|
||||
*
|
||||
* @param {string} app Package name on android, or URI scheme on iOS
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
|
||||
@@ -46,7 +46,6 @@ export class AppCenterAnalytics extends AwesomeCordovaNativePlugin {
|
||||
* Tracks an custom event.
|
||||
* You can send up to 200 distinct event names. Also, there is a maximum limit of 256 characters per event name
|
||||
* and 64 characters per event property name and event property value.
|
||||
*
|
||||
* @param {string} eventName Event name
|
||||
* @param {StringMap} properties Event properties
|
||||
* @returns {Promise<void>}
|
||||
@@ -58,7 +57,6 @@ export class AppCenterAnalytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if App Center Analytics is enabled
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -68,7 +66,6 @@ export class AppCenterAnalytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable App Center Analytics at runtime
|
||||
*
|
||||
* @param {boolean} shouldEnable Set value
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
|
||||
@@ -69,7 +69,6 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* App Center Crashes provides you with an API to generate a test crash for easy testing of the SDK.
|
||||
* This API can only be used in test/beta apps and won't do anything in production apps.
|
||||
*
|
||||
* @returns void
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -77,7 +76,6 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* At any time after starting the SDK, you can check if the app crashed in the previous launch
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -87,7 +85,6 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Details about the last crash
|
||||
*
|
||||
* @returns {Promise<AppCenterCrashReport>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -97,7 +94,6 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if App Center Crashes is enabled
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -107,7 +103,6 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable App Center Crashes at runtime
|
||||
*
|
||||
* @param {boolean} shouldEnable Set value
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
|
||||
@@ -31,7 +31,6 @@ export class LowMemory extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Generates a low memory warning.
|
||||
* For more info, please see: https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-generate-low-memory
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -35,7 +35,6 @@ import { Observable } from 'rxjs';
|
||||
export class AppCenterPush extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Subscribe to an event
|
||||
*
|
||||
* @param {string} eventName Event name
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@@ -48,7 +47,6 @@ export class AppCenterPush extends AwesomeCordovaNativePlugin {
|
||||
}
|
||||
/**
|
||||
* Check if App Center Push is enabled
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -58,7 +56,6 @@ export class AppCenterPush extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable App Center Push at runtime
|
||||
*
|
||||
* @param {boolean} shouldEnable Set value
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
|
||||
@@ -41,7 +41,6 @@ export class AppCenter extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Returns AppCenter UUID.
|
||||
* For more info, please see: https://docs.microsoft.com/en-us/appcenter/sdk/other-apis/cordova#identify-installations
|
||||
*
|
||||
* @returns {Promise<string>} Install ID
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -52,7 +51,6 @@ export class AppCenter extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Set a user ID that's used to augment crash reports.
|
||||
* For more info, please see: https://docs.microsoft.com/en-us/appcenter/sdk/other-apis/cordova#identify-users
|
||||
*
|
||||
* @param {string} userId Ex. "your-user-id"
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
|
||||
@@ -29,7 +29,6 @@ import { Injectable } from '@angular/core';
|
||||
export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get a preference value
|
||||
*
|
||||
* @param {string} dict Dictionary for key (OPTIONAL)
|
||||
* @param {string} key Key
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
@@ -43,7 +42,6 @@ export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set a preference value
|
||||
*
|
||||
* @param {string} dict Dictionary for key (OPTIONAL)
|
||||
* @param {string} key Key
|
||||
* @param {any} value Value
|
||||
@@ -58,7 +56,6 @@ export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Remove value from preferences
|
||||
*
|
||||
* @param {string} dict Dictionary for key (OPTIONAL)
|
||||
* @param {string} key Key
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
@@ -72,7 +69,6 @@ export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Clear preferences
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -84,7 +80,6 @@ export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show native preferences interface
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -96,7 +91,6 @@ export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show native preferences interface
|
||||
*
|
||||
* @param {boolean} subscribe true value to subscribe, false - unsubscribe
|
||||
* @returns {Observable<any>} Returns an observable
|
||||
*/
|
||||
@@ -111,7 +105,6 @@ export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
* Return named configuration context
|
||||
* In iOS you'll get a suite configuration, on Android — named file
|
||||
* Supports: Android, iOS
|
||||
*
|
||||
* @param {string} suiteName suite name
|
||||
* @returns {Object} Custom object, bound to that suite
|
||||
*/
|
||||
@@ -134,7 +127,6 @@ export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Return cloud synchronized configuration context
|
||||
* Currently supports Windows and iOS/macOS
|
||||
*
|
||||
* @returns {Object} Custom object, bound to that suite
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -147,7 +139,6 @@ export class AppPreferences extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Return default configuration context
|
||||
* Currently supports Windows and iOS/macOS
|
||||
*
|
||||
* @returns {Object} Custom Object, bound to that suite
|
||||
*/
|
||||
@Cordova({
|
||||
|
||||
@@ -258,7 +258,6 @@ export class AppRate extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set preferences
|
||||
*
|
||||
* @param pref
|
||||
* @returns void
|
||||
*/
|
||||
@@ -269,7 +268,6 @@ export class AppRate extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get preferences
|
||||
*
|
||||
* @returns AppRatePreferences
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -279,7 +277,6 @@ export class AppRate extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Prompts the user for rating
|
||||
*
|
||||
* @param {boolean} immediately Show the rating prompt immediately.
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -5,7 +5,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl
|
||||
* @name App Review
|
||||
* @description
|
||||
* Cordova plugin to review app
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { AppReview } from '@awesome-cordova-plugins/app-review/ngx';
|
||||
@@ -33,7 +32,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl
|
||||
export class AppReview extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Launches in-app review dialog.
|
||||
*
|
||||
* @returns {Promise<void>} Callback when operation is completed
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -44,7 +42,6 @@ export class AppReview extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Launches App/Play store page with a review form. By default current app screen
|
||||
* is displayed but you can pass a package name string to show another app details.
|
||||
*
|
||||
* @param {string} [packageName] Package name to show instead of the current app.
|
||||
* @returns {Promise<void>} Callback when operation is completed
|
||||
*/
|
||||
|
||||
@@ -35,7 +35,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class AppVersion extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Returns the name of the app, e.g.: "My Awesome App"
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -45,7 +44,6 @@ export class AppVersion extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the package name of the app, e.g.: "com.example.myawesomeapp"
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -57,7 +55,6 @@ export class AppVersion extends AwesomeCordovaNativePlugin {
|
||||
* Returns the build identifier of the app.
|
||||
* In iOS a string with the build version like "1.6095"
|
||||
* In Android a number generated from the version string, like 10203 for version "1.2.3"
|
||||
*
|
||||
* @returns {Promise<string | number>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -67,7 +64,6 @@ export class AppVersion extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the version of the app, e.g.: "1.2.3"
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -155,7 +155,6 @@ export interface WatchExistData {
|
||||
export class AppleWallet extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Simple call to determine if the current device supports Apple Pay and has a supported card installed.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -165,7 +164,6 @@ export class AppleWallet extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Simple call to check Card Eligibility
|
||||
*
|
||||
* @param {string} primaryAccountIdentifier
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@@ -176,7 +174,6 @@ export class AppleWallet extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Simple call to checkCardEligibilityBySuffix
|
||||
*
|
||||
* @param {string} cardSuffix
|
||||
* @returns {Promise<PairedDevicesFlags>}
|
||||
*/
|
||||
@@ -187,7 +184,6 @@ export class AppleWallet extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Simple call to check out if there is any paired Watches so that you can toggle visibility of 'Add to Watch' button
|
||||
*
|
||||
* @returns {Promise<WatchExistData>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -197,7 +193,6 @@ export class AppleWallet extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Simple call to check paired devices with a card by its suffix
|
||||
*
|
||||
* @param {string} cardSuffix
|
||||
* @returns {Promise<PairedDevicesFlags>}
|
||||
*/
|
||||
@@ -208,7 +203,6 @@ export class AppleWallet extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Simple call with the configuration data needed to instantiate a new PKAddPaymentPassViewController object.
|
||||
*
|
||||
* @param {cardData} data
|
||||
* @returns {Promise<SignatureCertificatesData>}
|
||||
*/
|
||||
@@ -219,7 +213,6 @@ export class AppleWallet extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Simple completion handler that takes encrypted card data returned from your server side, in order to get the final response from Apple to know if the card is added succesfully or not.
|
||||
*
|
||||
* @param {encryptedCardData} data
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
|
||||
@@ -72,7 +72,6 @@ export enum ConsentDialogState {
|
||||
export class Applovin extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Initialize the AppLovin SDK.
|
||||
*
|
||||
* @param {string} sdkKey The SDK key generated for your AppLovin account.
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -79,7 +79,6 @@ interface AbortedResponse {
|
||||
export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This enum represents the internal error codes which can be returned in a HTTPResponse object.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
@CordovaProperty()
|
||||
@@ -96,7 +95,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This returns an object representing a basic HTTP Authorization header of the form.
|
||||
*
|
||||
* @param username {string} Username
|
||||
* @param password {string} Password
|
||||
* @returns {Object} an object representing a basic HTTP Authorization header of the form {'Authorization': 'Basic base64EncodedUsernameAndPassword'}
|
||||
@@ -108,7 +106,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This sets up all future requests to use Basic HTTP authentication with the given username and password.
|
||||
*
|
||||
* @param username {string} Username
|
||||
* @param password {string} Password
|
||||
*/
|
||||
@@ -117,7 +114,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get all headers defined for a given hostname.
|
||||
*
|
||||
* @param host {string} The hostname
|
||||
* @returns {string} return all headers defined for the hostname
|
||||
*/
|
||||
@@ -128,7 +124,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set a header for all future requests. Takes a hostname, a header and a value.
|
||||
*
|
||||
* @param host {string} The hostname to be used for scoping this header
|
||||
* @param header {string} The name of the header
|
||||
* @param value {string} The value of the header
|
||||
@@ -138,7 +133,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the name of the data serializer which will be used for all future POST and PUT requests.
|
||||
*
|
||||
* @returns {string} returns the name of the configured data serializer
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -148,7 +142,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -157,7 +150,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Add a custom cookie.
|
||||
*
|
||||
* @param url {string} Scope of the cookie
|
||||
* @param cookie {string} RFC compliant cookie string
|
||||
*/
|
||||
@@ -172,7 +164,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Remove cookies for given URL.
|
||||
*
|
||||
* @param url {string}
|
||||
* @param cb
|
||||
*/
|
||||
@@ -181,7 +172,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Resolve cookie string for given URL.
|
||||
*
|
||||
* @param url {string}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -191,7 +181,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get global request timeout value in seconds.
|
||||
*
|
||||
* @returns {number} returns the global request timeout value
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -201,7 +190,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set global request timeout value in seconds.
|
||||
*
|
||||
* @param timeout {number} The timeout in seconds. Default 60
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -209,7 +197,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Resolve if it should follow redirects automatically.
|
||||
*
|
||||
* @returns {boolean} returns true if it is configured to follow redirects automatically
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -219,7 +206,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Configure if it should follow redirects automatically.
|
||||
*
|
||||
* @param follow {boolean} Set to false to disable following redirects automatically
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -231,7 +217,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
* 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
|
||||
*/
|
||||
@@ -242,7 +227,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a POST request
|
||||
*
|
||||
* @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
|
||||
@@ -255,7 +239,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a sync POST request
|
||||
*
|
||||
* @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
|
||||
@@ -279,7 +262,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a GET 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
|
||||
@@ -292,7 +274,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a sync GET 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
|
||||
@@ -316,7 +297,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a PUT request
|
||||
*
|
||||
* @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
|
||||
@@ -329,7 +309,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a sync PUT request
|
||||
*
|
||||
* @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
|
||||
@@ -353,7 +332,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a PATCH request
|
||||
*
|
||||
* @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
|
||||
@@ -366,7 +344,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a sync PATCH request
|
||||
*
|
||||
* @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
|
||||
@@ -390,7 +367,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a DELETE 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
|
||||
@@ -403,7 +379,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a sync DELETE 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
|
||||
@@ -427,7 +402,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a HEAD 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
|
||||
@@ -440,7 +414,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make a sync HEAD 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
|
||||
@@ -464,7 +437,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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
|
||||
@@ -477,7 +449,6 @@ export class HTTP extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Make an sync 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
|
||||
|
||||
@@ -84,7 +84,6 @@ export interface AppsflyerInviteOptions {
|
||||
export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* initialize the SDK
|
||||
*
|
||||
* @param {AppsflyerOptions} options
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -95,7 +94,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* These in-app events help you track how loyal users discover your app, and attribute them to specific campaigns/media-sources. Please take the time define the event/s you want to measure to allow you to track ROI (Return on Investment) and LTV (Lifetime Value).
|
||||
*
|
||||
* @param {string} eventName custom event name, is presented in your dashboard
|
||||
* @param {AppsflyerEvent} eventValues event details
|
||||
*/
|
||||
@@ -104,7 +102,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Setting your own Custom ID enables you to cross-reference your own unique ID with AppsFlyer’s user ID and the other devices’ IDs. This ID is available in AppsFlyer CSV reports along with postbacks APIs for cross-referencing with you internal IDs.
|
||||
*
|
||||
* @param {string} customerUserId user id
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -112,7 +109,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Setting your own Custom ID enables you to cross-reference your own unique ID with AppsFlyer’s user ID and the other devices’ IDs. This ID is available in AppsFlyer CSV reports along with postbacks APIs for cross-referencing with you internal IDs.
|
||||
*
|
||||
* @param {boolean} customerUserId In some extreme cases you might want to shut down all SDK tracking due to legal and privacy compliance. This can be achieved with the isStopTracking API. Once this API is invoked, our SDK will no longer communicate with our servers and stop functioning.
|
||||
* @param isStopTracking
|
||||
*/
|
||||
@@ -121,7 +117,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the data from Attribution
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -142,7 +137,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Allows to pass GCM/FCM Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for Uninstall Tracking.
|
||||
*
|
||||
* @param {string} token GCM/FCM ProjectNumber
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -150,7 +144,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* (iOS) Allows to pass APN Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for Uninstall Tracking.
|
||||
*
|
||||
* @param {string} token APN Token
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -166,7 +159,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* End User Opt-Out (Optional) AppsFlyer provides you a method to opt‐out specific users from AppsFlyer analytics. This method complies with the latest privacy requirements and complies with Facebook data and privacy policies. Default is FALSE, meaning tracking is enabled by default.
|
||||
*
|
||||
* @param {boolean} disable Set to true to opt-out user from tracking
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -174,7 +166,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set AppsFlyer’s OneLink ID. Setting a valid OneLink ID will result in shortened User Invite links, when one is generated. The OneLink ID can be obtained on the AppsFlyer Dashboard.
|
||||
*
|
||||
* @param {string} oneLinkId OneLink ID
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -182,7 +173,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Allowing your existing users to invite their friends and contacts as new users to your app can be a key growth factor for your app. AppsFlyer allows you to track and attribute new installs originating from user invites within your app.
|
||||
*
|
||||
* @param {AppsflyerInviteOptions} options Parameters for Invite link
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -193,7 +183,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Use this call to track an impression use the following API call. Make sure to use the promoted App ID as it appears within the AppsFlyer dashboard.
|
||||
*
|
||||
* @param {string} appId Promoted Application ID
|
||||
* @param {string} campaign Promoted Campaign
|
||||
*/
|
||||
@@ -202,7 +191,6 @@ export class Appsflyer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Use this call to track the click and launch the app store's app page (via Browser)
|
||||
*
|
||||
* @param {string} appId Promoted Application ID
|
||||
* @param {string} campaign Promoted Campaign
|
||||
* @param {Object} options Additional Parameters to track
|
||||
|
||||
@@ -6,7 +6,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
* @description
|
||||
* A Cordova plugin to manage volume of audio streams for: ring, music, notification and system. Possible
|
||||
* ringer values for those streams are: silent, vibrate and normal.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* constructor(public audioManagement: AudioManagement) { }
|
||||
@@ -44,19 +43,18 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
plugin: 'clovelced-plugin-audiomanagement',
|
||||
pluginRef: 'AudioManagement',
|
||||
repo: 'https://github.com/clovelCed/cordova-plugin-audiomanagement',
|
||||
platforms: ['Android']
|
||||
platforms: ['Android'],
|
||||
})
|
||||
@Injectable()
|
||||
export class AudioManagement extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Sets the `AudioManagement.AudioMode` for the device.
|
||||
*
|
||||
* @param {AudioMode} mode the device can be set to: Silent, Normal, Vibrate
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
errorIndex: 2,
|
||||
})
|
||||
setAudioMode(mode: AudioMode): Promise<void> {
|
||||
return;
|
||||
@@ -65,7 +63,6 @@ export class AudioManagement extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Gets the current `AudioMode` of the device. Thenable returns an object with
|
||||
* `label` and `audioMode` values.
|
||||
*
|
||||
* @returns {Promise<AudioModeReturn>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -75,14 +72,13 @@ export class AudioManagement extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the specified `VolumeType` for the device with the value from `volume`.
|
||||
*
|
||||
* @param {VolumeType} type the `VolumeType` to set
|
||||
* @param {number} volume the volume value
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 2,
|
||||
errorIndex: 3
|
||||
errorIndex: 3,
|
||||
})
|
||||
setVolume(type: VolumeType, volume: number): Promise<void> {
|
||||
return;
|
||||
@@ -91,13 +87,12 @@ export class AudioManagement extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Gets the specified `VolumeType`'s `volume`. Thenable returns an object with
|
||||
* a numeric property for volume, `volume`.
|
||||
*
|
||||
* @param {VolumeType} type the `VolumeType` to get
|
||||
* @returns {Promise<{volume: number}>}
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
errorIndex: 2,
|
||||
})
|
||||
getVolume(type: VolumeType): Promise<{ volume: number }> {
|
||||
return;
|
||||
@@ -106,31 +101,29 @@ export class AudioManagement extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Gets the specified `VolumeType`'s maximum `volume`. Thenable returns an
|
||||
* object with a numeric property, `maxVolume`.
|
||||
*
|
||||
* @param {VolumeType} type the `VolumeType` to get
|
||||
* @returns {Promise<{maxVolume: number}>}
|
||||
*/
|
||||
@Cordova({
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
errorIndex: 2,
|
||||
})
|
||||
getMaxVolume(type: VolumeType): Promise<{ maxVolume: number }> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
export enum AudioMode {
|
||||
SILENT = 0,
|
||||
VIBRATE,
|
||||
NORMAL
|
||||
NORMAL,
|
||||
}
|
||||
|
||||
export enum VolumeType {
|
||||
RING = 0,
|
||||
MUSIC,
|
||||
NOTIFICATION,
|
||||
SYSTEM
|
||||
SYSTEM,
|
||||
}
|
||||
|
||||
export interface AudioModeReturn {
|
||||
|
||||
@@ -59,7 +59,6 @@ export interface BackgroundFetchConfig {
|
||||
export class BackgroundFetch extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Configures the plugin's fetch callbackFn
|
||||
*
|
||||
* @param {BackgroundFetchConfig} config Configuration for plugin
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -73,7 +72,6 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Start the background-fetch API.
|
||||
* Your callbackFn provided to #configure will be executed each time a background-fetch event occurs. NOTE the #configure method automatically calls #start. You do not have to call this method after you #configure the plugin
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -83,7 +81,6 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stop the background-fetch API from firing fetch events. Your callbackFn provided to #configure will no longer be executed.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -93,7 +90,6 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* You MUST call this method in your fetch callbackFn provided to #configure in order to signal to iOS that your fetch action is complete. iOS provides only 30s of background-time for a fetch-event -- if you exceed this 30s, iOS will kill your app.
|
||||
*
|
||||
* @param taskId
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -103,7 +99,6 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Return the status of the background-fetch
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -77,8 +77,7 @@ export interface ServiceStatus {
|
||||
* Authorization status.
|
||||
*
|
||||
* Posible values:
|
||||
* NOT_AUTHORIZED, AUTHORIZED, AUTHORIZED_FOREGROUND
|
||||
*
|
||||
* NOT_AUTHORIZED, AUTHORIZED, AUTHORIZED_FOREGROUND
|
||||
* @example
|
||||
* if (authorization == BackgroundGeolocation.NOT_AUTHORIZED) {...}
|
||||
*/
|
||||
@@ -160,10 +159,9 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: all
|
||||
* Available providers:
|
||||
* DISTANCE_FILTER_PROVIDER,
|
||||
* ACTIVITY_PROVIDER
|
||||
* RAW_PROVIDER
|
||||
*
|
||||
* DISTANCE_FILTER_PROVIDER,
|
||||
* ACTIVITY_PROVIDER
|
||||
* RAW_PROVIDER
|
||||
* @default DISTANCE_FILTER_PROVIDER
|
||||
* @example
|
||||
* { locationProvider: LocationProvider.RAW_PROVIDER }
|
||||
@@ -176,12 +174,11 @@ export interface BackgroundGeolocationConfig {
|
||||
* Platform: all
|
||||
* Provider: all
|
||||
* Possible values:
|
||||
* HIGH_ACCURACY,
|
||||
* MEDIUM_ACCURACY,
|
||||
* LOW_ACCURACY,
|
||||
* PASSIVE_ACCURACY
|
||||
* HIGH_ACCURACY,
|
||||
* MEDIUM_ACCURACY,
|
||||
* LOW_ACCURACY,
|
||||
* PASSIVE_ACCURACY
|
||||
* Note: Accuracy has direct effect on power drain. Lower accuracy = lower power drain.
|
||||
*
|
||||
* @default MEDIUM_ACCURACY
|
||||
* @example
|
||||
* { desiredAccuracy: BackgroundGeolocationAccuracy.LOW }
|
||||
@@ -194,7 +191,6 @@ export interface BackgroundGeolocationConfig {
|
||||
* When stopped, the minimum distance the device must move beyond the stationary location for aggressive background-tracking to engage.
|
||||
* Platform: all
|
||||
* Provider: DISTANCE_FILTER
|
||||
*
|
||||
* @default 50
|
||||
*/
|
||||
stationaryRadius?: number;
|
||||
@@ -204,7 +200,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: all
|
||||
* Provider: all
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
debug?: boolean;
|
||||
@@ -214,7 +209,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: all
|
||||
* Provider: DISTANCE_FILTER, RAW
|
||||
*
|
||||
* @default 500
|
||||
* @see {@link https://apple.co/2oHo2CV|Apple docs}
|
||||
*/
|
||||
@@ -226,7 +220,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: all
|
||||
* Provider: all
|
||||
*
|
||||
* @default true
|
||||
*/
|
||||
stopOnTerminate?: boolean;
|
||||
@@ -236,7 +229,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: Android
|
||||
* Provider: all
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
startOnBoot?: boolean;
|
||||
@@ -246,7 +238,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: Android
|
||||
* Provider: all
|
||||
*
|
||||
* @default 60000
|
||||
* @see {@link https://bit.ly/1x00RUu|Android docs}
|
||||
*/
|
||||
@@ -257,7 +248,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: Android
|
||||
* Provider: ACTIVITY
|
||||
*
|
||||
* @default 120000
|
||||
* @see {@link https://bit.ly/1x00RUu|Android docs}
|
||||
*/
|
||||
@@ -269,7 +259,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: Android
|
||||
* Provider: ACTIVITY
|
||||
*
|
||||
* @default 10000
|
||||
*/
|
||||
activitiesInterval?: number;
|
||||
@@ -284,7 +273,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: Android
|
||||
* Provider: all
|
||||
*
|
||||
* @default true
|
||||
*/
|
||||
notificationsEnabled?: boolean;
|
||||
@@ -295,7 +283,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: Android
|
||||
* Provider: all
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
startForeground?: boolean;
|
||||
@@ -305,7 +292,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: Android
|
||||
* Provider: all
|
||||
*
|
||||
* @default "Background tracking"
|
||||
*/
|
||||
notificationTitle?: string;
|
||||
@@ -315,7 +301,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: Android
|
||||
* Provider: all
|
||||
*
|
||||
* @default "ENABLED"
|
||||
*/
|
||||
notificationText?: string;
|
||||
@@ -354,7 +339,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: iOS
|
||||
* Provider: all
|
||||
*
|
||||
* @default "OtherNavigation"
|
||||
* @see {@link https://apple.co/2oHofpH|Apple docs}
|
||||
*/
|
||||
@@ -365,7 +349,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: iOS
|
||||
* Provider: all
|
||||
*
|
||||
* @default false
|
||||
* @see {@link https://apple.co/2CbjEW2|Apple docs}
|
||||
*/
|
||||
@@ -376,7 +359,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: iOS
|
||||
* Provider: all
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
saveBatteryOnBackground?: boolean;
|
||||
@@ -402,7 +384,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: all
|
||||
* Provider: all
|
||||
*
|
||||
* @default 100
|
||||
*/
|
||||
syncThreshold?: number;
|
||||
@@ -420,7 +401,6 @@ export interface BackgroundGeolocationConfig {
|
||||
*
|
||||
* Platform: all
|
||||
* Provider: all
|
||||
*
|
||||
* @default 10000
|
||||
*/
|
||||
maxLocations?: number;
|
||||
@@ -438,9 +418,8 @@ export interface BackgroundGeolocationConfig {
|
||||
* Set location service provider @see https://github.com/mauron85/cordova-plugin-background-geolocation/wiki/Android-providers
|
||||
*
|
||||
* Possible values:
|
||||
* ANDROID_DISTANCE_FILTER_PROVIDER: 0,
|
||||
* ANDROID_ACTIVITY_PROVIDER: 1
|
||||
*
|
||||
* ANDROID_DISTANCE_FILTER_PROVIDER: 0,
|
||||
* ANDROID_ACTIVITY_PROVIDER: 1
|
||||
* @enum {number}
|
||||
*/
|
||||
export declare enum BackgroundGeolocationProvider {
|
||||
@@ -472,9 +451,8 @@ export declare enum BackgroundGeolocationAccuracy {
|
||||
* Used in the switchMode function
|
||||
*
|
||||
* Possible values:
|
||||
* BACKGROUND: 0
|
||||
* FOREGROUND: 1
|
||||
*
|
||||
* BACKGROUND: 0
|
||||
* FOREGROUND: 1
|
||||
* @enum {number}
|
||||
*/
|
||||
export declare enum BackgroundGeolocationMode {
|
||||
@@ -549,7 +527,6 @@ export declare enum BackgroundGeolocationIOSActivity {
|
||||
export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Configure the plugin.
|
||||
*
|
||||
* @param options {BackgroundGeolocationConfig} options An object of type Config
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -561,7 +538,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Turn ON the background-geolocation system.
|
||||
* The user will be tracked whenever they suspend the app.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -571,7 +547,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Turn OFF background-tracking
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -581,7 +556,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Inform the native plugin that you're finished, the background-task may be completed
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -593,7 +567,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Force the plugin to enter "moving" or "stationary" state
|
||||
*
|
||||
* @param isMoving {boolean}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -606,7 +579,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Setup configuration
|
||||
*
|
||||
* @param options {BackgroundGeolocationConfig}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -619,7 +591,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns current stationaryLocation if available. null if not
|
||||
*
|
||||
* @returns {Promise<Location>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -632,7 +603,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Add a stationary-region listener. Whenever the devices enters "stationary-mode",
|
||||
* your #success callback will be executed with #location param containing #radius of region
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -644,7 +614,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if location is enabled on the device
|
||||
*
|
||||
* @returns {Promise<number>} Returns a promise with int argument that takes values 0, 1 (true).
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -670,7 +639,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
* Method can be used to detect user changes in location services settings.
|
||||
* If user enable or disable location services then success callback will be executed.
|
||||
* In case or (SettingNotFoundException) fail callback will be executed.
|
||||
*
|
||||
* @returns {Observable<number>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -683,7 +651,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stop watching for location mode changes.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -696,11 +663,10 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Method will return all stored locations.
|
||||
* Locations are stored when:
|
||||
* - config.stopOnTerminate is false and main activity was killed
|
||||
* by the system
|
||||
* or
|
||||
* - option.debug is true
|
||||
*
|
||||
* - config.stopOnTerminate is false and main activity was killed
|
||||
* by the system
|
||||
* or
|
||||
* - option.debug is true
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -712,7 +678,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method will return locations, which has not been yet posted to server. NOTE: Locations does contain locationId.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -722,7 +687,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Delete stored location by given locationId.
|
||||
*
|
||||
* @param locationId {number}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -735,7 +699,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Delete all stored locations.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -754,7 +717,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* BackgroundGeolocation.Mode.FOREGROUND
|
||||
* BackgroundGeolocation.Mode.BACKGROUND
|
||||
*
|
||||
* @param modeId {number}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -767,7 +729,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Return all logged events. Useful for plugin debugging. Parameter limit limits number of returned entries.
|
||||
*
|
||||
* @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information.
|
||||
* @param fromId
|
||||
* @param minLevel
|
||||
@@ -785,7 +746,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Return all logged events. Useful for plugin debugging. Parameter limit limits number of returned entries.
|
||||
*
|
||||
* @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -799,7 +759,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
* {timeout: Maximum time in milliseconds device will wait for location,
|
||||
* maximumAge: Maximum age in milliseconds of a possible cached location that is acceptable to return;
|
||||
* enableHighAccuracy: if true and if the device is able to provide a more accurate position, it will do so}
|
||||
*
|
||||
* @param {BackgroundGeolocationCurrentPositionConfig} options
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -824,7 +783,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
* To perform any long running operation on iOS
|
||||
* you need to create background task
|
||||
* IMPORTANT: task has to be ended by endTask
|
||||
*
|
||||
* @returns {Promise<number>} taskKey
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -836,7 +794,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* End background task indentified by taskKey (iOS only)
|
||||
*
|
||||
* @param taskKey
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -853,7 +810,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* In this scenario the Activity was killed by the system and all registered
|
||||
* event listeners will not be triggered until the app is relaunched.
|
||||
*
|
||||
* @example
|
||||
* BackgroundGeolocation.headlessTask(function(event) {
|
||||
*
|
||||
@@ -888,7 +844,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
* Register event listener.
|
||||
*
|
||||
* Triggered when server responded with "<code>285 Updates Not Required</code>" to post/sync request.
|
||||
*
|
||||
* @param event
|
||||
* @param callbackFn
|
||||
*/
|
||||
@@ -903,7 +858,6 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin {
|
||||
* Unregister all event listeners for given event.
|
||||
*
|
||||
* If parameter <code>event</code> is not provided then all event listeners will be removed.
|
||||
*
|
||||
* @param event
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -99,7 +99,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable the background mode.
|
||||
*
|
||||
* @param enable {boolean} The status to set for.
|
||||
* @returns {void}
|
||||
*/
|
||||
@@ -110,7 +109,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Fire event with given arguments.
|
||||
*
|
||||
* @param event {string} event The event's name.
|
||||
* @param args {array} The callback's arguments.
|
||||
* @returns {string}
|
||||
@@ -124,7 +122,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if background mode is enabled or not.
|
||||
*
|
||||
* @returns {boolean} returns a boolean that indicates if the background mode is enabled.
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -136,7 +133,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Can be used to get the information if the background mode is active.
|
||||
*
|
||||
* @returns {boolean} returns a boolean that indicates if the background mode is active.
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -149,7 +145,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Overwrite the default settings.
|
||||
* Available only for Android platform.
|
||||
*
|
||||
* @param overrides {BackgroundModeConfiguration} Dict of options to be overridden.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -161,7 +156,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Modify the displayed information.
|
||||
* Available only for Android platform.
|
||||
*
|
||||
* @param {BackgroundModeConfiguration} [options] Any options you want to update. See table below.
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -173,7 +167,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Register callback for given event.
|
||||
* > Available events are `enable`, `disable`, `activate`, `deactivate` and `failure`.
|
||||
*
|
||||
* @param event {string} Event name
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@@ -188,7 +181,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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>}
|
||||
@@ -245,7 +237,6 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* If the screen is off.
|
||||
*
|
||||
* @param fn {function} Callback function to invoke with boolean arg.
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
|
||||
@@ -34,7 +34,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class Badge extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Clear the badge of the app icon.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -44,7 +43,6 @@ export class Badge extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the badge of the app icon.
|
||||
*
|
||||
* @param {number} badgeNumber The new badge number.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -55,7 +53,6 @@ export class Badge extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the badge of the app icon.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -65,7 +62,6 @@ export class Badge extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Increase the badge number.
|
||||
*
|
||||
* @param {number} increaseBy Count to add to the current badge number
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -76,7 +72,6 @@ export class Badge extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Decrease the badge number.
|
||||
*
|
||||
* @param {number} decreaseBy Count to subtract from the current badge number
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -87,7 +82,6 @@ export class Badge extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check support to show badges.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -97,7 +91,6 @@ export class Badge extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Determine if the app has permission to show badges.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -107,7 +100,6 @@ export class Badge extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Register permission to set badge notifications
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -128,7 +128,6 @@ export class BarcodeScanner extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Open the barcode scanner.
|
||||
*
|
||||
* @param {BarcodeScannerOptions} [options] Optional options to pass to the scanner
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with scanner data, or rejects with an error.
|
||||
*/
|
||||
@@ -142,7 +141,6 @@ export class BarcodeScanner extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Encodes data into a barcode.
|
||||
* NOTE: not well supported on Android
|
||||
*
|
||||
* @param {string} type Type of encoding
|
||||
* @param {any} data Data to encode
|
||||
* @returns {Promise<any>}
|
||||
|
||||
@@ -50,7 +50,6 @@ export interface BatteryStatusResponse {
|
||||
export class BatteryStatus extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Watch the change in battery level
|
||||
*
|
||||
* @returns {Observable<BatteryStatusResponse>} Returns an observable that pushes a status object
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -63,7 +62,6 @@ export class BatteryStatus extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Watch when the battery level goes low
|
||||
*
|
||||
* @returns {Observable<BatteryStatusResponse>} Returns an observable that pushes a status object
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -76,7 +74,6 @@ export class BatteryStatus extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Watch when the battery level goes to critical
|
||||
*
|
||||
* @returns {Observable<BatteryStatusResponse>} Returns an observable that pushes a status object
|
||||
*/
|
||||
@Cordova({
|
||||
|
||||
@@ -32,7 +32,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class BioCatch extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Start a session
|
||||
*
|
||||
* @param customerSessionID {String} Customer session id
|
||||
* @param wupUrl {String} WUP server URL
|
||||
* @param publicKey {String} Public Key
|
||||
@@ -45,7 +44,6 @@ export class BioCatch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Pause the session
|
||||
*
|
||||
* @returns {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -55,7 +53,6 @@ export class BioCatch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Resume the session
|
||||
*
|
||||
* @returns {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -65,7 +62,6 @@ export class BioCatch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stop the session
|
||||
*
|
||||
* @returns {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -75,7 +71,6 @@ export class BioCatch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reset the session
|
||||
*
|
||||
* @returns {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -85,7 +80,6 @@ export class BioCatch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Change the session context
|
||||
*
|
||||
* @param contextName {String} Context name
|
||||
* @returns {Promise<void>} Returns a promise
|
||||
*/
|
||||
@@ -96,7 +90,6 @@ export class BioCatch extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Update the customer session ID
|
||||
*
|
||||
* @param customerSessionID {String}
|
||||
* @returns {Promise<void>} Returns a promise
|
||||
*/
|
||||
|
||||
@@ -36,7 +36,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl
|
||||
export class BiometricWrapper extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This function activate iris activity
|
||||
*
|
||||
* @param args
|
||||
* @returns {Promise<any>} Returns a promise that resolves when iris data captured
|
||||
*/
|
||||
@@ -47,7 +46,6 @@ export class BiometricWrapper extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This function activate fingerprint activity
|
||||
*
|
||||
* @param args
|
||||
* @returns {Promise<any>} Returns a promise that resolves when FP data captured
|
||||
*/
|
||||
|
||||
@@ -184,7 +184,6 @@ export interface BLEScanOptions {
|
||||
export class BLE extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Scan and discover BLE peripherals for the specified amount of time.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.scan([], 5).subscribe(device => {
|
||||
@@ -204,7 +203,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Scan and discover BLE peripherals until `stopScan` is called.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.startScan([]).subscribe(device => {
|
||||
@@ -229,7 +227,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Scans for BLE devices. This function operates similarly to the `startScan` function, but allows you to specify extra options (like allowing duplicate device reports).
|
||||
*
|
||||
* @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices
|
||||
* @param {BLEScanOptions} options Options
|
||||
* @returns {Observable<any>} Returns an Observable that notifies of each peripheral discovered.
|
||||
@@ -245,7 +242,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stop a scan started by `startScan`.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.startScan([]).subscribe(device => {
|
||||
@@ -264,7 +260,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set device pin.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.setPin(pin).subscribe(success => {
|
||||
@@ -286,7 +281,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Connect to a peripheral.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.connect('12:34:56:78:9A:BC').subscribe(peripheralData => {
|
||||
@@ -315,7 +309,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* On Android you can pass a MAC address directly to autoConnect. With iOS, you need to get a device id by scanning,
|
||||
* calling ble.peripheralsWithIdentifiers, or calling ble.connectedPeripheralsWithServices.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* someFunction() {
|
||||
@@ -343,7 +336,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Request MTU size.
|
||||
* May be used to fix the Error 14 "Unlikely" on write requests with more than 20 bytes.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.requestMtu('12:34:56:78:9A:BC', 512).then(() => {
|
||||
@@ -383,13 +375,12 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
requestConnectionPriority(deviceId: string, priority: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Refresh Device Cache
|
||||
* This method may fix a issue of old cached services and characteristics.
|
||||
* NOTE Since this uses an undocumented API it's not guaranteed to work.
|
||||
* If you choose a too low delay time (timeoutMillis) the method could fail.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.refreshDeviceCache('12:34:56:78:9A:BC', 10000).then(discoveredServices => {
|
||||
@@ -409,7 +400,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Disconnect from a peripheral.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.disconnect('12:34:56:78:9A:BC').then(() => {
|
||||
@@ -426,7 +416,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Read the value of a characteristic.
|
||||
*
|
||||
* @param {string} deviceId UUID or MAC address of the peripheral
|
||||
* @param {string} serviceUUID UUID of the BLE service
|
||||
* @param {string} characteristicUUID UUID of the BLE characteristic
|
||||
@@ -439,7 +428,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Write the value of a characteristic.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* // send 1 byte to switch a light on
|
||||
@@ -473,7 +461,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Write the value of a characteristic without waiting for confirmation from the peripheral.
|
||||
*
|
||||
* @param {string} deviceId UUID or MAC address of the peripheral
|
||||
* @param {string} serviceUUID UUID of the BLE service
|
||||
* @param {string} characteristicUUID UUID of the BLE characteristic
|
||||
@@ -492,7 +479,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Register to be notified when the value of a characteristic changes.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.startNotification(device_id, 'FF10', 'FF11').subscribe(buffer => {
|
||||
@@ -518,7 +504,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stop being notified when the value of a characteristic changes.
|
||||
*
|
||||
* @param {string} deviceId UUID or MAC address of the peripheral
|
||||
* @param {string} serviceUUID UUID of the BLE service
|
||||
* @param {string} characteristicUUID UUID of the BLE characteristic
|
||||
@@ -531,7 +516,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Report the connection status.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.isConnected('FFCA0B09-CB1D-4DC0-A1EF-31AFD3EDFB53').then(
|
||||
@@ -549,7 +533,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Report if bluetooth is enabled.
|
||||
*
|
||||
* @returns {Promise<void>} Returns a Promise that resolves if Bluetooth is enabled, and rejects if disabled.
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -559,7 +542,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Register to be notified when Bluetooth state changes on the device.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* BLE.startStateNotifications().subscribe(state => {
|
||||
@@ -579,7 +561,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stop state notifications.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -589,7 +570,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Registers to be notified when Location service state changes on the device.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* ble.startLocationStateNotifications(success, failure);
|
||||
@@ -610,7 +590,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stop location state notifications.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -620,7 +599,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Open System Bluetooth settings (Android only).
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -630,7 +608,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable Bluetooth on the device (Android only).
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -640,7 +617,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Read the RSSI value on the device connection.
|
||||
*
|
||||
* @param {string} deviceId UUID or MAC address of the peripheral
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -653,7 +629,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
* Retrieves a list of the peripherals (containing any of the specified services)
|
||||
* currently connected to the system. The peripheral list is sent to the success callback.
|
||||
* iOS only
|
||||
*
|
||||
* @param {string[]} services List of services to discover
|
||||
* @returns {Promise<any>} Returns a promise with a list of peripheral objects
|
||||
*/
|
||||
@@ -665,7 +640,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Find the connected peripherals offering the listed service UUIDs.
|
||||
* iOS only
|
||||
*
|
||||
* @param {string[]} uuids List of peripheral UUIDs
|
||||
* @returns {Promise<any>} Returns a promise with a list of peripheral objects
|
||||
*/
|
||||
@@ -677,7 +651,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Find the bonded devices
|
||||
* Android only
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise with a list of peripheral objects
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -688,7 +661,6 @@ export class BLE extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Reports if location services are enabled.
|
||||
* Android only
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -2758,7 +2758,6 @@ export type BlinkIdRecognizerResultCtor = RecognizerResultCtor<BlinkIdRecognizer
|
||||
export class BlinkId extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Opens the camera dialog and attempts to scan a barcode/document
|
||||
*
|
||||
* @param overlaySettings {OverlaySettings} for camera overlay customization
|
||||
* @param recognizerCollection {RecognizerCollection} collection of recognizers to scan with
|
||||
* @param licenses
|
||||
|
||||
@@ -75,7 +75,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Connect to a Bluetooth device
|
||||
*
|
||||
* @param {string} deviceId Identifier of the remote device.
|
||||
* @param {string} deviceId this is the MAC address.
|
||||
* @param {string|string[]} interfaceId Identifier of the remote device
|
||||
@@ -92,7 +91,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Connect to a Bluetooth device
|
||||
*
|
||||
* @deprecated
|
||||
* @param {string} deviceId Identifier of the remote device.
|
||||
* @param {number} deviceId this is the connection ID
|
||||
@@ -110,7 +108,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Connect insecurely to a Bluetooth device
|
||||
*
|
||||
* @param {string} deviceId Identifier of the remote device. For Android this is the MAC address
|
||||
* @param {string | string[]} interfaceArray This identifies the serial port to connect to. For Android this is the SPP_UUID.
|
||||
* @returns {Promise<any>} Subscribe to connect.
|
||||
@@ -125,7 +122,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Disconnect from the connected device
|
||||
*
|
||||
* @param {string} interfaceId The interface to Disconnect
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -136,7 +132,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Disconnect from all the connected device
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -148,7 +143,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Writes data to the serial port
|
||||
*
|
||||
* @param {string} interfaceId The interface to send the data to
|
||||
* @param {ArrayBuffer | string | number[] | Uint8Array} data ArrayBuffer of data
|
||||
* @returns {Promise<any>} returns a promise when data has been written
|
||||
@@ -162,7 +156,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Gets the number of bytes of data available
|
||||
*
|
||||
* @param {string} interfaceId The interface to check
|
||||
* @returns {Promise<any>} returns a promise that contains the available bytes
|
||||
*/
|
||||
@@ -175,7 +168,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Function read reads the data from the buffer. The data is passed to the success callback as a String. Calling read when no data is available will pass an empty String to the callback.
|
||||
*
|
||||
* @param {string} interfaceId The interface to read
|
||||
* @returns {Promise<any>} returns a promise with data from the buffer
|
||||
*/
|
||||
@@ -188,7 +180,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reads data from the buffer until it reaches a delimiter
|
||||
*
|
||||
* @param {string} interfaceId The interface to read
|
||||
* @param {string} delimiter string that you want to search until
|
||||
* @returns {Observable<any>} returns a promise
|
||||
@@ -202,7 +193,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Subscribe to be notified when data is received
|
||||
*
|
||||
* @param {string | string[]} interfaceId The interface to subscribe to
|
||||
* @param {string} delimiter the string you want to watch for
|
||||
* @returns {Observable<any>} returns an observable.
|
||||
@@ -217,7 +207,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Unsubscribe from a subscription
|
||||
*
|
||||
* @param {string | string[]} interfaceId The interface to unsubscribe from
|
||||
* @returns {Promise<any>} returns an promise.
|
||||
*/
|
||||
@@ -230,7 +219,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Subscribe to be notified when data is received
|
||||
*
|
||||
* @param {string | string[]} interfaceId The interface to subscribe to
|
||||
* @returns {Observable<any>} returns an observable
|
||||
*/
|
||||
@@ -244,7 +232,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Unsubscribe from a subscription
|
||||
*
|
||||
* @param {string | string[]} interfaceId The interface to unsubscribe from
|
||||
* @returns {Promise<any>} returns an promise.
|
||||
*/
|
||||
@@ -257,7 +244,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Clears data in buffer
|
||||
*
|
||||
* @param {string} interfaceId The interface to clear data
|
||||
* @returns {Promise<any>} returns a promise when completed
|
||||
*/
|
||||
@@ -270,7 +256,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Lists bonded devices
|
||||
*
|
||||
* @returns {Promise<BluetoothClassicSerialPortDevice>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -282,7 +267,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reports the connection status
|
||||
*
|
||||
* @param {string} interfaceId The interface to check
|
||||
* @returns {Promise<boolean>} returns a promise
|
||||
*/
|
||||
@@ -295,7 +279,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reports if bluetooth is enabled
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -307,7 +290,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show the Bluetooth settings on the device
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -319,7 +301,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable Bluetooth on the device
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -331,7 +312,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Discover unpaired devices
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -343,7 +323,6 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Subscribe to be notified on Bluetooth device discovery. Discovery process must be initiated with the `discoverUnpaired` function.
|
||||
*
|
||||
* @returns {Observable<any>} Returns an observable
|
||||
*/
|
||||
@Cordova({
|
||||
|
||||
@@ -41,7 +41,6 @@ import { Observable } from 'rxjs';
|
||||
export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Connect to a Bluetooth device
|
||||
*
|
||||
* @param {string} macAddress_or_uuid Identifier of the remote device
|
||||
* @returns {Observable<any>} Subscribe to connect, unsubscribe to disconnect.
|
||||
*/
|
||||
@@ -56,7 +55,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Connect insecurely to a Bluetooth device
|
||||
*
|
||||
* @param {string} macAddress Identifier of the remote device
|
||||
* @returns {Observable<any>} Subscribe to connect, unsubscribe to disconnect.
|
||||
*/
|
||||
@@ -71,7 +69,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Disconnect from the connected device
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -81,7 +78,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Writes data to the serial port
|
||||
*
|
||||
* @param {any} data ArrayBuffer of data
|
||||
* @returns {Promise<any>} returns a promise when data has been written
|
||||
*/
|
||||
@@ -94,7 +90,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Gets the number of bytes of data available
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise that contains the available bytes
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -106,7 +101,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reads data from the buffer
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise with data from the buffer
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -118,7 +112,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reads data from the buffer until it reaches a delimiter
|
||||
*
|
||||
* @param {string} delimiter string that you want to search until
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@@ -131,7 +124,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Subscribe to be notified when data is received
|
||||
*
|
||||
* @param {string} delimiter the string you want to watch for
|
||||
* @returns {Observable<any>} returns an observable.
|
||||
*/
|
||||
@@ -146,7 +138,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Subscribe to be notified when data is received
|
||||
*
|
||||
* @returns {Observable<any>} returns an observable
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -160,7 +151,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Clears data in buffer
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise when completed
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -172,7 +162,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Lists bonded devices
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -184,7 +173,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reports if bluetooth is enabled
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -196,7 +184,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reports the connection status
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -208,7 +195,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reads the RSSI from the connected peripheral
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -220,7 +206,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show the Bluetooth settings on the device
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -232,7 +217,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable Bluetooth on the device
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -244,7 +228,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Discover unpaired devices
|
||||
*
|
||||
* @returns {Promise<any>} returns a promise
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -256,7 +239,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Subscribe to be notified on Bluetooth device discovery. Discovery process must be initiated with the `discoverUnpaired` function.
|
||||
*
|
||||
* @returns {Observable<any>} Returns an observable
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -270,7 +252,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the human readable device name that is broadcasted to other devices
|
||||
*
|
||||
* @param {string} newName Desired name of device
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -281,7 +262,6 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Makes the device discoverable by other devices
|
||||
*
|
||||
* @param {number} discoverableDuration Desired number of seconds device should be discoverable for
|
||||
*/
|
||||
@Cordova({
|
||||
|
||||
@@ -76,7 +76,6 @@ export interface BranchUniversalObject {
|
||||
export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* for development and debugging only
|
||||
*
|
||||
* @param {boolean} enable Enable debug
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -87,7 +86,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Disable tracking
|
||||
*
|
||||
* @param {boolean} disable disable tracking
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -98,7 +96,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Initializes Branch
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ otherPromise: true })
|
||||
@@ -108,7 +105,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Initializes Branch with callback
|
||||
*
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({ observable: true })
|
||||
@@ -118,7 +114,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set Request Metadata
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ otherPromise: true })
|
||||
@@ -128,7 +123,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* for better Android matching
|
||||
*
|
||||
* @param {string} linkDomain LinkDomain at branch
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -139,7 +133,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* First data
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ otherPromise: true })
|
||||
@@ -149,7 +142,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Latest data
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ otherPromise: true })
|
||||
@@ -159,7 +151,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set identy of user
|
||||
*
|
||||
* @param {string} userId
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -170,7 +161,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Logout user
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ otherPromise: true })
|
||||
@@ -180,7 +170,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Registers a custom event
|
||||
*
|
||||
* @param {string} eventName
|
||||
* @param {any} metaData
|
||||
* @returns {Promise<any>}
|
||||
@@ -192,7 +181,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Send Commerce Event
|
||||
*
|
||||
* @deprecated since v.3.1.0. As of https://help.branch.io/developers-hub/docs/cordova-phonegap-ionic#track-commerce
|
||||
* @param {string} event
|
||||
* @param {any} metaData
|
||||
@@ -205,7 +193,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Send Branch Event
|
||||
*
|
||||
* @param {string} event
|
||||
* @param {any} metaData
|
||||
* @returns {Promise<any>}
|
||||
@@ -217,7 +204,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* create a branchUniversalObj variable to reference with other Branch methods
|
||||
*
|
||||
* @param {BranchIoProperties} properties
|
||||
* @returns {Promise<BranchUniversalObject>}
|
||||
*/
|
||||
@@ -228,7 +214,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Load credits
|
||||
*
|
||||
* @param {any} bucket
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -239,7 +224,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Redeem Rewards
|
||||
*
|
||||
* @param {string} value
|
||||
* @param {any} bucket
|
||||
* @returns {Promise<any>}
|
||||
@@ -251,7 +235,6 @@ export class BranchIo extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show credit history
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ otherPromise: true })
|
||||
|
||||
@@ -7,7 +7,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl
|
||||
* The Brightness plugin let you control the display brightness of your device.
|
||||
*
|
||||
* Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see the [Brightness plugin docs](https://github.com/mgcrea/cordova-plugin-brightness).
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { Brightness } from '@awesome-cordova-plugins/brightness/ngx';
|
||||
|
||||
@@ -47,7 +47,6 @@ export type EventData = object | AndroidData | null;
|
||||
export class Broadcaster extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* 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)
|
||||
* @returns {Observable<any>} Returns an observable to watch when an event is received
|
||||
@@ -63,7 +62,6 @@ export class Broadcaster extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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)
|
||||
|
||||
@@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
* @name Browser Tab
|
||||
* @description
|
||||
* This plugin provides an interface to in-app browser tabs that exist on some mobile platforms, specifically [Custom Tabs](http://developer.android.com/tools/support-library/features.html#custom-tabs) on Android (including the [Chrome Custom Tabs](https://developer.chrome.com/multidevice/android/customtabs) implementation), and [SFSafariViewController](https://developer.apple.com/library/ios/documentation/SafariServices/Reference/SFSafariViewController_Ref/) on iOS.
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { BrowserTab } from '@awesome-cordova-plugins/browser-tab/ngx';
|
||||
@@ -25,39 +24,39 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'BrowserTab',
|
||||
plugin: 'cordova-plugin-browsertab',
|
||||
pluginRef: 'cordova.plugins.browsertab',
|
||||
repo: 'https://github.com/google/cordova-plugin-browsertab',
|
||||
platforms: ['Android', 'iOS'],
|
||||
pluginName: 'BrowserTab',
|
||||
plugin: 'cordova-plugin-browsertab',
|
||||
pluginRef: 'cordova.plugins.browsertab',
|
||||
repo: 'https://github.com/google/cordova-plugin-browsertab',
|
||||
platforms: ['Android', 'iOS'],
|
||||
})
|
||||
@Injectable()
|
||||
export class BrowserTab extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Check if BrowserTab option is available
|
||||
* @return {Promise<any>} Returns a promise that resolves when check is successful and returns true or false
|
||||
*/
|
||||
@Cordova()
|
||||
isAvailable(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
/**
|
||||
* Check if BrowserTab option is available
|
||||
* @return {Promise<any>} Returns a promise that resolves when check is successful and returns true or false
|
||||
*/
|
||||
@Cordova()
|
||||
isAvailable(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens the provided URL using a browser tab
|
||||
* @param {string} url The URL you want to open
|
||||
* @return {Promise<any>} Returns a promise that resolves when check open was successful
|
||||
*/
|
||||
@Cordova()
|
||||
openUrl(url: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
/**
|
||||
* Opens the provided URL using a browser tab
|
||||
* @param {string} url The URL you want to open
|
||||
* @return {Promise<any>} Returns a promise that resolves when check open was successful
|
||||
*/
|
||||
@Cordova()
|
||||
openUrl(url: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes browser tab
|
||||
* @return {Promise<any>} Returns a promise that resolves when close was finished
|
||||
*/
|
||||
@Cordova()
|
||||
close(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
/**
|
||||
* Closes browser tab
|
||||
* @return {Promise<any>} Returns a promise that resolves when close was finished
|
||||
*/
|
||||
@Cordova()
|
||||
close(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -97,7 +97,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
* - You've already granted permission
|
||||
*
|
||||
* If this returns false, you should call the `requestReadWritePermission` function
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -107,7 +106,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if we have read permission
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -117,7 +115,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if we have write permission
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -127,7 +124,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Request write permission
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -137,7 +133,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Request read permission
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -147,7 +142,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Requests read/write permissions
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -157,7 +151,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Create a calendar. (iOS only)
|
||||
*
|
||||
* @param {string | NameOrOptions} nameOrOptions either a string name or a options object. If string, provide the calendar name. IF an object, provide a calendar name as a string and a calendar color in hex format as a string
|
||||
* @returns {Promise<any>} Returns a Promise
|
||||
*/
|
||||
@@ -168,7 +161,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Delete a calendar. (iOS only)
|
||||
*
|
||||
* @param {string} name Name of the calendar to delete.
|
||||
* @returns {Promise<any>} Returns a Promise
|
||||
*/
|
||||
@@ -179,7 +171,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the default calendar options.
|
||||
*
|
||||
* @returns {CalendarOptions} Returns an object with the default calendar options
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -191,7 +182,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns options for a custom calender with specific color
|
||||
*
|
||||
* @returns {NameOrOptions} Returns an object with the default options
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -203,7 +193,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Silently create an event.
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -218,7 +207,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Silently create an event with additional options.
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -241,7 +229,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Interactively create an event.
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -262,7 +249,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Interactively create an event with additional options.
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -285,7 +271,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Find an event.
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -300,7 +285,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Find an event with additional options.
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -323,7 +307,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Find a list of events within the specified date range. (Android only)
|
||||
*
|
||||
* @param {Date} [startDate] The start date
|
||||
* @param {Date} [endDate] The end date
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with the list of events, or rejects with an error.
|
||||
@@ -337,7 +320,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get a list of all calendars.
|
||||
*
|
||||
* @returns {Promise<any>} A Promise that resolves with the list of calendars, or rejects with an error.
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -347,7 +329,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get a list of all future events in the specified calendar. (iOS only)
|
||||
*
|
||||
* @param calendarName
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with the list of events, or rejects with an error.
|
||||
*/
|
||||
@@ -360,7 +341,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Modify an event. (iOS only)
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -393,7 +373,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Modify an event with additional options. (iOS only)
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -430,7 +409,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Delete an event.
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -445,7 +423,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Delete an event from the specified Calendar. (iOS only)
|
||||
*
|
||||
* @param {string} [title] The event title
|
||||
* @param {string} [location] The event location
|
||||
* @param {string} [notes] The event notes
|
||||
@@ -470,7 +447,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Delete an event by id.
|
||||
*
|
||||
* @param {string} [id] The event id
|
||||
* @param {Date} [fromDate] The date where it start deleting from
|
||||
* @returns Returns a Promise
|
||||
@@ -482,7 +458,6 @@ export class Calendar extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Open the calendar at the specified date.
|
||||
*
|
||||
* @param {Date} date The date you want to open the calendar on
|
||||
* @returns {Promise<any>} Promise returns a promise
|
||||
*/
|
||||
|
||||
@@ -51,7 +51,6 @@ export interface CallDirectoryLog {
|
||||
export class CallDirectory extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Check if the call directory extension is available and enabled
|
||||
*
|
||||
* @returns {Promise<boolean>} Returns a promise with result
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -61,7 +60,6 @@ export class CallDirectory extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Add identification numbers
|
||||
*
|
||||
* @param {CallDirectoryItem[]} items Set of numbers with labels
|
||||
* @returns {Promise<any>} Returns a promise that resolves when numbers are added
|
||||
*/
|
||||
@@ -72,7 +70,6 @@ export class CallDirectory extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Remove identification numbers
|
||||
*
|
||||
* @param {CallDirectoryItem[]} items Set of numbers with arbitrary label
|
||||
* @returns {Promise<any>} Returns a promise that resolves when numbers are removed
|
||||
*/
|
||||
@@ -83,7 +80,6 @@ export class CallDirectory extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Remove all items from call directory. Refreshes immediately.
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise after refresh with message
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -93,7 +89,6 @@ export class CallDirectory extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get all numbers and labels in call directory
|
||||
*
|
||||
* @returns {CallDirectoryItem[]} Returns a promise that resolves with an array of all items
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -103,7 +98,6 @@ export class CallDirectory extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reload extension to process queued changes
|
||||
*
|
||||
* @returns {Promise<string>} Returns a promise after refresh with message
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -113,7 +107,6 @@ export class CallDirectory extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get log from plugin and call directory extension
|
||||
*
|
||||
* @returns {Promise<CallDirectoryLog>} Returns a promise with an object of log messages
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -32,7 +32,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class CallNumber extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Calls a phone number
|
||||
*
|
||||
* @param {string} numberToCall The phone number to call as a string
|
||||
* @param {boolean} bypassAppChooser Set to true to bypass the app chooser and go directly to dialer
|
||||
* @returns {Promise<any>}
|
||||
@@ -46,7 +45,6 @@ export class CallNumber extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if call feature is available
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -30,7 +30,7 @@ export interface CameraPreviewOptions {
|
||||
|
||||
/** Preview box drag across the screen, default 'false' */
|
||||
previewDrag?: boolean;
|
||||
|
||||
|
||||
/** Capture images to a file and return back the file path instead of returning base64 encoded data. */
|
||||
storeToFile: boolean;
|
||||
|
||||
@@ -193,7 +193,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Starts the camera preview instance.
|
||||
*
|
||||
* @param {CameraPreviewOptions} options
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -207,7 +206,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Starts the camera video instance.
|
||||
*
|
||||
* @param {any} options
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -221,7 +219,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stops the camera preview instance. (iOS & Android)
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -231,7 +228,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Stops the camera video instance. (iOS & Android)
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -241,7 +237,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Switch from the rear camera and front camera, if available.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -251,7 +246,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Hide the camera preview box.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -261,7 +255,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show the camera preview box.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -271,7 +264,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Take the picture (base64)
|
||||
*
|
||||
* @param {CameraPreviewPictureOptions} [options] size and quality of the picture to take
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -285,7 +277,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Take a snapshot of preview window (size specified in startCamera options)
|
||||
*
|
||||
* @param {CameraPreviewPictureOptions} [options] quality of the picture to take
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -299,8 +290,7 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
*
|
||||
* Set camera color effect.
|
||||
*
|
||||
*Set camera color effect.
|
||||
* @static
|
||||
* @param {string} effect name : 'none' (iOS & Android), 'aqua' (Android), 'blackboard' (Android), 'mono' (iOS & Android), 'negative' (iOS & Android), 'posterize' (iOS & Android), 'sepia' (iOS & Android), 'solarize' (Android) or 'whiteboard' (Android)
|
||||
* @returns {Promise<any>}
|
||||
@@ -315,7 +305,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the zoom (Android)
|
||||
*
|
||||
* @param [zoom] {number} Zoom value
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -329,7 +318,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the maximum zoom (Android)
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -339,7 +327,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get current zoom (Android)
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -349,7 +336,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the preview Size
|
||||
*
|
||||
* @param {CameraPreviewDimensions} [dimensions]
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -363,7 +349,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get focus mode
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -373,7 +358,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the focus mode
|
||||
*
|
||||
* @param {string} [focusMode] 'fixed', 'auto', 'continuous-picture', 'continuous-video' (iOS & Android), 'edof', 'infinity', 'macro' (Android Only)
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -387,7 +371,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get supported focus modes
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -397,7 +380,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the current flash mode
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -407,7 +389,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the flash mode
|
||||
*
|
||||
* @param {string} [flashMode] 'off' (iOS & Android), 'on' (iOS & Android), 'auto' (iOS & Android), 'torch' (Android)
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -421,7 +402,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get supported flash modes
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -431,7 +411,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get supported picture sizes
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -441,7 +420,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get exposure mode
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -451,7 +429,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get exposure modes
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -461,7 +438,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set exposure mode
|
||||
*
|
||||
* @param {string} [lock]
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -475,7 +451,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get exposure compensation (Android)
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -485,7 +460,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set exposure compensation (Android)
|
||||
*
|
||||
* @param {number} [exposureCompensation]
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -499,7 +473,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get exposure compensation range (Android)
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -509,7 +482,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set specific focus point. Note, this assumes the camera is full-screen.
|
||||
*
|
||||
* @param {number} xPoint
|
||||
* @param {number} yPoint
|
||||
* @returns {Promise<any>}
|
||||
@@ -521,7 +493,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Add a listener for the back event for the preview
|
||||
*
|
||||
* @returns {Promise<any>} if back button pressed
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -531,7 +502,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Return in use device camera fov
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -541,7 +511,6 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the characteristics of all available cameras
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -242,7 +242,6 @@ export class Camera extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Take a picture or video, or load one from the library.
|
||||
*
|
||||
* @param {CameraOptions} [options] Options that you want to pass to the camera. Encoding type, quality, etc. Platform-specific quirks are described in the [Cordova plugin docs](https://github.com/apache/cordova-plugin-camera#cameraoptions-errata-).
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with Base64 encoding of the image data, or the image file URI, depending on cameraOptions, otherwise rejects with an error.
|
||||
*/
|
||||
@@ -256,7 +255,6 @@ export class Camera extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Remove intermediate image files that are kept in temporary storage after calling camera.getPicture.
|
||||
* Applies only when the value of Camera.sourceType equals Camera.PictureSourceType.CAMERA and the Camera.destinationType equals Camera.DestinationType.FILE_URI.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
|
||||
@@ -224,10 +224,7 @@ export class CFUPIIntentCheckoutPayment implements CheckoutPayment {
|
||||
private readonly theme: CFTheme = new CFThemeBuilder().build();
|
||||
version: string;
|
||||
|
||||
constructor(
|
||||
session: CFSession,
|
||||
theme: CFTheme | null
|
||||
) {
|
||||
constructor(session: CFSession, theme: CFTheme | null) {
|
||||
this.session = session;
|
||||
if (theme !== null) {
|
||||
this.theme = theme;
|
||||
|
||||
@@ -190,7 +190,6 @@ export interface Phone {
|
||||
export class Checkout extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Initialize Frames plugin in Sandbox mode
|
||||
*
|
||||
* @param publicKey {string} Merchant's sandbox public key
|
||||
* @returns {Promise<any>} Returns a promise that resolves when Frames initiation is completed
|
||||
*/
|
||||
@@ -201,7 +200,6 @@ export class Checkout extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Initialize Frames plugin in Live mode
|
||||
*
|
||||
* @param publicKey {string} Merchant's live public key
|
||||
* @returns {Promise<any>} Returns a promise that resolves when Frames initiation is completed
|
||||
*/
|
||||
@@ -212,7 +210,6 @@ export class Checkout extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Exchange card details for a reference token that can be used later to request a card payment from your backend. Tokens are single use and expire after 15 minutes.
|
||||
*
|
||||
* @param ckoCardTokenRequest {CkoCardTokenRequest} Card tokenization request object
|
||||
* @returns {Promise<CkoCardTokenResponse>} Returns a promise that resolves when Token response object
|
||||
*/
|
||||
|
||||
@@ -52,7 +52,6 @@ export interface ChooserResult {
|
||||
export class Chooser extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* 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
|
||||
* data: MIME type, display name, and original URI.
|
||||
|
||||
@@ -67,7 +67,6 @@ export interface ChooserResult {
|
||||
export class Chooser extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Displays native prompt for user to select a file.
|
||||
*
|
||||
* @param {Object} options
|
||||
* @param {string} options.mimeTypes Optional MIME type filter (e.g. 'image/gif,video/*').
|
||||
* @param {string} options.maxFileSize Optional Max file size.
|
||||
|
||||
@@ -28,7 +28,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* notify device ready
|
||||
* NOTE: in iOS use to be notified of launch Push Notification or Deep Link
|
||||
* in Android use only in android phonegap build projects
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -43,7 +42,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Personalization
|
||||
* Enables the Personalization API
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -54,7 +52,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Personalization
|
||||
* Disables the Personalization API
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -64,7 +61,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enables tracking opt out for the currently active user.
|
||||
*
|
||||
* @param optOut {boolean}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -75,7 +71,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets CleverTap SDK to offline mode.
|
||||
*
|
||||
* @param offline {boolean}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -86,7 +81,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enables the reporting of device network related information, including IP address. This reporting is disabled by default.
|
||||
*
|
||||
* @param enable {boolean}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -111,7 +105,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Registers for push notifications
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -121,7 +114,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the device's push token
|
||||
*
|
||||
* @param token {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -132,7 +124,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the device's Baidu push token
|
||||
*
|
||||
* @param token {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -143,7 +134,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the device's Huawei push token
|
||||
*
|
||||
* @param token {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -154,7 +144,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Create Notification Channel for Android O+
|
||||
*
|
||||
* @param extras {any}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -165,7 +154,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Create Notification Channel for Android O+
|
||||
*
|
||||
* @param channelID {string}
|
||||
* @param channelName {string}
|
||||
* @param channelDescription {string}
|
||||
@@ -186,7 +174,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Create Notification Channel for Android O+
|
||||
*
|
||||
* @param channelID {string}
|
||||
* @param channelName {string}
|
||||
* @param channelDescription {string}
|
||||
@@ -209,7 +196,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Create Notification Channel with Group ID for Android O+
|
||||
*
|
||||
* @param channelID {string}
|
||||
* @param channelName {string}
|
||||
* @param channelDescription {string}
|
||||
@@ -233,7 +219,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Create Notification Channel with Group ID for Android O+
|
||||
*
|
||||
* @param channelID {string}
|
||||
* @param channelName {string}
|
||||
* @param channelDescription {string}
|
||||
@@ -258,7 +243,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Create Notification Channel Group for Android O+
|
||||
*
|
||||
* @param groupID {string}
|
||||
* @param groupName {string}
|
||||
* @returns {Promise<any>}
|
||||
@@ -270,7 +254,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Delete Notification Channel for Android O+
|
||||
*
|
||||
* @param channelID {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -281,7 +264,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Delete Notification Group for Android O+
|
||||
*
|
||||
* @param groupID {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -296,7 +278,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Record Screen View
|
||||
*
|
||||
* @param screenName {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -307,7 +288,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Record Event with Name
|
||||
*
|
||||
* @param eventName {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -318,7 +298,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Record Event with Name and Event properties
|
||||
*
|
||||
* @param eventName {string}
|
||||
* @param eventProps {any}
|
||||
* @returns {Promise<any>}
|
||||
@@ -330,7 +309,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Record Charged Event with Details and Items
|
||||
*
|
||||
* @param details {any} object with transaction details
|
||||
* @param items {any} array of items purchased
|
||||
* @returns {Promise<any>}
|
||||
@@ -342,61 +320,54 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the details of a specific event
|
||||
*
|
||||
* @param eventName {string} - The name of the event
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getUserEventLog(eventName: string): Promise<any> {
|
||||
return;
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the count of times an event occurred
|
||||
*
|
||||
* @param eventName {string} - The name of the event
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getUserEventLogCount(eventName: string): Promise<any> {
|
||||
return;
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get timestamp of user's last app visit
|
||||
*
|
||||
* @returns {Promise<any>} - Returns epoch seconds or -1
|
||||
*/
|
||||
@Cordova()
|
||||
getUserLastVisitTs(): Promise<any> {
|
||||
return;
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the total number of times the user has launched the app
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getUserAppLaunchCount(): Promise<any> {
|
||||
return;
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get full event history for the current user
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
getUserEventLogHistory(): Promise<any> {
|
||||
return;
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @deprecated - Use getUserEventLog() instead
|
||||
* Get Event First Time
|
||||
*
|
||||
* @param eventName {string}
|
||||
* callback returns epoch seconds or -1
|
||||
* @returns {Promise<any>}
|
||||
@@ -409,7 +380,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Use getUserEventLog() instead
|
||||
* Get Event Last Time
|
||||
*
|
||||
* @param eventName {string}
|
||||
* callback returns epoch seconds or -1
|
||||
* @returns {Promise<any>}
|
||||
@@ -422,7 +392,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Use getUserEventLogCount() instead
|
||||
* Get Event Number of Occurrences
|
||||
*
|
||||
* @param eventName {string}
|
||||
* calls back with int or -1
|
||||
* @returns {Promise<any>}
|
||||
@@ -433,9 +402,8 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* * @deprecated - Use getUserEventLog() instead
|
||||
* @deprecated - Use getUserEventLog() instead
|
||||
* Get Event Details
|
||||
*
|
||||
* @param eventName {string}
|
||||
* calls back with object {"eventName": <string>, "firstTime":<epoch seconds>, "lastTime": <epoch seconds>, "count": <int>} or empty object
|
||||
* @returns {Promise<any>}
|
||||
@@ -449,7 +417,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* @deprecated - Use getUserEventLogHistory() instead
|
||||
* Get Event History
|
||||
* calls back with object {"eventName1":<event1 details object>, "eventName2":<event2 details object>}
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -474,7 +441,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* for, among other things, more fine-grained geo-targeting and segmentation purposes.
|
||||
* Note: on iOS the call to CleverTapSDK must be made on the main thread due to LocationManager restrictions, but the CleverTapSDK method itself is non-blocking.
|
||||
* calls back with {lat:lat, lon:lon} lat and lon are floats
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -484,7 +450,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set location
|
||||
*
|
||||
* @param lat {number}
|
||||
* @param lon {number}
|
||||
* @returns {Promise<any>}
|
||||
@@ -511,7 +476,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* and data relating to the old user removed, and a new session is started
|
||||
* for the new user and data for that user refreshed via a network call to CleverTap.
|
||||
* In addition, any global frequency caps are reset as part of the switch.
|
||||
*
|
||||
* @param profile {any} object
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -522,7 +486,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set profile attributes
|
||||
*
|
||||
* @param profile {any} object
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -533,7 +496,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get User Profile Property
|
||||
*
|
||||
* @param propertyName {string}
|
||||
* calls back with value of propertyName or false
|
||||
* @returns {Promise<any>}
|
||||
@@ -547,7 +509,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* @deprecated This method is deprecated. Use getCleverTapID() instead.
|
||||
* Get a unique CleverTap identifier suitable for use with install attribution providers.
|
||||
* calls back with unique CleverTap attribution identifier
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -559,7 +520,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* @deprecated This method is deprecated. Use getCleverTapID() instead.
|
||||
* Get User Profile CleverTapID
|
||||
* calls back with CleverTapID or false
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -570,7 +530,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get User Profile CleverTapID
|
||||
* calls back with CleverTapID
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -580,7 +539,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Remove the property specified by key from the user profile
|
||||
*
|
||||
* @param key {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -591,7 +549,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method for setting a multi-value user profile property
|
||||
*
|
||||
* @param key {string}
|
||||
* @param values {any} array of strings
|
||||
* @returns {Promise<any>}
|
||||
@@ -603,7 +560,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method for adding a value to a multi-value user profile property
|
||||
*
|
||||
* @param key {string}
|
||||
* @param value {string}
|
||||
* @returns {Promise<any>}
|
||||
@@ -615,7 +571,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method for adding values to a multi-value user profile property
|
||||
*
|
||||
* @param key {string}
|
||||
* @param values {any} array of strings
|
||||
* @returns {Promise<any>}
|
||||
@@ -627,7 +582,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method for removing a value from a multi-value user profile property
|
||||
*
|
||||
* @param key {string}
|
||||
* @param value {string}
|
||||
* @returns {Promise<any>}
|
||||
@@ -639,7 +593,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method for removing a value from a multi-value user profile property
|
||||
*
|
||||
* @param key {string}
|
||||
* @param values {any} array of strings
|
||||
* @returns {Promise<any>}
|
||||
@@ -651,25 +604,23 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Method for incrementing a value for a single-value profile property (if it exists).
|
||||
*
|
||||
* @param key {string}
|
||||
* @param value {number}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
profileIncrementValueBy(key: string,value: number): Promise<any> {
|
||||
profileIncrementValueBy(key: string, value: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method for decrementing a value for a single-value profile property (if it exists).
|
||||
*
|
||||
* @param key {string}
|
||||
* @param value {number}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
profileDecrementValueBy(key: string,value: number): Promise<any> {
|
||||
profileDecrementValueBy(key: string, value: number): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -681,7 +632,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* Suspends and saves inApp notifications until 'resumeInAppNotifications' is called for current session.
|
||||
* Automatically resumes InApp notifications display on CleverTap shared instance creation.
|
||||
* Pending inApp notifications are displayed only for current session.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -701,7 +651,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Resumes displaying inApps notifications and shows pending inApp notifications if any.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -711,7 +660,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Deletes all images and gifs which are preloaded for inapps in cs mode.
|
||||
*
|
||||
* @param expiredOnly {boolean} - to clear only assets which will not be needed further for inapps
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -722,18 +670,16 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Deletes all types of files which are preloaded for SDK features like custom in-app templates, app functions and variables etc.
|
||||
*
|
||||
* @param expiredOnly {boolean} - to clear only assets which will not be needed further for inapps
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
clearFileResources(expiredOnly: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
@Cordova()
|
||||
clearFileResources(expiredOnly: boolean): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches In Apps from server.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -741,7 +687,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/*******************
|
||||
* Session
|
||||
******************/
|
||||
@@ -749,7 +694,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get Session Elapsed Time
|
||||
* calls back with seconds
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -761,7 +705,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* @deprecated - Use getUserAppLaunchCount() instead
|
||||
* Get Session Total Visits
|
||||
* calls back with with int or -1
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -772,7 +715,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get Session Screen Count
|
||||
* calls back with with int
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -784,7 +726,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* @deprecated - Use getUserLastVisitTs() instead
|
||||
* Get Session Previous Visit Time
|
||||
* calls back with with epoch seconds or -1
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -795,7 +736,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get Sesssion Referrer UTM details
|
||||
* object {"source": <string>, "medium": <string>, "campaign": <string>} or empty object
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -805,7 +745,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to manually track the utm details for an incoming install referrer
|
||||
*
|
||||
* @param source {string}
|
||||
* @param medium {string}
|
||||
* @param campaign {string}
|
||||
@@ -846,7 +785,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this method to open the App Inbox
|
||||
*
|
||||
* @param styleConfig : any or empty object
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -856,7 +794,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Fetch all Inbox Messages
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -866,7 +803,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Fetch all Unread Inbox Messages
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -876,7 +812,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Fetch Inbox Message For Id
|
||||
*
|
||||
* @param messageId {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -887,7 +822,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Delete Inbox Message For Id
|
||||
*
|
||||
* @param messageId {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -898,7 +832,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this method to delete bulk Inbox Messages for Given Message Ids
|
||||
*
|
||||
* @param messageIds {any} array of strings
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -909,7 +842,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Mark Read Inbox Message For Id
|
||||
*
|
||||
* @param messageId {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -920,7 +852,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Mark Read Inbox Messages For Ids in bulk
|
||||
*
|
||||
* @param messageIds {any} array of strings
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -931,7 +862,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to dismiss Inbox
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -941,7 +871,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Mark Push Inbox Notification Viewed Event for Id
|
||||
*
|
||||
* @param messageId {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -952,7 +881,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Mark Push Inbox Notification Clicked Event for Id
|
||||
*
|
||||
* @param messageId {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -963,7 +891,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Get All Display Units
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -973,7 +900,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Get Display Unit For Id
|
||||
*
|
||||
* @param id {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -984,7 +910,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Push DisplayUnit Viewed Event for ID
|
||||
*
|
||||
* @param id {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -995,7 +920,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Call this to Push DisplayUnit Clicked Event for ID
|
||||
*
|
||||
* @param id {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1007,7 +931,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to Get Feature Flag for key
|
||||
*
|
||||
* @param key {string}
|
||||
* @param defaultValue {string}
|
||||
* @returns {Promise<any>}
|
||||
@@ -1020,7 +943,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to Set Defaults for Product Config
|
||||
*
|
||||
* @param defaults {any}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1032,7 +954,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this for Product Config Fetch
|
||||
*
|
||||
* @param defaults {any}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1044,7 +965,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this for Product Config Fetch with Min Interval
|
||||
*
|
||||
* @param timeInterval {number}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1056,7 +976,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this for Product Config Activate
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -1067,7 +986,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this for Product Config Fetch and Activate
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -1078,7 +996,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to set Product Config Fetch with Min Interval
|
||||
*
|
||||
* @param timeInterval {number}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1090,7 +1007,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to Get Last Fetch Time Interval
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -1101,7 +1017,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to Get String
|
||||
*
|
||||
* @param key {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1113,7 +1028,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to Get Boolean
|
||||
*
|
||||
* @param key {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1125,7 +1039,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to Get Long
|
||||
*
|
||||
* @param key {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1137,7 +1050,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to Get Double
|
||||
*
|
||||
* @param key {string}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -1149,7 +1061,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* @deprecated - Since version 2.7.0 and will be removed in the future versions of this SDK.
|
||||
* Call this to Reset Product Config
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -1208,10 +1119,10 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
* @returns {Promise<any>}
|
||||
* @param {string} variable The String specifying the name of file varible to be created.
|
||||
*/
|
||||
@Cordova()
|
||||
defineFileVariable(variable: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
@Cordova()
|
||||
defineFileVariable(variable: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a variable or a group for the specified name.
|
||||
@@ -1251,7 +1162,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Called when the value of the file variable is downloaded and ready
|
||||
* @param {name} string the name of the variable
|
||||
@@ -1289,7 +1199,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/****************************
|
||||
* Custom Templates methods
|
||||
****************************/
|
||||
@@ -1318,105 +1227,98 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Notify the SDK that an active custom template is dismissed. The active custom template is considered to be
|
||||
* visible to the user until this method is called. Since the SDK can show only one InApp message at a time, all
|
||||
* other messages will be queued until the current one is dismissed.
|
||||
* @param {string} templateName The name of the active template
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Notify the SDK that an active custom template is dismissed. The active custom template is considered to be
|
||||
* visible to the user until this method is called. Since the SDK can show only one InApp message at a time, all
|
||||
* other messages will be queued until the current one is dismissed.
|
||||
* @param {string} templateName The name of the active template
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateSetDismissed(templateName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Notify the SDK that an active custom template is presented to the user.
|
||||
* @param {string} templateName The name of the active template
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Notify the SDK that an active custom template is presented to the user.
|
||||
* @param {string} templateName The name of the active template
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateSetPresented(templateName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Trigger a custom template action argument by name.
|
||||
*
|
||||
* @param {string} templateName The name of an active template for which the action is defined
|
||||
* @param {string} argName The action argument na
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Trigger a custom template action argument by name.
|
||||
* @param {string} templateName The name of an active template for which the action is defined
|
||||
* @param {string} argName The action argument na
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateRunAction(templateName: string, argName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a string argument by name.
|
||||
*
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Retrieve a string argument by name.
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateGetStringArg(templateName: string, argName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a number argument by name.
|
||||
*
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Retrieve a number argument by name.
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateGetNumberArg(templateName: string, argName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a boolean argument by name.
|
||||
*
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Retrieve a boolean argument by name.
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateGetBooleanArg(templateName: string, argName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a file argument by name.
|
||||
*
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Retrieve a file argument by name.
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateGetFileArg(templateName: string, argName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve an object argument by name.
|
||||
*
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Retrieve an object argument by name.
|
||||
* @param {string} templateName The name of an active template for which the argument is defined
|
||||
* @param {string} argName The action argument name
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateGetObjectArg(templateName: string, argName: string): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a string representation of an active's template context with information about all arguments.
|
||||
* @param {string} templateName The name of an active template
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
* Get a string representation of an active's template context with information about all arguments.
|
||||
* @param {string} templateName The name of an active template
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
customTemplateContextToString(templateName: string): Promise<any> {
|
||||
return;
|
||||
@@ -1448,7 +1350,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns true/false based on whether push permission is granted or denied.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -1456,13 +1357,11 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/*******************
|
||||
* Developer Options
|
||||
******************/
|
||||
/**
|
||||
* 0 is off, 1 is info, 2 is debug, default is 1
|
||||
*
|
||||
* @param level {number}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
|
||||
@@ -39,7 +39,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class Clipboard extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Copies the given text
|
||||
*
|
||||
* @param {string} text Text that gets copied on the system clipboard
|
||||
* @returns {Promise<any>} Returns a promise after the text has been copied
|
||||
*/
|
||||
@@ -50,7 +49,6 @@ export class Clipboard extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Pastes the text stored in clipboard
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise after the text has been pasted
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -60,7 +58,6 @@ export class Clipboard extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Clear the text stored in clipboard
|
||||
*
|
||||
* @returns {Promise<any>} Returns a promise after the text has been cleaned
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -41,7 +41,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class CloudSettings extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Indicates if any stored cloud settings currently exist for the current user.
|
||||
*
|
||||
* @returns {Promise<boolean>} Will be passed a boolean flag which indicates whether an store settings exist for the user.
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -51,7 +50,6 @@ export class CloudSettings extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Saves the settings to cloud backup.
|
||||
*
|
||||
* @param {object} settings - a JSON structure representing the user settings to save to cloud backup.
|
||||
* @param {boolean} [overwrite] - (optional) if true, existing settings will be replaced rather than updated. Defaults to false.
|
||||
* If false, existing settings will be merged with the new settings passed to this function.
|
||||
@@ -67,7 +65,6 @@ export class CloudSettings extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Loads the current settings.
|
||||
*
|
||||
* @returns {Promise<any>} Will be passed a single object argument which contains the saved settings as a JSON object.
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -77,7 +74,6 @@ export class CloudSettings extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Registers a function which will be called if/when settings on the device have been updated from the cloud.
|
||||
*
|
||||
* @param {Function} handler - callback function to invoke when device settings have been updated from the cloud.
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -85,7 +81,6 @@ export class CloudSettings extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Outputs verbose log messages from the native plugin components to the JS console.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -54,7 +54,6 @@ export interface IRemotePackage extends IPackage {
|
||||
|
||||
/**
|
||||
* Downloads the package update from the CodePush service.
|
||||
*
|
||||
* @param {SuccessCallback} downloadSuccess Called with one parameter, the downloaded package information, once the download completed successfully.
|
||||
* @param {ErrorCallback} [downloadError] Optional callback invoked in case of an error.
|
||||
* @param {SuccessCallback<DownloadProgress>} [downloadProgress] Optional callback invoked during the download process. It is called several times with one DownloadProgress parameter.
|
||||
@@ -67,7 +66,6 @@ export interface IRemotePackage extends IPackage {
|
||||
|
||||
/**
|
||||
* Aborts the current download session, previously started with download().
|
||||
*
|
||||
* @param {SuccessCallback<void>} [abortSuccess] Optional callback invoked if the abort operation succeeded.
|
||||
* @param {ErrorCallback} [abortError] Optional callback invoked in case of an error.
|
||||
*/
|
||||
@@ -94,7 +92,6 @@ export interface ILocalPackage extends IPackage {
|
||||
* Applies this package to the application. The application will be reloaded with this package and on every application launch this package will be loaded.
|
||||
* On the first run after the update, the application will wait for a codePush.notifyApplicationReady() call. Once this call is made, the install operation is considered a success.
|
||||
* Otherwise, the install operation will be marked as failed, and the application is reverted to its previous version on the next run.
|
||||
*
|
||||
* @param {SuccessCallback<InstallMode>} installSuccess Callback invoked if the install operation succeeded.
|
||||
* @param {ErrorCallback} [installError] Optional callback invoked in case of an error.
|
||||
* @param {InstallOptions} [installOptions] Optional parameter used for customizing the installation behavior.
|
||||
@@ -184,7 +181,6 @@ declare class AcquisitionManager {
|
||||
interface CodePushCordovaPlugin {
|
||||
/**
|
||||
* Get the current package information.
|
||||
*
|
||||
* @param packageSuccess Callback invoked with the currently deployed package information.
|
||||
* @param packageError Optional callback invoked in case of an error.
|
||||
*/
|
||||
@@ -198,7 +194,6 @@ interface CodePushCordovaPlugin {
|
||||
|
||||
/**
|
||||
* Checks with the CodePush server if an update package is available for download.
|
||||
*
|
||||
* @param {SuccessCallback<IRemotePackage>} querySuccess Callback invoked in case of a successful response from the server.
|
||||
* The callback takes one RemotePackage parameter. A non-null package is a valid update.
|
||||
* A null package means the application is up to date for the current native application version.
|
||||
@@ -215,7 +210,6 @@ interface CodePushCordovaPlugin {
|
||||
* Notifies the plugin that the update operation succeeded and that the application is ready.
|
||||
* Calling this function is required on the first run after an update. On every subsequent application run, calling this function is a noop.
|
||||
* If using sync API, calling this function is not required since sync calls it internally.
|
||||
*
|
||||
* @param {SuccessCallback<void>} [notifySucceeded] Optional callback invoked if the plugin was successfully notified.
|
||||
* @param {ErrorCallback} [notifyFailed] Optional callback invoked in case of an error during notifying the plugin.
|
||||
*/
|
||||
@@ -224,7 +218,6 @@ interface CodePushCordovaPlugin {
|
||||
/**
|
||||
* Reloads the application. If there is a pending update package installed using ON_NEXT_RESTART or ON_NEXT_RESUME modes, the update
|
||||
* will be immediately visible to the user. Otherwise, calling this function will simply reload the current version of the application.
|
||||
*
|
||||
* @param {SuccessCallback<void>} installSuccess
|
||||
* @param {ErrorCallback} [errorCallback]
|
||||
*/
|
||||
@@ -237,14 +230,13 @@ interface CodePushCordovaPlugin {
|
||||
* The algorithm of this method is the following:
|
||||
* - Checks for an update on the CodePush server.
|
||||
* - If an update is available
|
||||
* - If the update is mandatory and the alertMessage is set in options, the user will be informed that the application will be updated to the latest version.
|
||||
* The update package will then be downloaded and applied.
|
||||
* - If the update is not mandatory and the confirmMessage is set in options, the user will be asked if they want to update to the latest version.
|
||||
* If they decline, the syncCallback will be invoked with SyncStatus.UPDATE_IGNORED.
|
||||
* - Otherwise, the update package will be downloaded and applied with no user interaction.
|
||||
* - If the update is mandatory and the alertMessage is set in options, the user will be informed that the application will be updated to the latest version.
|
||||
* The update package will then be downloaded and applied.
|
||||
* - If the update is not mandatory and the confirmMessage is set in options, the user will be asked if they want to update to the latest version.
|
||||
* If they decline, the syncCallback will be invoked with SyncStatus.UPDATE_IGNORED.
|
||||
* - Otherwise, the update package will be downloaded and applied with no user interaction.
|
||||
* - If no update is available on the server, or if a previously rolled back update is available and the ignoreFailedUpdates is set to true, the syncCallback will be invoked with the SyncStatus.UP_TO_DATE.
|
||||
* - If an error occurs during checking for update, downloading or installing it, the syncCallback will be invoked with the SyncStatus.ERROR.
|
||||
*
|
||||
* @param {SuccessCallback<SyncStatus>} [syncCallback] Optional callback to be called with the status of the sync operation.
|
||||
* The callback will be called only once, and the possible statuses are defined by the SyncStatus enum.
|
||||
* @param {SyncOptions} [syncOptions] Optional SyncOptions parameter configuring the behavior of the sync operation.
|
||||
@@ -468,7 +460,6 @@ export interface DownloadProgress {
|
||||
export class CodePush extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get the current package information.
|
||||
*
|
||||
* @returns {Promise<ILocalPackage>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -479,7 +470,6 @@ export class CodePush extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Gets the pending package information, if any. A pending package is one that has been installed but the application still runs the old code.
|
||||
* This happens only after a package has been installed using ON_NEXT_RESTART or ON_NEXT_RESUME mode, but the application was not restarted/resumed yet.
|
||||
*
|
||||
* @returns {Promise<ILocalPackage>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -489,7 +479,6 @@ export class CodePush extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks with the CodePush server if an update package is available for download.
|
||||
*
|
||||
* @param {string} [deploymentKey] Optional deployment key that overrides the config.xml setting.
|
||||
* @returns {Promise<IRemotePackage>}
|
||||
*/
|
||||
@@ -504,7 +493,6 @@ export class CodePush extends AwesomeCordovaNativePlugin {
|
||||
* Notifies the plugin that the update operation succeeded and that the application is ready.
|
||||
* Calling this function is required on the first run after an update. On every subsequent application run, calling this function is a noop.
|
||||
* If using sync API, calling this function is not required since sync calls it internally.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -515,7 +503,6 @@ export class CodePush extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Reloads the application. If there is a pending update package installed using ON_NEXT_RESTART or ON_NEXT_RESUME modes, the update
|
||||
* will be immediately visible to the user. Otherwise, calling this function will simply reload the current version of the application.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -530,14 +517,13 @@ export class CodePush extends AwesomeCordovaNativePlugin {
|
||||
* The algorithm of this method is the following:
|
||||
* - Checks for an update on the CodePush server.
|
||||
* - If an update is available
|
||||
* - If the update is mandatory and the alertMessage is set in options, the user will be informed that the application will be updated to the latest version.
|
||||
* The update package will then be downloaded and applied.
|
||||
* - If the update is not mandatory and the confirmMessage is set in options, the user will be asked if they want to update to the latest version.
|
||||
* If they decline, the syncCallback will be invoked with SyncStatus.UPDATE_IGNORED.
|
||||
* - Otherwise, the update package will be downloaded and applied with no user interaction.
|
||||
* - If the update is mandatory and the alertMessage is set in options, the user will be informed that the application will be updated to the latest version.
|
||||
* The update package will then be downloaded and applied.
|
||||
* - If the update is not mandatory and the confirmMessage is set in options, the user will be asked if they want to update to the latest version.
|
||||
* If they decline, the syncCallback will be invoked with SyncStatus.UPDATE_IGNORED.
|
||||
* - Otherwise, the update package will be downloaded and applied with no user interaction.
|
||||
* - If no update is available on the server, or if a previously rolled back update is available and the ignoreFailedUpdates is set to true, the syncCallback will be invoked with the SyncStatus.UP_TO_DATE.
|
||||
* - If an error occurs during checking for update, downloading or installing it, the syncCallback will be invoked with the SyncStatus.ERROR.
|
||||
*
|
||||
* @param {SyncOptions} [syncOptions] Optional SyncOptions parameter configuring the behavior of the sync operation.
|
||||
* @param {SuccessCallback<DownloadProgress>} [downloadProgress] Optional callback invoked during the download process. It is called several times with one DownloadProgress parameter.
|
||||
* @returns {Observable<SyncStatus>}
|
||||
|
||||
@@ -208,7 +208,11 @@ export interface IContactField {
|
||||
* @hidden
|
||||
*/
|
||||
export class ContactField implements IContactField {
|
||||
constructor(public type?: string, public value?: string, public pref?: boolean) {}
|
||||
constructor(
|
||||
public type?: string,
|
||||
public value?: string,
|
||||
public pref?: boolean
|
||||
) {}
|
||||
}
|
||||
|
||||
export interface IContactAddress {
|
||||
@@ -303,7 +307,6 @@ export class ContactFindOptions implements IContactFindOptions {
|
||||
* @premier contacts
|
||||
* @description
|
||||
* Access and manage Contacts on the device.
|
||||
*
|
||||
* @usage
|
||||
*
|
||||
* ```typescript
|
||||
|
||||
@@ -16,7 +16,6 @@ export interface CropOption {
|
||||
* @name Crop Plugin Privacy
|
||||
* @description
|
||||
* This plugin does something
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { CropPluginPrivacy } from '@awesome-cordova-plugins/crop-plugin-privacy/ngx';
|
||||
@@ -38,11 +37,10 @@ export interface CropOption {
|
||||
plugin: 'cordova-plugin-crop-privacy',
|
||||
pluginRef: 'crop',
|
||||
repo: 'https://github.com/BaraAksayeth25/cordova-plugin-crop-privacy',
|
||||
platforms: ['Android']
|
||||
platforms: ['Android'],
|
||||
})
|
||||
@Injectable()
|
||||
export class CropPluginPrivacy extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This function does something
|
||||
* @param arg1 {string} path destination
|
||||
@@ -53,5 +51,4 @@ export class CropPluginPrivacy extends AwesomeCordovaNativePlugin {
|
||||
cropImage(arg1: string, arg2: CropOption): Promise<any> {
|
||||
return; // We add return; here to avoid any IDE / Compiler errors
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -37,7 +37,6 @@ import {
|
||||
export class CustomUISDK extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This function show dialog to ask user permision to fetch authcode
|
||||
*
|
||||
* @param clientId {string} unique id give to each merchant
|
||||
* @param mid {string} merchant id
|
||||
* @returns {Promise<string>} Returns authcode
|
||||
@@ -49,7 +48,6 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* This function check that paytm app is installed or not
|
||||
*
|
||||
* @returns {Promise<boolean>} Returns installed - true or not -false
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -94,7 +94,6 @@ export interface DeeplinkOptions {
|
||||
export class Deeplinks extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Define a set of paths to match against incoming deeplinks.
|
||||
*
|
||||
* @param {paths} paths Define a set of paths to match against incoming deeplinks.
|
||||
* paths takes an object of the form { 'path': data }. If a deeplink
|
||||
* matches the path, the resulting path-data pair will be returned in the
|
||||
@@ -111,14 +110,13 @@ export class Deeplinks extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
*
|
||||
* This is a convenience version of `route` that takes a reference to a NavController
|
||||
* from Ionic, or a custom class that conforms to this protocol:
|
||||
*This is a convenience version of `route` that takes a reference to a NavController
|
||||
*from Ionic, or a custom class that conforms to this protocol:
|
||||
*
|
||||
* NavController.push = function(View, Params){}
|
||||
*
|
||||
* This handler will automatically navigate when a route matches. If you need finer-grained
|
||||
* control over the behavior of a matching deeplink, use the plain `route` method.
|
||||
*NavController.push = function(View, Params){}
|
||||
*
|
||||
*This handler will automatically navigate when a route matches. If you need finer-grained
|
||||
*control over the behavior of a matching deeplink, use the plain `route` method.
|
||||
* @param {Nav} navController Define a set of paths to match against incoming deeplinks.
|
||||
* paths takes an object of the form { 'path': data }. If a deeplink
|
||||
* matches the path, the resulting path-data pair will be returned in the
|
||||
|
||||
@@ -43,7 +43,6 @@ export interface AndroidAccount {
|
||||
export class DeviceAccounts extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Gets all accounts registered on the Android Device
|
||||
*
|
||||
* @returns {Promise<AndroidAccount[]>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -53,7 +52,6 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get all accounts registered on Android device for requested type
|
||||
*
|
||||
* @param {string} type
|
||||
* @returns {Promise<AndroidAccount[]>}
|
||||
*/
|
||||
@@ -64,7 +62,6 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get all emails registered on Android device (accounts with 'com.google' type)
|
||||
*
|
||||
* @returns {Promise<string[]>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -74,7 +71,6 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the first email registered on Android device
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -84,7 +80,6 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get permissions for access to email registered on Android device 8.0+
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -94,7 +89,6 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get permissions for access to email registered on Android device 8.0+ for requested type
|
||||
*
|
||||
* @param {string} type
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
|
||||
@@ -83,7 +83,6 @@ export interface DeviceMotionAccelerometerOptions {
|
||||
export class DeviceMotion extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get the current acceleration along the x, y, and z axes.
|
||||
*
|
||||
* @returns {Promise<DeviceMotionAccelerationData>} Returns object with x, y, z, and timestamp properties
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -93,7 +92,6 @@ export class DeviceMotion extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Watch the device acceleration. Clear the watch by unsubscribing from the observable.
|
||||
*
|
||||
* @param {AccelerometerOptions} options list of options for the accelerometer.
|
||||
* @returns {Observable<DeviceMotionAccelerationData>} Observable returns an observable that you can subscribe to
|
||||
*/
|
||||
|
||||
@@ -89,7 +89,6 @@ export interface DeviceOrientationCompassOptions {
|
||||
export class DeviceOrientation extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get the current compass heading.
|
||||
*
|
||||
* @returns {Promise<DeviceOrientationCompassHeading>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -101,7 +100,6 @@ export class DeviceOrientation extends AwesomeCordovaNativePlugin {
|
||||
* Get the device current heading at a regular interval
|
||||
*
|
||||
* Stop the watch by unsubscribing from the observable
|
||||
*
|
||||
* @param {DeviceOrientationCompassOptions} [options] Options for compass. Frequency and Filter. Optional
|
||||
* @returns {Observable<DeviceOrientationCompassHeading>} Returns an observable that contains the compass heading
|
||||
*/
|
||||
|
||||
@@ -52,7 +52,6 @@ export interface UpdateOptions {
|
||||
export class DfuUpdate extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Start the Firmware-Update-Process
|
||||
*
|
||||
* @param options - Options for the process
|
||||
* @returns {Observable<any>} Returns a Observable that emits when something happens
|
||||
*/
|
||||
|
||||
@@ -132,7 +132,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
SENSORS: ['BODY_SENSORS'],
|
||||
SMS: ['SEND_SMS', 'RECEIVE_SMS', 'READ_SMS', 'RECEIVE_WAP_PUSH', 'RECEIVE_MMS'],
|
||||
STORAGE: ['READ_EXTERNAL_STORAGE', 'WRITE_EXTERNAL_STORAGE'],
|
||||
NEARBY_DEVICES: ["BLUETOOTH_ADVERTISE", "BLUETOOTH_SCAN", "BLUETOOTH_CONNECT"],
|
||||
NEARBY_DEVICES: ['BLUETOOTH_ADVERTISE', 'BLUETOOTH_SCAN', 'BLUETOOTH_CONNECT'],
|
||||
};
|
||||
|
||||
locationMode = {
|
||||
@@ -164,21 +164,21 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
@CordovaProperty()
|
||||
cpuArchitecture: {
|
||||
MIPS: string;
|
||||
MIPS_64: string;
|
||||
UNKNOWN: string;
|
||||
ARMv6: string;
|
||||
ARMv7: string;
|
||||
ARMv8: string;
|
||||
X86: string;
|
||||
X86_64: string;
|
||||
MIPS: string;
|
||||
MIPS_64: string;
|
||||
UNKNOWN: string;
|
||||
ARMv6: string;
|
||||
ARMv7: string;
|
||||
ARMv8: string;
|
||||
X86: string;
|
||||
X86_64: string;
|
||||
};
|
||||
|
||||
@CordovaProperty()
|
||||
remoteNotificationType: {
|
||||
ALERT: string;
|
||||
SOUND: string;
|
||||
BADGE: string;
|
||||
ALERT: string;
|
||||
SOUND: string;
|
||||
BADGE: string;
|
||||
};
|
||||
|
||||
@CordovaProperty()
|
||||
@@ -206,7 +206,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if app is able to access device location.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -217,7 +216,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if Wifi is connected/enabled. On iOS this returns true if the device is connected to a network by WiFi. On Android and Windows 10 Mobile this returns true if the WiFi setting is set to enabled.
|
||||
* On Android this requires permission. `<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />`
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -228,7 +226,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if the device has a camera. On Android this returns true if the device has a camera. On iOS this returns true if both the device has a camera AND the application is authorized to use it. On Windows 10 Mobile this returns true if both the device has a rear-facing camera AND the
|
||||
* application is authorized to use it.
|
||||
*
|
||||
* @param {boolean} [externalStorage] Android only: If true, checks permission for READ_EXTERNAL_STORAGE in addition to CAMERA run-time permission.
|
||||
* cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true.
|
||||
* @returns {Promise<any>}
|
||||
@@ -241,7 +238,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if the device has Bluetooth capabilities and if so that Bluetooth is switched on (same on Android, iOS and Windows 10 Mobile)
|
||||
* On Android this requires permission <uses-permission android:name="android.permission.BLUETOOTH" />
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -275,7 +271,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns true if the WiFi setting is set to enabled, and is the same as `isWifiAvailable()`
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'Windows 10'] })
|
||||
@@ -286,7 +281,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Enables/disables WiFi on the device.
|
||||
* Requires `ACCESS_WIFI_STATE` and `CHANGE_WIFI_STATE` permissions on Android
|
||||
*
|
||||
* @param {boolean} state
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -298,7 +292,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Enables/disables Bluetooth on the device.
|
||||
* Requires `BLUETOOTH` and `BLUETOOTH_ADMIN` permissions on Android
|
||||
*
|
||||
* @param {boolean} state
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -307,7 +300,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
// ANDROID AND IOS ONLY
|
||||
|
||||
/**
|
||||
@@ -321,7 +313,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns true if the device setting for location is on. On Android this returns true if Location Mode is switched on. On iOS this returns true if Location Services is switched on.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -332,7 +323,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if the application is authorized to use location.
|
||||
* Note for Android: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -342,7 +332,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the location authorization status for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -352,7 +341,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the individual location authorization status for each type of location access (FINE, COARSE and BACKGROUND).
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -360,11 +348,9 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns the location authorization status for the application.
|
||||
* Note for Android: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time.
|
||||
*
|
||||
* @param {string} [mode] location authorization mode: "always" or "when_in_use". If not specified, defaults to "when_in_use". (this.locationAuthorizationMode)
|
||||
* @param {string} [accuracy] requested location accuracy: "full" or "reduced". If not specified, defaults to "full". (this.locationAccuracyAuthorization)
|
||||
* @returns {Promise<any>}
|
||||
@@ -376,7 +362,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if camera hardware is present on device.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -387,7 +372,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if the application is authorized to use the camera.
|
||||
* Note for Android: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return TRUE as permissions are already granted at installation time.
|
||||
*
|
||||
* @param {boolean} [externalStorage] Android only: If true, checks permission for READ_EXTERNAL_STORAGE in addition to CAMERA run-time permission.
|
||||
* cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true.
|
||||
* @returns {Promise<any>}
|
||||
@@ -399,7 +383,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the camera authorization status for the application.
|
||||
*
|
||||
* @param {boolean} [externalStorage] Android only: If true, checks permission for READ_EXTERNAL_STORAGE in addition to CAMERA run-time permission.
|
||||
* cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true.
|
||||
* @returns {Promise<any>}
|
||||
@@ -411,7 +394,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Requests camera authorization for the application.
|
||||
*
|
||||
* @param {boolean} [externalStorage] Android only: If true, requests permission for READ_EXTERNAL_STORAGE in addition to CAMERA run-time permission.
|
||||
* cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true.
|
||||
* @returns {Promise<any>}
|
||||
@@ -423,7 +405,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the application is authorized to use the microphone.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -433,7 +414,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the microphone authorization status for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -443,7 +423,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Requests microphone authorization for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -453,7 +432,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the application is authorized to use contacts (address book).
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -463,7 +441,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the contacts authorization status for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -473,7 +450,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Requests contacts authorization for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -485,11 +461,10 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Checks if the application is authorized to use the calendar.
|
||||
*
|
||||
* Notes for Android:
|
||||
* - This is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return TRUE as permissions are already granted at installation time.
|
||||
* - This is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return TRUE as permissions are already granted at installation time.
|
||||
*
|
||||
* Notes for iOS:
|
||||
* - This relates to Calendar Events (not Calendar Reminders)
|
||||
*
|
||||
* - This relates to Calendar Events (not Calendar Reminders)
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -501,11 +476,10 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Returns the calendar authorization status for the application.
|
||||
*
|
||||
* Notes for Android:
|
||||
* - This is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return `GRANTED` status as permissions are already granted at installation time.
|
||||
* - This is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return `GRANTED` status as permissions are already granted at installation time.
|
||||
*
|
||||
* Notes for iOS:
|
||||
* - This relates to Calendar Events (not Calendar Reminders)
|
||||
*
|
||||
* - This relates to Calendar Events (not Calendar Reminders)
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -517,14 +491,13 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Requests calendar authorization for the application.
|
||||
*
|
||||
* Notes for iOS:
|
||||
* - Should only be called if authorization status is NOT_DETERMINED. Calling it when in any other state will have no effect and just return the current authorization status.
|
||||
* - This relates to Calendar Events (not Calendar Reminders)
|
||||
* - Should only be called if authorization status is NOT_DETERMINED. Calling it when in any other state will have no effect and just return the current authorization status.
|
||||
* - This relates to Calendar Events (not Calendar Reminders)
|
||||
*
|
||||
* Notes for Android:
|
||||
* - This is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will have no effect as the permissions are already granted at installation time.
|
||||
* - This requests permission for `READ_CALENDAR` run-time permission
|
||||
* - Required permissions must be added to `AndroidManifest.xml` as appropriate - see Android permissions: `READ_CALENDAR`, `WRITE_CALENDAR`
|
||||
*
|
||||
* - This is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will have no effect as the permissions are already granted at installation time.
|
||||
* - This requests permission for `READ_CALENDAR` run-time permission
|
||||
* - Required permissions must be added to `AndroidManifest.xml` as appropriate - see Android permissions: `READ_CALENDAR`, `WRITE_CALENDAR`
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -536,7 +509,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Opens settings page for this app.
|
||||
* On Android, this opens the "App Info" page in the Settings app.
|
||||
* On iOS, this opens the app settings page in the Settings app. This works only on iOS 8+ - iOS 7 and below will invoke the errorCallback.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -546,7 +518,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the state of Bluetooth on the device.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
@@ -556,7 +527,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Registers a function to be called when a change in Bluetooth state occurs.
|
||||
*
|
||||
* @param {Function} handler
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'], sync: true })
|
||||
@@ -564,7 +534,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Registers a function to be called when a change in Location state occurs.
|
||||
*
|
||||
* @param {Function} handler
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'], sync: true })
|
||||
@@ -572,23 +541,21 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns CPU architecture of the current device.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
getArchitecture(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current battery level of the device as a percentage.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
getCurrentBatteryLevel(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// ANDROID ONLY
|
||||
|
||||
@@ -597,7 +564,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* By default, a "warm" restart will be performed in which the main Cordova activity is immediately restarted, causing the Webview instance to be recreated.
|
||||
* However, if the `cold` parameter is set to true, then the application will be "cold" restarted, meaning a system exit will be performed, causing the entire application to be restarted.
|
||||
* This is useful if you want to fully reset the native application state but will cause the application to briefly disappear and re-appear..
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'], callbackOrder: 'reverse' })
|
||||
@@ -605,11 +571,9 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Checks if high-accuracy locations are available to the app from GPS hardware.
|
||||
* Returns true if Location mode is enabled and is set to "Device only" or "High accuracy" AND if the app is authorized to use location.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -619,10 +583,9 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if location mode is set to return high-accuracy locations from GPS hardware.
|
||||
* Returns true if Location mode is enabled and is set to either:
|
||||
* - Device only = GPS hardware only (high accuracy)
|
||||
* - High accuracy = GPS hardware, network triangulation and Wifi network IDs (high and low accuracy)
|
||||
*
|
||||
* Returns true if Location mode is enabled and is set to either:
|
||||
* - Device only = GPS hardware only (high accuracy)
|
||||
* - High accuracy = GPS hardware, network triangulation and Wifi network IDs (high and low accuracy)
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -633,7 +596,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if low-accuracy locations are available to the app from network triangulation/WiFi access points.
|
||||
* Returns true if Location mode is enabled and is set to "Battery saving" or "High accuracy" AND if the app is authorized to use location.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -644,9 +606,8 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if location mode is set to return low-accuracy locations from network triangulation/WiFi access points.
|
||||
* Returns true if Location mode is enabled and is set to either:
|
||||
* - Battery saving = network triangulation and Wifi network IDs (low accuracy)
|
||||
* - High accuracy = GPS hardware, network triangulation and Wifi network IDs (high and low accuracy)
|
||||
*
|
||||
* - Battery saving = network triangulation and Wifi network IDs (low accuracy)
|
||||
* - High accuracy = GPS hardware, network triangulation and Wifi network IDs (high and low accuracy)
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -656,7 +617,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if airplane mode is enabled on device.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -664,9 +624,8 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
/**
|
||||
* Checks if mobile data is enabled on device.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -676,7 +635,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the current location mode setting for the device.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -686,7 +644,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns details of the OS of the device on which the app is currently running
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -696,7 +653,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns details of the SDK levels used to build the app.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -707,7 +663,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Returns the current authorization status for a given permission.
|
||||
* Note: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time.
|
||||
*
|
||||
* @param permission
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -719,7 +674,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Returns the current authorization status for multiple permissions.
|
||||
* Note: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time.
|
||||
*
|
||||
* @param {any[]} permissions
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -731,7 +685,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Requests app to be granted authorization for a runtime permission.
|
||||
* Note: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will have no effect as the permissions are already granted at installation time.
|
||||
*
|
||||
* @param permission
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -743,7 +696,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Requests app to be granted authorization for multiple runtime permissions.
|
||||
* Note: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time.
|
||||
*
|
||||
* @param {any[]} permissions
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -757,7 +709,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Note that only one request can be made concurrently because the native API cannot handle concurrent requests,
|
||||
* so the plugin will invoke the error callback if attempting to make more than one simultaneous request.
|
||||
* Multiple permission requests should be grouped into a single call since the native API is setup to handle batch requests of multiple permission groups.
|
||||
*
|
||||
* @returns {boolean}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -768,7 +719,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Registers a function to be called when a runtime permission request has completed.
|
||||
* Pass in a falsy value to de-register the currently registered function.
|
||||
*
|
||||
* @param {Function} handler
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -779,7 +729,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if the device setting for Bluetooth is switched on.
|
||||
* This requires `BLUETOOTH` permission on Android
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -789,7 +738,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the device has Bluetooth capabilities.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -799,7 +747,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the device has Bluetooth Low Energy (LE) capabilities.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -809,7 +756,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the device supports Bluetooth Low Energy (LE) Peripheral mode.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -819,18 +765,16 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the Bluetooth authorization status of the application on the device.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android', 'iOS'] })
|
||||
getBluetoothAuthorizationStatus(): Promise<any> {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns the individual authorization status for each Bluetooth run-time permission on Android 12+ / API 31+
|
||||
* On Android 11 / API 30 and below, all will be returned as GRANTED if the manifest has BLUETOOTH since they are implicitly granted at build-time.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -840,7 +784,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the application is authorized to use external storage.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -850,7 +793,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* CReturns the external storage authorization status for the application.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -860,7 +802,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Requests external storage authorization for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -875,7 +816,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* This differs from the "external directories" returned by cordova-plugin-file which return mount points relating to non-removable (internal) storage.
|
||||
*
|
||||
* Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#getexternalsdcarddetails)
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -903,7 +843,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if NFC hardware is present on device.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -914,7 +853,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if the device setting for NFC is switched on.
|
||||
* Note: this operation does not require NFC permission in the manifest.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -925,7 +863,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if NFC is available to the app. Returns true if the device has NFC capabilities AND if NFC setting is switched on.
|
||||
* Note: this operation does not require NFC permission in the manifest.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -935,7 +872,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Registers a function to be called when a change in NFC state occurs. Pass in a falsy value to de-register the currently registered function.
|
||||
*
|
||||
* @param {Function} hander callback function to be called when NFC state changes
|
||||
* @param handler
|
||||
* @returns {Promise<any>}
|
||||
@@ -948,7 +884,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the device data roaming setting is enabled.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -958,7 +893,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the device setting for ADB(debug) is switched on.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -968,7 +902,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the device is rooted.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['Android'] })
|
||||
@@ -980,14 +913,12 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the application is authorized to use the Camera Roll in Photos app.
|
||||
*
|
||||
* @param accessLevel - (optional) On iOS 14+, specifies the level of access to the photo library to query as a constant in cordova.plugins.diagnostic.photoLibraryAccessLevel`
|
||||
* Possible values are:
|
||||
* ADD_ONLY - can add to but not read from Photo Library
|
||||
* READ_WRITE - can both add to and read from Photo Library
|
||||
* Defaults to ADD_ONLY if not specified
|
||||
* Has no effect on iOS 13 or below
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'], callbackOrder: 'reverse' })
|
||||
@@ -997,14 +928,12 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the authorization status for the application to use the Camera Roll in Photos app.
|
||||
*
|
||||
* @param accessLevel - (optional) On iOS 14+, specifies the level of access to the photo library to query as a constant in cordova.plugins.diagnostic.photoLibraryAccessLevel`
|
||||
* Possible values are:
|
||||
* ADD_ONLY - can add to but not read from Photo Library
|
||||
* READ_WRITE - can both add to and read from Photo Library
|
||||
* Defaults to ADD_ONLY if not specified
|
||||
* Has no effect on iOS 13 or below
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'], callbackOrder: 'reverse' })
|
||||
@@ -1016,14 +945,12 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Requests camera roll authorization for the application.
|
||||
* Should only be called if authorization status is NOT_REQUESTED.
|
||||
* Calling it when in any other state will have no effect.
|
||||
*
|
||||
* @param accessLevel - (optional) On iOS 14+, specifies the level of access to the photo library to query as a constant in cordova.plugins.diagnostic.photoLibraryAccessLevel`
|
||||
* Possible values are:
|
||||
* ADD_ONLY - can add to but not read from Photo Library
|
||||
* READ_WRITE - can both add to and read from Photo Library
|
||||
* Defaults to ADD_ONLY if not specified
|
||||
* Has no effect on iOS 13 or below
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'], callbackOrder: 'reverse' })
|
||||
@@ -1031,9 +958,8 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
/**
|
||||
* Presents limited library picker UI on iOS 14+
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1043,7 +969,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if remote (push) notifications are enabled.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS', 'Android'] })
|
||||
@@ -1053,7 +978,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Indicates if the app is registered for remote (push) notifications on the device.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1064,7 +988,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Returns the authorization status for the application to use Remote Notifications.
|
||||
* Note: Works on iOS 10+ only (iOS 9 and below will invoke the error callback).
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1074,7 +997,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Requests reminders authorization for the application.
|
||||
*
|
||||
* @param types
|
||||
* @param omitRegistration
|
||||
* @returns {Promise<any>}
|
||||
@@ -1087,7 +1009,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1097,7 +1018,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the application is authorized to use reminders.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1107,7 +1027,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the reminders authorization status for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1117,7 +1036,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Requests reminders authorization for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1127,7 +1045,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if the application is authorized for background refresh.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1137,7 +1054,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the background refresh authorization status for the application.
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1149,7 +1065,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Requests Bluetooth authorization for the application.
|
||||
*
|
||||
* Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#requestbluetoothauthorization)
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1159,7 +1074,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Checks if motion tracking is available on the current device.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1171,7 +1085,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Checks if it's possible to determine the outcome of a motion authorization request on the current device.
|
||||
* There's no direct way to determine if authorization was granted or denied, so the Pedometer API must be used to indirectly determine this:
|
||||
* therefore, if the device supports motion tracking but not Pedometer Event Tracking, the outcome of requesting motion detection cannot be determined.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1183,7 +1096,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Requests motion tracking authorization for the application.
|
||||
*
|
||||
* Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#requestmotionauthorization)
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1195,7 +1107,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Checks motion authorization status for the application.
|
||||
*
|
||||
* Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#getmotionauthorizationstatus)
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'] })
|
||||
@@ -1207,7 +1118,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Returns the location accuracy authorization for the application on iOS 14+ and Android 12+. Note: calling on iOS <14 or Android <12 will always return cordova.plugins.diagnostic.locationAccuracyAuthorization.FULL
|
||||
*
|
||||
* Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#getlocationaccuracyauthorization)
|
||||
*
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS', 'Android'] })
|
||||
@@ -1219,7 +1129,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Requests temporary access to full location accuracy for the application on iOS 14+.
|
||||
*
|
||||
* Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#requesttemporaryfullaccuracyauthorization)
|
||||
*
|
||||
* @param purpose
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
@@ -1232,7 +1141,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
|
||||
* Registers a function to be called when a change in location accuracy authorization occurs on iOS 14+.
|
||||
*
|
||||
* Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#registerLocationAccuracyAuthorizationChangeHandler)
|
||||
*
|
||||
* @param handler
|
||||
*/
|
||||
@Cordova({ platforms: ['iOS'], sync: true })
|
||||
|
||||
@@ -48,7 +48,6 @@ export interface DialogsPromptCallback {
|
||||
export class Dialogs extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Shows a custom alert or dialog box.
|
||||
*
|
||||
* @param {string} message Dialog message.
|
||||
* @param {string} [title] Dialog title. (Optional, defaults to Alert)
|
||||
* @param {string} [buttonName] Button name. (Optional, defaults to OK)
|
||||
@@ -64,7 +63,6 @@ export class Dialogs extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Displays a customizable confirmation dialog box.
|
||||
*
|
||||
* @param {string} message Dialog message.
|
||||
* @param {string} [title] Dialog title. (Optional, defaults to Confirm)
|
||||
* @param {string[]} [buttonLabels] Array of strings specifying button labels. (Optional, defaults to [OK,Cancel])
|
||||
@@ -80,7 +78,6 @@ export class Dialogs extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Displays a native dialog box that is more customizable than the browser's prompt function.
|
||||
*
|
||||
* @param {string} [message] Dialog message.
|
||||
* @param {string} [title] Dialog title. (Optional, defaults to Prompt)
|
||||
* @param {string[]} [buttonLabels] Array of strings specifying button labels. (Optional, defaults to ["OK","Cancel"])
|
||||
@@ -102,7 +99,6 @@ export class Dialogs extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* The device plays a beep sound.
|
||||
*
|
||||
* @param {numbers} times The number of times to repeat the beep.
|
||||
*/
|
||||
@Cordova({
|
||||
|
||||
@@ -31,7 +31,6 @@ import { Injectable } from '@angular/core';
|
||||
export class DNS extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Resolve hostnames into an underlying network address.
|
||||
*
|
||||
* @param hostname
|
||||
* @returns {Promise<string>} Returns a promise that resolves with the resolution.
|
||||
*/
|
||||
|
||||
@@ -32,7 +32,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class DocumentPicker extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Open a file
|
||||
*
|
||||
* @param {string} [option] files between 'image', 'pdf' or 'all'
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
|
||||
@@ -79,7 +79,6 @@ export interface DocumentScannerOptions {
|
||||
export class DocumentScanner extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Scan a document
|
||||
*
|
||||
* @param opts {DocumentScannerOptions} optional parameter for controlling scanning
|
||||
* @returns {Promise<string>} file URL of scanned document image
|
||||
*/
|
||||
|
||||
@@ -62,7 +62,6 @@ export interface DocumentViewerOptions {
|
||||
export class DocumentViewer extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Displays the email composer pre-filled with data.
|
||||
*
|
||||
* @returns {Promise<any>} Resolves promise when the EmailComposer has been opened
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -72,7 +71,6 @@ export class DocumentViewer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if the document can be shown
|
||||
*
|
||||
* @param url {string} Url to the file
|
||||
* @param contentType {string} Content type of the file
|
||||
* @param options {DocumentViewerOptions} options
|
||||
@@ -94,7 +92,6 @@ export class DocumentViewer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Opens the file
|
||||
*
|
||||
* @param url {string} Url to the file
|
||||
* @param contentType {string} Content type of the file
|
||||
* @param options {DocumentViewerOptions} options
|
||||
|
||||
@@ -5,7 +5,7 @@ export enum NotificationVisibility {
|
||||
Visible = 0,
|
||||
VisibleNotifyCompleted = 1,
|
||||
VisibilityHidden = 2,
|
||||
VisibleNotifyOnlyCompletion = 3
|
||||
VisibleNotifyOnlyCompletion = 3,
|
||||
}
|
||||
|
||||
export interface DownloadHttpHeader {
|
||||
|
||||
@@ -54,7 +54,6 @@ export enum EnumResolution {
|
||||
* @name dynamsoft-barcode-scanner
|
||||
* @description
|
||||
* This plugin scans barcodes using Dynamsoft Barcode Reader
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { dynamsoft-barcode-scanner } from '@awesome-cordova-plugins/dynamsoft-barcode-scanner';
|
||||
|
||||
@@ -131,7 +131,6 @@ export interface EmailComposerOptions {
|
||||
export class EmailComposer extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Checks if the app has a permission to access email accounts information
|
||||
*
|
||||
* @returns {Promise<boolean>} returns a promise that resolves with a boolean that indicates if the permission was granted
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -144,7 +143,6 @@ export class EmailComposer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Request permission to access email accounts information
|
||||
*
|
||||
* @returns {Promise<boolean>} returns a promise that resolves with a boolean that indicates if the permission was granted
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -157,7 +155,6 @@ export class EmailComposer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Verifies if an email account is configured on the device.
|
||||
*
|
||||
* @returns {Promise<any>} Resolves if available, rejects if not available
|
||||
*/
|
||||
@CordovaCheck()
|
||||
@@ -175,7 +172,6 @@ export class EmailComposer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -201,7 +197,6 @@ export class EmailComposer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns an array of email clients installed on the device.
|
||||
*
|
||||
* @returns {Promise<string[]>} Resolves if available, rejects if not available
|
||||
*/
|
||||
@CordovaCheck()
|
||||
@@ -219,7 +214,6 @@ export class EmailComposer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Verifies if sending emails is supported on the device.
|
||||
*
|
||||
* @param {string} [app] App id or uri scheme.
|
||||
* @returns {Promise<any>} Resolves if available, rejects if not available
|
||||
*/
|
||||
@@ -234,7 +228,6 @@ export class EmailComposer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Displays the email composer pre-filled with data.
|
||||
*
|
||||
* @param {EmailComposerOptions} options Email
|
||||
* @param {any} [scope] Scope for the promise
|
||||
* @returns {Promise<any>} Resolves promise when the EmailComposer has been opened
|
||||
@@ -249,7 +242,6 @@ export class EmailComposer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Adds a new mail app alias.
|
||||
*
|
||||
* @param {string} alias The alias name
|
||||
* @param {string} packageName The package name
|
||||
*/
|
||||
|
||||
@@ -44,7 +44,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Add logging that will be sent with your crash data. This logging will not show up
|
||||
* in the system.log and will only be visible in your Crashlytics dashboard.
|
||||
*
|
||||
* @param message {string}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -62,7 +61,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Used to log a non-fatal error message (Android only).
|
||||
*
|
||||
* @param message
|
||||
* @param stacktrace
|
||||
*/
|
||||
@@ -73,7 +71,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Used to record a non-fatal error message (iOS only).
|
||||
*
|
||||
* @param message
|
||||
* @param code
|
||||
*/
|
||||
@@ -84,7 +81,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the user's identifier for logging to Crashlytics backend.
|
||||
*
|
||||
* @param userId
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -94,7 +90,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the user's name for logging to Crashlytics backend.
|
||||
*
|
||||
* @param userName
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -104,7 +99,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets the user's email address for logging to Crashlytics backend.
|
||||
*
|
||||
* @param email
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -114,7 +108,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets a custom key/value pair for logging to Crashlytics backend.
|
||||
*
|
||||
* @param value
|
||||
* @param key
|
||||
*/
|
||||
@@ -125,7 +118,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets a custom key/value pair for logging to Crashlytics backend.
|
||||
*
|
||||
* @param value
|
||||
* @param key
|
||||
*/
|
||||
@@ -136,7 +128,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets a custom key/value pair for logging to Crashlytics backend.
|
||||
*
|
||||
* @param value
|
||||
* @param key
|
||||
*/
|
||||
@@ -147,7 +138,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets a custom key/value pair for logging to Crashlytics backend.
|
||||
*
|
||||
* @param value
|
||||
* @param key
|
||||
*/
|
||||
@@ -194,7 +184,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#purchase
|
||||
*
|
||||
* @param itemPrice The item's amount in the currency specified.
|
||||
* @param currency The ISO4217 currency code.
|
||||
* @param success Was the purchase completed succesfully?
|
||||
@@ -222,7 +211,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#add-to-cart
|
||||
*
|
||||
* @param itemPrice The item's amount in the currency specified.
|
||||
* @param currency The ISO4217 currency code.
|
||||
* @param itemName The human-readable name for the item.
|
||||
@@ -248,7 +236,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#start-checkout
|
||||
*
|
||||
* @param totalPrice The total price of all items in cart in the currency specified.
|
||||
* @param currency The ISO4217 currency code.
|
||||
* @param itemCount The count of items in cart.
|
||||
@@ -263,7 +250,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* Sends the Search tracking event.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#search
|
||||
*
|
||||
* @param query What the user is searching for.
|
||||
* @param attributes Any additional user-defined attributes to be logged.
|
||||
*/
|
||||
@@ -278,7 +264,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#share
|
||||
*
|
||||
* @param method The method used to share content.
|
||||
* @param contentName The description of the content.
|
||||
* @param contentType The type or genre of content.
|
||||
@@ -302,7 +287,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#rated-content
|
||||
*
|
||||
* @param rating An integer rating of the content.
|
||||
* @param contentName The human-readable name of content.
|
||||
* @param contentType The category your item falls under.
|
||||
@@ -326,7 +310,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#sign-up
|
||||
*
|
||||
* @param method An optional description of the sign up method (Twitter, Facebook, etc.); defaults to "Direct".
|
||||
* @param success An optional flag that indicates sign up success; defaults to true.
|
||||
* @param attributes Any additional user-defined attributes to be logged.
|
||||
@@ -342,7 +325,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#log-in
|
||||
*
|
||||
* @param method An optional description of the sign in method (Twitter, Facebook, etc.); defaults to "Direct".
|
||||
* @param success An optional flag that indicates sign in success; defaults to true.
|
||||
* @param attributes Any additional user-defined attributes to be logged.
|
||||
@@ -358,7 +340,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#invite
|
||||
*
|
||||
* @param method An optional description of the sign in method (Twitter, Facebook, etc.); defaults to "Direct".
|
||||
* @param attributes Any additional user-defined attributes to be logged.
|
||||
*/
|
||||
@@ -373,7 +354,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#level-start
|
||||
*
|
||||
* @param levelName String key describing the level.
|
||||
* @param attributes Any additional user-defined attributes to be logged.
|
||||
*/
|
||||
@@ -388,7 +368,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* All parameters are optional.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#level-end
|
||||
*
|
||||
* @param levelName String key describing the level.
|
||||
* @param score The score for this level.
|
||||
* @param success Completed the level or failed trying.
|
||||
@@ -403,7 +382,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* Send the Content View tracking event.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#content-view
|
||||
*
|
||||
* @param name
|
||||
* @param type
|
||||
* @param id
|
||||
@@ -416,7 +394,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Shortcut for sendContentView(...) using type of "Screen".
|
||||
*
|
||||
* @param name
|
||||
* @param id
|
||||
* @param attributes
|
||||
@@ -430,7 +407,6 @@ export class Answers extends AwesomeCordovaNativePlugin {
|
||||
* Send a custom tracking event with the given name.
|
||||
*
|
||||
* https://docs.fabric.io/android/answers/answers-events.html#custom-event
|
||||
*
|
||||
* @param name
|
||||
* @param attributes
|
||||
*/
|
||||
|
||||
@@ -160,7 +160,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the current application ID
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the current application ID
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -170,7 +169,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the application ID
|
||||
*
|
||||
* @param {string} id application ID
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -180,7 +178,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the current application name
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the current application name
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -190,7 +187,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the application name
|
||||
*
|
||||
* @param {string} name application name
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -203,17 +199,16 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* ```typescript
|
||||
* {
|
||||
* status: 'connected',
|
||||
* authResponse: {
|
||||
* accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* data_access_expiration_time: '1623680244',
|
||||
* expiresIn: 5183979,
|
||||
* userID: '634565435'
|
||||
* }
|
||||
* status: 'connected',
|
||||
* authResponse: {
|
||||
* accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* data_access_expiration_time: '1623680244',
|
||||
* expiresIn: 5183979,
|
||||
* userID: '634565435'
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) this app has upon logging in.
|
||||
* @returns {Promise<FacebookLoginResponse>} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.
|
||||
*/
|
||||
@@ -227,16 +222,15 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* ```typescript
|
||||
* {
|
||||
* status: 'connected',
|
||||
* authResponse: {
|
||||
* authenticationToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* nonce: 'foo',
|
||||
* userID: '634565435'
|
||||
* }
|
||||
* status: 'connected',
|
||||
* authResponse: {
|
||||
* authenticationToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* nonce: 'foo',
|
||||
* userID: '634565435'
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/limited-login/permissions) this app has upon logging in.
|
||||
* @param {string} nonce Nonce to create the configuration with.
|
||||
* @returns {Promise<FacebookLimitedLoginResponse>} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.
|
||||
@@ -248,7 +242,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if the user has approved all necessary permissions
|
||||
*
|
||||
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) to check for
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with a success string if all passed permissions are granted, or an error string if any permissions are not granted
|
||||
*/
|
||||
@@ -259,7 +252,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if data access has expired for the user
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with a success string if data access is expired, or rejects with an error
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -269,7 +261,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reauthorize data access after it has expired
|
||||
*
|
||||
* @returns {Promise<FacebookLoginResponse>} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -281,7 +272,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
* Logout of Facebook.
|
||||
*
|
||||
* For more info see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.logout)
|
||||
*
|
||||
* @returns {Promise<any>} Returns a Promise that resolves on a successful logout, and rejects if logout fails.
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -300,18 +290,17 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* ```
|
||||
* {
|
||||
* authResponse: {
|
||||
* userID: '12345678912345',
|
||||
* accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* data_access_expiration_time: '1623680244',
|
||||
* expiresIn: '5183738'
|
||||
* },
|
||||
* status: 'connected'
|
||||
* authResponse: {
|
||||
* userID: '12345678912345',
|
||||
* accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* data_access_expiration_time: '1623680244',
|
||||
* expiresIn: '5183738'
|
||||
* },
|
||||
* status: 'connected'
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* For more information see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.getLoginStatus)
|
||||
*
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with a status, or rejects with an error
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -321,7 +310,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get a Facebook access token for using Facebook services.
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with an access token, or rejects with an error
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -331,7 +319,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get profile information for the currently logged in user
|
||||
*
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with success data, or rejects with an error
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -344,13 +331,12 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* ```
|
||||
* {
|
||||
* method: 'share',
|
||||
* href: 'http://example.com'
|
||||
* method: 'share',
|
||||
* href: 'http://example.com'
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* For more options see the [Cordova plugin docs](https://github.com/cordova-plugin-facebook-connect/cordova-plugin-facebook-connect#show-a-dialog) and the [Facebook docs](https://developers.facebook.com/docs/javascript/reference/FB.ui)
|
||||
*
|
||||
* @param {Object} options The dialog options
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with success data, or rejects with an error
|
||||
*/
|
||||
@@ -364,10 +350,9 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* For more information see:
|
||||
*
|
||||
* Calling the Graph API - https://developers.facebook.com/docs/javascript/reference/FB.api
|
||||
* Graph Explorer - https://developers.facebook.com/tools/explorer
|
||||
* Graph API - https://developers.facebook.com/docs/graph-api
|
||||
*
|
||||
* Calling the Graph API - https://developers.facebook.com/docs/javascript/reference/FB.api
|
||||
* Graph Explorer - https://developers.facebook.com/tools/explorer
|
||||
* Graph API - https://developers.facebook.com/docs/graph-api
|
||||
* @param {string} requestPath Graph API endpoint you want to call
|
||||
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) for this request.
|
||||
* @param {string} httpMethod HTTP method for the request, one of "GET", "POST", or "DELETE" (default is "GET")
|
||||
@@ -380,7 +365,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set Data Processing Options for App events. For more information see [Facebook docs](https://developers.facebook.com/docs/app-events/guides/ccpa)
|
||||
*
|
||||
* @param {string[]} options List of options, i.e. ["LDU"]
|
||||
* @param {number} country The numeric identifier for the country
|
||||
* @param {number} state The numeric identifier for the state
|
||||
@@ -392,7 +376,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set user data for Advanced Matching. For more information see [Facebook docs](https://developers.facebook.com/docs/app-events/advanced-matching/)
|
||||
*
|
||||
* @param {Object} userData An object containing data about the user
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -410,7 +393,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Log an event. For more information see the Events section above.
|
||||
*
|
||||
* @param {string} name Name of the event
|
||||
* @param {Object} [params] An object containing extra data to log with the event
|
||||
* @param {number} [valueToSum] any value to be added to added to a sum on each event
|
||||
@@ -426,7 +408,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable the auto log app event feature - https://developers.facebook.com/docs/app-events/gdpr-compliance/
|
||||
*
|
||||
* @param {boolean} enabled value to be set
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -439,7 +420,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable collection of advertiser-id
|
||||
*
|
||||
* @param {boolean} enabled value to be set
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -449,7 +429,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable advertiser tracking (iOS Only)
|
||||
*
|
||||
* @param {boolean} enabled value to be set
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -459,7 +438,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Log a purchase. For more information see the Events section above.
|
||||
*
|
||||
* @param {number} value Value of the purchase.
|
||||
* @param {string} currency The currency, as an [ISO 4217 currency code](http://en.wikipedia.org/wiki/ISO_4217)
|
||||
* @param {Object} params An object containing extra data to log with the event
|
||||
@@ -472,7 +450,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the deferred app link
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the deep link
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -482,7 +459,6 @@ export class Facebook extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Manually log activation events
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -165,7 +165,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the current application ID
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the current application ID
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -175,7 +174,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the application ID
|
||||
*
|
||||
* @param {string} id application ID
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -185,7 +183,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get the current application name
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the current application name
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -195,7 +192,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set the application name
|
||||
*
|
||||
* @param {string} name application name
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -208,17 +204,16 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* ```typescript
|
||||
* {
|
||||
* status: 'connected',
|
||||
* authResponse: {
|
||||
* accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* data_access_expiration_time: '1623680244',
|
||||
* expiresIn: 5183979,
|
||||
* userID: '634565435'
|
||||
* }
|
||||
* status: 'connected',
|
||||
* authResponse: {
|
||||
* accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* data_access_expiration_time: '1623680244',
|
||||
* expiresIn: 5183979,
|
||||
* userID: '634565435'
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) this app has upon logging in.
|
||||
* @returns {Promise<FbSdkLoginResponse>} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.
|
||||
*/
|
||||
@@ -232,16 +227,15 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* ```typescript
|
||||
* {
|
||||
* status: 'connected',
|
||||
* authResponse: {
|
||||
* authenticationToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* nonce: 'foo',
|
||||
* userID: '634565435'
|
||||
* }
|
||||
* status: 'connected',
|
||||
* authResponse: {
|
||||
* authenticationToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* nonce: 'foo',
|
||||
* userID: '634565435'
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/limited-login/permissions) this app has upon logging in.
|
||||
* @param {string} nonce Nonce to create the configuration with.
|
||||
* @returns {Promise<FbSdkLimitedLoginResponse>} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.
|
||||
@@ -253,7 +247,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if the user has approved all necessary permissions
|
||||
*
|
||||
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) to check for
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with a success string if all passed permissions are granted, or an error string if any permissions are not granted
|
||||
*/
|
||||
@@ -264,7 +257,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if data access has expired for the user
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with a success string if data access is expired, or rejects with an error
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -274,7 +266,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Reauthorize data access after it has expired
|
||||
*
|
||||
* @returns {Promise<FbSdkLoginResponse>} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -286,7 +277,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
* Logout of Facebook.
|
||||
*
|
||||
* For more info see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.logout)
|
||||
*
|
||||
* @returns {Promise<any>} Returns a Promise that resolves on a successful logout, and rejects if logout fails.
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -305,18 +295,17 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* ```
|
||||
* {
|
||||
* authResponse: {
|
||||
* userID: '12345678912345',
|
||||
* accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* data_access_expiration_time: '1623680244',
|
||||
* expiresIn: '5183738'
|
||||
* },
|
||||
* status: 'connected'
|
||||
* authResponse: {
|
||||
* userID: '12345678912345',
|
||||
* accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
|
||||
* data_access_expiration_time: '1623680244',
|
||||
* expiresIn: '5183738'
|
||||
* },
|
||||
* status: 'connected'
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* For more information see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.getLoginStatus)
|
||||
*
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with a status, or rejects with an error
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -326,7 +315,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get a Facebook access token for using Facebook services.
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with an access token, or rejects with an error
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -336,7 +324,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get profile information for the currently logged in user
|
||||
*
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with success data, or rejects with an error
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -349,13 +336,12 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* ```
|
||||
* {
|
||||
* method: 'share',
|
||||
* href: 'http://example.com'
|
||||
* method: 'share',
|
||||
* href: 'http://example.com'
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* For more options see the [Cordova plugin docs](https://github.com/MaximBelov/cordova-plugin-fbsdk#show-a-dialog) and the [Facebook docs](https://developers.facebook.com/docs/javascript/reference/FB.ui)
|
||||
*
|
||||
* @param {Object} options The dialog options
|
||||
* @returns {Promise<any>} Returns a Promise that resolves with success data, or rejects with an error
|
||||
*/
|
||||
@@ -369,10 +355,9 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
*
|
||||
* For more information see:
|
||||
*
|
||||
* Calling the Graph API - https://developers.facebook.com/docs/javascript/reference/FB.api
|
||||
* Graph Explorer - https://developers.facebook.com/tools/explorer
|
||||
* Graph API - https://developers.facebook.com/docs/graph-api
|
||||
*
|
||||
* Calling the Graph API - https://developers.facebook.com/docs/javascript/reference/FB.api
|
||||
* Graph Explorer - https://developers.facebook.com/tools/explorer
|
||||
* Graph API - https://developers.facebook.com/docs/graph-api
|
||||
* @param {string} requestPath Graph API endpoint you want to call
|
||||
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) for this request.
|
||||
* @param {string} httpMethod HTTP method for the request, one of "GET", "POST", or "DELETE" (default is "GET")
|
||||
@@ -385,7 +370,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set Data Processing Options for App events. For more information see [Facebook docs](https://developers.facebook.com/docs/app-events/guides/ccpa)
|
||||
*
|
||||
* @param {string[]} options List of options, i.e. ["LDU"]
|
||||
* @param {number} country The numeric identifier for the country
|
||||
* @param {number} state The numeric identifier for the state
|
||||
@@ -397,7 +381,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set user data for Advanced Matching. For more information see [Facebook docs](https://developers.facebook.com/docs/app-events/advanced-matching/)
|
||||
*
|
||||
* @param {Object} userData An object containing data about the user
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -415,7 +398,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Log an event. For more information see the Events section above.
|
||||
*
|
||||
* @param {string} name Name of the event
|
||||
* @param {Object} [params] An object containing extra data to log with the event
|
||||
* @param {number} [valueToSum] any value to be added to added to a sum on each event
|
||||
@@ -431,7 +413,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable the auto log app event feature - https://developers.facebook.com/docs/app-events/gdpr-compliance/
|
||||
*
|
||||
* @param {boolean} enabled value to be set
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -444,7 +425,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable collection of advertiser-id
|
||||
*
|
||||
* @param {boolean} enabled value to be set
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -454,7 +434,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Enable or disable advertiser tracking (iOS Only)
|
||||
*
|
||||
* @param {boolean} enabled value to be set
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -464,7 +443,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Log a purchase. For more information see the Events section above.
|
||||
*
|
||||
* @param {number} value Value of the purchase.
|
||||
* @param {string} currency The currency, as an [ISO 4217 currency code](http://en.wikipedia.org/wiki/ISO_4217)
|
||||
* @param {Object} params An object containing extra data to log with the event
|
||||
@@ -477,7 +455,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns the deferred app link
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the deep link
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -487,7 +464,6 @@ export class FbSdk extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Manually log activation events
|
||||
*
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
|
||||
@@ -128,7 +128,6 @@ export interface IChannelConfiguration {
|
||||
export class FCM extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Gets ios device's current APNS token
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the APNS token
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -138,7 +137,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Gets device's current registration id
|
||||
*
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the registration id token
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -148,7 +146,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Event firing on the token refresh
|
||||
*
|
||||
* @returns {Observable<string>} Returns an Observable that notifies with the change of device's registration id
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -160,7 +157,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Subscribes you to a [topic](https://firebase.google.com/docs/notifications/android/console-topics)
|
||||
*
|
||||
* @param {string} topic Topic to be subscribed to
|
||||
* @returns {Promise<any>} Returns a promise resolving in result of subscribing to a topic
|
||||
*/
|
||||
@@ -171,7 +167,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Unsubscribes you from a [topic](https://firebase.google.com/docs/notifications/android/console-topics)
|
||||
*
|
||||
* @param {string} topic Topic to be unsubscribed from
|
||||
* @returns {Promise<any>} Returns a promise resolving in result of unsubscribing from a topic
|
||||
*/
|
||||
@@ -182,7 +177,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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
|
||||
@@ -195,7 +189,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Watch for incoming notifications
|
||||
*
|
||||
* @returns {Observable<any>} returns an object with data from the notification
|
||||
*/
|
||||
@Cordova({
|
||||
@@ -209,7 +202,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Removes existing push notifications from the notifications center
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
@Cordova()
|
||||
@@ -219,7 +211,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -234,7 +225,6 @@ export class FCM extends AwesomeCordovaNativePlugin {
|
||||
* 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>}
|
||||
*/
|
||||
|
||||
@@ -20,7 +20,6 @@ export interface VideoInformation {
|
||||
* @name FFMpeg
|
||||
* @description
|
||||
* Simple plugin that binds mobile ffmpeg to execute ffmpeg commands
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { FFMpeg } from '@awesome-cordova-plugins/ffmpeg/ngx';
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
/* eslint-disable jsdoc/require-returns-check */
|
||||
/* eslint-disable jsdoc/check-tag-names */
|
||||
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-plugins/core';
|
||||
@@ -36,7 +35,6 @@ export class FileChooser extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Launches a chooser dialog. The filter param allows filtering a the mime type
|
||||
* { "mime": "application/pdf" }
|
||||
*
|
||||
* @param {string} [filter] Filter allowing filter by a mime type (text/plain, image/png, image/jpeg, audio/wav etc.)
|
||||
* @returns {Promise<string>} URI of the selected file
|
||||
*/
|
||||
|
||||
@@ -32,7 +32,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl
|
||||
export class FileMD5 extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Get MD5 checksum from a file
|
||||
*
|
||||
* @param fileEntry {FileEntry} File entry is a org.apache.cordova.file.FileEntry
|
||||
* @returns {Promise<any>} Promise with md5sum
|
||||
*/
|
||||
|
||||
@@ -34,7 +34,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class FileOpener extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Open an file
|
||||
*
|
||||
* @param {string} filePath File Path
|
||||
* @param {string} fileMIMEType File MIME Type
|
||||
* @returns {Promise<any>}
|
||||
@@ -50,7 +49,6 @@ export class FileOpener extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Uninstalls a package
|
||||
*
|
||||
* @param {string} packageId Package ID
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -65,7 +63,6 @@ export class FileOpener extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if an app is already installed
|
||||
*
|
||||
* @param {string} packageId Package ID
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -80,7 +77,6 @@ export class FileOpener extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* 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>}
|
||||
|
||||
@@ -34,7 +34,6 @@ declare const window: any;
|
||||
export class FilePath extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Resolve native path for given content URL/path.
|
||||
*
|
||||
* @param {string} path Content URL/path.
|
||||
* @returns {Promise<string>}
|
||||
*/
|
||||
|
||||
@@ -179,12 +179,11 @@ export class FileTransfer extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Error code rejected from upload with FileTransferError
|
||||
* Defined in FileTransferError.
|
||||
* FILE_NOT_FOUND_ERR: 1 Return when file was not found
|
||||
* INVALID_URL_ERR: 2, Return when url was invalid
|
||||
* CONNECTION_ERR: 3, Return on connection error
|
||||
* ABORT_ERR: 4, Return on aborting
|
||||
* NOT_MODIFIED_ERR: 5 Return on '304 Not Modified' HTTP response
|
||||
*
|
||||
* FILE_NOT_FOUND_ERR: 1 Return when file was not found
|
||||
* INVALID_URL_ERR: 2, Return when url was invalid
|
||||
* CONNECTION_ERR: 3, Return on connection error
|
||||
* ABORT_ERR: 4, Return on aborting
|
||||
* NOT_MODIFIED_ERR: 5 Return on '304 Not Modified' HTTP response
|
||||
* @enum {number}
|
||||
*/
|
||||
FileTransferErrorCode = {
|
||||
@@ -197,7 +196,6 @@ export class FileTransfer extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Creates a new FileTransfer object
|
||||
*
|
||||
* @returns {FileTransferObject}
|
||||
*/
|
||||
create(): FileTransferObject {
|
||||
@@ -223,7 +221,6 @@ export class FileTransferObject {
|
||||
|
||||
/**
|
||||
* Sends a file to a server.
|
||||
*
|
||||
* @param {string} fileUrl Filesystem URL representing the file on the device or a data URI. For backwards compatibility, this can also be the full path of the file on the device.
|
||||
* @param {string} url URL of the server to receive the file, as encoded by encodeURI().
|
||||
* @param {FileUploadOptions} [options] Optional parameters.
|
||||
@@ -245,7 +242,6 @@ export class FileTransferObject {
|
||||
|
||||
/**
|
||||
* Downloads a file from server.
|
||||
*
|
||||
* @param {string} source URL of the server to download the file, as encoded by encodeURI().
|
||||
* @param {string} target Filesystem url representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device.
|
||||
* @param {boolean} [trustAllHosts] Optional parameter, defaults to false. If set to true, it accepts all security certificates. This is useful because Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS.
|
||||
@@ -262,7 +258,6 @@ export class FileTransferObject {
|
||||
|
||||
/**
|
||||
* Registers a listener that gets called whenever a new chunk of data is transferred.
|
||||
*
|
||||
* @param {Function} listener Listener that takes a progress event.
|
||||
*/
|
||||
@InstanceCheck({ sync: true })
|
||||
|
||||
@@ -36,7 +36,6 @@ export interface IFile extends Blob {
|
||||
* Returns a "slice" of the file. Since Cordova Files don't contain the actual
|
||||
* content, this really returns a File with adjusted start and end.
|
||||
* Slices of slices are supported.
|
||||
*
|
||||
* @param start {Number} The index at which to start the slice (inclusive).
|
||||
* @param end {Number} The index at which to end the slice (exclusive).
|
||||
*/
|
||||
@@ -56,7 +55,6 @@ export interface LocalFileSystem {
|
||||
|
||||
/**
|
||||
* Requests a filesystem in which to store application data.
|
||||
*
|
||||
* @param type Whether the filesystem requested should be persistent, as defined above. Use one of TEMPORARY or
|
||||
* PERSISTENT.
|
||||
* @param size This is an indicator of how much storage space, in bytes, the application expects to need.
|
||||
@@ -73,7 +71,6 @@ 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 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
|
||||
@@ -95,14 +92,12 @@ export interface LocalFileSystem {
|
||||
export interface Metadata {
|
||||
/**
|
||||
* This is the time at which the file or directory was last modified.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
modificationTime: Date;
|
||||
|
||||
/**
|
||||
* The size of the file, in bytes. This must return 0 for directories.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
size: number;
|
||||
@@ -128,14 +123,12 @@ export interface FileSystem {
|
||||
/**
|
||||
* This is the name of the file system. The specifics of naming filesystems is unspecified, but a name must be unique
|
||||
* across the list of exposed file systems.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
name: string;
|
||||
|
||||
/**
|
||||
* The root directory of the file system.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
root: DirectoryEntry;
|
||||
@@ -158,7 +151,6 @@ export interface Entry {
|
||||
|
||||
/**
|
||||
* Look up metadata about this entry.
|
||||
*
|
||||
* @param successCallback A callback that is called with the time of the last modification.
|
||||
* @param errorCallback ErrorCallback A callback that is called when errors happen.
|
||||
*/
|
||||
@@ -166,7 +158,6 @@ export interface Entry {
|
||||
|
||||
/**
|
||||
* Set the metadata of the entry.
|
||||
*
|
||||
* @param successCallback {Function} is called with a Metadata object
|
||||
* @param errorCallback {Function} is called with a FileError
|
||||
* @param metadataObject {Metadata} keys and values to set
|
||||
@@ -242,7 +233,6 @@ export interface Entry {
|
||||
|
||||
/**
|
||||
* Return a URL that can be passed across the bridge to identify this entry.
|
||||
*
|
||||
* @returns string URL that can be passed across the bridge to identify this entry
|
||||
*/
|
||||
toInternalURL(): string;
|
||||
@@ -250,7 +240,6 @@ export interface Entry {
|
||||
/**
|
||||
* Deletes a file or directory. It is an error to attempt to delete a directory that is not empty. It is an error to
|
||||
* attempt to delete the root directory of a filesystem.
|
||||
*
|
||||
* @param successCallback A callback that is called on success.
|
||||
* @param errorCallback A callback that is called when errors happen.
|
||||
*/
|
||||
@@ -259,7 +248,6 @@ export interface Entry {
|
||||
/**
|
||||
* Look up the parent DirectoryEntry containing this Entry. If this Entry is the root of its filesystem, its parent
|
||||
* is itself.
|
||||
*
|
||||
* @param successCallback A callback that is called to return the parent Entry.
|
||||
* @param errorCallback A callback that is called when errors happen.
|
||||
*/
|
||||
@@ -277,7 +265,6 @@ export interface DirectoryEntry extends Entry {
|
||||
|
||||
/**
|
||||
* Creates or looks up a file.
|
||||
*
|
||||
* @param path Either an absolute path or a relative path from this DirectoryEntry to the file to be looked up or
|
||||
* created. It is an error to attempt to create a file whose immediate parent does not yet exist.
|
||||
* @param options
|
||||
@@ -296,7 +283,6 @@ export interface DirectoryEntry extends Entry {
|
||||
|
||||
/**
|
||||
* Creates or looks up a directory.
|
||||
*
|
||||
* @param path Either an absolute path or a relative path from this DirectoryEntry to the directory to be looked up
|
||||
* or created. It is an error to attempt to create a directory whose immediate parent does not yet exist.
|
||||
* @param options
|
||||
@@ -322,7 +308,6 @@ export interface DirectoryEntry extends Entry {
|
||||
* Deletes a directory and all of its contents, if any. In the event of an error [e.g. trying to delete a directory
|
||||
* that contains a file that cannot be removed], some of the contents of the directory may be deleted. It is an error
|
||||
* to attempt to delete the root directory of a filesystem.
|
||||
*
|
||||
* @param successCallback A callback that is called on success.
|
||||
* @param errorCallback A callback that is called when errors happen.
|
||||
*/
|
||||
@@ -345,7 +330,6 @@ export interface DirectoryReader {
|
||||
|
||||
/**
|
||||
* Read the next block of entries from this directory.
|
||||
*
|
||||
* @param successCallback Called once per successful call to readEntries to deliver the next previously-unreported
|
||||
* set of Entries in the associated Directory. If all Entries have already been returned from previous invocations
|
||||
* of readEntries, successCallback must be called with a zero-length array as an argument.
|
||||
@@ -360,7 +344,6 @@ export interface DirectoryReader {
|
||||
export interface FileEntry extends Entry {
|
||||
/**
|
||||
* Creates a new FileWriter associated with the file that this FileEntry represents.
|
||||
*
|
||||
* @param successCallback A callback that is called with the new FileWriter.
|
||||
* @param errorCallback A callback that is called when errors happen.
|
||||
*/
|
||||
@@ -368,7 +351,6 @@ export interface FileEntry extends Entry {
|
||||
|
||||
/**
|
||||
* Returns a File that represents the current state of the file that this FileEntry represents.
|
||||
*
|
||||
* @param successCallback A callback that is called with the File.
|
||||
* @param errorCallback A callback that is called when errors happen.
|
||||
*/
|
||||
@@ -458,20 +440,17 @@ export declare class FileSaver extends EventTarget {
|
||||
|
||||
/**
|
||||
* The blob is being written.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
INIT: number;
|
||||
/**
|
||||
* The object has been constructed, but there is no pending write.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
WRITING: number;
|
||||
/**
|
||||
* The entire Blob has been written to the file, an error occurred during the write, or the write was aborted using
|
||||
* abort(). The FileSaver is no longer writing the blob.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
DONE: number;
|
||||
@@ -483,13 +462,11 @@ export declare class FileSaver extends EventTarget {
|
||||
* <li>WRITING</li>
|
||||
* <li>DONE</li>
|
||||
* <ul>
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
readyState: number;
|
||||
/**
|
||||
* The last error that occurred on the FileSaver.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
error: Error;
|
||||
@@ -539,14 +516,12 @@ export declare class FileWriter extends FileSaver {
|
||||
|
||||
/**
|
||||
* Write the supplied data to the file at position.
|
||||
*
|
||||
* @param data The blob to write.
|
||||
*/
|
||||
write(data: ArrayBuffer | Blob | string): void;
|
||||
|
||||
/**
|
||||
* Seek sets the file position at which the next write will occur.
|
||||
*
|
||||
* @param offset If nonnegative, an absolute byte offset into the file. If negative, an offset back from the end of
|
||||
* the file.
|
||||
*/
|
||||
@@ -555,7 +530,6 @@ export declare class FileWriter extends FileSaver {
|
||||
/**
|
||||
* Changes the length of the file to that specified. If shortening the file, data beyond the new length must be
|
||||
* discarded. If extending the file, the existing data must be zero-padded up to the new length.
|
||||
*
|
||||
* @param size The size to which the length of the file is to be adjusted, measured in bytes.
|
||||
*/
|
||||
truncate(size: number): void;
|
||||
@@ -748,7 +722,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get free disk space in Bytes
|
||||
*
|
||||
* @returns {Promise<number>} Returns a promise that resolves with the remaining free disk space in Bytes
|
||||
*/
|
||||
@CordovaCheck()
|
||||
@@ -760,7 +733,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if a directory exists in a certain path, directory.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} dir Name of directory to check
|
||||
* @returns {Promise<boolean>} Returns a Promise that resolves to true if the directory exists or rejects with an
|
||||
@@ -784,7 +756,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
* Creates a new directory in the specific path.
|
||||
* The replace boolean value determines whether to replace an existing directory with the same name.
|
||||
* If an existing directory exists and the replace value is false, the promise will fail and return an error.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} dirName Name of directory to create
|
||||
* @param {boolean} replace If true, replaces file with same name. If false returns error
|
||||
@@ -813,7 +784,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Remove a directory at a given path.
|
||||
*
|
||||
* @param {string} path The path to the directory
|
||||
* @param {string} dirName The directory name
|
||||
* @returns {Promise<RemoveResult>} Returns a Promise that resolves to a RemoveResult or rejects with an error.
|
||||
@@ -837,7 +807,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Move a directory to a given path.
|
||||
*
|
||||
* @param {string} path The source path to the directory
|
||||
* @param {string} dirName The source directory name
|
||||
* @param {string} newPath The destination path to the directory
|
||||
@@ -868,7 +837,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Copy a directory in various methods. If destination directory exists, will fail to copy.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
|
||||
* @param {string} dirName Name of directory to copy
|
||||
* @param {string} newPath Base FileSystem of new location
|
||||
@@ -896,7 +864,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* List files and directory from a given path.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
|
||||
* @param {string} dirName Name of directory
|
||||
* @returns {Promise<Entry[]>} Returns a Promise that resolves to an array of Entry objects or rejects with an error.
|
||||
@@ -924,7 +891,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Removes all files and the directory from a desired location.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} dirName Name of directory
|
||||
* @returns {Promise<RemoveResult>} Returns a Promise that resolves with a RemoveResult or rejects with an error.
|
||||
@@ -948,7 +914,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if a file exists in a certain path, directory.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} file Name of file to check
|
||||
* @returns {Promise<boolean>} Returns a Promise that resolves with a boolean or rejects with an error.
|
||||
@@ -976,7 +941,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
* Creates a new file in the specific path.
|
||||
* The replace boolean value determines whether to replace an existing file with the same name.
|
||||
* If an existing file exists and the replace value is false, the promise will fail and return an error.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} fileName Name of file to create
|
||||
* @param {boolean} replace If true, replaces file with same name. If false returns error
|
||||
@@ -1005,7 +969,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Removes a file from a desired location.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} fileName Name of file to remove
|
||||
* @returns {Promise<RemoveResult>} Returns a Promise that resolves to a RemoveResult or rejects with an error.
|
||||
@@ -1029,7 +992,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Write a new file to the desired location.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} fileName path relative to base path
|
||||
* @param {string | Blob | ArrayBuffer} text content, blob or ArrayBuffer to write
|
||||
@@ -1066,7 +1028,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Write content to FileEntry.
|
||||
*
|
||||
* @hidden
|
||||
* Write to an existing file.
|
||||
* @param {FileEntry} fe file entry object
|
||||
@@ -1092,7 +1053,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Write to an existing file.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} fileName path relative to base path
|
||||
* @param {string | Blob} text content or blob to write
|
||||
@@ -1105,7 +1065,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Read the contents of a file as text.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} file Name of file, relative to path.
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the contents of the file as string or rejects with
|
||||
@@ -1119,8 +1078,7 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Read file and return data as a base64 encoded data url.
|
||||
* A data url is of the form:
|
||||
* data: [<mediatype>][;base64],<data>
|
||||
*
|
||||
* data: [<mediatype>][;base64],<data>
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} file Name of file, relative to path.
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the contents of the file as data URL or rejects
|
||||
@@ -1133,7 +1091,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Read file and return data as a binary data.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} file Name of file, relative to path.
|
||||
* @returns {Promise<string>} Returns a Promise that resolves with the contents of the file as string rejects with an
|
||||
@@ -1146,7 +1103,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Read file and return data as an ArrayBuffer.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} file Name of file, relative to path.
|
||||
* @returns {Promise<ArrayBuffer>} Returns a Promise that resolves with the contents of the file as ArrayBuffer or
|
||||
@@ -1159,7 +1115,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Move a file to a given path.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} fileName Name of file to move
|
||||
* @param {string} newPath Base FileSystem of new location
|
||||
@@ -1189,7 +1144,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Copy a file in various methods. If file exists, will fail to copy.
|
||||
*
|
||||
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above
|
||||
* @param {string} fileName Name of file to copy
|
||||
* @param {string} newPath Base FileSystem of new location
|
||||
@@ -1229,7 +1183,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Resolves a local file system URL
|
||||
*
|
||||
* @param fileUrl {string} file system url
|
||||
* @returns {Promise<Entry>}
|
||||
*/
|
||||
@@ -1256,7 +1209,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Resolves a local directory url
|
||||
*
|
||||
* @param directoryUrl {string} directory system url
|
||||
* @returns {Promise<DirectoryEntry>}
|
||||
*/
|
||||
@@ -1275,7 +1227,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get a directory
|
||||
*
|
||||
* @param directoryEntry {DirectoryEntry} Directory entry, obtained by resolveDirectoryUrl method
|
||||
* @param directoryName {string} Directory name
|
||||
* @param flags {Flags} Options
|
||||
@@ -1305,7 +1256,6 @@ export class File extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Get a file
|
||||
*
|
||||
* @param directoryEntry {DirectoryEntry} Directory entry, obtained by resolveDirectoryUrl method
|
||||
* @param fileName {string} File name
|
||||
* @param flags {Flags} Options
|
||||
|
||||
@@ -7,136 +7,115 @@ export type BIOMETRIC_TYPE = 'finger' | 'face' | 'biometric';
|
||||
export enum BIOMETRIC_ERRORS {
|
||||
/**
|
||||
* 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,
|
||||
/**
|
||||
* Convenience constant
|
||||
*
|
||||
* @type {number}
|
||||
*/
|
||||
BIOMETRIC_SECRET_NOT_FOUND = -113
|
||||
BIOMETRIC_SECRET_NOT_FOUND = -113,
|
||||
}
|
||||
|
||||
export interface FingerprintOptions {
|
||||
/**
|
||||
* Title in biometric prompt (android only)
|
||||
*
|
||||
* @default {APP_NAME} Biometric Sign On
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Subtitle in biometric Prompt (android only)
|
||||
*
|
||||
* @default null
|
||||
*/
|
||||
subtitle?: string;
|
||||
|
||||
/**
|
||||
* 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;
|
||||
|
||||
/**
|
||||
* (Android): If false user confirmation is NOT required after a biometric has been authenticated.
|
||||
*
|
||||
* @default true.
|
||||
* See https://developer.android.com/training/sign-in/biometric-auth#no-explicit-user-action
|
||||
*/
|
||||
@@ -151,7 +130,6 @@ export interface FingerprintSecretOptions extends FingerprintOptions {
|
||||
|
||||
/**
|
||||
* If `true` secret will be deleted when biometry items are deleted or enrolled
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
invalidateOnEnrollment?: boolean;
|
||||
@@ -159,17 +137,16 @@ export interface FingerprintSecretOptions extends FingerprintOptions {
|
||||
|
||||
export interface FingerprintAvailableOptions {
|
||||
/**
|
||||
* (Android): If true will only return success if Class 3 (BIOMETRIC_STRONG) Biometrics are enrolled on the device.
|
||||
* It is reccomended you use this if planning on using the registerBiometricSecret and loadBiometricSecret methods.
|
||||
*/
|
||||
* (Android): If true will only return success if Class 3 (BIOMETRIC_STRONG) Biometrics are enrolled on the device.
|
||||
* It is reccomended you use this if planning on using the registerBiometricSecret and loadBiometricSecret methods.
|
||||
*/
|
||||
requireStrongBiometrics: boolean;
|
||||
|
||||
/**
|
||||
* (iOS): If true checks if backup authentication option is available, e.g. passcode.
|
||||
* Default: false, which means check for biometrics only.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
* (iOS): If true checks if backup authentication option is available, e.g. passcode.
|
||||
* Default: false, which means check for biometrics only.
|
||||
* @default false
|
||||
*/
|
||||
allowBackup?: boolean;
|
||||
}
|
||||
|
||||
@@ -236,16 +213,14 @@ export interface FingerprintAvailableOptions {
|
||||
})
|
||||
@Injectable()
|
||||
export class FingerprintAIO extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Check if fingerprint authentication is available
|
||||
*
|
||||
* @param {FingerprintAvailableOptions} options Options for platform specific fingerprint API
|
||||
* @returns {Promise<BIOMETRIC_TYPE>} Returns a promise with result which depends on device and os.
|
||||
* iPhone X will return 'face' other Android or iOS devices will return 'finger' Android P+ will return 'biometric'
|
||||
*/
|
||||
@Cordova({
|
||||
callbackOrder: 'reverse'
|
||||
callbackOrder: 'reverse',
|
||||
})
|
||||
isAvailable(options: FingerprintAvailableOptions): Promise<BIOMETRIC_TYPE> {
|
||||
return;
|
||||
@@ -253,7 +228,6 @@ export class FingerprintAIO extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show authentication dialogue and register secret
|
||||
*
|
||||
* @param {FingerprintSecretOptions} options Options for platform specific fingerprint API
|
||||
* @returns {Promise<void>} Returns a promise that resolves when authentication was successful
|
||||
*/
|
||||
@@ -264,7 +238,6 @@ export class FingerprintAIO extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show authentication dialogue and load secret
|
||||
*
|
||||
* @param {FingerprintOptions} options Options for platform specific fingerprint API
|
||||
* @returns {Promise<string>} Returns a promise that resolves when authentication was successful
|
||||
*/
|
||||
@@ -275,7 +248,6 @@ export class FingerprintAIO extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Show authentication dialogue
|
||||
*
|
||||
* @param {FingerprintOptions} options Options for platform specific fingerprint API
|
||||
* @returns {Promise<void>} Returns a promise that resolves when authentication was successful
|
||||
*/
|
||||
|
||||
@@ -53,7 +53,6 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Logs an app event.
|
||||
* Be aware of automatically collected events.
|
||||
*
|
||||
* @param {string} name The name of the event
|
||||
* @param {any} params Some param to configure something
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
@@ -66,7 +65,6 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Sets the user ID property.
|
||||
* This feature must be used in accordance with Google's Privacy Policy.
|
||||
*
|
||||
* @param {string} id The user ID
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
*/
|
||||
@@ -78,7 +76,6 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* This feature must be used in accordance with Google's Privacy Policy.
|
||||
* Be aware of automatically collected user properties.
|
||||
*
|
||||
* @param {string} name The property name
|
||||
* @param {string} value The property value
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
@@ -90,7 +87,6 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Sets whether analytics collection is enabled for this app on this device.
|
||||
*
|
||||
* @param {boolean} enabled
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
*/
|
||||
@@ -102,7 +98,6 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Sets the current screen name, which specifies the current visual context in your app.
|
||||
* This helps identify the areas in your app where users spend their time and how they interact with your app.
|
||||
*
|
||||
* @param {string} name The name of the screen
|
||||
* @returns {Promise<any>} Returns a promise
|
||||
*/
|
||||
@@ -113,7 +108,6 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Clears all analytics data for this instance from the device and resets the app instance ID
|
||||
*
|
||||
* @returns {Promise<void>} Returns a promise
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
|
||||
@@ -35,7 +35,6 @@ import { Observable } from 'rxjs';
|
||||
export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Returns the current user logged in Firebase service
|
||||
*
|
||||
* @returns {Promise<any>} Returns the user info
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -45,7 +44,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Returns a JWT token used to identify the user to a Firebase service.
|
||||
*
|
||||
* @param forceRefresh {boolean} Force Refresh
|
||||
* @returns {Promise<any>} Returns the id token
|
||||
*/
|
||||
@@ -56,7 +54,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Tries to create a new user account with the given email address and password.
|
||||
*
|
||||
* @param email Email
|
||||
* @param password Password
|
||||
*/
|
||||
@@ -76,7 +73,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Triggers the Firebase Authentication backend to send a password-reset email to the given email address,
|
||||
* which must correspond to an existing user of your app.
|
||||
*
|
||||
* @param email Email
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -86,7 +82,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Asynchronously signs in using an email and password.
|
||||
*
|
||||
* @param email Email
|
||||
* @param password Password
|
||||
*/
|
||||
@@ -103,7 +98,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
* timeout [milliseconds] is the maximum amount of time you are willing to wait for SMS auto-retrieval
|
||||
* to be completed by the library. Maximum allowed value is 2 minutes. Use 0 to disable SMS-auto-retrieval.
|
||||
* If you specify a positive value less than 30 seconds, library will default to 30 seconds.
|
||||
*
|
||||
* @param phoneNumber Phone number
|
||||
* @param timeout {number} Timeout
|
||||
*/
|
||||
@@ -114,7 +108,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Asynchronously signs in using verificationId and 6-digit SMS code.
|
||||
*
|
||||
* @param verificationId Verification ID
|
||||
* @param smsCode SMS code
|
||||
*/
|
||||
@@ -133,7 +126,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Uses Google's idToken and accessToken to sign-in into firebase account. In order to retrieve those tokens follow instructions for Android and iOS
|
||||
*
|
||||
* @param idToken ID Token
|
||||
* @param accessToken Access Token
|
||||
*/
|
||||
@@ -144,7 +136,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Uses Apples's idToken and rawNonce (optional) to sign-in into firebase account. In order to retrieve those tokens follow instructions for Android and iOS
|
||||
*
|
||||
* @param idToken ID Token
|
||||
* @param identityToken
|
||||
* @param rawNonce Access Token
|
||||
@@ -156,7 +147,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Uses Facebook's accessToken to sign-in into firebase account. In order to retrieve those tokens follow instructions for Android and iOS.
|
||||
*
|
||||
* @param accessToken Access Token
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -166,7 +156,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Uses Twitter's token and secret to sign-in into firebase account. In order to retrieve those tokens follow instructions for Android and iOS.
|
||||
*
|
||||
* @param token Token
|
||||
* @param secret Secret
|
||||
*/
|
||||
@@ -188,7 +177,6 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Set's the current user language code. The string used to set this property must be a language code that follows BCP 47.
|
||||
*
|
||||
* @param languageCode Language Code
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
|
||||
@@ -33,7 +33,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl
|
||||
export class FirebaseConfig extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* Starts fetching configs, adhering to the specified minimum fetch interval.
|
||||
*
|
||||
* @param {number} expirationDuration
|
||||
* @returns {Promise<null>}
|
||||
*/
|
||||
@@ -44,7 +43,6 @@ export class FirebaseConfig extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Asynchronously activates the most recently fetched configs, so that the fetched key value pairs take effect.
|
||||
*
|
||||
* @returns {Promise<null>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -54,7 +52,6 @@ export class FirebaseConfig extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Asynchronously fetches and then activates the fetched configs.
|
||||
*
|
||||
* @returns {Promise<null>}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
@@ -64,7 +61,6 @@ export class FirebaseConfig extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Fetches a boolean configuration value from RemoteConfig
|
||||
*
|
||||
* @param {string} key
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@@ -75,7 +71,6 @@ export class FirebaseConfig extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Fetches a string configuration value from RemoteConfig
|
||||
*
|
||||
* @param {string} key
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@@ -86,7 +81,6 @@ export class FirebaseConfig extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Fetches a numeric configuration value from RemoteConfig
|
||||
*
|
||||
* @param {string} key
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
@@ -97,7 +91,6 @@ export class FirebaseConfig extends AwesomeCordovaNativePlugin {
|
||||
|
||||
/**
|
||||
* Fetches an array of bytes configuration value from RemoteConfig
|
||||
*
|
||||
* @param {string} key
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
|
||||
@@ -31,7 +31,6 @@ export class FirebaseCrash extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* 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
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -43,7 +42,6 @@ export class FirebaseCrash extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* 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
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@@ -55,7 +53,6 @@ export class FirebaseCrash extends AwesomeCordovaNativePlugin {
|
||||
/**
|
||||
* 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>}
|
||||
*/
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user