Class GPS

Hierarchy

GPSCommon
- GPS

Index

Constructors

Properties

enabled iosChangeLocListener iosChangeLocManager gps_status_event

Methods

authorize clearWatch distance enable getCurrentLocation getLastKnownLocation hasGPS isAuthorized isEnabled onListenerAdded onListenerRemoved openGPSSettings prepareForRequest watchLocation

Constructors

constructor

new GPS(): GPS
Returns GPS
Overrides GPSCommon.constructor
- Defined in packages/gps/index.ios.d.ts:34

Properties

enabled

enabled: boolean

iosChangeLocListener

iosChangeLocListener: LocationChangeListenerImpl

iosChangeLocManager

iosChangeLocManager: CLLocationManager

`Static` gps_status_event

gps_status_event: string

Methods

authorize

authorize(always?: boolean): Promise<boolean>
Parameters
- Optional always: boolean
Returns Promise<boolean>
Inherited from GPSCommon.authorize
- Defined in packages/gps/index.common.d.ts:21

clearWatch

clearWatch(watchId: number): void
Parameters
- watchId: number
Returns void
- Defined in packages/gps/index.ios.d.ts:40

distance

distance<T>(loc1: GenericGeoLocation<T>, loc2: GenericGeoLocation<T>): number
Type Parameters
- T = DefaultLatLonKeys
Parameters
- loc1: GenericGeoLocation<T>
- loc2: GenericGeoLocation<T>
Returns number
- Defined in packages/gps/index.ios.d.ts:45

enable

enable(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/gps/index.ios.d.ts:43

getCurrentLocation

getCurrentLocation<T>(options: Options): Promise<GenericGeoLocation<T>>
Type Parameters
- T = DefaultLatLonKeys
Parameters
- options: Options
Returns Promise<GenericGeoLocation<T>>
- Defined in packages/gps/index.ios.d.ts:38

getLastKnownLocation

getLastKnownLocation<T>(): GenericGeoLocation<T>
Type Parameters
- T = DefaultLatLonKeys
Returns GenericGeoLocation<T>
- Defined in packages/gps/index.ios.d.ts:46

hasGPS

hasGPS(): boolean
Returns boolean
- Defined in packages/gps/index.ios.d.ts:41

isAuthorized

isAuthorized(always?: boolean): Promise<boolean>
Parameters
- Optional always: boolean
Returns Promise<boolean>
Inherited from GPSCommon.isAuthorized
- Defined in packages/gps/index.common.d.ts:22

isEnabled

isEnabled(): boolean
Returns boolean
- Defined in packages/gps/index.ios.d.ts:44

onListenerAdded

onListenerAdded(eventName: string, count: number): void
Parameters
- eventName: string
- count: number
Returns void
Overrides GPSCommon.onListenerAdded
- Defined in packages/gps/index.ios.d.ts:35

onListenerRemoved

onListenerRemoved(eventName: string, count: number): void
Parameters
- eventName: string
- count: number
Returns void
Overrides GPSCommon.onListenerRemoved
- Defined in packages/gps/index.ios.d.ts:36

openGPSSettings

openGPSSettings(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/gps/index.ios.d.ts:42

prepareForRequest

prepareForRequest(options: Options): Promise<boolean>
Parameters
- options: Options
Returns Promise<boolean>
- Defined in packages/gps/index.ios.d.ts:37

watchLocation

watchLocation<T>(successCallback: successCallbackType<T>, errorCallback: errorCallbackType, options: Options): Promise<number>
Type Parameters
- T = DefaultLatLonKeys
Parameters
- successCallback: successCallbackType<T>
- errorCallback: errorCallbackType
- options: Options
Returns Promise<number>
- Defined in packages/gps/index.ios.d.ts:39

Generated using TypeDoc