API Reference / Modules / common-core/src/utils/shims / GlobalInitDataDefinition

# Interface: GlobalInitDataDefinition

common-core/src/utils/shims.GlobalInitDataDefinition

Init data parameters which are not context specific

# Implemented by

default

# Table of contents

# Properties

# alwaysUseCache

• Optional alwaysUseCache: boolean

Deprecated

Description

when set to true and assets were prechaced by the asset loader they are returned from cache. Otherwise we always return a fresh copy from network usage: alwaysUseCache=true default: not set -> assets fetched from url, set -> assets from cache

# Defined in

packages/common-core/src/utils/shims.ts:64 (opens new window)

# configuratorId

• Optional configuratorId: string

Description

The id which should be used for this embedding instance. When this id is set all InitData parameter can be set and changed in Rubens Admin. This is the way we recommend to set init data params. Ask your Roomle contact for your configuratorId.

# Defined in

packages/common-core/src/utils/shims.ts:58 (opens new window)

# customApiUrl

• Optional customApiUrl: string

Description

Set which RAPI (Roomle API) backend should be used usage: customApiUrl=https://www.roomle.com/api/v2

# Defined in

packages/common-core/src/utils/shims.ts:70 (opens new window)

# e2e

• Optional e2e: boolean

Description

Can be set to true if started as an end-to-end test. This will disable post-processing

# Defined in

packages/common-core/src/utils/shims.ts:76 (opens new window)

# e2eRoomleRendererForImages

• Optional e2eRoomleRendererForImages: boolean

Description

If set to true, the Roomle Renderer is used for perspective and top images this should help the E2E tests of Joe to migrate from comparing Roomle Renderer images to Three.js Renderer images

# Defined in

packages/common-core/src/utils/shims.ts:82 (opens new window)

# locale

• Optional locale: string

Description

locale to use for the embedding instance

# Defined in

packages/common-core/src/utils/shims.ts:34 (opens new window)

# overrideCountry

• Optional overrideCountry: string

Description

Set country to use for the Roomle price service. If not used the customer IP address will be used to determine the location. usage: overrideCountry=de

# Defined in

packages/common-core/src/utils/shims.ts:46 (opens new window)

# overrideRapi

• Optional overrideRapi: RapiServerUrlType

Description

Set which RAPI (Roomle API) backend should be used options: live, test

# Defined in

packages/common-core/src/utils/shims.ts:52 (opens new window)

# overrideTenant

• Optional overrideTenant: number

Deprecated

Description

Can be used for content testing

# Defined in

packages/common-core/src/utils/shims.ts:41 (opens new window)