Documentation

# Class: default

configurator-core/src/configurator..default

# Implements

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

• new default(creator)

# Parameters

Name Type
creator string

# Defined in

packages/common-core/src/rapi-access.ts:224 (opens new window)

# Properties

# _creator_

• _creator_: string

# Implementation of

Context.creator

# Defined in

packages/common-core/src/rapi-access.ts:198 (opens new window)

# Methods

# changeUseOfHDGeometry

▸ changeUseOfHDGeometry(): void

# Returns

void

# Defined in

packages/common-core/src/rapi-access.ts:274 (opens new window)

# cleanUp

▸ cleanUp(): void

# Returns

void

# Defined in

packages/common-core/src/rapi-access.ts:528 (opens new window)

# combineMaterialsToGroups

▸ combineMaterialsToGroups(materials): Promise<RapiMaterialGroup[]>

# Parameters

Name Type
materials RapiMaterial[]

# Returns

Promise<RapiMaterialGroup[]>

# Defined in

packages/common-core/src/rapi-access.ts:813 (opens new window)

# createNewPlan

▸ createNewPlan(): RapiPlan

# Returns

RapiPlan

# Defined in

packages/common-core/src/rapi-access.ts:1770 (opens new window)

# export3D

▸ export3D(id, email, fileFormat, options?): Promise<unknown>

Export a configuration id into a given file format and send it via email

# Parameters

Name Type Description
id string
email string
fileFormat string check API documentation for valid formats
options object -

# Returns

Promise<unknown>

# Defined in

packages/common-core/src/rapi-access.ts:1649 (opens new window)

# getAdditionalContentsOfItems

▸ getAdditionalContentsOfItems(rapiItems): Promise<RapiAdditionalContent[]>

# Parameters

Name Type
rapiItems RapiItem[]

# Returns

Promise<RapiAdditionalContent[]>

# Defined in

packages/common-core/src/rapi-access.ts:417 (opens new window)

# getCatalog

▸ getCatalog(id): Promise<RapiCatalog>

# Parameters

Name Type
id string

# Returns

Promise<RapiCatalog>

# Defined in

packages/common-core/src/rapi-access.ts:357 (opens new window)

# getComponent

▸ getComponent(id): Promise<RapiComponent>

# Parameters

Name Type
id string

# Returns

Promise<RapiComponent>

# Defined in

packages/common-core/src/rapi-access.ts:317 (opens new window)

# getComponents

▸ getComponents(ids): Promise<RapiComponent[]>

# Parameters

Name Type
ids string[]

# Returns

Promise<RapiComponent[]>

# Defined in

packages/common-core/src/rapi-access.ts:335 (opens new window)

# getComponentsOf

▸ getComponentsOf(rapiJson): Promise<RapiComponent[]>

# Parameters

Name Type
rapiJson RapiJson

# Returns

Promise<RapiComponent[]>

# Defined in

packages/common-core/src/rapi-access.ts:411 (opens new window)

# getConfiguration

▸ getConfiguration(id): Promise<RapiConfiguration>

# Parameters

Name Type
id string

# Returns

Promise<RapiConfiguration>

# Defined in

packages/common-core/src/rapi-access.ts:321 (opens new window)

# getConfigurations

▸ getConfigurations(ids): Promise<RapiConfiguration[]>

# Parameters

Name Type
ids string[]

# Returns

Promise<RapiConfiguration[]>

# Defined in

packages/common-core/src/rapi-access.ts:325 (opens new window)

# getConfiguratorSettings

▸ getConfiguratorSettings(id): Promise<RapiConfiguratorSettings>

# Parameters

Name Type
id string

# Returns

Promise<RapiConfiguratorSettings>

# Defined in

packages/common-core/src/rapi-access.ts:1571 (opens new window)

# getCurrentSkin

▸ getCurrentSkin(): Promise<RapiSkin>

# Returns

Promise<RapiSkin>

# Defined in

packages/common-core/src/rapi-access.ts:1553 (opens new window)

# getHSCPackage

▸ getHSCPackage(id): Promise<void | RapiPackage>

# Parameters

Name Type
id string

# Returns

Promise<void | RapiPackage>

# Defined in

packages/common-core/src/rapi-access.ts:285 (opens new window)

# getItem

▸ getItem(id): Promise<RapiItem>

# Parameters

Name Type
id string

# Returns

Promise<RapiItem>

# Defined in

packages/common-core/src/rapi-access.ts:329 (opens new window)

# getItems

▸ getItems(ids): Promise<RapiItem[]>

# Parameters

Name Type
ids string[]

# Returns

Promise<RapiItem[]>

# Defined in

packages/common-core/src/rapi-access.ts:339 (opens new window)

# getItemsOf

▸ getItemsOf(rapiJson): Promise<RapiItem[]>

# Parameters

Name Type
rapiJson RapiJson

# Returns

Promise<RapiItem[]>

# Defined in

packages/common-core/src/rapi-access.ts:396 (opens new window)

# getMaterial

▸ getMaterial(id): Promise<RapiMaterial>

# Parameters

Name Type
id string

# Returns

Promise<RapiMaterial>

