MPVenueProvider Class Reference

#include <MPVenueProvider.h>

Inheritance diagram for MPVenueProvider:

Instance Methods
(void)	- getVenues
(void)	- getBuildingWithinBounds:
(void)	- getBuildings
(void)	- getBuildingWithId:
(void)	- getVenueWithId:
(void)	- getVenuesWithCompletion:
(void)	- getBuildingWithinBounds:completionHandler:
(void)	- getBuildingsWithCompletion:
(void)	- getBuildingWithId:completionHandler:
(void)	- getVenueWithId:completionHandler:
(void)	- getDataFromPoint:completionHandler:

Class Methods
(nullable NSDictionary *)	+ getDataFromPoint:
(BOOL)	+ isOfflineDataAvailableForSolutionId:language:

Properties
id< MPVenueProviderDelegate >	delegate

Detailed Description

Venue provider interface, that defines a delegate and a method for venue queries.

Method Documentation

getBuildings

- (void) getBuildings

Get buildings from this provider

getBuildingsWithCompletion:

- (void) getBuildingsWithCompletion:

(nullable mpBuildingListHandlerBlockType)

handler

Get buildings from this provider

Parameters

handler

Buildings fetch callback block

getBuildingWithId:

- (void) getBuildingWithId:

(nonnull NSString *)

buildingId

Get a single building detail object

Parameters

buildingId

Building id

getBuildingWithId:completionHandler:

- (void) getBuildingWithId:		(nonnull NSString *)	buildingId
completionHandler:		(nullable mpBuildingDetailsHandlerBlockType)	handler

Get single building detail object

Parameters

buildingId	Building id
handler	Building details fetch callback block

getBuildingWithinBounds:

- (void) getBuildingWithinBounds:

(nonnull MPMapExtend *)

mapExtend

Get a single building within given bounds

Parameters

mapExtend

The geographic bounds, defined by north, south, west and east

getBuildingWithinBounds:completionHandler:

- (void) getBuildingWithinBounds:		(nonnull MPMapExtend *)	mapExtend
completionHandler:		(nullable mpBuildingDetailsHandlerBlockType)	handler

Get a single building within given bounds

Parameters

mapExtend	The geographic bounds, defined by north, south, west and east
handler	Building fetch callback block

getDataFromPoint:

+ (nullable NSDictionary *) getDataFromPoint:

(nonnull MPPoint *)

point

Synchronously get all possible data related to the provided geographical point.

Parameters

point

Geographic point

Returns

A dictionary of venue, building and floor objects. Can be empty.

getDataFromPoint:completionHandler:

- (void) getDataFromPoint:		(nonnull MPPoint *)	point
completionHandler:		(nullable mpGeocodeHandlerBlockType)	completionHandler

Get all possible data related to the provided geographical point. Callback arguments will be nullable venue, building and floor objects.

Parameters

point	Geographic point
completionHandler	Data fetch callback block. Arguments will be nullable venue, building and floor objects.

getVenues

- (void) getVenues

Get venues from this provider

getVenuesWithCompletion:

- (void) getVenuesWithCompletion:

(nullable mpVenueListHandlerBlockType)

handler

Get all venues from this provider

Parameters

handler

Venue fetch callback block

getVenueWithId:

- (void) getVenueWithId:

(nonnull NSString *)

venueId

Get a single venue object

Parameters

venueId

Venue id

getVenueWithId:completionHandler:

- (void) getVenueWithId:		(nonnull NSString *)	venueId
completionHandler:		(nullable mpVenueDetailsHandlerBlockType)	handler

Get single venue details object

Parameters

venueId	Venue id
handler	Venue details fetch callback block

isOfflineDataAvailableForSolutionId:language:

+ (BOOL) isOfflineDataAvailableForSolutionId:		(nonnull NSString *)	solutionId
language:		(nonnull NSString *)	language

Determine if cached or preloaded data is available for the given solutionId.

Parameters

solutionId	solutionId to checkfor offline data availability.
language	language to check for offline availability.

Returns

YES if offline or preloaded data is available, else NO,

Property Documentation

delegate

- (id<MPVenueProviderDelegate>) delegate

readwritenonatomicweak

Venue provider delegate.