API Reference › Globals › RoomleSdk
# Class: RoomleSdk
# Hierarchy
- RoomleSdk
# Index
# Accessors
# Methods
- getConfigurator
- getContext
- getGlbViewer
- getMaterialViewer
- getPlanner
- getRapiAccess
- setGlobalInitData
# Accessors
# Static callbacks
• get callbacks(): Promise‹GlobalCallback›
Defined in packages/common-core/src/roomle-sdk.ts:56
Get the global callback instance this is helpful if you want to listen to callbacks which are triggered globally, e.g.: onNetworkRequest
Returns: Promise‹GlobalCallback›
# Methods
# Static getConfigurator
▸ getConfigurator(initData?: InitDataDefinition, context?: string): Promise‹Configurator›
Defined in packages/common-core/src/roomle-sdk.ts:19
Parameters:
| Name | Type |
|---|---|
initData? | InitDataDefinition |
context? | string |
Returns: Promise‹Configurator›
# Static getContext
▸ getContext(contextName: string): string
Defined in packages/common-core/src/roomle-sdk.ts:81
Pass in the desired context name and you'll get back a unique context name which does not exist yet.
Parameters:
| Name | Type | Description |
|---|---|---|
contextName | string |
Returns: string
# Static getGlbViewer
▸ getGlbViewer(initData?: InitDataDefinition, context?: string): Promise‹GlbViewer›
Defined in packages/common-core/src/roomle-sdk.ts:29
Parameters:
| Name | Type |
|---|---|
initData? | InitDataDefinition |
context? | string |
Returns: Promise‹GlbViewer›
# Static getMaterialViewer
▸ getMaterialViewer(initData?: InitDataDefinition, context?: string): Promise‹MaterialViewer›
Defined in packages/common-core/src/roomle-sdk.ts:34
Parameters:
| Name | Type |
|---|---|
initData? | InitDataDefinition |
context? | string |
Returns: Promise‹MaterialViewer›
# Static getPlanner
▸ getPlanner(initData?: InitDataDefinition, context?: string): Promise‹Planner›
Defined in packages/common-core/src/roomle-sdk.ts:24
Parameters:
| Name | Type |
|---|---|
initData? | InitDataDefinition |
context? | string |
Returns: Promise‹Planner›
# Static getRapiAccess
▸ getRapiAccess(): Promise‹RapiAccess›
Defined in packages/common-core/src/roomle-sdk.ts:43
Get a rapi access instance If you want to set used locale or tenant you have to call setGlobalInitData first
Returns: Promise‹RapiAccess›
# Static setGlobalInitData
▸ setGlobalInitData(globalInitData: GlobalInitDataDefinition): void
Defined in packages/common-core/src/roomle-sdk.ts:67
Set global init data params like locale or tenant
Parameters:
| Name | Type |
|---|---|
globalInitData | GlobalInitDataDefinition |
Returns: void