Configurator.Internal.default-1
configurator-core/src/configurator.internal.default
Implements
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new default(creator
)
Parameters
Name | Type |
---|---|
|
|
Properties
_creator_
• _creator_: string
Implementation of
Methods
changeUseOfHDGeometry
▸ changeUseOfHDGeometry(): void
Returns
void
cleanUp
▸ cleanUp(): void
Returns
void
combineMaterialsToGroups
▸ combineMaterialsToGroups(materials
): Promise
<RapiMaterialGroup
[]>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiMaterialGroup
[]>
createNewPlan
▸ createNewPlan(): RapiPlan
Returns
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 |
---|---|---|
|
| |
|
| |
|
| check API documentation for valid formats |
|
| - |
Returns
Promise
<unknown
>
getAdditionalContentsOfItems
▸ getAdditionalContentsOfItems(rapiItems
): Promise
<RapiAdditionalContent
[]>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiAdditionalContent
[]>
getCatalog
▸ getCatalog(id
): Promise
<RapiCatalog
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiCatalog
>
getComponent
▸ getComponent(id
): Promise
<RapiComponent
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiComponent
>
getComponents
▸ getComponents(ids
): Promise
<RapiComponent
[]>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiComponent
[]>
getComponentsOf
▸ getComponentsOf(rapiJson
): Promise
<RapiComponent
[]>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiComponent
[]>
getConfiguration
▸ getConfiguration(id
): Promise
<RapiConfiguration
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiConfiguration
>
getConfigurations
▸ getConfigurations(ids
): Promise
<RapiConfiguration
[]>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiConfiguration
[]>
getConfiguratorSettings
▸ getConfiguratorSettings(id
): Promise
<RapiConfiguratorSettings
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiConfiguratorSettings
>
getCurrentSkin
▸ getCurrentSkin(): Promise
<RapiSkin
>
Returns
Promise
<RapiSkin
>
getHSCPackage
▸ getHSCPackage(id
): Promise
<void
| RapiPackage
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<void
| RapiPackage
>
getItem
▸ getItem(id
): Promise
<RapiItem
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiItem
>
getItems
▸ getItems(ids
): Promise
<RapiItem
[]>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiItem
[]>
getItemsOf
▸ getItemsOf(rapiJson
): Promise
<RapiItem
[]>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiItem
[]>
getMaterial
▸ getMaterial(id
): Promise
<RapiMaterial
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiMaterial
>
getMaterials
▸ getMaterials(ids
): Promise
<RapiMaterial
[]>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiMaterial
[]>
getMaterialsByGroup
▸ getMaterialsByGroup(groupIdsToCheck
): Promise
<RapiMaterialGroup
[]>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiMaterialGroup
[]>
getMaterialsOf
▸ getMaterialsOf(rapiJson
): Promise
<RapiMaterial
[]>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiMaterial
[]>
getMesh
▸ getMesh(id
, format?
, quality?
): Promise
<RapiMeshData
>
Parameters
Name | Type | Default value |
---|---|---|
|
|
|
|
|
|
|
|
|
Returns
Promise
<RapiMeshData
>
getMeshesOfCatalog
▸ getMeshesOfCatalog(catalogId
): Promise
<RapiMesh
[]>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiMesh
[]>
getPlan
▸ getPlan(id
): Promise
<RapiPlan
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiPlan
>
getPlanSnapshot
▸ getPlanSnapshot(id
): Promise
<RapiPlanSnapshotGetData
>
Parameters
Name | Type |
---|---|
| `ps_${string}` |
Returns
Promise
<RapiPlanSnapshotGetData
>
getPreloadForConfiguration
▸ getPreloadForConfiguration(id
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<void
>
getPreloadForItem
▸ getPreloadForItem(id
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<void
>
getPrices
▸ getPrices(pricesIds
): Promise
<RapiPrice
[]>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiPrice
[]>
getShortUrl
▸ getShortUrl(referencedId
, type
): Promise
<RapiShortId
>
Parameters
Name | Type |
---|---|
|
|
|
Returns
Promise
<RapiShortId
>
getTag
▸ getTag(id
): Promise
<RapiTag
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiTag
>
getTags
▸ getTags(ids
): Promise
<RapiTag
[]>
Parameters
Name | Type |
---|---|
|
|
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 |
---|---|
|
|
Returns
Promise
<RapiTenant
>
getTexture
▸ getTexture(id
): Promise
<RapiTexture
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiTexture
>
getTexturesOf
▸ getTexturesOf(rapiJson
): Promise
<RapiTexture
[]>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiTexture
[]>
peekComponent
▸ peekComponent(id
): RapiComponent
Parameters
Name | Type |
---|---|
|
|
Returns
peekConfiguration
▸ peekConfiguration(id
): RapiConfiguration
Parameters
Name | Type |
---|---|
|
|
Returns
peekItem
▸ peekItem(id
): RapiItem
Parameters
Name | Type |
---|---|
|
|
Returns
peekMaterial
▸ peekMaterial(id
): RapiMaterial
Parameters
Name | Type |
---|---|
|
|
Returns
removeCurrentToken
▸ removeCurrentToken(): void
Returns
void
resolveShortUrl
▸ resolveShortUrl(id
): Promise
<RapiShortId
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<RapiShortId
>
saveConfiguration
▸ saveConfiguration(configuration
): Promise
<RapiConfiguration
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiConfiguration
>
saveConfigurationImage
▸ saveConfigurationImage(configuration
, image1
, type1
, image2
, type2
): Promise
<RapiConfiguration
>
Parameters
Name | Type |
---|---|
| |
| |
| |
| |
|
Returns
Promise
<RapiConfiguration
>
savePlan
▸ savePlan(plan
): Promise
<RapiPlan
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiPlan
>
savePlanSnapshot
▸ savePlanSnapshot(planSnapshot
): Promise
<RapiPlanSnapshotGetData
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiPlanSnapshotGetData
>
savePlanSnapshotImage
▸ savePlanSnapshotImage(planSnapshot
, image1
, type1
, image2
, type2
): Promise
<RapiPlanSnapshotGetData
>
Parameters
Name | Type |
---|---|
| |
| |
| |
| |
|
Returns
Promise
<RapiPlanSnapshotGetData
>
sendUserAction
▸ sendUserAction(userAction
): Promise
<RapiJson
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<RapiJson
>
setCurrentToken
▸ setCurrentToken(token
): void
Parameters
Name | Type |
---|---|
|
|
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 |
---|---|---|
|
| |
|
| |
| 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 |
---|---|---|
|
| |
|
| |
| the email template to use |
Returns
Promise
<unknown
>
signinUser
▸ signinUser(email
, password
): Promise
<RapiAuth
>
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
Promise
<RapiAuth
>
signoutUser
▸ signoutUser(token
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<void
>
trackView
▸ trackView(id
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<void
>
updateCache
▸ updateCache(rapiPath
, data
): void
Parameters
Name | Type |
---|---|
| |
|
|
Returns
void
clearCaches
▸ Static
clearCaches(): void
Returns
void
Last updated