HorizonOptions

data class HorizonOptions(val elementTypes: List<HorizonElementType>, val mainPathSearchOptions: MainPathOptions, val subPathSearchOptions: List<SubPathOptions> = listOf(), val numberOfPaths: Int = 1)

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 four types of search options:

  1. the set of horizon element types the client is interested in,

  2. path search options for the main path,

  3. path search options for the sub-paths,

  4. the maximum number of paths the client can receive.

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

Parameters

elementTypes

Types of horizon element of interest.

mainPathSearchOptions

Search options for the main path.

subPathSearchOptions

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

numberOfPaths

Maximum number of paths the client can receive.

Throws

Constructors

Link copied to clipboard
constructor(elementTypes: List<HorizonElementType>, mainPathSearchOptions: MainPathOptions, subPathSearchOptions: List<SubPathOptions> = listOf(), numberOfPaths: Int = 1)

Properties

Link copied to clipboard
Link copied to clipboard