@intelligentgraphics/openconfiguration.host
    Preparing search index...

    Interface FullHostOperations<SP>

    interface FullHostOperations<SP extends object> {
        calculatePrices?(
            request: PriceCalculationRequest,
        ): Promise<PriceCalculationResponse>;
        configurationUpdate(update: ConfigurationUpdate): void;
        executeCustom?(payload: { type: string }): Promise<unknown>;
        restore?(pin: string): Promise<RestoreResult<SP>>;
        save?(params: HostSaveParams<SP>): Promise<SaveResult>;
    }

    Type Parameters

    • SP extends object

    Hierarchy (View Summary)

    Index

    Methods

    calculatePrices? configurationUpdate executeCustom? restore? save?

    Methods

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

      Parameters

      • payload: { type: string }

      Returns Promise<unknown>

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

    Settings

    Member Visibility

    On This Page

    Methods