HorizonEngine

public protocol HorizonEngine

The HorizonEngine protocol is responsible for fetching horizon data.

Warning

This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.

  • Register for HorizonEngine updates with the following options.

    Declaration

    Swift

    func registerHorizonOptions(options: HorizonOptions) throws

    Parameters

    options

    The requested HorizonOptions.

  • Unregister for HorizonEngine updates on the following options.

    Declaration

    Swift

    func unregisterHorizonOptions(options: HorizonOptions) throws

    Parameters

    options

    The requested HorizonOptions.

  • Generate the horizon

    Declaration

    Swift

    func generateHorizon(
    options: [HorizonOptions],
    session: NavigationSnapshot
) throws -> [HorizonResponse]

    Parameters

    options

    List of requested Horizon Options.
    session

    The current navigation snapshot.

    Return Value

    An array with vehicle horizon results.