VenueEngine

public class VenueEngine
extension VenueEngine: NativeBase
extension VenueEngine: Hashable

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.

  • Creates a new instance of this class.

    Throws

    InstantiationError Indicates what went wrong when the instantiation was attempted.

    Declaration

    Swift

    public init(callback: VenueEngineInitCompletionHandler?) throws

    Parameters

    callback

    The optional callback that will be triggered when a venue engine initialization will be completed. After the initialization, the VenueService should be started using one of its methods or using VenueEngine.start(String).

  • Creates a new instance of this class.

    Throws

    InstantiationError Indicates what went wrong when the instantiation was attempted.

    Declaration

    Swift

    public init(_ sdkEngine: SDKNativeEngine, callback: VenueEngineInitCompletionHandler?) throws

    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 VenueService should be started using one of its methods or using VenueEngine.start(String).

  • The venue service. Gets the VenueService. This service can be used to load the VenueModel objects.

    Declaration

    Swift

    public var venueService: VenueService { get }

  • The venue map. Gets a venue map to visualize venues and control the state of the venues on the map. You need to start the VenueService to be able to load venues.

    Declaration

    Swift

    public var venueMap: VenueMap { get }

  • 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 as VenueServiceDelegate. If the authentication will fail, the venue service will not be started.

    Declaration

    Swift

    public func start(callback: AuthenticationCompletionHandler?)

    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.

  • 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 as VenueServiceDelegate. If the authentication will fail, the venue service will not be started.

    Declaration

    Swift

    public func start(token: String)

    Parameters

    token

    SDK project scope token to be used for authentication

  • Releases all internally used resources. The instance can’t be used anymore after calling this method.

    Declaration

    Swift

    public func destroy()