HorizonOptions

public struct HorizonOptions
extension HorizonOptions: Hashable

Horizon subscription configuration. The client uses subscription options to define the extent of the paths in the horizon and the map attributes that are collected for these paths. A subscription configuration consists of search options, such as the path search distance and the path search time, as well as a set of types of horizon elements that the client is interested in. The search distance and time determine the length of the horizon paths. The set of horizon element types determines which map attributes will be collected for those paths.

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: MainPathOptions

  • The options for searching for the each subPath level. The position in the array determines the subPath level value.

    Declaration

    Swift

    public let subPathSearchOptions: [SubPathOptions]

  • Maximum number of paths that can be returned.

    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)