API Reference › Globals › RapiAccess

Class: RapiAccess

Hierarchy

• RapiAccess

Implements

• Context

Index

Constructors

• constructor

Properties

• creator

Methods

• changeUseOfHDGeometry
• cleanUp
• combineMaterialsToGroups
• createNewPlan
• export3D
• getAdditionalContentsOfItems
• getCatalog
• getComponent
• getComponents
• getComponentsOf
• getConfiguration
• getConfigurations
• getConfiguratorSettings
• getCurrentSkin
• getHSCPackage
• getItem
• getItems
• getItemsOf
• getMaterial
• getMaterials
• getMaterialsByGroup
• getMaterialsOf
• getMesh
• getMeshesOfCatalog
• getPlan
• getPreloadForConfiguration
• getPreloadForItem
• getPrices
• getShortUrl
• getTag
• getTags
• getTenant
• getTexture
• getTexturesOf
• peekComponent
• peekConfiguration
• peekItem
• peekMaterial
• removeCurrentToken
• saveConfiguration
• savePerspectiveImage
• savePlan
• saveTopImage
• sendUserAction
• setCurrentToken
• shareConfiguration
• signinUser
• signoutUser
• trackView
• clearCaches

Constructors

constructor

+ new RapiAccess(creator: string): RapiAccess

Defined in packages/common-core/src/rapi-access.ts:188

Parameters:

Name	Type
creator	string

Returns: RapiAccess

Properties

creator

• creator: string

_Implementation of Context.creator_

Defined in packages/common-core/src/rapi-access.ts:164

Methods

changeUseOfHDGeometry

▸ changeUseOfHDGeometry(): void

Defined in packages/common-core/src/rapi-access.ts:235

Returns: void

---

cleanUp

▸ cleanUp(): void

Defined in packages/common-core/src/rapi-access.ts:429

Returns: void

---

combineMaterialsToGroups

▸ combineMaterialsToGroups(materials: RapiMaterial[]): Promise‹RapiMaterialGroup[]›

Defined in packages/common-core/src/rapi-access.ts:605

Parameters:

Name	Type
materials	RapiMaterial[]

Returns: Promise‹RapiMaterialGroup[]›

---

createNewPlan

▸ createNewPlan(): RapiPlan

Defined in packages/common-core/src/rapi-access.ts:1321

Returns: RapiPlan

---

export3D

▸ export3D(id: RapiId, email: string, fileFormat: string, options: object): Promise‹unknown›

Defined in packages/common-core/src/rapi-access.ts:1225

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

Parameters:

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

Returns: Promise‹unknown›

---

getAdditionalContentsOfItems

▸ getAdditionalContentsOfItems(rapiItems: RapiItem[]): Promise‹RapiAdditionalContent[]›

Defined in packages/common-core/src/rapi-access.ts:351

Parameters:

Name	Type
rapiItems	RapiItem[]

Returns: Promise‹RapiAdditionalContent[]›

---

getCatalog

▸ getCatalog(id: RapiId): Promise‹RapiCatalog›

Defined in packages/common-core/src/rapi-access.ts:311

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiCatalog›

---

getComponent

▸ getComponent(id: RapiId): Promise‹RapiComponent›

Defined in packages/common-core/src/rapi-access.ts:275

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiComponent›

---

getComponents

▸ getComponents(ids: RapiId[]): Promise‹RapiComponent[]›

Defined in packages/common-core/src/rapi-access.ts:291

Parameters:

Name	Type
ids	RapiId[]

Returns: Promise‹RapiComponent[]›

---

getComponentsOf

▸ getComponentsOf(rapiJson: RapiJson): Promise‹RapiComponent[]›

Defined in packages/common-core/src/rapi-access.ts:347

Parameters:

Name	Type
rapiJson	RapiJson

Returns: Promise‹RapiComponent[]›

---

getConfiguration

▸ getConfiguration(id: RapiId): Promise‹RapiConfiguration›

Defined in packages/common-core/src/rapi-access.ts:279

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiConfiguration›

---

getConfigurations

▸ getConfigurations(ids: RapiId[]): Promise‹RapiConfiguration[]›

Defined in packages/common-core/src/rapi-access.ts:283

Parameters:

Name	Type
ids	RapiId[]

Returns: Promise‹RapiConfiguration[]›

---

getConfiguratorSettings

▸ getConfiguratorSettings(id: RapiId): Promise‹RapiConfiguratorSettings›

Defined in packages/common-core/src/rapi-access.ts:1177

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiConfiguratorSettings›

---

getCurrentSkin

