ExposedApi.Internal.SdkConnector

Embedding API Reference / Modules / exposed-api / <internal> / SdkConnector

Class: SdkConnector

exposed-api.<internal>.SdkConnector

Table of contents

Constructors

• constructor

Accessors

• configuratorApi
• configuratorConnector
• hasPlanner
• isE2E
• plannerApi
• plannerConnector
• viewerApi
• viewerConnector

Methods

• addUiCallback
• canvasElementReady
• createExposedApi
• getRapiAccess
• getStorage
• getTenant
• giveGaConsent
• goBack
• hasActivePackage
• initCanvasElement
• initConfigurator
• initialized
• isCorrectConfiguratorDomain
• isIdAGlb
• loadComponent
• loadConfigurableItem
• loadConfiguration
• loadConfigurationString
• loadObject
• loadPlan
• loadSelectedPlanObject
• loadStaticItem
• preparePerspectiveImage
• removeUiCallback
• saveConfigToIdb
• saveCurrentConfiguration
• saveCurrentObject
• saveCurrentPlanOrConfiguration
• setParameter
• waitForLoad

Constructors

constructor

• new SdkConnector(sdkWrapper, store, analytics, embeddingCallbacks, eventEmitter, intl, libs): SdkConnector

Parameters

Name	Type
sdkWrapper	RoomleSdkWrapper
store	Store<StoreState>
analytics	Analytics
embeddingCallbacks	ExposedCallbacks
eventEmitter	default
intl	Translator
libs	Libs

Returns

SdkConnector

Accessors

configuratorApi

• get configuratorApi(): Promise<RoomleConfiguratorType>

Returns

Promise<RoomleConfiguratorType>

---

configuratorConnector

• get configuratorConnector(): Promise<SdkConnectorConfigurator>

Returns

Promise<SdkConnectorConfigurator>

---

hasPlanner

• get hasPlanner(): boolean

Returns

boolean

---

isE2E

• get isE2E(): boolean

Returns

boolean

---

plannerApi

• get plannerApi(): Promise<RoomlePlannerWithExtObjs>

Returns

Promise<RoomlePlannerWithExtObjs>

---

plannerConnector

• get plannerConnector(): Promise<SdkConnectorPlanner>

Returns

Promise<SdkConnectorPlanner>

---

viewerApi

• get viewerApi(): Promise<default>

Returns

Promise<default>

---

viewerConnector

• get viewerConnector(): Promise<SdkConnectorViewer>

Returns

Promise<SdkConnectorViewer>

Methods

addUiCallback

▸ addUiCallback(listener): void

Parameters

Name	Type
listener	UiCallbacks

Returns

void

Deprecated

use .configuratorConnector.then((connector) => connector.addUiCallback(listener))

---

canvasElementReady

▸ canvasElementReady(element): void

Parameters

Name	Type
element	HTMLElement

Returns

void

---

createExposedApi

▸ createExposedApi(module, mainMessageHandler, eventEmitter): Promise<void>

Parameters

Name	Type
module	SDK_MODULES
mainMessageHandler	MessageHandler
eventEmitter	default

Returns

Promise<void>

---

getRapiAccess

▸ getRapiAccess(): Promise<default>

Returns

Promise<default>

---

getStorage

▸ getStorage(): Nullable<default>

Returns

Nullable<default>

---

getTenant

▸ getTenant(): Promise<RapiTenant>

Returns

Promise<RapiTenant>

---

giveGaConsent

▸ giveGaConsent(): void

Returns

void

---

goBack

▸ goBack(): Promise<void>

Returns

Promise<void>

---

hasActivePackage

▸ hasActivePackage(): Promise<boolean>

Returns

Promise<boolean>

---

initCanvasElement

▸ initCanvasElement(module): Promise<void>

Parameters

Name	Type
module	SDK_MODULES

Returns

Promise<void>

---

initConfigurator

▸ initConfigurator(): Promise<void>

Returns

Promise<void>

---

initialized

▸ initialized(): void

Returns

void

---

isCorrectConfiguratorDomain

▸ isCorrectConfiguratorDomain(): Promise<boolean>

