HorizonOptions

public struct HorizonOptions
extension HorizonOptions: Hashable

Horizon options define the extent of the paths in the horizon and the map attributes to be collected for these paths. A set of horizon options consists of the following: A subscription configuration consists of four types of search options:

  1. The set of horizon element types the client is interested in
  2. The path search options for the main path (the path that the user is currently on, extending along the most likely trajectory).
  3. The path search options for the sub-paths (any horizon path that is not the main path).
  4. The maximum number of paths the client can receive.

    5. Important

    This is a Public Preview API. It may be changed or removed at any time.

Public

  • id

    Unique ID of the HorizonOptions

    Declaration

    Swift

    public let id: UUID

  • The requested element types.

    Declaration

    Swift

    public let elementTypes: [HorizonElementType]

  • The options for searching for the main path

    Declaration

    Swift

    public let mainPathSearchOptions: MainPathSearchOptions

  • Search options for sub-path levels. The container element at index i encodes search options for path level i + 1. The horizon is extended to the deepest sub-path level, as specified by the search options for sub-path levels.

    Declaration

    Swift

    public let subPathSearchOptions: [SubPathSearchOptions]

  • Maximum number of paths the client can receive. The default value is 1.

    Declaration

    Swift

    public let numberOfPaths: Int

Hashable

  • Declaration

    Swift

    public static func == (lhs: HorizonOptions, rhs: HorizonOptions) -> Bool

  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)

HorizonOptions.InitializationError

  • An error that occurs during the creation of the instance.

    See more

    Declaration

    Swift

    public enum InitializationError : Error