@tauri-apps/plugin-geolocation

Type Aliases

Coordinates

type Coordinates = object;

Defined in: plugins/geolocation/guest-js/index.ts:12

Properties

Property	Type	Description	Defined in
accuracy	number	Accuracy level of the latitude and longitude coordinates in meters.	plugins/geolocation/guest-js/index.ts:24
altitude	number | null	The altitude the user is at, if available.	plugins/geolocation/guest-js/index.ts:33
altitudeAccuracy	number | null	Accuracy level of the altitude coordinate in meters, if available. Available on all iOS versions and on Android 8 and above.	plugins/geolocation/guest-js/index.ts:29
heading	number | null	The heading the user is facing, if available.	plugins/geolocation/guest-js/index.ts:38
latitude	number	Latitude in decimal degrees.	plugins/geolocation/guest-js/index.ts:16
longitude	number	Longitude in decimal degrees.	plugins/geolocation/guest-js/index.ts:20
speed	number | null	-	plugins/geolocation/guest-js/index.ts:34

---

PermissionStatus

type PermissionStatus = object;

Defined in: plugins/geolocation/guest-js/index.ts:41

Properties

Property	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.	plugins/geolocation/guest-js/index.ts:59
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.	plugins/geolocation/guest-js/index.ts:49

---

PermissionType

type PermissionType = "location" | "coarseLocation";

Defined in: plugins/geolocation/guest-js/index.ts:62

---

Position

type Position = object;

Defined in: plugins/geolocation/guest-js/index.ts:64

Properties

Property	Type	Description	Defined in
coords	Coordinates	The GPD coordinates along with the accuracy of the data.	plugins/geolocation/guest-js/index.ts:72
timestamp	number	Creation time for these coordinates.	plugins/geolocation/guest-js/index.ts:68

---

PositionOptions

type PositionOptions = object;

Defined in: plugins/geolocation/guest-js/index.ts:75

Properties

Property	Type	Description	Defined in
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).	plugins/geolocation/guest-js/index.ts:80
maximumAge	number	The maximum age in milliseconds of a possible cached position that is acceptable to return. Default: 0 Ignored on iOS	plugins/geolocation/guest-js/index.ts:92
timeout	number	The maximum wait time in milliseconds for location updates. On Android the timeout gets ignored for getCurrentPosition. Ignored on iOS	plugins/geolocation/guest-js/index.ts:86

Functions

checkPermissions()

function checkPermissions(): Promise<PermissionStatus>;

Defined in: plugins/geolocation/guest-js/index.ts:128

Returns

Promise<PermissionStatus>

---

clearWatch()

function clearWatch(channelId): Promise<void>;

Defined in: plugins/geolocation/guest-js/index.ts:122

Parameters

Parameter	Type
channelId	number

Returns

Promise<void>

---

getCurrentPosition()

function getCurrentPosition(options?): Promise<Position>;

Defined in: plugins/geolocation/guest-js/index.ts:114

Parameters

Parameter	Type
options?	PositionOptions

Returns

Promise<Position>

---

requestPermissions()

function requestPermissions(permissions): Promise<PermissionStatus>;

Defined in: plugins/geolocation/guest-js/index.ts:132

Parameters

Parameter	Type
permissions	| PermissionType[] | null

Returns

Promise<PermissionStatus>

---

watchPosition()

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

Defined in: plugins/geolocation/guest-js/index.ts:95

Parameters

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

Returns

Promise<number>