Returns

Promise<boolean>

---

isIdAGlb

▸ isIdAGlb(id): Promise<boolean>

Parameters

Name	Type
id	string

Returns

Promise<boolean>

---

loadComponent

▸ loadComponent(componentId, initData?): Promise<Nullable<LoadResponse>>

Parameters

Name	Type
componentId	string
initData?	UiInitData

Returns

Promise<Nullable<LoadResponse>>

---

loadConfigurableItem

▸ loadConfigurableItem(configurableItemId, initData?): Promise<Nullable<LoadResponse>>

Parameters

Name	Type
configurableItemId	string
initData?	UiInitData

Returns

Promise<Nullable<LoadResponse>>

---

loadConfiguration

▸ loadConfiguration(configurationId, initData?): Promise<Nullable<LoadResponse>>

Parameters

Name	Type
configurationId	string
initData?	UiInitData

Returns

Promise<Nullable<LoadResponse>>

---

loadConfigurationString

▸ loadConfigurationString(configurationString, initData?): Promise<Nullable<LoadResponse>>

Parameters

Name	Type
configurationString	string
initData?	UiInitData

Returns

Promise<Nullable<LoadResponse>>

---

loadObject

▸ loadObject(id): Promise<Nullable<LoadResponse>>

Load a object which can be one of the following:

• Component (use your component id and prefix it with 'component@', e.g. component@demoCatalogId:externalMeshes)
• Plan
• Static item (e.g. GLB)
• Configurable Item
• Configuration

Parameters

Name	Type
id	string

Returns

Promise<Nullable<LoadResponse>>

---

loadPlan

▸ loadPlan(id, options?): Promise<{ objectRuntimeId: Nullable<number> ; plan: Nullable<void> }>

Parameters

Name	Type
id	Nullable<string>
options	Object
options.doNotFinishLoading?	boolean
options.isObjectId?	boolean

Returns

Promise<{ objectRuntimeId: Nullable<number> ; plan: Nullable<void> }>

---

loadSelectedPlanObject

▸ loadSelectedPlanObject(shouldStartConfigure?): Promise<void>

Parameters

Name	Type	Default value
shouldStartConfigure	boolean	true

Returns

Promise<void>

---

loadStaticItem

▸ loadStaticItem(id): Promise<null>

Parameters

Name	Type
id	Nullable<string>

Returns

Promise<null>

---

preparePerspectiveImage

▸ preparePerspectiveImage(): Promise<Base64Image>

Returns

Promise<Base64Image>

---

removeUiCallback

▸ removeUiCallback(listener): void

Parameters

Name	Type
listener	UiCallbacks

Returns

void

Deprecated

use configuratorConnector.then((connector) => connector.removeUiCallback(listener))

---

saveConfigToIdb

▸ saveConfigToIdb(): Promise<void>

Returns

Promise<void>

---

saveCurrentConfiguration

▸ saveCurrentConfiguration(): Promise<RapiConfigurationEnhanced | ExternalConfiguration>

Returns

Promise<RapiConfigurationEnhanced | ExternalConfiguration>

---

saveCurrentObject

▸ saveCurrentObject(): Promise<RapiConfigurationEnhanced | RapiPlanSnapshotGetData | RapiPlan | ExternalConfiguration>

Returns

Promise<RapiConfigurationEnhanced | RapiPlanSnapshotGetData | RapiPlan | ExternalConfiguration>

---

saveCurrentPlanOrConfiguration

▸ saveCurrentPlanOrConfiguration(): Promise<RapiConfigurationEnhanced | RapiPlanSnapshotGetData | ExternalConfiguration>

Returns

Promise<RapiConfigurationEnhanced | RapiPlanSnapshotGetData | ExternalConfiguration>

---

setParameter

▸ setParameter(parameter, value, isRaw?): Promise<void>

Parameters

Name	Type	Default value
parameter	KernelParameter	undefined
value	string	undefined
isRaw	boolean	false

Returns

Promise<void>

---

waitForLoad

▸ waitForLoad(): Promise<Nullable<LoadResponse>>

Returns

Promise<Nullable<LoadResponse>>