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

# Class: SdkConnector

exposed-api.<internal>.SdkConnector

# Table of contents

# Constructors

constructor

# Accessors

# Methods

# 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

SdkConnector

# Defined in

src/configurator/business-logic/sdk-connector.ts:201 (opens new window)

# Accessors

# configuratorApi

• get configuratorApi(): Promise<default>

# Returns

Promise<default>

# Defined in

src/configurator/business-logic/sdk-connector.ts:177 (opens new window)

# configuratorConnector

• get configuratorConnector(): Promise<SdkConnectorConfigurator>

# Returns

Promise<SdkConnectorConfigurator>

# Defined in

src/configurator/business-logic/sdk-connector.ts:150 (opens new window)

# hasPlanner

• get hasPlanner(): boolean

# Returns

boolean

# Defined in

src/configurator/business-logic/sdk-connector.ts:756 (opens new window)

# isE2E

• get isE2E(): boolean

# Returns

boolean

# Defined in

src/configurator/business-logic/sdk-connector.ts:146 (opens new window)

# plannerApi

• get plannerApi(): Promise<default>

# Returns

Promise<default>

# Defined in

src/configurator/business-logic/sdk-connector.ts:185 (opens new window)

# plannerConnector

• get plannerConnector(): Promise<SdkConnectorPlanner>

# Returns

Promise<SdkConnectorPlanner>

# Defined in

src/configurator/business-logic/sdk-connector.ts:168 (opens new window)

# viewerApi

• get viewerApi(): Promise<default>

# Returns

Promise<default>

# Defined in

src/configurator/business-logic/sdk-connector.ts:193 (opens new window)

# viewerConnector

• get viewerConnector(): Promise<SdkConnectorViewer>

# Returns

Promise<SdkConnectorViewer>

# Defined in

src/configurator/business-logic/sdk-connector.ts:159 (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:285 (opens new window)

# canvasElementReady

▸ canvasElementReady(element): void

# Parameters

Name	Type
`element`	`HTMLElement`

# Returns

void

# Defined in

src/configurator/business-logic/sdk-connector.ts:631 (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:219 (opens new window)

# getRapiAccess

▸ getRapiAccess(): Promise<default>

# Returns

Promise<default>

# Defined in

src/configurator/business-logic/sdk-connector.ts:254 (opens new window)

# getStorage

▸ getStorage(): Nullable<default>

# Returns

Nullable<default>

# Defined in

src/configurator/business-logic/sdk-connector.ts:513 (opens new window)

# getTenant

▸ getTenant(): Promise<RapiTenant>

# Returns

Promise<RapiTenant>

# Defined in

src/configurator/business-logic/sdk-connector.ts:723 (opens new window)

# giveGaConsent

▸ giveGaConsent(): void

# Returns

void

# Defined in

src/configurator/business-logic/sdk-connector.ts:748 (opens new window)

# goBack

▸ goBack(): Promise<void>

# Returns

Promise<void>

# Defined in

src/configurator/business-logic/sdk-connector.ts:265 (opens new window)

# hasActivePackage

▸ hasActivePackage(): Promise<boolean>

# Returns

Promise<boolean>

# Defined in

src/configurator/business-logic/sdk-connector.ts:313 (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:638 (opens new window)

# initConfigurator

▸ initConfigurator(): Promise<void>

# Returns

Promise<void>

# Defined in

src/configurator/business-logic/sdk-connector.ts:702 (opens new window)

# initialized

▸ initialized(): void

# Returns

void

# Defined in

src/configurator/business-logic/sdk-connector.ts:250 (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:318 (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:622 (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:539 (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:601 (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:527 (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:578 (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