MapsIndoors iOS SDK V3
Loading...
Searching...
No Matches
Instance Methods | Class Methods | Properties | List of all members
MPLocationService Class Reference

#include <MPLocationService.h>

Inheritance diagram for MPLocationService:

Instance Methods

(instancetype) - NS_UNAVAILABLE
 
(void) - getLocationsUsingQuery:filter:completionHandler:
 
(NSArray< MPLocation * > *) - getLocationsByExternalIds:
 

Class Methods

(instancetype) + sharedInstance
 

Properties

id< MPLocationServiceDelegatedelegate
 
MPLocationSourceStatus locationSourceStatus
 

Detailed Description

The LocationService acts as service for search and filtering in the full, aggregated collection of Locations. The service requests from all registered Location sources, both internal MapsIndoors and external. Get the shared instance through sharedInstance (MPLocationService).

Method Documentation

◆ getLocationsByExternalIds:

- (NSArray< MPLocation * > *) getLocationsByExternalIds: (NSArray< NSString * > *) externalIds

Get the Locations that have the provided external IDs associated. Multiple Locations may have the same external ID associated, so a request with e.g. two external IDs may return more than two Locations.

Parameters
externalIdsThe list of external IDs to get Locations for.
Returns
An array of Locations that have the requested external IDs. The number of returned Locations may be higher than number of provided external IDs.

◆ getLocationsUsingQuery:filter:completionHandler:

- (void) getLocationsUsingQuery: (MPQuery *) query
filter: (MPFilter *) filter
completionHandler: (nullable mpLocationsHandlerBlockType) handler 

Get locations with given filter, query and callback handler block.

Parameters
queryThe query object
filterThe filter object
handlerThe handler block

◆ NS_UNAVAILABLE

- (instancetype) NS_UNAVAILABLE

◆ sharedInstance

+ (instancetype) sharedInstance

Get the shared instance.

Property Documentation

◆ delegate

- (id<MPLocationServiceDelegate>) delegate
readwritenonatomicweak

Set a delegate to be informed about the status of loading the locations of the current solution.

◆ locationSourceStatus

- (MPLocationSourceStatus) locationSourceStatus
readnonatomicassign

The current status of the Location Source. The Location Service can not be used reliably until the status is MPLocationSourceStatusComplete.