SYPlacesManager Class Reference

Represents a set of data about a physical place. More...

#import <SYPlacesManager.h>

Inheritance diagram for SYPlacesManager:

Collaboration diagram for SYPlacesManager:

Public Types
typedef void(^	SYPlacesManagerLoadPlacesBlock) (NSArray< SYPlace * > *_Nullable places, NSError *_Nullable error)
	Type of completion block for asynchronous loading places. More...
typedef void(^	SYPlacesManagerLoadPlaceLinkBlock) (SYPlaceLink *_Nullable link, NSError *_Nullable error)
typedef void(^	SYPlacesManagerAddIndividualPlacesBlock) (NSArray< SYIndividualPlaceId * > *_Nullable placeIds, NSError *_Nullable error)
typedef void(^	SYPlacesManagerRemoveIndividualPlacesBlock) (NSError *_Nullable error)
typedef void(^	SYPlacesManagerGetAvailableCategoriesBlock) (NSArray< SYPlaceCategoryGroupVisibility * > *_Nullable groups, NSError *_Nullable error)
typedef void(^	SYPlacesManagerSetVisibleCategoriesBlock) (NSError *_Nullable error)

Instance Methods
((unavailable("Use +[SYPlaces sharedPlaces] instead.")	- __attribute__
	SYPlaces is singleton, use [SYPlaces sharedPlaces] to access singleton instance. More...
(nonnull SYTask *)	- loadPlace:withCompletion:
	Load place detail information about map POI object. More...
(nonnull SYTask *)	- loadPlaces:withCompletion:
	Load places detail information about map POI objects. More...
(nonnull SYTask *)	- loadCity:withCompletion:
	Load detail information about map city object. More...
(nonnull SYTask *)	- loadExternalPlaceId:withCompletion:
	Load external place id. More...
(nonnull SYTask *)	- loadExternalPlaceIds:withCompletion:
	Load external place ids. More...
(nonnull SYTask *)	- loadEVConnector:withCompletion:
	Load ev connector detail informations about map POI EV Station object. More...
(void)	- addIndividualPlaces:completion:
	Add Individual Places. After the callback is delivered, these places shall be visible on the Map (if enabled) and also be present in the Navigation analyzers. Places with same identifiers will be replaced. More...
(void)	- removeIndividualPlaces:completion:
	Remove Individual Places. More...
(void)	- loadPlaceLinkWithId:completion:
	Load PlaceLink corresponding to the IndividualPlace with given id. More...
(void)	- getAvailableCategoriesWithCompletion:
	Get available groups of categories, which could be visible or hidden. More...
(void)	- setVisibleCategories:withCompletion:
	Set groups of categories with flag, if places of these categories should be visible or not. More...

Class Methods
(nonnull SYPlacesManager *)	+ sharedPlaces
	Returns SYPlaces singleton instance. More...
((unavailable("Use +[SYPlaces sharedPlaces] instead.")	+ __attribute__

Detailed Description

Represents a set of data about a physical place.

Member Typedef Documentation

SYPlacesManagerLoadPlacesBlock

- (typedef void(^ SYPlacesManagerLoadPlacesBlock) (NSArray< SYPlace * > *_Nullable places, NSError *_Nullable error))

Type of completion block for asynchronous loading places.

SYPlacesManagerLoadPlaceLinkBlock

- (typedef void(^ SYPlacesManagerLoadPlaceLinkBlock) (SYPlaceLink *_Nullable link, NSError *_Nullable error))

SYPlacesManagerAddIndividualPlacesBlock

- (typedef void(^ SYPlacesManagerAddIndividualPlacesBlock) (NSArray< SYIndividualPlaceId * > *_Nullable placeIds, NSError *_Nullable error))

SYPlacesManagerRemoveIndividualPlacesBlock

- (typedef void(^ SYPlacesManagerRemoveIndividualPlacesBlock) (NSError *_Nullable error))

SYPlacesManagerGetAvailableCategoriesBlock

- (typedef void(^ SYPlacesManagerGetAvailableCategoriesBlock) (NSArray< SYPlaceCategoryGroupVisibility * > *_Nullable groups, NSError *_Nullable error))

SYPlacesManagerSetVisibleCategoriesBlock

- (typedef void(^ SYPlacesManagerSetVisibleCategoriesBlock) (NSError *_Nullable error))

Method Documentation

sharedPlaces

+ (nonnull SYPlacesManager*) sharedPlaces

Returns SYPlaces singleton instance.

__attribute__ [1/2]

- ((unavailable("Use +[SYPlaces sharedPlaces] instead.") __attribute__

SYPlaces is singleton, use [SYPlaces sharedPlaces] to access singleton instance.

__attribute__ [2/2]

+ ((unavailable("Use +[SYPlaces sharedPlaces] instead.") __attribute__

loadPlace:withCompletion:

- (nonnull SYTask*) loadPlace:		(nonnull SYPlaceLink *)	link
withCompletion:		(nonnull void(^)(SYPlace *_Nullable place, NSError *_Nullable error))	completion

Load place detail information about map POI object.

loadPlaces:withCompletion:

- (nonnull SYTask*) loadPlaces:		(nonnull NSArray< SYPlaceLink * > *)	links
withCompletion:		(nonnull SYPlacesManagerLoadPlacesBlock)	completion

Load places detail information about map POI objects.

loadCity:withCompletion:

- (nonnull SYTask*) loadCity:		(nonnull SYCityLink *)	link
withCompletion:		(nonnull void(^)(SYCity *_Nullable city, NSError *_Nullable error))	completion

Load detail information about map city object.

loadExternalPlaceId:withCompletion:

- (nonnull SYTask*) loadExternalPlaceId:		(nonnull SYPlaceLink *)	link
withCompletion:		(nonnull void(^)(NSData *_Nullable id, NSError *_Nullable error))	completion

Load external place id.

loadExternalPlaceIds:withCompletion:

- (nonnull SYTask*) loadExternalPlaceIds:		(nonnull NSArray< SYPlaceLink * > *)	links
withCompletion:		(nonnull void(^)(NSArray< NSData * > *_Nullable id, NSError *_Nullable error))	completion

Load external place ids.

loadEVConnector:withCompletion:

- (nonnull SYTask*) loadEVConnector:		(nonnull SYPlaceLink *)	link
withCompletion:		(nonnull void(^)(NSArray< SYEVConnector * > *_Nullable connectors, NSError *_Nullable error))	completion

Load ev connector detail informations about map POI EV Station object.

addIndividualPlaces:completion:

- (void) addIndividualPlaces:		(nonnull NSArray< SYIndividualPlaceData * > *)	places
completion:		(nonnull SYPlacesManagerAddIndividualPlacesBlock)	completion

Add Individual Places. After the callback is delivered, these places shall be visible on the Map (if enabled) and also be present in the Navigation analyzers. Places with same identifiers will be replaced.

Parameters

places	Places to be added.
completion	Callback of the operation.

removeIndividualPlaces:completion:

- (void) removeIndividualPlaces:		(nonnull NSArray< SYIndividualPlaceId * > *)	placeIds
completion:		(nonnull SYPlacesManagerRemoveIndividualPlacesBlock)	completion

Remove Individual Places.

Parameters

places	IDs belonging to the places, which are to be removed.
completion	Callback of the operation.

loadPlaceLinkWithId:completion:

- (void) loadPlaceLinkWithId:		(nonnull SYIndividualPlaceId *)	placeId
completion:		(nonnull SYPlacesManagerLoadPlaceLinkBlock)	completion

Load PlaceLink corresponding to the IndividualPlace with given id.

Parameters

placeId	ID of the place returned by addIndividualPlaces
completion	Callback of the operation.

getAvailableCategoriesWithCompletion:

- (void) getAvailableCategoriesWithCompletion:

(nonnull SYPlacesManagerGetAvailableCategoriesBlock)

completion

Get available groups of categories, which could be visible or hidden.

Parameters

completion

Callback of the operation.

setVisibleCategories:withCompletion:

- (void) setVisibleCategories:		(nonnull NSArray< SYPlaceCategoryGroupVisibility * > *)	categories
withCompletion:		(nonnull SYPlacesManagerSetVisibleCategoriesBlock)	completion

Set groups of categories with flag, if places of these categories should be visible or not.

Parameters

categories	Array of categories with user visibility preference.
completion	Callback of the operation.

---

The documentation for this class was generated from the following file:

• SYPlacesManager.h