init

node_modules/@capacitor/geolocation/dist/esm/definitions.d.ts

@@ -0,0 +1,187 @@
+import type { PermissionState } from '@capacitor/core';
+export type CallbackID = string;
+export interface PermissionStatus {
+    /**
+     * Permission state for location alias.
+     *
+     * On Android it requests/checks both ACCESS_COARSE_LOCATION and
+     * ACCESS_FINE_LOCATION permissions.
+     *
+     * On iOS and web it requests/checks location permission.
+     *
+     * @since 1.0.0
+     */
+    location: PermissionState;
+    /**
+     * Permission state for coarseLocation alias.
+     *
+     * On Android it requests/checks ACCESS_COARSE_LOCATION.
+     *
+     * On Android 12+, users can choose between Approximate location (ACCESS_COARSE_LOCATION) or
+     * Precise location (ACCESS_FINE_LOCATION), so this alias can be used if the app doesn't
+     * need high accuracy.
+     *
+     * On iOS and web it will have the same value as location alias.
+     *
+     * @since 1.2.0
+     */
+    coarseLocation: PermissionState;
+}
+export type GeolocationPermissionType = 'location' | 'coarseLocation';
+export interface GeolocationPluginPermissions {
+    permissions: GeolocationPermissionType[];
+}
+export interface GeolocationPlugin {
+    /**
+     * Get the current GPS location of the device
+     *
+     * @since 1.0.0
+     */
+    getCurrentPosition(options?: PositionOptions): Promise<Position>;
+    /**
+     * Set up a watch for location changes. Note that watching for location changes
+     * can consume a large amount of energy. Be smart about listening only when you need to.
+     *
+     * @since 1.0.0
+     */
+    watchPosition(options: PositionOptions, callback: WatchPositionCallback): Promise<CallbackID>;
+    /**
+     * Clear a given watch
+     *
+     * @since 1.0.0
+     */
+    clearWatch(options: ClearWatchOptions): Promise<void>;
+    /**
+     * Check location permissions.  Will throw if system location services are disabled.
+     *
+     * @since 1.0.0
+     */
+    checkPermissions(): Promise<PermissionStatus>;
+    /**
+     * Request location permissions.  Will throw if system location services are disabled.
+     *
+     * Not available on web.
+     *
+     * @since 1.0.0
+     */
+    requestPermissions(permissions?: GeolocationPluginPermissions): Promise<PermissionStatus>;
+}
+export interface ClearWatchOptions {
+    id: CallbackID;
+}
+export interface Position {
+    /**
+     * Creation timestamp for coords
+     *
+     * @since 1.0.0
+     */
+    timestamp: number;
+    /**
+     * The GPS coordinates along with the accuracy of the data
+     *
+     * @since 1.0.0
+     */
+    coords: {
+        /**
+         * Latitude in decimal degrees
+         *
+         * @since 1.0.0
+         */
+        latitude: number;
+        /**
+         * longitude in decimal degrees
+         *
+         * @since 1.0.0
+         */
+        longitude: number;
+        /**
+         * Accuracy level of the latitude and longitude coordinates in meters
+         *
+         * @since 1.0.0
+         */
+        accuracy: number;
+        /**
+         * Accuracy level of the altitude coordinate in meters, if available.
+         *
+         * Available on all iOS versions and on Android 8.0+.
+         *
+         * @since 1.0.0
+         */
+        altitudeAccuracy: number | null | undefined;
+        /**
+         * The altitude the user is at (if available)
+         *
+         * @since 1.0.0
+         */
+        altitude: number | null;
+        /**
+         * The speed the user is traveling (if available)
+         *
+         * @since 1.0.0
+         */
+        speed: number | null;
+        /**
+         * The heading the user is facing (if available)
+         *
+         * @since 1.0.0
+         */
+        heading: number | null;
+    };
+}
+export interface PositionOptions {
+    /**
+     * High accuracy mode (such as GPS, if available)
+     *
+     * On Android 12+ devices it will be ignored if users didn't grant
+     * ACCESS_FINE_LOCATION permissions (can be checked with location alias).
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    enableHighAccuracy?: boolean;
+    /**
+     * The maximum wait time in milliseconds for location updates.
+     *
+     * In Android, since version 7.1.0 of the plugin, it is also used to determine the
+     * interval of location updates for `watchPosition`.
+     *
+     * @default 10000
+     * @since 1.0.0
+     */
+    timeout?: number;
+    /**
+     * The maximum age in milliseconds of a possible cached position that is acceptable to return
+     *
+     * @default 0
+     * @since 1.0.0
+     */
+    maximumAge?: number;
+    /**
+     * The minumum update interval for location updates.
+     *
+     * If location updates are available faster than this interval then an update
+     * will only occur if the minimum update interval has expired since the last location update.
+     *
+     * This parameter is only available for Android. It has no effect on iOS or Web platforms.
+     *
+     * @default 5000
+     * @since 6.1.0
+     */
+    minimumUpdateInterval?: number;
+}
+export type WatchPositionCallback = (position: Position | null, err?: any) => void;
+/**
+ * @deprecated Use `PositionOptions`.
+ * @since 1.0.0
+ */
+export type GeolocationOptions = PositionOptions;
+/**
+ * @deprecated Use `WatchPositionCallback`.
+ * @since 1.0.0
+ */
+export type GeolocationWatchCallback = WatchPositionCallback;
+/**
+ * @deprecated Use `Position`.
+ * @since 1.0.0
+ */
+export type GeolocationPosition = Position;