# Defined in

packages/common-core/src/rapi-access.ts:473 (opens new window)

# getMaterials

▸ getMaterials(ids): Promise<RapiMaterial[]>

# Parameters

Name Type
ids string[]

# Returns

Promise<RapiMaterial[]>

# Defined in

packages/common-core/src/rapi-access.ts:495 (opens new window)

# getMaterialsByGroup

▸ getMaterialsByGroup(groupIdsToCheck): Promise<RapiMaterialGroup[]>

# Parameters

Name Type
groupIdsToCheck string[]

# Returns

Promise<RapiMaterialGroup[]>

# Defined in

packages/common-core/src/rapi-access.ts:532 (opens new window)

# getMaterialsOf

▸ getMaterialsOf(rapiJson): Promise<RapiMaterial[]>

# Parameters

Name Type
rapiJson RapiJson

# Returns

Promise<RapiMaterial[]>

# Defined in

packages/common-core/src/rapi-access.ts:402 (opens new window)

# getMesh

▸ getMesh(id, format?, quality?): Promise<RapiMeshData>

# Parameters

Name Type Default value
id string undefined
format string MESH_DEFAULT_FORMAT
quality number MESH_DEFAULT_QUALITY

# Returns

Promise<RapiMeshData>

# Defined in

packages/common-core/src/rapi-access.ts:361 (opens new window)

# getMeshesOfCatalog

▸ getMeshesOfCatalog(catalogId): Promise<RapiMesh[]>

# Parameters

Name Type
catalogId string

# Returns

Promise<RapiMesh[]>

# Defined in

packages/common-core/src/rapi-access.ts:373 (opens new window)

# getPlan

▸ getPlan(id): Promise<RapiPlan>

# Parameters

Name Type
id string

# Returns

Promise<RapiPlan>

# Defined in

packages/common-core/src/rapi-access.ts:504 (opens new window)

# getPlanSnapshot

▸ getPlanSnapshot(id): Promise<RapiPlanSnapshotGetData>

# Parameters

Name Type
id `ps_${string}`

# Returns

Promise<RapiPlanSnapshotGetData>

# Defined in

packages/common-core/src/rapi-access.ts:508 (opens new window)

# getPreloadForConfiguration

▸ getPreloadForConfiguration(id): Promise<void>

# Parameters

Name Type
id string

# Returns

Promise<void>

# Defined in

packages/common-core/src/rapi-access.ts:233 (opens new window)

# getPreloadForItem

▸ getPreloadForItem(id): Promise<void>

# Parameters

Name Type
id string

# Returns

Promise<void>

# Defined in

packages/common-core/src/rapi-access.ts:229 (opens new window)

# getPrices

▸ getPrices(pricesIds): Promise<RapiPrice[]>

# Parameters

Name Type
pricesIds string[]

# Returns

Promise<RapiPrice[]>

# Defined in

packages/common-core/src/rapi-access.ts:1564 (opens new window)

# getShortUrl

▸ getShortUrl(referencedId, type): Promise<RapiShortId>

# Parameters

Name Type
referencedId string
type SHORT_TYPES

# Returns

Promise<RapiShortId>

# Defined in

packages/common-core/src/rapi-access.ts:698 (opens new window)

# getTag

▸ getTag(id): Promise<RapiTag>

# Parameters

Name Type
id string

# Returns

Promise<RapiTag>

# Defined in

packages/common-core/src/rapi-access.ts:345 (opens new window)

# getTags

▸ getTags(ids): Promise<RapiTag[]>

# Parameters

Name Type
ids string[]

# Returns

Promise<RapiTag[]>

# Defined in

packages/common-core/src/rapi-access.ts:349 (opens new window)

# getTenant

▸ getTenant(tenantId?): Promise<RapiTenant>

Returns info about the tenant with the provided ID. If the ID is not set it tries to use the current tenant.

# Parameters

Name Type
tenantId? number

# Returns

Promise<RapiTenant>

# Defined in

packages/common-core/src/rapi-access.ts:1546 (opens new window)

# getTexture

▸ getTexture(id): Promise<RapiTexture>

# Parameters

Name Type
id string

# Returns

Promise<RapiTexture>

# Defined in

packages/common-core/src/rapi-access.ts:353 (opens new window)

# getTexturesOf

▸ getTexturesOf(rapiJson): Promise<RapiTexture[]>

# Parameters

Name Type
rapiJson RapiJson

# Returns

Promise<RapiTexture[]>

# Defined in

packages/common-core/src/rapi-access.ts:390 (opens new window)

# peekComponent

▸ peekComponent(id): RapiComponent

# Parameters

Name Type
id string

# Returns

RapiComponent

# Defined in

packages/common-core/src/rapi-access.ts:483 (opens new window)

# peekConfiguration

▸ peekConfiguration(id): RapiConfiguration

# Parameters

Name Type
id string

# Returns

RapiConfiguration

# Defined in

packages/common-core/src/rapi-access.ts:491 (opens new window)

# peekItem

▸ peekItem(id): RapiItem

# Parameters

Name Type
id string

# Returns

RapiItem

# Defined in

