awesome-cordova-plugins/src/@ionic-native/plugins/location-accuracy/index.ts

import { Injectable } from '@angular/core';
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';

/**
 * @name Location Accuracy
 * @description
 * This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of Location Services by triggering a native dialog from within the app, avoiding the need for the user to leave your app to change location settings manually.
 *
 * @usage
 * ```typescript
 * import { LocationAccuracy } from '@ionic-native/location-accuracy';
 *
 * constructor(private locationAccuracy: LocationAccuracy) { }
 *
 * ...
 *
 * this.locationAccuracy.canRequest().then((canRequest: boolean) => {
 *
 *   if(canRequest) {
 *     // the accuracy option will be ignored by iOS
 *     this.locationAccuracy.request(this.locationAccuracy.REQUEST_PRIORITY_HIGH_ACCURACY).then(
 *       () => console.log('Request successful'),
 *       error => console.log('Error requesting location permissions', error)
 *     );
 *   }
 *
 * });
 *
 * ```
 */
@Plugin({
  pluginName: 'LocationAccuracy',
  plugin: 'cordova-plugin-request-location-accuracy',
  pluginRef: 'cordova.plugins.locationAccuracy',
  repo: 'https://github.com/dpa99c/cordova-plugin-request-location-accuracy',
  platforms: ['Android', 'iOS']
})
@Injectable()
export class LocationAccuracy extends IonicNativePlugin {
  /**
   * Indicates if you can request accurate location
   * @returns {Promise<boolean>} Returns a promise that resovles with a boolean that indicates if you can request accurate location
   */
  @Cordova()
  canRequest(): Promise<boolean> { return; }

  /**
   * Indicates if a request is currently in progress
   * @returns {Promise<boolean>} Returns a promise that resolves with a boolean that indicates if a request is currently in progress
   */
  @Cordova()
  isRequesting(): Promise<boolean> { return; }

  /**
   * Requests accurate location
   * @param accuracy {number} Accuracy, from 0 to 4. You can use the static properties of this class that start with REQUEST_PRIORITY_
   * @returns {Promise<any>} Returns a promise that resolves on success and rejects if an error occurred
   */
  @Cordova({ callbackOrder: 'reverse' })
  request(accuracy: number): Promise<any> { return; }

  /**
   * Convenience constant
   * @type {number}
   */
  REQUEST_PRIORITY_NO_POWER = 0;

  /**
   * Convenience constant
   * @type {number}
   */
  REQUEST_PRIORITY_LOW_POWER = 1;

  /**
   * Convenience constant
   * @type {number}
   */
  REQUEST_PRIORITY_BALANCED_POWER_ACCURACY = 2;

  /**
   * Convenience constant
   * @type {number}
   */
  REQUEST_PRIORITY_HIGH_ACCURACY = 3;

  /**
   * Convenience constant
   * @type {number}
   */
  SUCCESS_SETTINGS_SATISFIED = 0;

  /**
   * Convenience constant
   * @type {number}
   */
  SUCCESS_USER_AGREED = 1;

  /**
   * Convenience constant
   * @type {number}
   */
  ERROR_ALREADY_REQUESTING = -1;

  /**
   * Convenience constant
   * @type {number}
   */
  ERROR_INVALID_ACTION = 0;

  /**
   * Convenience constant
   * @type {number}
   */
  ERROR_INVALID_ACCURACY = 1;

  /**
   * Convenience constant
   * @type {number}
   */
  ERROR_EXCEPTION = 1;

  /**
   * Convenience constant
   * @type {number}
   */
  ERROR_CANNOT_CHANGE_ACCURACY = 3;

  /**
   * Convenience constant
   * @type {number}
   */
  ERROR_USER_DISAGREED = 4;

  /**
   * Convenience constant
   * @type {number}
   */
  ERROR_GOOGLE_API_CONNECTION_FAILED = 4;

}