VenueEngine (API Reference)
Class VenueEngine
VenueEngine is an add-on to the base map functionality with its own content loading and cache. VenueEngine gives access to the venue functionality, which allows you to load and visualize venues on the map, search content inside venues etc.
-
Constructor Summary
ConstructorsConstructorDescriptionVenueEngine(SDKNativeEngine sdkEngine, VenueEngineInitCallback callback) Creates a new instance of this class.VenueEngine(VenueEngineInitCallback callback) Creates a new instance of this class. -
Method Summary
Modifier and TypeMethodDescriptionvoiddestroy()Releases all internally used resources.Gets a venue map to visualize venues.Gets the venue service.voidstart(AuthenticationCallback callback) Authenticates asynchronously using HERE SDK credentials and uses a result token to start theVenueService.voidAuthenticates asynchronously using HERE SDK credentials using a token to start theVenueService.
-
Constructor Details
-
VenueEngine
Creates a new instance of this class.
- Parameters:
callback-The optional callback that will be triggered when a venue engine initialization will be completed. After the initialization, the
VenueServiceshould be started using one of its methods or usingstart(String).- Throws:
InstantiationErrorException-Indicates what went wrong when the instantiation was attempted.
-
VenueEngine
public VenueEngine(@NonNull SDKNativeEngine sdkEngine, @Nullable VenueEngineInitCallback callback) throws InstantiationErrorException Creates a new instance of this class.
- Parameters:
sdkEngine-Instance of existing SDKEngine.
callback-The optional callback that will be triggered when a venue engine initialization will be completed. After the initialization, the
VenueServiceshould be started using one of its methods or usingstart(String).- Throws:
InstantiationErrorException-Indicates what went wrong when the instantiation was attempted.
-
-
Method Details
-
start
Authenticates asynchronously using HERE SDK credentials and uses a result token to start the
VenueService. An initialization status of the venue service is returned to objects registered asVenueServiceListener. If the authentication will fail, the venue service will not be started.- Parameters:
callback-The optional callback that will be triggered when the authentication will be completed. If the authentication fails, the venue service will not be started.
-
start
Authenticates asynchronously using HERE SDK credentials using a token to start the
VenueService. An initialization status of the venue service is returned to objects registered asVenueServiceListener. If the authentication will fail, the venue service will not be started.- Parameters:
token-SDK project scope token to be used for authentication
-
destroy
public void destroy()Releases all internally used resources. The instance can't be used anymore after calling this method.
-
getVenueService
Gets the venue service. This service can be used to load the venue model objects.
Gets the
VenueService. This service can be used to load theVenueModelobjects.- Returns:
The venue service.
-
getVenueMap
Gets a venue map to visualize venues.
Gets a venue map to visualize venues and control the state of the venues on the map. You need to start the
VenueServiceto be able to load venues.- Returns:
The venue map.
-