<MPLocationSource> Protocol Reference

#include <MPLocationSource.h>

Inheritance diagram for <MPLocationSource>:

Instance Methods
(NSArray< MPLocation * > *)	- getLocations
(void)	- addLocationsObserver:
(void)	- removeLocationsObserver:
(MPLocationSourceStatus)	- status
(int)	- sourceId

Detailed Description

Location source protocol.

Method Documentation

addLocationsObserver:

- (void) addLocationsObserver: (id< MPLocationsObserver >) observer

required

Add an observer that gets callbacks about updates, additions and deletions to locations in this location source

Parameters

observer

The observer object

getLocations

- (NSArray< MPLocation * > *) getLocations

required

Get the locations available from the location source at this point in time

Returns

The list of locations

removeLocationsObserver:

- (void) removeLocationsObserver: (id< MPLocationsObserver >) observer

required

Remove an observer that gets callbacks about updates, additions and deletions to locations in this location source

Parameters

observer

The observer object to remove

sourceId

- (int) sourceId

required

Get the id of the location source

status

- (MPLocationSourceStatus) status

required

Get the status of the location source: .available available and expected to provide data .unavailable unavailable but expected to provide data under normal circumstances .initialising processing and expected to provide data when initialised .inactive intentionally inactive and not expected to provide data

Returns

The status of the location source