Documentation

configurator-core/src/configurator..default

# Implements

Context

# Table of contents

# Constructors

constructor

# Properties

_creator_

# Methods

# Constructors

# constructor

• new default(creator)

# Parameters

Name	Type
`creator`	`string`

# Properties

# _creator_

• _creator_: string

# Implementation of

Context.creator

# Methods

# changeUseOfHDGeometry

▸ changeUseOfHDGeometry(): void

# Returns

void

# cleanUp

▸ cleanUp(): void

# Returns

void

# combineMaterialsToGroups

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

# Parameters

Name	Type
`materials`	`RapiMaterial`[]

# Returns

Promise<RapiMaterialGroup[]>

# createNewPlan

▸ createNewPlan(): RapiPlan

# Returns

RapiPlan

# 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>

# getAdditionalContentsOfItems

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

# Parameters

Name	Type
`rapiItems`	`RapiItem`[]

# Returns

Promise<RapiAdditionalContent[]>

# getCatalog

▸ getCatalog(id): Promise<RapiCatalog>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiCatalog>

# getComponent

▸ getComponent(id): Promise<RapiComponent>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiComponent>

# getComponents

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

# Parameters

Name	Type
`ids`	`string`[]

# Returns

Promise<RapiComponent[]>

# getComponentsOf

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

# Parameters

Name	Type
`rapiJson`	`RapiJson`

# Returns

Promise<RapiComponent[]>

# getConfiguration

▸ getConfiguration(id): Promise<RapiConfiguration>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiConfiguration>

# getConfigurations

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

# Parameters

Name	Type
`ids`	`string`[]

# Returns

Promise<RapiConfiguration[]>

# getConfiguratorSettings

▸ getConfiguratorSettings(id): Promise<RapiConfiguratorSettings>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiConfiguratorSettings>

# getCurrentSkin

▸ getCurrentSkin(): Promise<RapiSkin>

# Returns

Promise<RapiSkin>

# getHSCPackage

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

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<void | RapiPackage>

# getItem

▸ getItem(id): Promise<RapiItem>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiItem>

# getItems

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

# Parameters

Name	Type
`ids`	`string`[]

# Returns

Promise<RapiItem[]>

# getItemsOf

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

# Parameters

Name	Type
`rapiJson`	`RapiJson`

# Returns

Promise<RapiItem[]>

# getMaterial

▸ getMaterial(id): Promise<RapiMaterial>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiMaterial>

# getMaterials

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

# Parameters

Name	Type
`ids`	`string`[]

# Returns

Promise<RapiMaterial[]>

# getMaterialsByGroup

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

# Parameters

Name	Type
`groupIdsToCheck`	`string`[]

# Returns

Promise<RapiMaterialGroup[]>

# getMaterialsOf

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

# Parameters

Name	Type
`rapiJson`	`RapiJson`

# Returns

Promise<RapiMaterial[]>

# 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>

# getMeshesOfCatalog

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

# Parameters

Name	Type
`catalogId`	`string`

# Returns

Promise<RapiMesh[]>

# getPlan

▸ getPlan(id): Promise<RapiPlan>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiPlan>

# getPlanSnapshot

▸ getPlanSnapshot(id): Promise<RapiPlanSnapshotGetData>

# Parameters

Name	Type
`id`	`ps_${string}`

# Returns

Promise<RapiPlanSnapshotGetData>

# getPreloadForConfiguration

▸ getPreloadForConfiguration(id): Promise<void>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<void>

# getPreloadForItem

▸ getPreloadForItem(id): Promise<void>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<void>

# getPrices

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

# Parameters

Name	Type
`pricesIds`	`string`[]

# Returns

Promise<RapiPrice[]>

# getShortUrl

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

# Parameters

Name	Type
`referencedId`	`string`
`type`	`SHORT_TYPES`

# Returns

Promise<RapiShortId>

# getTag

▸ getTag(id): Promise<RapiTag>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiTag>

# getTags

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

# Parameters

Name	Type
`ids`	`string`[]

# Returns

Promise<RapiTag[]>

# 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>

# getTexture

▸ getTexture(id): Promise<RapiTexture>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiTexture>

# getTexturesOf

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

# Parameters

Name	Type
`rapiJson`	`RapiJson`

# Returns

Promise<RapiTexture[]>

# peekComponent

▸ peekComponent(id): RapiComponent

# Parameters

Name	Type
`id`	`string`

# Returns

RapiComponent

# peekConfiguration

▸ peekConfiguration(id): RapiConfiguration

# Parameters

Name	Type
`id`	`string`

# Returns

RapiConfiguration

# peekItem

▸ peekItem(id): RapiItem

# Parameters

Name	Type
`id`	`string`

# Returns

RapiItem

# peekMaterial

▸ peekMaterial(id): RapiMaterial

# Parameters

Name	Type
`id`	`string`

# Returns

RapiMaterial

# removeCurrentToken

▸ removeCurrentToken(): void

# Returns

void

# resolveShortUrl

▸ resolveShortUrl(id): Promise<RapiShortId>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<RapiShortId>

# saveConfiguration

▸ saveConfiguration(configuration): Promise<RapiConfiguration>

# Parameters

Name	Type
`configuration`	`RapiConfiguration`

# Returns

Promise<RapiConfiguration>

# savePerspectiveImage

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

# Parameters

Name	Type
`configuration`	`RapiConfiguration`
`perspectiveImage`	`Base64Image`

# Returns

Promise<RapiConfiguration>

# savePlan

▸ savePlan(plan): Promise<RapiPlan>

# Parameters

Name	Type
`plan`	`RapiPlan`

# Returns

Promise<RapiPlan>

# savePlanSnapshot

▸ savePlanSnapshot(planSnapshot): Promise<RapiPlanSnapshotGetData>

# Parameters

Name	Type
`planSnapshot`	`RapiPlanSnapshotPostData`

# Returns

Promise<RapiPlanSnapshotGetData>

# savePlanSnapshotPerspectiveImage

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

# Parameters

Name	Type
`planSnapshot`	`RapiPlanSnapshotPostData`
`perspectiveImage`	`Base64Image`

# Returns

Promise<RapiPlanSnapshotGetData>

# savePlanSnapshotTopImage

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

# Parameters

Name	Type
`planSnapshot`	`RapiPlanSnapshotPostData`
`topImage`	`Base64Image`

# Returns

Promise<RapiPlanSnapshotGetData>

# saveTopImage

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

# Parameters

Name	Type
`configuration`	`RapiConfiguration`
`topImage`	`Base64Image`

# Returns

Promise<RapiConfiguration>

# sendUserAction

▸ sendUserAction(userAction): Promise<RapiJson>

# Parameters

Name	Type
`userAction`	`UserAction`

# Returns

Promise<RapiJson>

# setCurrentToken

▸ setCurrentToken(token): void

# Parameters

Name	Type
`token`	`string`

# Returns

void

# 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>

# 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>

# signinUser

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

# Parameters

Name	Type
`email`	`string`
`passwordMD5`	`string`

# Returns

Promise<RapiAuth>

# signoutUser

▸ signoutUser(token): Promise<void>

# Parameters

Name	Type
`token`	`string`

# Returns

Promise<void>

# trackView

▸ trackView(id): Promise<void>

# Parameters

Name	Type
`id`	`string`

# Returns

Promise<void>

# updateCache

▸ updateCache(rapiPath, data): void

# Parameters

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

# Returns

void

# clearCaches

▸ Static clearCaches(): void

# Returns

void