Class PositionService

Position service class

Index

Accessors

improvedPosition position sourceType instance

Methods

addImprovedPositionListener addPositionListener getDataSource getImprovedPosition getPosition removeDataSource removeListener requestLocation setExternalDataSource setLiveDataSource requestLocationPermission

Accessors

improvedPosition

get improvedPosition(): GemImprovedPosition | null
Gets the latest improved position data available

Returns GemImprovedPosition | null
Latest improved position or null if not available

Throws
An exception if it fails
- Defined in positionservice.ts:147

position

get position(): GemPosition | null
Gets the latest position data available

Returns GemPosition | null
Latest position or null if not available

Throws
An exception if it fails
- Defined in positionservice.ts:123

sourceType

get sourceType(): DataSourceType
Gets the method used to obtain position data

Returns DataSourceType
The data source type

Throws
An exception if it fails
- Defined in positionservice.ts:203

`Static`instance

get instance(): PositionService
Gets the singleton instance of PositionService

Returns PositionService
- Defined in positionservice.ts:26

Methods

addImprovedPositionListener

addImprovedPositionListener(
positionUpdatedCallback: (position: GemImprovedPosition) => void,
): GemPositionListener
Register a new improved position listener
Parameters
- positionUpdatedCallback: (position: GemImprovedPosition) => void
  The callback for improved position updates
Returns GemPositionListener
The created position listener

Throws
An exception if it fails
- Defined in positionservice.ts:66

addPositionListener

addPositionListener(
positionUpdatedCallback: (position: GemPosition) => void,
): GemPositionListener
Register a new listener for position updates
Parameters
- positionUpdatedCallback: (position: GemPosition) => void
  The callback for position updates
Returns GemPositionListener
The created position listener

Throws
An exception if it fails
- Defined in positionservice.ts:39

getDataSource

getDataSource(): DataSource | null
Gets the current data source used for position data

Returns DataSource | null
The data source or null if none exists

Throws
An exception if it fails
- Defined in positionservice.ts:190

getImprovedPosition

getImprovedPosition(): GemImprovedPosition | null
Returns GemImprovedPosition | null
Deprecated
Use the improvedPosition getter instead
- Defined in positionservice.ts:114

getPosition

getPosition(): GemPosition | null
Returns GemPosition | null
Deprecated
Use the position getter instead
- Defined in positionservice.ts:107

removeDataSource

removeDataSource(): void
Removes the current position data source

Returns void
Throws
An exception if it fails
- Defined in positionservice.ts:216

removeListener

removeListener(listener: IGemPositionListener): void
Unregister a position listener
Parameters
- listener: IGemPositionListener
  The listener to unregister
Returns void
Throws
An exception if it fails
- Defined in positionservice.ts:92

requestLocation

requestLocation(): Promise<boolean>
Requests location permission and sets live data source

Returns Promise<boolean>
Promise resolving to true if permission granted and live data source set successfully

Throws
An exception if it fails
- Defined in positionservice.ts:256

setExternalDataSource

setExternalDataSource(dataSource: DataSource): GemError
Sets an external data source for position data
Parameters
- dataSource: DataSource
  The data source to use
Returns GemError
GemError indicating success or failure

Throws
An exception if it fails
- Defined in positionservice.ts:233

setLiveDataSource

setLiveDataSource(): GemError
Sets the position service current datasource to live

Returns GemError
GemError indicating success or failure

Throws
An exception if it fails
- Defined in positionservice.ts:171

`Static`requestLocationPermission

requestLocationPermission(): Promise<boolean>
Requests location permission (Web only)

Returns Promise<boolean>
Promise resolving to true if permission granted

Throws
UnimplementedError on iOS/Android
- Defined in positionservice.ts:247