packages/common-core/src/rapi-access.ts:487 (opens new window)

# peekMaterial

▸ peekMaterial(id): RapiMaterial

# Parameters

Name Type
id string

# Returns

RapiMaterial

# Defined in

packages/common-core/src/rapi-access.ts:479 (opens new window)

# removeCurrentToken

▸ removeCurrentToken(): void

# Returns

void

# Defined in

packages/common-core/src/rapi-access.ts:1766 (opens new window)

# saveConfiguration

▸ saveConfiguration(configuration): Promise<RapiConfiguration>

# Parameters

Name Type
configuration RapiConfiguration

# Returns

Promise<RapiConfiguration>

# Defined in

packages/common-core/src/rapi-access.ts:642 (opens new window)

# savePerspectiveImage

▸ savePerspectiveImage(configuration, perspectiveImage): Promise<RapiConfiguration>

# Parameters

Name Type
configuration RapiConfiguration
perspectiveImage Base64Image

# Returns

Promise<RapiConfiguration>

# Defined in

packages/common-core/src/rapi-access.ts:669 (opens new window)

# savePlan

▸ savePlan(plan): Promise<RapiPlan>

# Parameters

Name Type
plan RapiPlan

# Returns

Promise<RapiPlan>

# Defined in

packages/common-core/src/rapi-access.ts:1733 (opens new window)

# savePlanSnapshot

▸ savePlanSnapshot(planSnapshot): Promise<RapiPlanSnapshotGetData>

# Parameters

Name Type
planSnapshot RapiPlanSnapshotPostData

# Returns

Promise<RapiPlanSnapshotGetData>

# Defined in

packages/common-core/src/rapi-access.ts:1747 (opens new window)

# savePlanSnapshotPerspectiveImage

▸ savePlanSnapshotPerspectiveImage(planSnapshot, perspectiveImage): Promise<RapiPlanSnapshotGetData>

# Parameters

Name Type
planSnapshot RapiPlanSnapshotPostData
perspectiveImage Base64Image

# Returns

Promise<RapiPlanSnapshotGetData>

# Defined in

packages/common-core/src/rapi-access.ts:687 (opens new window)

# savePlanSnapshotTopImage

▸ savePlanSnapshotTopImage(planSnapshot, topImage): Promise<RapiPlanSnapshotGetData>

# Parameters

Name Type
planSnapshot RapiPlanSnapshotPostData
topImage Base64Image

# Returns

Promise<RapiPlanSnapshotGetData>

# Defined in

packages/common-core/src/rapi-access.ts:680 (opens new window)

# saveTopImage

▸ saveTopImage(configuration, topImage): Promise<RapiConfiguration>

# Parameters

Name Type
configuration RapiConfiguration
topImage Base64Image

# Returns

Promise<RapiConfiguration>

# Defined in

packages/common-core/src/rapi-access.ts:665 (opens new window)

# sendUserAction

▸ sendUserAction(userAction): Promise<RapiJson>

# Parameters

Name Type
userAction UserAction

# Returns

Promise<RapiJson>

# Defined in

packages/common-core/src/rapi-access.ts:1587 (opens new window)

# setCurrentToken

▸ setCurrentToken(token): void

# Parameters

Name Type
token string

# Returns

void

# Defined in

packages/common-core/src/rapi-access.ts:1762 (opens new window)

# shareConfiguration

▸ shareConfiguration(id, email, type): Promise<unknown>

Export a configuration or plansnapshot id into a given file format and send it via email Shares a configuration id using email

# Parameters

Name Type Description
id string
email string
type MAIL_TYPE the email template to use

# Returns

Promise<unknown>

# Defined in

packages/common-core/src/rapi-access.ts:1629 (opens new window)

# sharePlanSnapshot

▸ sharePlanSnapshot(id, email, type): Promise<unknown>

Shares a sharePlanSnapshot id using email

# Parameters

Name Type Description
id string
email string
type MAIL_TYPE the email template to use

# Returns

Promise<unknown>

# Defined in

packages/common-core/src/rapi-access.ts:1639 (opens new window)

# signinUser

▸ signinUser(email, passwordMD5): Promise<RapiAuth>

# Parameters

Name Type
email string
passwordMD5 string

# Returns

Promise<RapiAuth>

# Defined in

packages/common-core/src/rapi-access.ts:1701 (opens new window)

# signoutUser

▸ signoutUser(token): Promise<void>

# Parameters

Name Type
token string

# Returns

Promise<void>

# Defined in

packages/common-core/src/rapi-access.ts:1720 (opens new window)

# trackView

▸ trackView(id): Promise<void>

# Parameters

Name Type
id string

# Returns

Promise<void>

# Defined in

packages/common-core/src/rapi-access.ts:1686 (opens new window)

# updateCache

▸ updateCache(rapiPath, data): void

# Parameters

Name Type
rapiPath RAPI_PATHS
data RapiJson & { id: string }

# Returns

void

# Defined in

packages/common-core/src/rapi-access.ts:1794 (opens new window)

# clearCaches

▸ Static clearCaches(): void

# Returns

void

# Defined in

packages/common-core/src/rapi-access.ts:518 (opens new window)