/** * This is a template for new plugin wrappers * * TODO: * - Add/Change information below * - Document usage (importing, executing main functionality) * - Remove any imports that you are not using * - Add this file to /src/index.ts (follow style of other plugins) * - Remove all the comments included in this template, EXCEPT the @Plugin wrapper docs and any other docs you added * - Remove this note * */ import { Plugin, Cordova, CordovaProperty, CordovaInstance, InstanceProperty } from '@ionic-native/core'; import { Injectable } from '@angular/core'; import { Observable } from 'rxjs/Observable'; /** * @name Plugin Name * @description * This plugin does something * * @usage * ``` * import { PluginName } from 'ionic-native'; * * PluginName.functionName('Hello', 123) * .then((something: any) => doSomething(something)) * .catch((error: any) => console.log(error)); * * ``` */ @Plugin({ pluginName: 'PluginName', plugin: '', // npm package name, example: cordova-plugin-camera pluginRef: '', // the variable reference to call the plugin, example: navigator.geolocation repo: '', // the github repository URL for the plugin install: '' // OPTIONAL install command, in case the plugin requires variables }) @Injectable() export class PluginName { /** * This function does something * @param arg1 {string} Some param to configure something * @param arg2 {number} Another param to configure something * @return {Promise} Returns a promise that resolves when something happens */ @Cordova() functionName(arg1: string, arg2: number): Promise { return; // We add return; here to avoid any IDE / Compiler errors } }