Interface Options

Provides options for location monitoring.

interface Options {
    activityType?: any;
    allowsBackgroundLocationUpdates?: boolean;
    deferredLocationUpdates?: { timeout: number; traveled: number };
    desiredAccuracy?: number;
    dontOpenSettings?: boolean;
    maximumAge?: number;
    minimumUpdateTime?: number;
    nmeaAltitude?: boolean;
    onDeferred?: deferredCallbackType;
    onLocationPaused?: () => void;
    pausesLocationUpdatesAutomatically?: boolean;
    provider?: "gps" | "network" | "passive";
    skipPermissionCheck?: boolean;
    timeout?: number;
    updateDistance?: number;
}

Properties

activityType? allowsBackgroundLocationUpdates? deferredLocationUpdates? desiredAccuracy? dontOpenSettings? maximumAge? minimumUpdateTime? nmeaAltitude? onDeferred? onLocationPaused? pausesLocationUpdatesAutomatically? provider? skipPermissionCheck? timeout? updateDistance?

Properties

OptionalactivityType

activityType?: any

iOS only

OptionalallowsBackgroundLocationUpdates

allowsBackgroundLocationUpdates?: boolean

iOS only

OptionaldeferredLocationUpdates

deferredLocationUpdates?: { timeout: number; traveled: number }

iOS only

OptionaldesiredAccuracy

desiredAccuracy?: number

Specifies desired accuracy in meters. Defaults to DesiredAccuracy.HIGH

OptionaldontOpenSettings

dontOpenSettings?: boolean

monitor the location in the background.

OptionalmaximumAge

maximumAge?: number

how old locations to receive in ms.

OptionalminimumUpdateTime

minimumUpdateTime?: number

Minimum time interval between location updates, in milliseconds.

OptionalnmeaAltitude

nmeaAltitude?: boolean

OptionalonDeferred

onDeferred?: deferredCallbackType

OptionalonLocationPaused

onLocationPaused?: () => void

OptionalpausesLocationUpdatesAutomatically

pausesLocationUpdatesAutomatically?: boolean

iOS only

Optionalprovider

provider?: "gps" | "network" | "passive"

android only

OptionalskipPermissionCheck

skipPermissionCheck?: boolean

monitor the location in the background.

Optionaltimeout

timeout?: number

how long to wait for a location in ms.

OptionalupdateDistance

updateDistance?: number

Update distance filter in meters. Specifies how often to update. Default on iOS is no filter, on Android it is 0 meters

Settings

Member Visibility

On This Page

Properties