# ExposedApi.Internal

[Embedding API Reference](/rubens/rubens-products/rubens-products-reference.md) / [Modules](/rubens/rubens-products/rubens-products-reference/modules.md) / [exposed-api](/rubens/rubens-products/rubens-products-reference/modules/exposed_api.md) / \<internal>

## Module: \<internal>

### Table of contents

#### Enumerations

* [BUTTON\_ACTIONS](/rubens/rubens-products/rubens-products-reference/enums/exposed_api._internal_.button_actions.md)
* [GA\_CATEGORY](/rubens/rubens-products/rubens-products-reference/enums/exposed_api._internal_.ga_category.md)
* [GA\_CUSTOM](/rubens/rubens-products/rubens-products-reference/enums/exposed_api._internal_.ga_custom.md)
* [SDK\_MODULES](/rubens/rubens-products/rubens-products-reference/enums/exposed_api._internal_.sdk_modules.md)

#### Enumeration Members

* [EXPORT\_3D](#export_3d)
* [LOAD\_PRODUCT](#load_product)
* [OPEN\_AR](#open_ar)
* [SAVE\_DRAFT](#save_draft)
* [TUTORIALS](#tutorials)

#### Classes

* [Connector](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.connector.md)
* [ExposedApiDragGhost](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.exposedapidragghost.md)
* [ExposedApiDragHandler](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.exposedapidraghandler.md)
* [Libs](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.libs.md)
* [MessageHandler](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.messagehandler.md)
* [RoomleSdkWrapper](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.roomlesdkwrapper.md)
* [SdkConnector](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.sdkconnector.md)
* [SdkConnectorConfigurator](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.sdkconnectorconfigurator.md)
* [SdkConnectorPlanner](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.sdkconnectorplanner.md)
* [SdkConnectorViewer](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.sdkconnectorviewer.md)
* [UiCallbacks](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.uicallbacks.md)
* [default](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.default.md)
* [default](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.default-1.md)
* [default](/rubens/rubens-products/rubens-products-reference/classes/exposed_api._internal_.default-2.md)

#### Interfaces

* [Analytics](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.analytics.md)
* [CollectionViewComponentIcon](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.collectionviewcomponenticon.md)
* [CollectionViewElement](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.collectionviewelement.md)
* [CollectionViewState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.collectionviewstate.md)
* [CoreData](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.coredata.md)
* [CoreState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.corestate.md)
* [DragGhostOptions](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.dragghostoptions.md)
* [DragInOptions](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.draginoptions.md)
* [DragInSettings](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.draginsettings.md)
* [EmbeddingCommand](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.embeddingcommand.md)
* [EmbeddingResponse](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.embeddingresponse.md)
* [GridViewElement](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.gridviewelement.md)
* [GridViewUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.gridviewuistate.md)
* [GridViewVariantElement](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.gridviewvariantelement.md)
* [IncomingMessageBus](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.incomingmessagebus.md)
* [KernelBoundsFormatted](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.kernelboundsformatted.md)
* [OutgoingMessageBus](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.outgoingmessagebus.md)
* [OverlayState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.overlaystate.md)
* [ParameterGroup](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.parametergroup.md)
* [PartlistResponse](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.partlistresponse.md)
* [PlannerCoreData](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.plannercoredata.md)
* [PlannerUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.planneruistate.md)
* [PointRect](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.pointrect.md)
* [SampleRoom](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.sampleroom.md)
* [SceneSelection](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.sceneselection.md)
* [SharedUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md)
* [StoreState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.storestate.md)
* [TabCategory](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.tabcategory.md)
* [Translator](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.translator.md)
* [UiLabels](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.uilabels.md)
* [UiPossibleChildTagWithKey](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.uipossiblechildtagwithkey.md)
* [UiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.uistate.md)
* [WrapLines](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.wraplines.md)

#### Type Aliases

* [CallbackApi](#callbackapi)
* [CollectionViewElementPossibleTypes](#collectionviewelementpossibletypes)
* [CollectionViewTypes](#collectionviewtypes)
* [CommunicationSide](#communicationside)
* [CustomViewCommunicationSide](#customviewcommunicationside)
* [CustomViewCommunicationSideParent](#customviewcommunicationsideparent)
* [EmbeddingPluginMode](#embeddingpluginmode)
* [Enumify](#enumify)
* [EventCallback](#eventcallback)
* [EventMap](#eventmap)
* [EventsDataMap](#eventsdatamap)
* [ExposedOverlays](#exposedoverlays)
* [GoogleAnalyticsCallback](#googleanalyticscallback)
* [GridViewElementPossiblePayload](#gridviewelementpossiblepayload)
* [LoadResponse](#loadresponse)
* [MaterialsForObjects](#materialsforobjects)
* [MessageExecution](#messageexecution)
* [MessageExecutionResult](#messageexecutionresult)
* [Nullable](#nullable)
* [OverlaysOpenState](#overlaysopenstate)
* [RgbHexValue](#rgbhexvalue)
* [RoomType](#roomtype)
* [RoomleConfiguratorType](#roomleconfiguratortype)
* [RoomleConfiguratorWithExtObjs](#roomleconfiguratorwithextobjs)
* [RoomlePlannerWithExtObjs](#roomleplannerwithextobjs)
* [SampleMaterial](#samplematerial)
* [SelectionType](#selectiontype)
* [ViewTypeState](#viewtypestate)
* [WithUiLabels](#withuilabels)

#### Variables

* [COLLECTION\_VIEW\_TYPES](#collection_view_types)
* [PLAN\_OBJECT\_TYPES](#plan_object_types)

### Enumeration Members

#### EXPORT\_3D

• **EXPORT\_3D**: `5`

***

#### LOAD\_PRODUCT

• **LOAD\_PRODUCT**: `12`

***

#### OPEN\_AR

• **OPEN\_AR**: `4`

***

#### SAVE\_DRAFT

• **SAVE\_DRAFT**: `1`

***

#### TUTORIALS

• **TUTORIALS**: `11`

### Type Aliases

#### CallbackApi

Ƭ **CallbackApi**: `ConfiguratorUiCallbacks` & `RoomlePlannerUiCallback`

***

#### CollectionViewElementPossibleTypes

Ƭ **CollectionViewElementPossibleTypes**: `UiPossibleChildTag` | `UiKernelParameter` | `RapiTagForUi`

***

#### CollectionViewTypes

Ƭ **CollectionViewTypes**: [`Enumify`](#enumify)\<typeof [`COLLECTION_VIEW_TYPES`](#collection_view_types)>

***

#### CommunicationSide

Ƭ **CommunicationSide**: `"iframe"` | `"website"` | `"main"` | [`CustomViewCommunicationSide`](#customviewcommunicationside) | [`CustomViewCommunicationSideParent`](#customviewcommunicationsideparent)

***

#### CustomViewCommunicationSide

Ƭ **CustomViewCommunicationSide**: \`custom-view-${PossibleCustomViews}\`

***

#### CustomViewCommunicationSideParent

Ƭ **CustomViewCommunicationSideParent**: \`custom-view-${PossibleCustomViews}-parent\`

***

#### EmbeddingPluginMode

Ƭ **EmbeddingPluginMode**: `"website"` | `"custom-view"`

***

#### Enumify

Ƭ **Enumify**<`T`>: `T`\[keyof `T`]

**Type parameters**

| Name |
| ---- |
| `T`  |

***

#### EventCallback

Ƭ **EventCallback**<`T`>: (`payload`: `T`) => `void`

**Type parameters**

| Name | Type      |
| ---- | --------- |
| `T`  | `unknown` |

**Type declaration**

▸ (`payload`): `void`

**Parameters**

| Name      | Type |
| --------- | ---- |
| `payload` | `T`  |

**Returns**

`void`

***

#### EventMap

Ƭ **EventMap**<`T`>: `Map`<`string`, `Set`<[`EventCallback`](#eventcallback)<`T`>>>

**Type parameters**

| Name |
| ---- |
| `T`  |

***

#### EventsDataMap

Ƭ **EventsDataMap**<`T`>: `Map`<`string`, `T`>

**Type parameters**

| Name |
| ---- |
| `T`  |

***

#### ExposedOverlays

Ƭ **ExposedOverlays**: typeof [`SAVE_DRAFT`](#save_draft) | typeof [`OPEN_AR`](#open_ar) | typeof [`EXPORT_3D`](#export_3d) | typeof [`TUTORIALS`](#tutorials) | typeof [`LOAD_PRODUCT`](#load_product)

***

#### GoogleAnalyticsCallback

Ƭ **GoogleAnalyticsCallback**: (...`args`: `any`\[]) => `void`

**Type declaration**

▸ (`...args`): `void`

**Parameters**

| Name      | Type     |
| --------- | -------- |
| `...args` | `any`\[] |

**Returns**

`void`

***

#### GridViewElementPossiblePayload

Ƭ **GridViewElementPossiblePayload**: [`WithUiLabels`](#withuilabels)<`RapiMaterial`> | [`WithUiLabels`](#withuilabels)<`KernelValue`> | [`WithUiLabels`](#withuilabels)<`UiPossibleChild`> | [`WithUiLabels`](#withuilabels)<`RapiItem`> | [`WithUiLabels`](#withuilabels)<[`SampleRoom`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.sampleroom.md)> | [`WithUiLabels`](#withuilabels)<[`SampleMaterial`](#samplematerial)> | [`WithUiLabels`](#withuilabels)<`RapiComponent`> | [`WithUiLabels`](#withuilabels)<[`MaterialsForObjects`](#materialsforobjects)>

***

#### LoadResponse

Ƭ **LoadResponse**: [`PartlistResponse`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.partlistresponse.md) | `void`

***

#### MaterialsForObjects

Ƭ **MaterialsForObjects**: `RapiMaterial` | [`SampleMaterial`](#samplematerial)

***

#### MessageExecution

Ƭ **MessageExecution**: (`message`: [`EmbeddingCommand`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.embeddingcommand.md), `event`: `MessageEvent`) => [`MessageExecutionResult`](#messageexecutionresult) | `Promise`<[`MessageExecutionResult`](#messageexecutionresult)>

**Type declaration**

▸ (`message`, `event`): [`MessageExecutionResult`](#messageexecutionresult) | `Promise`<[`MessageExecutionResult`](#messageexecutionresult)>

**Parameters**

| Name      | Type                                                                                                                          |
| --------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `message` | [`EmbeddingCommand`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.embeddingcommand.md) |
| `event`   | `MessageEvent`                                                                                                                |

**Returns**

[`MessageExecutionResult`](#messageexecutionresult) | `Promise`<[`MessageExecutionResult`](#messageexecutionresult)>

***

#### MessageExecutionResult

Ƭ **MessageExecutionResult**: `Promise`<[`EmbeddingResponse`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.embeddingresponse.md) | `void`> | `undefined`

***

#### Nullable

Ƭ **Nullable**<`T`>: `T` | `null`

**Type parameters**

| Name |
| ---- |
| `T`  |

***

#### OverlaysOpenState

Ƭ **OverlaysOpenState**: `Object`

**Index signature**

▪ \[key: `string`]: [`OverlayState`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.overlaystate.md)

***

#### RgbHexValue

Ƭ **RgbHexValue**: \`#${string}\`

***

#### RoomType

Ƭ **RoomType**: `"empty"` | `"floor"` | `"wall"` | `"corner"` | `"square"` | `"L"`

***

#### RoomleConfiguratorType

Ƭ **RoomleConfiguratorType**: `RoomleConfigurator` | [`RoomleConfiguratorWithExtObjs`](#roomleconfiguratorwithextobjs)

***

#### RoomleConfiguratorWithExtObjs

Ƭ **RoomleConfiguratorWithExtObjs**: `RoomleConfigurator`<\[`"external-objects"`]>

***

#### RoomlePlannerWithExtObjs

Ƭ **RoomlePlannerWithExtObjs**: `RoomlePlanner`<\[`"external-objects"`]>

***

#### SampleMaterial

Ƭ **SampleMaterial**: `Object`

**Type declaration**

| Name                  | Type                          |
| --------------------- | ----------------------------- |
| `__IS_SAMPLE_COLOR__` | `1`                           |
| `color`               | [`RgbHexValue`](#rgbhexvalue) |
| `id`                  | `string`                      |
| `label`               | `string`                      |

***

#### SelectionType

Ƭ **SelectionType**: [`Enumify`](#enumify)\<typeof [`PLAN_OBJECT_TYPES`](#plan_object_types)>

***

#### ViewTypeState

Ƭ **ViewTypeState**: `"list"` | `"small"` | `"big"`

***

#### WithUiLabels

Ƭ **WithUiLabels**<`T`>: `T` & { `uiLabels?`: [`UiLabels`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.uilabels.md) }

**Type parameters**

| Name |
| ---- |
| `T`  |

### Variables

#### COLLECTION\_VIEW\_TYPES

• `Const` **COLLECTION\_VIEW\_TYPES**: `Object`

**Type declaration**

| Name                     | Type                       |
| ------------------------ | -------------------------- |
| `CONFIGURATOR_SIDE_BAR`  | `"configurator_side_bar"`  |
| `DUMMY`                  | `"dummy_side_bar"`         |
| `FLOOR_SIDE_BAR`         | `"floor_side_bar"`         |
| `PLANNER_SIDE_BAR`       | `"planner_side_bar"`       |
| `PRODUCT_SETTINGS`       | `"product_settings"`       |
| `STATIC_COLLECTION_VIEW` | `"static_collection_view"` |
| `UNIT_TEST`              | `"test_state"`             |
| `WALL_SIDE_BAR`          | `"wall_side_bar"`          |

***

#### PLAN\_OBJECT\_TYPES

• `Const` **PLAN\_OBJECT\_TYPES**: `Object`

**Type declaration**

| Name                     | Type                       |
| ------------------------ | -------------------------- |
| `CONFIGURATION`          | `"configuration"`          |
| `DOOR`                   | `"door"`                   |
| `EXTERNAL_CONFIGURATION` | `"external-configuration"` |
| `FLOOR`                  | `"floor"`                  |
| `MEASURE`                | `"measure"`                |
| `STATIC`                 | `"static"`                 |
| `UNKNOWN`                | `"unknown"`                |
| `WALL`                   | `"wall"`                   |
| `WINDOW`                 | `"window"`                 |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.roomle.com/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.