@ionic-native/core

property install

static install: string;

property platforms

static platforms: string[];

property plugin

static plugin: string;

property pluginName

static pluginName: string;

property pluginRef

static pluginRef: string;

property repo

static repo: string;

method getPlugin

static getPlugin: () => any;

• Returns the original plugin object

method getPluginInstallName

static getPluginInstallName: () => string;

• Returns the plugin's install name

method getPluginName

static getPluginName: () => string;

• Returns the plugin's name

method getPluginRef

static getPluginRef: () => string;

• Returns the plugin's reference

method getSupportedPlatforms

static getSupportedPlatforms: () => string[];

• Returns the plugin's supported platforms

method installed

static installed: () => boolean;

• Returns a boolean that indicates whether the plugin is installed {boolean}

property callbackOrder

callbackOrder?: 'reverse';

• Callback order. Set to reverse if the success/error callbacks are the first 2 arguments that the wrapped method takes.

property callbackStyle

callbackStyle?: 'node' | 'object';

• Callback style

property clearFunction

clearFunction?: string;

• If observable is set to true, this can be set to a different function name that will cancel the observable.

property clearWithArgs

clearWithArgs?: boolean;

• This can be used if clearFunction is set. Set this to true to call the clearFunction with the same arguments used in the initial function.

property destruct

destruct?: boolean;

property element

element?: any;

• Element to attach the event listener to, this is optional, defaults to window

property errorIndex

errorIndex?: number;

• Set a custom index for the error callback function. This doesn't work if callbackOrder or callbackStyle are set.

property errorName

errorName?: string;

• Error function property name. This must be set if callbackStyle is set to object.

property event

event?: string;

• Event name, this must be set if eventObservable is set to true

property eventObservable

eventObservable?: boolean;

• Creates an observable that wraps a global event. Replaces document.addEventListener

property methodName

methodName?: string;

• If the method-name of the cordova plugin is different from the wrappers one, it can be defined here

property observable

observable?: boolean;

• Set to true to return an observable

property otherPromise

otherPromise?: boolean;

• Set to true if the wrapped method returns a promise

property platforms

platforms?: string[];

• Supported platforms

property successIndex

successIndex?: number;

• Set a custom index for the success callback function. This doesn't work if callbackOrder or callbackStyle are set.

property successName

successName?: string;

• Success function property name. This must be set if callbackStyle is set to object.

property sync

sync?: boolean;

• Set to true if the wrapped method is a sync function

property install

install?: string;

• Custom install command

property installVariables

installVariables?: string[];

• Available installation variables

property platforms

platforms?: string[];

• Supported platforms

property plugin

plugin: string;

• Plugin NPM package name

property pluginName

pluginName: string;

• Plugin name, this should match the class name

property pluginRef

pluginRef?: string;

• Plugin object reference

property repo

repo?: string;

• Github repository URL

index signature

[key: string]: any;