Interface MPPositionProviderInterface`Abstract`

Interface for added a position provider to the SDK.

Export

MPPositionProviderInterface

interface MPPositionProviderInterface {
    get name(): string;
    addOnPositionUpdateListener(listener: OnPositionUpdateListener): void;
    getLatestPosition(): MPPositionResultInterface;
    removeOnPositionUpdateListener(listener: OnPositionUpdateListener): void;
}

Index

Accessors

Methods

addOnPositionUpdateListener getLatestPosition removeOnPositionUpdateListener

Accessors

`Abstract`name

get name(): string
The name of the position provider, used to identify it.

Returns string
- Defined in MPPositionProviderInterface.ts:44

Methods

`Abstract`addOnPositionUpdateListener

addOnPositionUpdateListener(listener: OnPositionUpdateListener): void
Add a listener to the position provider.

The listener should be invoked when a new position has been received.
Parameters
- listener: OnPositionUpdateListener
Returns void
- Defined in MPPositionProviderInterface.ts:20

`Abstract`getLatestPosition

getLatestPosition(): MPPositionResultInterface
Invoked when the latest valid position is needed.

Returns MPPositionResultInterface
- Defined in MPPositionProviderInterface.ts:36

`Abstract`removeOnPositionUpdateListener

removeOnPositionUpdateListener(listener: OnPositionUpdateListener): void
Remove a listener.
Parameters
- listener: OnPositionUpdateListener
Returns void
- Defined in MPPositionProviderInterface.ts:28