ExposedCallbacks.ExposedCallbacks
Embedding API Reference / Modules / exposed-callbacks / ExposedCallbacks
Class: ExposedCallbacks
exposed-callbacks.ExposedCallbacks
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new ExposedCallbacks(): ExposedCallbacks
Returns
Properties
onButtonClicked
• onButtonClicked: <K>(name
: K
, args?
: ButtonCallbackPayloads
[K
]) => boolean
| void
| Promise
<boolean
>
Gets called when a button in the UI is clicked
Type declaration
▸ <K
>(name
, args?
): boolean
| void
| Promise
<boolean
>
Type parameters
Name | Type |
---|---|
| extends |
Parameters
Name | Type | Description |
---|---|---|
|
| |
| Optional arguments specific to the button that was clicked. This parameter is an object where each key is a UI_BUTTON and the value is the corresponding arguments for that button. |
Returns
boolean
| void
| Promise
<boolean
>
Methods
onBackToWebsite
▸ onBackToWebsite(): void
Gets called when the configuring is paused and the user leaves fullscreen configurator mode
Returns
void
onPartListUpdate
▸ onPartListUpdate(partList
, hash
): void
fullList fullList (needed for price calculation) of the current configuration
Parameters
Name | Type | Description |
---|---|---|
|
| the part list with all details, grouped, etc |
|
| - |
Returns
void
onPlanElementAdded
▸ onPlanElementAdded(addedObject
): void
Called when an element is added to the plan, not called when wall or construction element added
Parameters
Name | Type |
---|---|
|
|
Returns
void
onPlanElementChanged
▸ onPlanElementChanged(changedObject
): void
Called when an element is changed in the plan, not called when wall or construction element changed
Parameters
Name | Type |
---|---|
|
|
Returns
void
onPlanElementRemoved
▸ onPlanElementRemoved(removedObject
): void
Called when an element is removed from the plan, not called when wall or construction element removed
Parameters
Name | Type |
---|---|
|
|
Returns
void
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 |
---|---|---|
|
| all objects in the plan |
Returns
void
onRequestPlan
▸ onRequestPlan(planId
, image
, items
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
onRequestProduct
▸ onRequestProduct(configurationId
, image
, partList
, price
, labels
, configuration
): void
Returns all necessary params when 'Request Product'/'Checkout' button has pressed
Parameters
Name | Type | Description |
---|---|---|
|
| id of the current configuration |
|
| image of the current configuration |
|
| the part list with all details, grouped, etc |
| price of the current configuration, either set via setPrice or from Roomle price service | |
| the label of the catalog and the furniture system | |
|
| the data returned from the Roomle backend |
Returns
void
onResize
▸ onResize(isDesktop
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
onSaveDraft
▸ onSaveDraft(id
, image
, url
, data
): void
called when triggerSaveDraft called
Parameters
Name | Type | Description |
---|---|---|
|
| configuration id or plan id |
|
| image of the current configuration |
|
| generated url from save draft |
|
| object contains { type: 'plan' | 'configuration', payload: configuration object or plan snapshot data} |
Returns
void
onTooltipClose
▸ onTooltipClose(tooltipName
): void
Gets triggered if a tooltip gets closed by controls button
Parameters
Name | Type |
---|---|
|
|
Returns
void
onUseFullPage
▸ onUseFullPage(): void
Returns
void
Last updated