Class Client<SP>

constructor

• new Client<SP extends object = object>(config?: ClientConfig): Client<SP>

  Type Parameters

  • SP extends object = object

  Parameters

  • Optionalconfig: ClientConfig

  Returns Client<SP>

ReadonlyhostStatus

Readonlyoff

Readonlyon

Readonlyonce

calculatePrices

• calculatePrices(
      request: PriceCalculationRequest,
  ): Promise<PriceCalculationResponse>

  Calculates prices.

  Parameters

  • request: PriceCalculationRequest

  Returns Promise<PriceCalculationResponse>

  Since

  1.6.0

dispose

• dispose(): void

  Returns void

executeCustom

• executeCustom<R>(
      payload: { type: string; [property: string]: unknown },
  ): Promise<R>

  Executes a custom host operation.

  The payload is required to have a type attribute used to distinguish between different operations.

  If the host encounters an operation it is not equipped to handle, it should throw an error with the name set to NotSupportedError.

  Type Parameters

  • R

  Parameters

  • payload: { type: string; [property: string]: unknown }

  Returns Promise<R>

getKnownHostFeatures

• getKnownHostFeatures(): ("persist" | "prices" | "custom")[]

  Returns ("persist" | "prices" | "custom")[]

hasLegacyPlanningFeature

• hasLegacyPlanningFeature(): boolean

  Returns true if the host is not known or has a version that doesn't explicitly define it's features.

  Returns boolean

restore

• restore(pin: string): Promise<RestoreResult<SP>>

  Restores a planning from a backend.

  The backend should return the data that was saved with the pin.

  Will only be used when save is also implemented.

  Parameters

  • pin: string

  Returns Promise<RestoreResult<SP>>

save

• save(params: HostSaveParams<SP>): Promise<SaveResult>

  Saves plannings to a backend.

  The backend should return a pin that can be used to restore the planning.

  Will only be used when restore is also implemented.

  Parameters

  • params: HostSaveParams<SP>

  Returns Promise<SaveResult>

sendConfigurationUpdate

• sendConfigurationUpdate(update: ConfigurationUpdate): void

  Parameters

  • update: ConfigurationUpdate

  Returns void

sendExit

• sendExit(): void

  Returns void

sendFinish

• sendFinish(): void

  Returns void

sendInitialized

• sendInitialized(): void

  Returns void

sendStarted

• sendStarted(clientConfigurationOperations?: ClientConfigurationOperations): void

  Parameters

  • OptionalclientConfigurationOperations: ClientConfigurationOperations

  Returns void

sendStartedError

• sendStartedError(error: ConfiguratorEventError): void

  Parameters

  • error: ConfiguratorEventError

  Returns void

StaticcreateIfNecessary

• createIfNecessary<SP extends object = object>(): Client<SP> | undefined

  Creates a client if a parent window exists.

  This does not mean, that an actual ConfiguratorControlHost exists. It might exist, but we can't know for sure

  Type Parameters

  • SP extends object = object

  Returns Client<SP> | undefined

  Static

StaticdetectHost

• detectHost(): ClientDetectedHost

  Returns ClientDetectedHost

StaticparseQueryParameters

• parseQueryParameters(queryString: string): ConfiguratorQueryParams

  Returns all parsed and known configurator control query params

  Parameters

  • queryString: string

  Returns ConfiguratorQueryParams

  Static