▸ getCurrentSkin(): Promise‹RapiSkin›

Defined in packages/common-core/src/rapi-access.ts:1169

Returns: Promise‹RapiSkin›

---

getHSCPackage

▸ getHSCPackage(id: RapiId): Promise‹RapiPackage | void›

Defined in packages/common-core/src/rapi-access.ts:246

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiPackage | void›

---

getItem

▸ getItem(id: RapiId): Promise‹RapiItem›

Defined in packages/common-core/src/rapi-access.ts:287

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiItem›

---

getItems

▸ getItems(ids: RapiId[]): Promise‹RapiItem[]›

Defined in packages/common-core/src/rapi-access.ts:295

Parameters:

Name	Type
ids	RapiId[]

Returns: Promise‹RapiItem[]›

---

getItemsOf

▸ getItemsOf(rapiJson: RapiJson): Promise‹RapiItem[]›

Defined in packages/common-core/src/rapi-access.ts:338

Parameters:

Name	Type
rapiJson	RapiJson

Returns: Promise‹RapiItem[]›

---

getMaterial

▸ getMaterial(id: RapiId): Promise‹RapiMaterial›

Defined in packages/common-core/src/rapi-access.ts:389

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiMaterial›

---

getMaterials

▸ getMaterials(ids: RapiId[]): Promise‹RapiMaterial[]›

Defined in packages/common-core/src/rapi-access.ts:409

Parameters:

Name	Type
ids	RapiId[]

Returns: Promise‹RapiMaterial[]›

---

getMaterialsByGroup

▸ getMaterialsByGroup(groupIdsToCheck: RapiId[]): Promise‹RapiMaterialGroup[]›

Defined in packages/common-core/src/rapi-access.ts:433

Parameters:

Name	Type
groupIdsToCheck	RapiId[]

Returns: Promise‹RapiMaterialGroup[]›

---

getMaterialsOf

▸ getMaterialsOf(rapiJson: RapiJson): Promise‹RapiMaterial[]›

Defined in packages/common-core/src/rapi-access.ts:342

Parameters:

Name	Type
rapiJson	RapiJson

Returns: Promise‹RapiMaterial[]›

---

getMesh

▸ getMesh(id: RapiId, format: string, quality: number): Promise‹RapiMeshData›

Defined in packages/common-core/src/rapi-access.ts:315

Parameters:

Name	Type	Default
id	RapiId	-
format	string	MESH_DEFAULT_FORMAT
quality	number	MESH_DEFAULT_QUALITY

Returns: Promise‹RapiMeshData›

---

getMeshesOfCatalog

▸ getMeshesOfCatalog(catalogId: RapiId): Promise‹RapiMesh[]›

Defined in packages/common-core/src/rapi-access.ts:320

Parameters:

Name	Type
catalogId	RapiId

Returns: Promise‹RapiMesh[]›

---

getPlan

▸ getPlan(id: RapiId): Promise‹RapiPlan›

Defined in packages/common-core/src/rapi-access.ts:414

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiPlan›

---

getPreloadForConfiguration

▸ getPreloadForConfiguration(id: RapiId): Promise‹void›

Defined in packages/common-core/src/rapi-access.ts:199

Parameters:

Name	Type
id	RapiId

Returns: Promise‹void›

---

getPreloadForItem

▸ getPreloadForItem(id: RapiId): Promise‹void›

Defined in packages/common-core/src/rapi-access.ts:195

Parameters:

Name	Type
id	RapiId

Returns: Promise‹void›

---

getPrices

▸ getPrices(pricesIds: PriceId[]): Promise‹RapiPrice[]›

Defined in packages/common-core/src/rapi-access.ts:1173

Parameters:

Name	Type
pricesIds	PriceId[]

Returns: Promise‹RapiPrice[]›

---

getShortUrl

▸ getShortUrl(referencedId: RapiId, type: SHORT_TYPES): Promise‹RapiShortId›

Defined in packages/common-core/src/rapi-access.ts:533

Parameters:

Name	Type
referencedId	RapiId
type	SHORT_TYPES

Returns: Promise‹RapiShortId›

---

getTag

▸ getTag(id: RapiId): Promise‹RapiTag›

Defined in packages/common-core/src/rapi-access.ts:299

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiTag›

---

getTags

▸ getTags(ids: RapiId[]): Promise‹RapiTag[]›

Defined in packages/common-core/src/rapi-access.ts:303

Parameters:

Name	Type
ids	RapiId[]

Returns: Promise‹RapiTag[]›

---

getTenant

