Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

ExposedApi.Internal.SdkConnector

Class: SdkConnector

exposed-api.<internal>.SdkConnector

Table of contents

Constructors

Accessors

Methods

Constructors

constructor

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

Parameters

Name
Type

store

Store<StoreState>

analytics

embeddingCallbacks

eventEmitter

libs

Returns

Accessors

configuratorApi

• get configuratorApi(): Promise<RoomleConfiguratorType>

Returns


configuratorConnector

• get configuratorConnector(): Promise<SdkConnectorConfigurator>

Returns


hasPlanner

• get hasPlanner(): boolean

Returns

boolean


isE2E

• get isE2E(): boolean

Returns

boolean


plannerApi

• get plannerApi(): Promise<RoomlePlannerWithExtObjs>

Returns


plannerConnector

• get plannerConnector(): Promise<SdkConnectorPlanner>

Returns


viewerApi

• get viewerApi(): Promise<default>

Returns

Promise<default>


viewerConnector

• get viewerConnector(): Promise<SdkConnectorViewer>

Returns

Methods

addUiCallback

▸ addUiCallback(listener): void

Parameters

Name
Type

listener

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

mainMessageHandler

eventEmitter

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

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?

Returns


loadConfigurableItem

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

Parameters

Name
Type

configurableItemId

string

initData?

Returns


loadConfiguration

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

Parameters

Name
Type

configurationId

string

initData?

Returns


loadConfigurationString

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

Parameters

Name
Type

configurationString

string

initData?

Returns


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


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

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

Last updated