Interface AsukaRenderEngineAssembly

interface AsukaRenderEngineAssembly {
    autoPlace(componentId: string, options?: AsukaAssemblyMutationOptions): AsukaMutationPromise<AsukaAssemblyPlacementResult>;
    configure(patch: Partial<AsukaAssemblyState>, options?: AsukaAssemblyMutationOptions): AsukaMutationPromise<AsukaAssemblyState>;
    connect(connection: Partial<AsukaAssemblyConnection>, options?: AsukaAssemblyMutationOptions): AsukaMutationPromise<null | AsukaAssemblyConnection>;
    disconnect(connectionId: string, options?: AsukaAssemblyMutationOptions): AsukaMutationPromise<null | AsukaAssemblyConnection>;
    export(kind: AsukaAssemblyExportKind, options?: AsukaAssemblyExportOptions): Promise<Blob>;
    getBom(options?: {
        currency?: string;
    }): AsukaAssemblyBom;
    getComponent(id: string): null | AsukaAssemblyComponent;
    getQuote(options?: AsukaAssemblyQuoteOptions): AsukaAssemblyQuote;
    getState(): AsukaAssemblyState;
    listComponents(): AsukaAssemblyComponent[];
    place(componentId: string, input?: AsukaAssemblyPlacementInput, options?: AsukaAssemblyMutationOptions): AsukaMutationPromise<AsukaAssemblyPlacementResult>;
    previewPlacement(componentId: string, input?: AsukaAssemblyPlacementInput): AsukaAssemblyPlacementResult;
    syncCatalog(elements: AsukaElement[]): void;
    validate(): AsukaAssemblyValidation;
}

Index

Methods

autoPlace configure connect disconnect export getBom getComponent getQuote getState listComponents place previewPlacement syncCatalog validate

Methods

autoPlace

autoPlace(componentId, options?): AsukaMutationPromise<AsukaAssemblyPlacementResult>
Parameters
- componentId: string
- Optionaloptions: AsukaAssemblyMutationOptions
Returns AsukaMutationPromise<AsukaAssemblyPlacementResult>

configure

configure(patch, options?): AsukaMutationPromise<AsukaAssemblyState>
Parameters
- patch: Partial<AsukaAssemblyState>
- Optionaloptions: AsukaAssemblyMutationOptions
Returns AsukaMutationPromise<AsukaAssemblyState>

connect

connect(connection, options?): AsukaMutationPromise<null | AsukaAssemblyConnection>
Parameters
- connection: Partial<AsukaAssemblyConnection>
- Optionaloptions: AsukaAssemblyMutationOptions
Returns AsukaMutationPromise<null | AsukaAssemblyConnection>

disconnect

disconnect(connectionId, options?): AsukaMutationPromise<null | AsukaAssemblyConnection>
Parameters
- connectionId: string
- Optionaloptions: AsukaAssemblyMutationOptions
Returns AsukaMutationPromise<null | AsukaAssemblyConnection>

export

export(kind, options?): Promise<Blob>
Parameters
- kind: AsukaAssemblyExportKind
- Optionaloptions: AsukaAssemblyExportOptions
Returns Promise<Blob>

getBom

getBom(options?): AsukaAssemblyBom
Parameters
- Optionaloptions: {
  currency?: string;
  }
  - Optionalcurrency?: string
Returns AsukaAssemblyBom

getComponent

getComponent(id): null | AsukaAssemblyComponent
Parameters
- id: string
Returns null | AsukaAssemblyComponent

getQuote

getQuote(options?): AsukaAssemblyQuote
Parameters
- Optionaloptions: AsukaAssemblyQuoteOptions
Returns AsukaAssemblyQuote

getState

getState(): AsukaAssemblyState
Returns AsukaAssemblyState

listComponents

listComponents(): AsukaAssemblyComponent[]
Returns AsukaAssemblyComponent[]

place

place(componentId, input?, options?): AsukaMutationPromise<AsukaAssemblyPlacementResult>
Parameters
- componentId: string
- Optionalinput: AsukaAssemblyPlacementInput
- Optionaloptions: AsukaAssemblyMutationOptions
Returns AsukaMutationPromise<AsukaAssemblyPlacementResult>

previewPlacement

previewPlacement(componentId, input?): AsukaAssemblyPlacementResult
Parameters
- componentId: string
- Optionalinput: AsukaAssemblyPlacementInput
Returns AsukaAssemblyPlacementResult

syncCatalog

syncCatalog(elements): void
Parameters
- elements: AsukaElement[]
Returns void

validate

validate(): AsukaAssemblyValidation
Returns AsukaAssemblyValidation