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

Readonlyon

Readonlyonce

calculatePrices

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

• Parameters

  • request: PriceCalculationRequest

  Returns Promise<PriceCalculationResponse>

dispose

• dispose(): void

• Returns void

getKnownHostFeatures

• getKnownHostFeatures(): HostOperationFeatures[]

• Returns HostOperationFeatures[]

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

• Parameters

  • pin: string

  Returns Promise<RestoreResult<SP>>

save

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

• 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>(): undefined | Client<SP>

• 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 undefined | Client<SP>

  Static

StaticdetectHost

• detectHost(): ClientDetectedHost

• Returns ClientDetectedHost

StaticparseQueryParameters

• parseQueryParameters(queryString: string): Partial<ConfiguratorQueryParams>

• Returns all parsed and known configurator control query params

  Parameters

  • queryString: string

  Returns Partial<ConfiguratorQueryParams>

  Static