Embedding API Reference / Modules / exposed-api / <internal> / SdkConnector
# Class: SdkConnector
exposed-api.<internal>.SdkConnector
# Table of contents
# Constructors
# Accessors
- configuratorApi
- configuratorConnector
- hasPlanner
- plannerApi
- plannerConnector
- viewerApi
- viewerConnector
# Methods
- addUiCallback
- canvasElementReady
- createExposedApi
- getRapiAccess
- getStorage
- getTenant
- giveGaConsent
- goBack
- hasActivePackage
- initCanvasElement
- initialized
- isCorrectConfiguratorDomain
- isIdAGlb
- loadComponent
- loadConfigurableItem
- loadConfiguration
- loadConfigurationString
- loadObject
- loadPlan
- loadSelectedPlanObject
- loadStaticItem
- preparePerspectiveImage
- removeUiCallback
- saveConfigToIdb
- saveCurrentConfiguration
- saveCurrentObject
- setMessageHandler
- setParameter
- waitForLoad
# Constructors
# constructor
• new SdkConnector(sdkWrapper
, store
, analytics?
, embeddingCallbacks?
, eventEmitter?
): SdkConnector
# Parameters
Name | Type | Default value |
---|---|---|
sdkWrapper | RoomleSdkWrapper | undefined |
store | Store <StoreState > | undefined |
analytics | Nullable <Analytics > | null |
embeddingCallbacks | Nullable <ExposedCallbacks > | null |
eventEmitter | Nullable <default > | null |
# Returns
# Defined in
src/configurator/business-logic/sdk-connector.ts:197 (opens new window)
# Accessors
# configuratorApi
• get
configuratorApi(): Promise
<default
>
# Returns
Promise
<default
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:173 (opens new window)
# configuratorConnector
• get
configuratorConnector(): Promise
<SdkConnectorConfigurator
>
# Returns
Promise
<SdkConnectorConfigurator
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:146 (opens new window)
# hasPlanner
• get
hasPlanner(): boolean
# Returns
boolean
# Defined in
src/configurator/business-logic/sdk-connector.ts:741 (opens new window)
# plannerApi
• get
plannerApi(): Promise
<default
>
# Returns
Promise
<default
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:181 (opens new window)
# plannerConnector
• get
plannerConnector(): Promise
<SdkConnectorPlanner
>
# Returns
Promise
<SdkConnectorPlanner
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:164 (opens new window)
# viewerApi
• get
viewerApi(): Promise
<default
>
# Returns
Promise
<default
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:189 (opens new window)
# viewerConnector
• get
viewerConnector(): Promise
<SdkConnectorViewer
>
# Returns
Promise
<SdkConnectorViewer
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:155 (opens new window)
# Methods
# addUiCallback
▸ addUiCallback(listener
): void
# Parameters
Name | Type |
---|---|
listener | UiCallbacks |
# Returns
void
Deprecated
use .configuratorConnector.then((connector) => connector.addUiCallback(listener))
# Defined in
src/configurator/business-logic/sdk-connector.ts:281 (opens new window)
# canvasElementReady
▸ canvasElementReady(element
): void
# Parameters
Name | Type |
---|---|
element | HTMLElement |
# Returns
void
# Defined in
src/configurator/business-logic/sdk-connector.ts:638 (opens new window)
# createExposedApi
▸ createExposedApi(module
): Promise
<void
>
# Parameters
Name | Type |
---|---|
module | SDK_MODULES |
# Returns
Promise
<void
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:215 (opens new window)
# getRapiAccess
▸ getRapiAccess(): Promise
<default
>
# Returns
Promise
<default
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:250 (opens new window)
# getStorage
▸ getStorage(): Nullable
<default
>
# Returns
Nullable
<default
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:508 (opens new window)
# getTenant
▸ getTenant(): Promise
<RapiTenant
>
# Returns
Promise
<RapiTenant
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:708 (opens new window)
# giveGaConsent
▸ giveGaConsent(): void
# Returns
void
# Defined in
src/configurator/business-logic/sdk-connector.ts:733 (opens new window)
# goBack
▸ goBack(): Promise
<void
>
# Returns
Promise
<void
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:261 (opens new window)
# hasActivePackage
▸ hasActivePackage(): Promise
<boolean
>
# Returns
Promise
<boolean
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:309 (opens new window)
# initCanvasElement
▸ initCanvasElement(module
): Promise
<void
>
# Parameters
Name | Type |
---|---|
module | SDK_MODULES |
# Returns
Promise
<void
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:645 (opens new window)
# initialized
▸ initialized(): void
# Returns
void
# Defined in
src/configurator/business-logic/sdk-connector.ts:246 (opens new window)
# isCorrectConfiguratorDomain
▸ isCorrectConfiguratorDomain(configuratorId
): Promise
<boolean
>
# Parameters
Name | Type |
---|---|
configuratorId | string |
# Returns
Promise
<boolean
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:314 (opens new window)
# isIdAGlb
▸ isIdAGlb(id
): Promise
<boolean
>
# Parameters
Name | Type |
---|---|
id | string |
# Returns
Promise
<boolean
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:629 (opens new window)
# loadComponent
▸ loadComponent(componentId
, initData?
): Promise
<Nullable
<LoadResponse
>>
# Parameters
Name | Type |
---|---|
componentId | string |
initData? | UiInitData |
# Returns
Promise
<Nullable
<LoadResponse
>>
# Defined in
src/configurator/business-logic/sdk-connector.ts:534 (opens new window)
# loadConfigurableItem
▸ loadConfigurableItem(configurableItemId
, initData?
): Promise
<Nullable
<LoadResponse
>>
# Parameters
Name | Type |
---|---|
configurableItemId | string |
initData? | UiInitData |
# Returns
Promise
<Nullable
<LoadResponse
>>
# Defined in
src/configurator/business-logic/sdk-connector.ts:608 (opens new window)
# loadConfiguration
▸ loadConfiguration(configurationId
, initData?
): Promise
<Nullable
<LoadResponse
>>
# Parameters
Name | Type |
---|---|
configurationId | string |
initData? | UiInitData |
# Returns
Promise
<Nullable
<LoadResponse
>>
# Defined in
src/configurator/business-logic/sdk-connector.ts:522 (opens new window)
# loadConfigurationString
▸ loadConfigurationString(configurationString
, initData?
): Promise
<Nullable
<LoadResponse
>>
# Parameters
Name | Type |
---|---|
configurationString | string |
initData? | UiInitData |
# Returns
Promise
<Nullable
<LoadResponse
>>
# Defined in
src/configurator/business-logic/sdk-connector.ts:585 (opens new window)
# 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
>>
# Defined in
src/configurator/business-logic/sdk-connector.ts:372 (opens new window)
# 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
> }>
# Defined in
src/configurator/business-logic/sdk-connector.ts:479 (opens new window)
# loadSelectedPlanObject
▸ loadSelectedPlanObject(shouldStartConfigure?
): Promise
<void
>
# Parameters
Name | Type | Default value |
---|---|---|
shouldStartConfigure | boolean | true |
# Returns
Promise
<void
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:549 (opens new window)
# loadStaticItem
▸ loadStaticItem(id
): Promise
<null
>
# Parameters
Name | Type |
---|---|
id | Nullable <string > |
# Returns
Promise
<null
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:457 (opens new window)
# preparePerspectiveImage
▸ preparePerspectiveImage(): Promise
<Base64Image
>
# Returns
Promise
<Base64Image
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:757 (opens new window)
# removeUiCallback
▸ removeUiCallback(listener
): void
# Parameters
Name | Type |
---|---|
listener | UiCallbacks |
# Returns
void
Deprecated
use configuratorConnector.then((connector) => connector.removeUiCallback(listener))
# Defined in
src/configurator/business-logic/sdk-connector.ts:291 (opens new window)
# saveConfigToIdb
▸ saveConfigToIdb(): Promise
<void
>
# Returns
Promise
<void
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:512 (opens new window)
# saveCurrentConfiguration
▸ saveCurrentConfiguration(): Promise
<RapiConfigurationEnhanced
>
# Returns
Promise
<RapiConfigurationEnhanced
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:728 (opens new window)
# saveCurrentObject
▸ saveCurrentObject(): Promise
<RapiConfigurationEnhanced
| RapiPlanSnapshotGetData
| RapiPlan
>
# Returns
Promise
<RapiConfigurationEnhanced
| RapiPlanSnapshotGetData
| RapiPlan
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:745 (opens new window)
# setMessageHandler
▸ setMessageHandler(messageHandler
): void
# Parameters
Name | Type |
---|---|
messageHandler | MessageHandler |
# Returns
void
# Defined in
src/configurator/business-logic/sdk-connector.ts:211 (opens new window)
# setParameter
▸ setParameter(parameter
, value
, isRaw?
): Promise
<void
>
# Parameters
Name | Type | Default value |
---|---|---|
parameter | KernelParameter | undefined |
value | string | undefined |
isRaw | boolean | false |
# Returns
Promise
<void
>
# Defined in
src/configurator/business-logic/sdk-connector.ts:297 (opens new window)
# waitForLoad
▸ waitForLoad(): Promise
<Nullable
<LoadResponse
>>
# Returns
Promise
<Nullable
<LoadResponse
>>
# Defined in
src/configurator/business-logic/sdk-connector.ts:254 (opens new window)