▸ getTenant(tenantId?: number): Promise‹RapiTenant›

Defined in packages/common-core/src/rapi-access.ts:1162

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	Description
tenantId?	number

Returns: Promise‹RapiTenant›

---

getTexture

▸ getTexture(id: RapiId): Promise‹RapiTexture›

Defined in packages/common-core/src/rapi-access.ts:307

Parameters:

Name	Type
id	RapiId

Returns: Promise‹RapiTexture›

---

getTexturesOf

▸ getTexturesOf(rapiJson: RapiJson): Promise‹RapiTexture[]›

Defined in packages/common-core/src/rapi-access.ts:334

Parameters:

Name	Type
rapiJson	RapiJson

Returns: Promise‹RapiTexture[]›

---

peekComponent

▸ peekComponent(id: RapiId): RapiComponent

Defined in packages/common-core/src/rapi-access.ts:397

Parameters:

Name	Type
id	RapiId

Returns: RapiComponent

---

peekConfiguration

▸ peekConfiguration(id: RapiId): RapiConfiguration

Defined in packages/common-core/src/rapi-access.ts:405

Parameters:

Name	Type
id	RapiId

Returns: RapiConfiguration

---

peekItem

▸ peekItem(id: RapiId): RapiItem

Defined in packages/common-core/src/rapi-access.ts:401

Parameters:

Name	Type
id	RapiId

Returns: RapiItem

---

peekMaterial

▸ peekMaterial(id: RapiId): RapiMaterial

Defined in packages/common-core/src/rapi-access.ts:393

Parameters:

Name	Type
id	RapiId

Returns: RapiMaterial

---

removeCurrentToken

▸ removeCurrentToken(): void

Defined in packages/common-core/src/rapi-access.ts:1317

Returns: void

---

saveConfiguration

▸ saveConfiguration(configuration: RapiConfiguration): Promise‹RapiConfiguration›

Defined in packages/common-core/src/rapi-access.ts:509

Parameters:

Name	Type
configuration	RapiConfiguration

Returns: Promise‹RapiConfiguration›

---

savePerspectiveImage

▸ savePerspectiveImage(configuration: RapiConfiguration, perspectiveImage: Base64Image): Promise‹RapiConfiguration›

Defined in packages/common-core/src/rapi-access.ts:529

Parameters:

Name	Type
configuration	RapiConfiguration
perspectiveImage	Base64Image

Returns: Promise‹RapiConfiguration›

---

savePlan

▸ savePlan(plan: RapiPlan): Promise‹RapiPlan›

Defined in packages/common-core/src/rapi-access.ts:1299

Parameters:

Name	Type
plan	RapiPlan

Returns: Promise‹RapiPlan›

---

saveTopImage

▸ saveTopImage(configuration: RapiConfiguration, topImage: Base64Image): Promise‹RapiConfiguration›

Defined in packages/common-core/src/rapi-access.ts:525

Parameters:

Name	Type
configuration	RapiConfiguration
topImage	Base64Image

Returns: Promise‹RapiConfiguration›

---

sendUserAction

▸ sendUserAction(userAction: UserAction): Promise‹RapiJson›

Defined in packages/common-core/src/rapi-access.ts:1188

Parameters:

Name	Type
userAction	UserAction

Returns: Promise‹RapiJson›

---

setCurrentToken

▸ setCurrentToken(token: string): void

Defined in packages/common-core/src/rapi-access.ts:1313

Parameters:

Name	Type
token	string

Returns: void

---

shareConfiguration

▸ shareConfiguration(id: RapiId, email: string, type: MAIL_TYPE): Promise‹unknown›

Defined in packages/common-core/src/rapi-access.ts:1201

Shares a configuration id using email

Parameters:

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

Returns: Promise‹unknown›

---

signinUser

▸ signinUser(email: string, passwordMD5: string): Promise‹RapiAuth›

Defined in packages/common-core/src/rapi-access.ts:1267

Parameters:

Name	Type
email	string
passwordMD5	string

Returns: Promise‹RapiAuth›

---

signoutUser

▸ signoutUser(token: string): Promise‹void›

Defined in packages/common-core/src/rapi-access.ts:1286

Parameters:

Name	Type
token	string

Returns: Promise‹void›

---

trackView

▸ trackView(id: string): Promise‹void›

Defined in packages/common-core/src/rapi-access.ts:1252

Parameters:

Name	Type
id	string

Returns: Promise‹void›

---

Static clearCaches

▸ clearCaches(): void

Defined in packages/common-core/src/rapi-access.ts:419

Returns: void