Embedding API Reference / Modules / exposed-callbacks / ExposedCallbacks

# Class: ExposedCallbacks

exposed-callbacks.ExposedCallbacks

# Table of contents

# Constructors

constructor

# Methods

# Constructors

# constructor

• new ExposedCallbacks(): ExposedCallbacks

# Returns

ExposedCallbacks

# Methods

# onBackToWebsite

▸ onBackToWebsite(): void

Gets called when the configuring is paused and the user leaves fullscreen configurator mode

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:57 (opens new window)

# onButtonClicked

▸ onButtonClicked(name): boolean | void | Promise<boolean>

Gets called when a button in the UI is clicked

# Parameters

Name	Type
`name`	`UI_BUTTON`

# Returns

boolean | void | Promise<boolean>

overrideEventBehaviour true if the event has been consumed and it should not trigger default behaviour, undefined or false otherwise

# Defined in

src/configurator/embedding/exposed-callbacks.ts:64 (opens new window)

# onPartListUpdate

▸ onPartListUpdate(partList, hash): void

fullList fullList (needed for price calculation) of the current configuration

# Parameters

Name	Type	Description
`partList`	`KernelPartList`	the part list with all details, grouped, etc
`hash`	`string`	-

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:46 (opens new window)

# onPlanElementAdded

▸ onPlanElementAdded(addedObject): void

Called when an element is added to the plan, not called when wall or construction element added

# Parameters

Name	Type
`addedObject`	`UiPlanObject`

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:84 (opens new window)

# onPlanElementChanged

▸ onPlanElementChanged(changedObject): void

Called when an element is changed in the plan, not called when wall or construction element changed

# Parameters

Name	Type
`changedObject`	`UiPlanObject`

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:97 (opens new window)

# onPlanElementRemoved

▸ onPlanElementRemoved(removedObject): void

Called when an element is removed from the plan, not called when wall or construction element removed

# Parameters

Name	Type
`removedObject`	`UiPlanObject`

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:90 (opens new window)

# onPlanUpdate

▸ onPlanUpdate(objects): void

Gets called if a plan object gets added, changed or removed and returns all objects of the plan

# Parameters

Name	Type	Description
`objects`	`UiPlanObject`[]	all objects in the plan

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:78 (opens new window)

# onRequestPlan

▸ onRequestPlan(planId, image, items): void

# Parameters

Name	Type
`planId`	`string`
`image`	`Base64Image`
`items`	`any`[]

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:68 (opens new window)

# onRequestProduct

▸ onRequestProduct(configurationId, image, partList, price, labels, configuration): void

Returns all necessary params when 'Request Product'/'Checkout' button has pressed

# Parameters

Name	Type	Description
`configurationId`	`string`	id of the current configuration
`image`	`Base64Image`	image of the current configuration
`partList`	`KernelPartList`	the part list with all details, grouped, etc
`price`	`Price`	price of the current configuration, either set via setPrice or from Roomle price service
`labels`	`Labels`	the label of the catalog and the furniture system
`configuration`	`RapiConfigurationEnhanced`	the data returned from the Roomle backend

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:33 (opens new window)

# onResize

▸ onResize(isDesktop): void

# Parameters

Name	Type
`isDesktop`	`boolean`

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:49 (opens new window)

# onSaveDraft

▸ onSaveDraft(id, image, url, data): void

called when triggerSaveDraft called

# Parameters

Name	Type	Description
`id`	`string`	configuration id or plan id
`image`	`string`	image of the current configuration
`url`	`string`	generated url from save draft
`data`	`SaveDraftPayload`	object contains { type: 'plan' \| 'configuration', payload: configuration object or plan snapshot data}

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:117 (opens new window)

# onTooltipClose

▸ onTooltipClose(tooltipName): void

Gets triggered if a tooltip gets closed by controls button

# Parameters

Name	Type
`tooltipName`	`string`

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:104 (opens new window)

# onUseFullPage

▸ onUseFullPage(): void

# Returns

void

# Defined in

src/configurator/embedding/exposed-callbacks.ts:51 (opens new window)