ExposedApi.Internal.SdkConnector
Embedding API Reference / Modules / exposed-api / <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
Returns
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
listener
Returns
void
Deprecated
use .configuratorConnector.then((connector) => connector.addUiCallback(listener))
canvasElementReady
â–¸ canvasElementReady(element
): void
Parameters
element
HTMLElement
Returns
void
createExposedApi
â–¸ createExposedApi(module
, mainMessageHandler
, eventEmitter
): Promise
<void
>
Parameters
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
module
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
id
string
Returns
Promise
<boolean
>
loadComponent
â–¸ loadComponent(componentId
, initData?
): Promise
<Nullable
<LoadResponse
>>
Parameters
componentId
string
initData?
Returns
Promise
<Nullable
<LoadResponse
>>
loadConfigurableItem
â–¸ loadConfigurableItem(configurableItemId
, initData?
): Promise
<Nullable
<LoadResponse
>>
Parameters
configurableItemId
string
initData?
Returns
Promise
<Nullable
<LoadResponse
>>
loadConfiguration
â–¸ loadConfiguration(configurationId
, initData?
): Promise
<Nullable
<LoadResponse
>>
Parameters
configurationId
string
initData?
Returns
Promise
<Nullable
<LoadResponse
>>
loadConfigurationString
â–¸ loadConfigurationString(configurationString
, initData?
): Promise
<Nullable
<LoadResponse
>>
Parameters
configurationString
string
initData?
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
id
string
Returns
Promise
<Nullable
<LoadResponse
>>
loadPlan
â–¸ loadPlan(id
, options?
): Promise
<{ objectRuntimeId
: Nullable
<number
> ; plan
: Nullable
<void
> }>
Parameters
Returns
Promise
<{ objectRuntimeId
: Nullable
<number
> ; plan
: Nullable
<void
> }>
loadSelectedPlanObject
â–¸ loadSelectedPlanObject(shouldStartConfigure?
): Promise
<void
>
Parameters
shouldStartConfigure
boolean
true
Returns
Promise
<void
>
loadStaticItem
â–¸ loadStaticItem(id
): Promise
<null
>
Parameters
id
Nullable
<string
>
Returns
Promise
<null
>
preparePerspectiveImage
â–¸ preparePerspectiveImage(): Promise
<Base64Image
>
Returns
Promise
<Base64Image
>
removeUiCallback
â–¸ removeUiCallback(listener
): void
Parameters
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
parameter
KernelParameter
undefined
value
string
undefined
isRaw
boolean
false
Returns
Promise
<void
>
waitForLoad
â–¸ waitForLoad(): Promise
<Nullable
<LoadResponse
>>
Returns
Promise
<Nullable
<LoadResponse
>>
Last updated