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
K
extends UI_BUTTON
Parameters
name
K
args?
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
>
onShowCustomView
• onShowCustomView: (...__namedParameters
: CustomViewCallbackInfo
) => Nullable
<boolean
> | Promise
<Nullable
<boolean
>>
Type declaration
▸ (...«destructured»
): Nullable
<boolean
> | Promise
<Nullable
<boolean
>>
Parameters
...«destructured»
Returns
Nullable
<boolean
> | Promise
<Nullable
<boolean
>>
Methods
onBackToWebsite
▸ onBackToWebsite(): void
Gets called when the configuring is paused and the user leaves fullscreen configurator mode
Returns
void
onCollapseDrawer
▸ onCollapseDrawer(_wasChangeBetweenDesktopAndMobile
): void
Parameters
_wasChangeBetweenDesktopAndMobile
boolean
Returns
void
onExpandDrawer
▸ onExpandDrawer(_wasChangeBetweenDesktopAndMobile
): void
Parameters
_wasChangeBetweenDesktopAndMobile
boolean
Returns
void
onHideCustomView
▸ onHideCustomView(...«destructured»
): void
Parameters
...«destructured»
Returns
void
onHidePopUp
▸ onHidePopUp(): void
Returns
void
onPartListUpdate
▸ onPartListUpdate(partList
, hash
): void
fullList fullList (needed for price calculation) of the current configuration
Parameters
partList
KernelPartList
the part list with all details, grouped, etc
hash
string
-
Returns
void
onPlanElementAdded
▸ onPlanElementAdded(addedObject
): void
Called when an element is added to the plan, not called when wall or construction element added
Parameters
addedObject
UiPlanObject
Returns
void
onPlanElementChanged
▸ onPlanElementChanged(changedObject
): void
Called when an element is changed in the plan, not called when wall or construction element changed
Parameters
changedObject
UiPlanObject
Returns
void
onPlanElementMoved
▸ onPlanElementMoved(changedObject
): void
Called when an element is moved in the plan, not called when wall or construction element is moved
Parameters
changedObject
UiPlanObject
Returns
void
onPlanElementRemoved
▸ onPlanElementRemoved(removedObject
): void
Called when an element is removed from the plan, not called when wall or construction element removed
Parameters
removedObject
UiPlanObject
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
objects
UiPlanObject
[]
all objects in the plan
Returns
void
onRequestPlan
▸ onRequestPlan(planId
, image
, items
, plan
): void
Parameters
planId
string
image
Base64Image
items
any
[]
plan
any
Returns
void
onRequestProduct
▸ onRequestProduct(configurationId
, image
, partList
, price
, labels
, configuration
): void
Returns all necessary params when 'Request Product'/'Checkout' button has pressed
Parameters
configurationId
string
id of the current configuration
image
Base64Image
image of the current configuration
partList
KernelPartList
the part list with all details, grouped, etc
configuration
RapiConfigurationEnhanced
| ExternalConfiguration
the data returned from the Roomle backend
Returns
void
onResize
▸ onResize(isDesktop
): void
Parameters
isDesktop
boolean
Returns
void
onSaveDraft
▸ onSaveDraft(id
, image
, url
, data
): void
called when triggerSaveDraft called
Parameters
id
string
configuration id or plan id
image
string
image of the current configuration
url
string
generated url from save draft
data
object contains { type: 'plan' | 'configuration', payload: configuration object or plan snapshot data}
Returns
void
onShowPopUp
▸ onShowPopUp(): void
Returns
void
onSidebarEvent
▸ onSidebarEvent(...«destructured»
): void
Parameters
...«destructured»
SidebarEventCallbackInfo
Returns
void
onTooltipClose
▸ onTooltipClose(tooltipName
): void
Gets triggered if a tooltip gets closed by controls button
Parameters
tooltipName
string
Returns
void
onUseFullPage
▸ onUseFullPage(): void
Returns
void
Last updated