geolocation

Type Aliases

type Coordinates: object;

Name	Type	Description
`accuracy`	`number`	Accuracy level of the latitude and longitude coordinates in meters.
`altitude`	`number` \| `null`	The altitude the user is at, if available.
`altitudeAccuracy`	`number` \| `null`	Accuracy level of the altitude coordinate in meters, if available. Available on all iOS versions and on Android 8 and above.
`heading`	`number` \| `null`	The heading the user is facing, if available.
`latitude`	`number`	Latitude in decimal degrees.
`longitude`	`number`	Longitude in decimal degrees.
`speed`	`number` \| `null`	-

type PermissionStatus: object;

Name	Type	Description	Defined in
`coarseLocation`	`PermissionState`	Permissions state for the coarseLoaction alias. On Android, it requests/checks ACCESS_COARSE_LOCATION. On Android 12+, users can choose between Approximate location (ACCESS_COARSE_LOCATION) and Precise location (ACCESS_FINE_LOCATION). On iOS, it will have the same value as the `location` alias.
`location`	`PermissionState`	Permission state for the location alias. On Android, it requests/checks both ACCESS_COARSE_LOCATION and ACCESS_FINE_LOCATION permissions. On iOS, it requests/checks location permissions.

type PermissionType: "location" | "coarseLocation";

type Position: object;

Name	Type	Description	Defined in
`coords`	`Coordinates`	The GPD coordinates along with the accuracy of the data.
`timestamp`	`number`	Creation time for these coordinates.

type PositionOptions: object;

Name	Type	Description
`enableHighAccuracy`	`boolean`	High accuracy mode (such as GPS, if available) Will be ignored on Android 12+ if users didn’t grant the ACCESS_FINE_LOCATION permission (`coarseLocation` permission).
`maximumAge`	`number`	The maximum age in milliseconds of a possible cached position that is acceptable to return. Default: 0 Ignored on iOS
`timeout`	`number`	The maximum wait time in milliseconds for location updates. On Android the timeout gets ignored for getCurrentPosition. Ignored on iOS

function checkPermissions(): Promise<PermissionStatus>

function clearWatch(channelId): Promise<void>

Parameter	Type
`channelId`	`number`

function getCurrentPosition(options?): Promise<Position>

Parameter	Type
`options`?	`PositionOptions`

function requestPermissions(permissions): Promise<PermissionStatus>

Parameter	Type
`permissions`	`null` \| `PermissionType`[]

function watchPosition(options, cb): Promise<number>

Parameter	Type
`options`	`PositionOptions`
`cb`	(`location`, `error`?) => `void`

Promise<number>