# ibm-wch-sdk-api

> Exposes framework independent APIs for ibm-wch-sdk-ng and similar SDKs.

Latest version **5.0.361** (published 2018-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install ibm-wch-sdk-api
pnpm add ibm-wch-sdk-api
yarn add ibm-wch-sdk-api
bun add ibm-wch-sdk-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.361 |
| Published | 2018-10-10 |
| First published | 2018-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 382.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Carsten Leue |
| Maintainers | carstenleue |

## Links

- npm: https://www.npmjs.com/package/ibm-wch-sdk-api
- Repository: https://github.ibm.com/DX/prod-wch-sdk-ng5
- Issues: https://developer.ibm.com/answers/smartspace/wch/index.html
- npm.io page: https://npm.io/package/ibm-wch-sdk-api

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.7.1

## Recent versions

- 5.0.361 (latest) — 2018-10-10
- 5.0.348 — 2018-10-10
- 5.0.341 — 2018-06-21
- 5.0.340 — 2018-06-21
- 5.0.334 — 2018-05-23
- 5.0.321 — 2018-05-22
- 5.0.325 — 2018-05-09
- 5.0.316 — 2018-05-03
- 5.0.314 — 2018-04-30
- 5.0.300 — 2018-04-27
- 5.0.269 — 2018-04-10
- 5.0.265 — 2018-04-06
- 5.0.258 — 2018-04-04
- 5.0.254 — 2018-04-04
- 5.0.240 — 2018-03-27
- … 15 more at https://npm.io/package/ibm-wch-sdk-api/versions

## README

<a name="_6413c217ac070f0cc888ef237e5f77bca091ed14c4a6b017e8102394c2fc842d"></a>
# ibm-wch-sdk-api

Exposes framework independent APIs for [ibm-wch-sdk-ng](https://www.npmjs.com/package/ibm-wch-sdk-ng) and similar SDKs.

## Details

Refer to the [documentation](#_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375).

## Changes

[CHANGELOG](#_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512)

## Class documentation

Refer to the [documentation](#_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b).

## Usage

Install the module via

```bash
npm install --save ibm-wch-sdk-theme
```

<a name="_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375"></a>
# API

* [services](#_2e7dfe61ef2eebf4639dddfd3db5850531fea53c360a5cca7e3920d2b11a3dfb)
* [interfaces](#_e85450ea16246a3e0ff45a1d4454cf0289c2825a0cc4a222723860b94f3a9cdf)
<a name="_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512"></a>
# Changelog

## Current

### Changed

### Added

* New quick access fields `group` and `groups` on the `RenderingContext`
* Typing support for `group` elements
* Declaration of the event types and payloads for cross iframe events to switch between public and protected mode.

## 5.0.217

### Added

* Initial version
<a name="_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b"></a>

#  ibm-wch-sdk-api

## Index

### External modules

* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["interfaces/delivery/v1/base.item"](#_afea4de06c609f7c30a48d607bac01c287499a38006e896a4ab08b7906ab3063)
* ["interfaces/delivery/v1/content/content.item"](#_d75f2e857f4e8c971c4cd86c6565c11a7568bdc75398b7313b79819084ebd704)
* ["interfaces/delivery/v1/content/elements"](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* ["interfaces/delivery/v1/error/error"](#_97744c5cae9eea4935d84ca50d2bab30609b14b5d990690fe5302cc7e058e330)
* ["interfaces/delivery/v1/layout/layout"](#_4de850970270efdab4162e42efbd88d3ad575c083a61d4d5fc758dc7eb20bc83)
* ["interfaces/delivery/v1/rendering/context/content.item.with.layout"](#_3e1c601d1e4286ba832c387e66c883b4817df33635e5da74b484b94f9500630d)
* ["interfaces/delivery/v1/rendering/context/extended.context"](#_4e96fea3bf624583a56132c09ee4c876a6d082a2c1c5700653e004424d47adcd)
* ["interfaces/delivery/v1/rendering/context/hub.context"](#_44d86ea768b4a35533f1c78c3f087054bc447e1a105b98f4dbed4e70991f8bdf)
* ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7)
* ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf)
* ["interfaces/delivery/v1/site/site"](#_6145bb40d03cc106e28e159900a0b95f824dab273a47422cd988b271036aecd2)
* ["interfaces/delivery/v1/site/site.child"](#_e94ec2e15f2b437470df7ce154dd6040a61cc5e3df5c6491c685cc7f5c12048a)
* ["interfaces/delivery/v1/site/site.context"](#_7a3c20cbecc6cb9f80b672797a7d6dac6f4c1b6d37af31ef5e6a0e89e682ceb5)
* ["interfaces/delivery/v1/site/site.page"](#_90f532b0241c23c8dde8016164afd8bdd88c7ea5c5820966323cd4d7faa4f136)
* ["interfaces/delivery/v1/user/user"](#_ed80d3696a6bd211bf927dd55e15ca9bcdb1c9237cfd1a121010aa7d2c3592c0)
* ["interfaces/delivery/v1/users/currentuser/constants"](#_ae0cfb6a465c55bfbc2ca945e917786a557433065cc9189a74dde34a5f4d8177)
* ["interfaces/logging/logger"](#_fe515c9b90a4f17a73ce5bc44ed848d7fe5703aea6dfbc28e957c75e091b2a2d)
* ["interfaces/logging/logger.factory"](#_94fa52231da6493363f588763c848f4f7cecf66fe1eb52d61a78d5e4301457a6)
* ["interfaces/login/v1/basicauth/index"](#_dac65c77b0cb0cc52d6d682d26bc9b87600989892e9f3a7ef16dada57362d18e)
* ["interfaces/login/v1/redirect/index"](#_4c3b6c3954cc5a4b95cd9788e728eac76d01e2003836bc5806ba2949f210375f)
* ["interfaces/login/v1/removecookies/index"](#_18958968e7577a9f4c4895d615f9c9d97256a3fee757a047a29cf131498c9281)
* ["interfaces/messages/messages"](#_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d)
* ["interfaces/messages/sdk.navigate.by.path.message"](#_622733230f0c6ad31bf56b396da59767cf483237891a5434c9ede42f171aa5c5)
* ["interfaces/messages/sdk.refresh.message"](#_3f4345d27805e6adac090f349258646fff6b3b4347fddefa018197689cd77bad)
* ["interfaces/messages/sdk.set.mode.message"](#_45c8d94271d8381ed7d9c3f48e023774f189ee7539fe3ab3a487a84b0f6a89ce)
* ["interfaces/messages/sdk.subscribe.active.route.message"](#_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c)
* ["interfaces/messages/sdk.subscribe.message"](#_4faf6361999930d706d52f519fde3d28ef55a5f91cd3180996f94d0f11483c10)
* ["interfaces/messages/sdk.subscribe.mode.message"](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032)
* ["interfaces/messages/sdk.subscribe.route.message"](#_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b)
* ["interfaces/query"](#_45c541ae696659e96d969ecb6cb661833a94f1395541d0f1824511ca1a48ea92)
* ["interfaces/registry/v1/currenttenant/index"](#_48e8df5998eaafe94429d1e273e001ad85e19cbbdc9904eb084c209d9b16628b)
* ["interfaces/sdk/router/router"](#_877e2ce0cc1e815e6e0c2332f26ea2eafaa3b05dad4eff1acc8a0796fe37703c)
* ["interfaces/sdk/sdk"](#_8bafd0c044de202782302356d37bcf05c205090fb4f91611d867bfe41fa9305f)
* ["interfaces/sdk/search/search"](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8)
* ["interfaces/sdk/version/version"](#_699e57ae41eef21c9f67f14fe8f82ab9b0d9f99ffebf0824e4d75776a1527230)
* ["interfaces/user-profile/v1/users/currentuser/index"](#_dc2f7042bfb04a1659e8376926cfafdbf79cd46142cd56ef5f33644ae1ac7931)
* ["services/hub-info/hub-info"](#_ca2a71da2cd83d09268fcae3830fc011491b514bfb61f4a1a55553b14388d53a)
* ["services/hub-info/hub-info.config"](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d)
* ["services/info/url.config"](#_4cbc0ba789efa769fbf2a19947a0e8773ce45da9610f3caff324b33ad67a4cdb)
* ["services/logging/logger.service"](#_ede8ea0fddcda0580eb2bbf4c926b2864731cceeae82765e14e145c093c72fef)

---


<a name="_2e7dfe61ef2eebf4639dddfd3db5850531fea53c360a5cca7e3920d2b11a3dfb"></a>
# Services

* [logging][./logging/]
* [info][./info/]
<a name="_e85450ea16246a3e0ff45a1d4454cf0289c2825a0cc4a222723860b94f3a9cdf"></a>
# Interfaces

* [logging](#_bf82eb0c990fed72cb6202e6637de386337fcd5333c02a2a11eec69abda51324)
* [delivery](#_93acaf358afd2719ba9b61156e5a1692b35bde21ef30536d187fc22f02dbc33e)
* [sdk](#_68e84d440988b4bf8d61b2879ed7ad2d519769630167e4b8e0da3e7c3a44ea39)
* [messages](#_0457e4c7a4d5f3d3229398309f2c7232155d4eab86b58baf4b4a1f08b68e9ac0)
<a name="_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)

# External module: "index"

## Index

---


<a name="_afea4de06c609f7c30a48d607bac01c287499a38006e896a4ab08b7906ab3063"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/base.item"](#_afea4de06c609f7c30a48d607bac01c287499a38006e896a4ab08b7906ab3063)

# External module: "interfaces/delivery/v1/base.item"

## Index

### Enumerations

* [DraftStatus](#_2af626f2e7ddd4cf63232c734b3502acca4855b128e8582868de477e0b3e7ab5)

### Interfaces

* [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)

---


<a name="_d75f2e857f4e8c971c4cd86c6565c11a7568bdc75398b7313b79819084ebd704"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/content/content.item"](#_d75f2e857f4e8c971c4cd86c6565c11a7568bdc75398b7313b79819084ebd704)

# External module: "interfaces/delivery/v1/content/content.item"

## Index

### Interfaces

* [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)

---


<a name="_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/content/elements"](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)

# External module: "interfaces/delivery/v1/content/elements"

## Index

### Type aliases

* [ELEMENT_TYPE](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)

### Variables

* [_ELEMENT_TYPE_CATEGORY](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_DATE](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_FILE](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_FORMATTED_TEXT](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_GROUP](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_IMAGE](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_LINK](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_LOCATION](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_NUMBER](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_OPTION_SELECTION](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_REFERENCE](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_TEXT](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_TOGGLE](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* [_ELEMENT_TYPE_VIDEO](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)

---

## Type aliases

<a id="element_type"></a>

###  ELEMENT_TYPE

**Ƭ ELEMENT_TYPE**: * "text" &#124; "number" &#124; "toggle" &#124; "formattedtext" &#124; "link" &#124; "datetime" &#124; "file" &#124; "video" &#124; "image" &#124; "reference" &#124; "category" &#124; "location" &#124; "optionselection" &#124; "group"
*

*Defined in interfaces/delivery/v1/content/elements.ts:2*

___

## Variables

<a id="_element_type_category"></a>

### `<Const>` _ELEMENT_TYPE_CATEGORY

**● _ELEMENT_TYPE_CATEGORY**: *"category"* = "category"

*Defined in interfaces/delivery/v1/content/elements.ts:14*

___
<a id="_element_type_date"></a>

### `<Const>` _ELEMENT_TYPE_DATE

**● _ELEMENT_TYPE_DATE**: *"datetime"* = "datetime"

*Defined in interfaces/delivery/v1/content/elements.ts:13*

___
<a id="_element_type_file"></a>

### `<Const>` _ELEMENT_TYPE_FILE

**● _ELEMENT_TYPE_FILE**: *"file"* = "file"

*Defined in interfaces/delivery/v1/content/elements.ts:15*

___
<a id="_element_type_formatted_text"></a>

### `<Const>` _ELEMENT_TYPE_FORMATTED_TEXT

**● _ELEMENT_TYPE_FORMATTED_TEXT**: *"formattedtext"* = "formattedtext"

*Defined in interfaces/delivery/v1/content/elements.ts:9*

___
<a id="_element_type_group"></a>

### `<Const>` _ELEMENT_TYPE_GROUP

**● _ELEMENT_TYPE_GROUP**: *"group"* = "group"

*Defined in interfaces/delivery/v1/content/elements.ts:6*

___
<a id="_element_type_image"></a>

### `<Const>` _ELEMENT_TYPE_IMAGE

**● _ELEMENT_TYPE_IMAGE**: *"image"* = "image"

*Defined in interfaces/delivery/v1/content/elements.ts:17*

___
<a id="_element_type_link"></a>

### `<Const>` _ELEMENT_TYPE_LINK

**● _ELEMENT_TYPE_LINK**: *"link"* = "link"

*Defined in interfaces/delivery/v1/content/elements.ts:12*

___
<a id="_element_type_location"></a>

### `<Const>` _ELEMENT_TYPE_LOCATION

**● _ELEMENT_TYPE_LOCATION**: *"location"* = "location"

*Defined in interfaces/delivery/v1/content/elements.ts:19*

___
<a id="_element_type_number"></a>

### `<Const>` _ELEMENT_TYPE_NUMBER

**● _ELEMENT_TYPE_NUMBER**: *"number"* = "number"

*Defined in interfaces/delivery/v1/content/elements.ts:10*

___
<a id="_element_type_option_selection"></a>

### `<Const>` _ELEMENT_TYPE_OPTION_SELECTION

**● _ELEMENT_TYPE_OPTION_SELECTION**: *"optionselection"* = "optionselection"

*Defined in interfaces/delivery/v1/content/elements.ts:7*

___
<a id="_element_type_reference"></a>

### `<Const>` _ELEMENT_TYPE_REFERENCE

**● _ELEMENT_TYPE_REFERENCE**: *"reference"* = "reference"

*Defined in interfaces/delivery/v1/content/elements.ts:18*

___
<a id="_element_type_text"></a>

### `<Const>` _ELEMENT_TYPE_TEXT

**● _ELEMENT_TYPE_TEXT**: *"text"* = "text"

*Defined in interfaces/delivery/v1/content/elements.ts:8*

___
<a id="_element_type_toggle"></a>

### `<Const>` _ELEMENT_TYPE_TOGGLE

**● _ELEMENT_TYPE_TOGGLE**: *"toggle"* = "toggle"

*Defined in interfaces/delivery/v1/content/elements.ts:11*

___
<a id="_element_type_video"></a>

### `<Const>` _ELEMENT_TYPE_VIDEO

**● _ELEMENT_TYPE_VIDEO**: *"video"* = "video"

*Defined in interfaces/delivery/v1/content/elements.ts:16*

___


<a name="_97744c5cae9eea4935d84ca50d2bab30609b14b5d990690fe5302cc7e058e330"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/error/error"](#_97744c5cae9eea4935d84ca50d2bab30609b14b5d990690fe5302cc7e058e330)

# External module: "interfaces/delivery/v1/error/error"

## Index

### Interfaces

* [ErrorDetail](#_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d)
* [ErrorResponse](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)

---


<a name="_4de850970270efdab4162e42efbd88d3ad575c083a61d4d5fc758dc7eb20bc83"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/layout/layout"](#_4de850970270efdab4162e42efbd88d3ad575c083a61d4d5fc758dc7eb20bc83)

# External module: "interfaces/delivery/v1/layout/layout"

## Index

### Interfaces

* [Layout](#_64042f4865a37637bcab39d2a8ac86f5077885c81f515da8695361102851740c)

---


<a name="_3e1c601d1e4286ba832c387e66c883b4817df33635e5da74b484b94f9500630d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/content.item.with.layout"](#_3e1c601d1e4286ba832c387e66c883b4817df33635e5da74b484b94f9500630d)

# External module: "interfaces/delivery/v1/rendering/context/content.item.with.layout"

## Index

### Interfaces

* [ContentItemWithLayout](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)

---


<a name="_4e96fea3bf624583a56132c09ee4c876a6d082a2c1c5700653e004424d47adcd"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/extended.context"](#_4e96fea3bf624583a56132c09ee4c876a6d082a2c1c5700653e004424d47adcd)

# External module: "interfaces/delivery/v1/rendering/context/extended.context"

## Index

### Interfaces

* [ExtendedContext](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)

---


<a name="_44d86ea768b4a35533f1c78c3f087054bc447e1a105b98f4dbed4e70991f8bdf"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/hub.context"](#_44d86ea768b4a35533f1c78c3f087054bc447e1a105b98f4dbed4e70991f8bdf)

# External module: "interfaces/delivery/v1/rendering/context/hub.context"

## Index

### Interfaces

* [HubContext](#_4799ac267139f3d5886c0d9cb6bef396c39c6fd21495b7b8234e07775b24a36a)

---


<a name="_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7)

# External module: "interfaces/delivery/v1/rendering/context/rendering.context"

## Index

### Interfaces

* [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)
* [Asset](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)
* [Category](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)
* [CategoryElement](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)
* [DateElement](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09)
* [ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)
* [File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)
* [FileElement](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540)
* [FormattedTextElement](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7)
* [Group](#_f223c9e6a8ba7a2285a96195622e4afdcadf8851a3591bdcd96ae40db7fe6310)
* [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)
* [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)
* [ImageElement](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76)
* [Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)
* [LinkElement](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6)
* [Location](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8)
* [LocationElement](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89)
* [MultiDateElement](#_2b57ec9f1dfd5f28bc48893458cd9f7947f1e4643b404025339b053b6cfa6ce0)
* [MultiFileElement](#_3187c1cfda9f25e464c46d0bb76399746b93d61cb8f007d9aa604890af2a4b25)
* [MultiFormattedTextElement](#_b933c37b4644209fa53f66920d5c56400a74d302b7d0b5c025935d6cbb70b6d0)
* [MultiGroupElement](#_f7c66899364f4f31e9bb4d2393648295f1eaee3384a6c426d3176b1691442177)
* [MultiImageElement](#_80ca3145a4f74a3b4b17ce9213bf5020a18731f72e22f8d1c318b7a91e7ae883)
* [MultiLinkElement](#_78af407458457107666257b4333774457c69d3ac0bc5622d4d3d2a87a7f518d2)
* [MultiNumberElement](#_36840cbb62256490ae648db8e86fd4ff02348b8e7e649268f6f4d0a7a00cfb91)
* [MultiOptionSelectionElement](#_bec62da677db1391c471eadaf28a48379eb7d2755e23776cfca243910f24dd2f)
* [MultiReferenceElement](#_9fef3a937860227119a6b87f53cd2e16b9ca82fda073bfbcfa58a8450bb27aa3)
* [MultiTextElement](#_c925b289d9f663cd56895cf293d44de6f0bd91724de0c176a1109a0c89cc0d54)
* [MultiToggleElement](#_f023a7b354c99dab41f5c33babb4fbc62ed86de5f9e118a52ef1aba7a26e47ad)
* [MultiVideoElement](#_8fd3b140a17fbefe86a0404bf4c51a46f28fc1d4bf2275e68992a1bfb55b368d)
* [NumberElement](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156)
* [OptionSelection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)
* [OptionSelectionElement](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18)
* [ReferenceElement](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6)
* [RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [Rendition](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)
* [Resource](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)
* [SingleDateElement](#_93dc8bc3c92170f26ea7331b7046bd044219dd702fcaeb1f9da4842d174eaf74)
* [SingleFileElement](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177)
* [SingleFormattedTextElement](#_f615a73ccc2555e6868d97b20d9c402cabf1da5de6e7b289cf39aece105b6eab)
* [SingleGroupElement](#_222b6931f0cca029d0a37348535a172f4619bbb38dea2f8a860cf482a3572e6a)
* [SingleImageElement](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)
* [SingleLinkElement](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)
* [SingleNumberElement](#_af320b1ae3dfe67d140be94c36b9b7705adff5d9a8b0f4410b6b21768bb48899)
* [SingleOptionSelectionElement](#_e357f4427f30e0f8622a4e0a6f24666a3b08f3ca538635575cef7ea99912729b)
* [SingleReferenceElement](#_e5c5486e7981bfd35c72721c070d84617e14b02e6c4b9854e682cbebfea8b1bf)
* [SingleTextElement](#_c71214e31a75cf8303591bc5088d69405026c036159ac98f107f9e47839e7d32)
* [SingleToggleElement](#_a6566fa719ef6b265d7fdf7b118b4b5a6e9e4dc7d406712ca492ecd1f5222a0a)
* [SingleVideoElement](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)
* [TextElement](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c)
* [ToggleElement](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142)
* [TypeRef](#_72e90345ad5c3500a6241f71e3c6d1d3dd28e2e278561692727a43ab3aa7bc64)
* [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)
* [VideoElement](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73)

### Type aliases

* [Element](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7)
* [GroupType](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7)
* [SimpleType](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7)

---

## Type aliases

<a id="element"></a>

###  Element

**Ƭ Element**: * [LocationElement](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89) &#124; [SingleReferenceElement](#_e5c5486e7981bfd35c72721c070d84617e14b02e6c4b9854e682cbebfea8b1bf) &#124; [MultiReferenceElement](#_9fef3a937860227119a6b87f53cd2e16b9ca82fda073bfbcfa58a8450bb27aa3) &#124; [SingleImageElement](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c) &#124; [MultiImageElement](#_80ca3145a4f74a3b4b17ce9213bf5020a18731f72e22f8d1c318b7a91e7ae883) &#124; [SingleVideoElement](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71) &#124; [MultiVideoElement](#_8fd3b140a17fbefe86a0404bf4c51a46f28fc1d4bf2275e68992a1bfb55b368d) &#124; [SingleFileElement](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177) &#124; [MultiFileElement](#_3187c1cfda9f25e464c46d0bb76399746b93d61cb8f007d9aa604890af2a4b25) &#124; [SingleToggleElement](#_a6566fa719ef6b265d7fdf7b118b4b5a6e9e4dc7d406712ca492ecd1f5222a0a) &#124; [MultiToggleElement](#_f023a7b354c99dab41f5c33babb4fbc62ed86de5f9e118a52ef1aba7a26e47ad) &#124; [SingleTextElement](#_c71214e31a75cf8303591bc5088d69405026c036159ac98f107f9e47839e7d32) &#124; [MultiTextElement](#_c925b289d9f663cd56895cf293d44de6f0bd91724de0c176a1109a0c89cc0d54) &#124; [SingleNumberElement](#_af320b1ae3dfe67d140be94c36b9b7705adff5d9a8b0f4410b6b21768bb48899) &#124; [MultiNumberElement](#_36840cbb62256490ae648db8e86fd4ff02348b8e7e649268f6f4d0a7a00cfb91) &#124; [SingleLinkElement](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344) &#124; [MultiLinkElement](#_78af407458457107666257b4333774457c69d3ac0bc5622d4d3d2a87a7f518d2) &#124; [SingleFormattedTextElement](#_f615a73ccc2555e6868d97b20d9c402cabf1da5de6e7b289cf39aece105b6eab) &#124; [MultiFormattedTextElement](#_b933c37b4644209fa53f66920d5c56400a74d302b7d0b5c025935d6cbb70b6d0) &#124; [SingleOptionSelectionElement](#_e357f4427f30e0f8622a4e0a6f24666a3b08f3ca538635575cef7ea99912729b) &#124; [MultiOptionSelectionElement](#_bec62da677db1391c471eadaf28a48379eb7d2755e23776cfca243910f24dd2f) &#124; [SingleDateElement](#_93dc8bc3c92170f26ea7331b7046bd044219dd702fcaeb1f9da4842d174eaf74) &#124; [MultiDateElement](#_2b57ec9f1dfd5f28bc48893458cd9f7947f1e4643b404025339b053b6cfa6ce0) &#124; [SingleGroupElement](#_222b6931f0cca029d0a37348535a172f4619bbb38dea2f8a860cf482a3572e6a) &#124; [MultiGroupElement](#_f7c66899364f4f31e9bb4d2393648295f1eaee3384a6c426d3176b1691442177)
*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:386*

___
<a id="grouptype"></a>

###  GroupType

**Ƭ GroupType**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[SimpleType](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:402*

___
<a id="simpletype"></a>

###  SimpleType

**Ƭ SimpleType**: * `string` &#124; `string`[] &#124; `number` &#124; `number`[] &#124; [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a) &#124; [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)[] &#124; `Date` &#124; `Date`[] &#124; [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d) &#124; [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)[] &#124; [File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506) &#124; [File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)[] &#124; `boolean` &#124; `boolean`[] &#124; [Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7) &#124; [Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)[] &#124; [OptionSelection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c) &#124; [OptionSelection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)[] &#124; [RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42) &#124; [RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)[] &#124; [Category](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f) &#124; [Location](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8) &#124; `object`
*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:398*

___


<a name="_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf)

# External module: "interfaces/delivery/v1/search/search.result"

## Index

### Interfaces

* [PageSearchResult](#_f1e2a6f45ddaedd9474e21f536e5d992fa5fa44853bf1fc9d6040279230145cf)
* [RenderingContextQueryResult](#_8ab884cdc475a46f409f9714cdd0fae9e0bd14bd4a26d7241dc0f9e5993bd975)
* [RenderingContextSearchResult](#_0da8e0ee755c3653ef1ac0645e9676ab4ba6f9512404b63a0ee8ac655b1a4846)
* [SearchResult](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f)
* [SearchResults](#_12c67d7429a19401c081b1ad2073b6ec0c6bd1228051de2c1e513935c3bccb9c)
* [SitePagesQueryResult](#_0bb838053c0a65d4b266eb8188b988de622519d5ac81ee7dc310486dd8ff26f9)

---


<a name="_6145bb40d03cc106e28e159900a0b95f824dab273a47422cd988b271036aecd2"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site"](#_6145bb40d03cc106e28e159900a0b95f824dab273a47422cd988b271036aecd2)

# External module: "interfaces/delivery/v1/site/site"

## Index

### Interfaces

* [Site](#_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000)
* [SiteRoot](#_304b6432baca923435e7277682bb8f27afe6a84efaf7d6b77f8e3062b270ebd2)

---


<a name="_e94ec2e15f2b437470df7ce154dd6040a61cc5e3df5c6491c685cc7f5c12048a"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site.child"](#_e94ec2e15f2b437470df7ce154dd6040a61cc5e3df5c6491c685cc7f5c12048a)

# External module: "interfaces/delivery/v1/site/site.child"

## Index

### Interfaces

* [SiteChild](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)

---


<a name="_7a3c20cbecc6cb9f80b672797a7d6dac6f4c1b6d37af31ef5e6a0e89e682ceb5"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site.context"](#_7a3c20cbecc6cb9f80b672797a7d6dac6f4c1b6d37af31ef5e6a0e89e682ceb5)

# External module: "interfaces/delivery/v1/site/site.context"

## Index

### Interfaces

* [SiteContext](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)

---


<a name="_90f532b0241c23c8dde8016164afd8bdd88c7ea5c5820966323cd4d7faa4f136"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site.page"](#_90f532b0241c23c8dde8016164afd8bdd88c7ea5c5820966323cd4d7faa4f136)

# External module: "interfaces/delivery/v1/site/site.page"

## Index

### Interfaces

* [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)

---


<a name="_ed80d3696a6bd211bf927dd55e15ca9bcdb1c9237cfd1a121010aa7d2c3592c0"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/user/user"](#_ed80d3696a6bd211bf927dd55e15ca9bcdb1c9237cfd1a121010aa7d2c3592c0)

# External module: "interfaces/delivery/v1/user/user"

## Index

### Interfaces

* [User](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)

---


<a name="_ae0cfb6a465c55bfbc2ca945e917786a557433065cc9189a74dde34a5f4d8177"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/users/currentuser/constants"](#_ae0cfb6a465c55bfbc2ca945e917786a557433065cc9189a74dde34a5f4d8177)

# External module: "interfaces/delivery/v1/users/currentuser/constants"

## Index

### Variables

* [REL_PATH_CURRENT_USER](#_ae0cfb6a465c55bfbc2ca945e917786a557433065cc9189a74dde34a5f4d8177)

---

## Variables

<a id="rel_path_current_user"></a>

### `<Const>` REL_PATH_CURRENT_USER

**● REL_PATH_CURRENT_USER**: *"user-profile/v1/users/currentuser"* = "user-profile/v1/users/currentuser"

*Defined in interfaces/delivery/v1/users/currentuser/constants.ts:2*

___


<a name="_fe515c9b90a4f17a73ce5bc44ed848d7fe5703aea6dfbc28e957c75e091b2a2d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/logging/logger"](#_fe515c9b90a4f17a73ce5bc44ed848d7fe5703aea6dfbc28e957c75e091b2a2d)

# External module: "interfaces/logging/logger"

## Index

### Interfaces

* [Logger](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)

---


<a name="_94fa52231da6493363f588763c848f4f7cecf66fe1eb52d61a78d5e4301457a6"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/logging/logger.factory"](#_94fa52231da6493363f588763c848f4f7cecf66fe1eb52d61a78d5e4301457a6)

# External module: "interfaces/logging/logger.factory"

## Index

### Interfaces

* [DynamicLoggerFactory](#_dba062739a32acb9737be551381453ab80c56905ec8eac65a7079e5c03a112a1)
* [LoggerFactory](#_cf0baec94532e589ab96e8937533c72487e558033c4282cc9a514478cc5770aa)

---


<a name="_dac65c77b0cb0cc52d6d682d26bc9b87600989892e9f3a7ef16dada57362d18e"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/login/v1/basicauth/index"](#_dac65c77b0cb0cc52d6d682d26bc9b87600989892e9f3a7ef16dada57362d18e)

# External module: "interfaces/login/v1/basicauth/index"

## Index

### Variables

* [HEADER_BASICAUTH_TENANT_ID](#_dac65c77b0cb0cc52d6d682d26bc9b87600989892e9f3a7ef16dada57362d18e)
* [KEY_BASICAUTH_LOGIN_PASSWORD](#_dac65c77b0cb0cc52d6d682d26bc9b87600989892e9f3a7ef16dada57362d18e)
* [KEY_BASICAUTH_LOGIN_USERNAME](#_dac65c77b0cb0cc52d6d682d26bc9b87600989892e9f3a7ef16dada57362d18e)
* [REL_PATH_BASICAUTH_LOGIN](#_dac65c77b0cb0cc52d6d682d26bc9b87600989892e9f3a7ef16dada57362d18e)

---

## Variables

<a id="header_basicauth_tenant_id"></a>

### `<Const>` HEADER_BASICAUTH_TENANT_ID

**● HEADER_BASICAUTH_TENANT_ID**: *"x-ibm-dx-tenant-id"* = "x-ibm-dx-tenant-id"

*Defined in interfaces/login/v1/basicauth/index.ts:6*

___
<a id="key_basicauth_login_password"></a>

### `<Const>` KEY_BASICAUTH_LOGIN_PASSWORD

**● KEY_BASICAUTH_LOGIN_PASSWORD**: *"j_password"* = "j_password"

*Defined in interfaces/login/v1/basicauth/index.ts:4*

___
<a id="key_basicauth_login_username"></a>

### `<Const>` KEY_BASICAUTH_LOGIN_USERNAME

**● KEY_BASICAUTH_LOGIN_USERNAME**: *"j_username"* = "j_username"

*Defined in interfaces/login/v1/basicauth/index.ts:3*

___
<a id="rel_path_basicauth_login"></a>

### `<Const>` REL_PATH_BASICAUTH_LOGIN

**● REL_PATH_BASICAUTH_LOGIN**: *"login/v1/basicauth"* = "login/v1/basicauth"

*Defined in interfaces/login/v1/basicauth/index.ts:2*

___


<a name="_4c3b6c3954cc5a4b95cd9788e728eac76d01e2003836bc5806ba2949f210375f"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/login/v1/redirect/index"](#_4c3b6c3954cc5a4b95cd9788e728eac76d01e2003836bc5806ba2949f210375f)

# External module: "interfaces/login/v1/redirect/index"

## Index

### Variables

* [PARAM_REDIRECT_LOGIN_TARGET_TENANT](#_4c3b6c3954cc5a4b95cd9788e728eac76d01e2003836bc5806ba2949f210375f)
* [PARAM_REDIRECT_LOGIN_TARGET_URL](#_4c3b6c3954cc5a4b95cd9788e728eac76d01e2003836bc5806ba2949f210375f)
* [REL_PATH_REDIRECT_LOGIN](#_4c3b6c3954cc5a4b95cd9788e728eac76d01e2003836bc5806ba2949f210375f)

---

## Variables

<a id="param_redirect_login_target_tenant"></a>

### `<Const>` PARAM_REDIRECT_LOGIN_TARGET_TENANT

**● PARAM_REDIRECT_LOGIN_TARGET_TENANT**: *"targetTenant"* = "targetTenant"

*Defined in interfaces/login/v1/redirect/index.ts:3*

___
<a id="param_redirect_login_target_url"></a>

### `<Const>` PARAM_REDIRECT_LOGIN_TARGET_URL

**● PARAM_REDIRECT_LOGIN_TARGET_URL**: *"targetUrl"* = "targetUrl"

*Defined in interfaces/login/v1/redirect/index.ts:2*

___
<a id="rel_path_redirect_login"></a>

### `<Const>` REL_PATH_REDIRECT_LOGIN

**● REL_PATH_REDIRECT_LOGIN**: *"login/v1/redirect"* = "login/v1/redirect"

*Defined in interfaces/login/v1/redirect/index.ts:1*

___


<a name="_18958968e7577a9f4c4895d615f9c9d97256a3fee757a047a29cf131498c9281"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/login/v1/removecookies/index"](#_18958968e7577a9f4c4895d615f9c9d97256a3fee757a047a29cf131498c9281)

# External module: "interfaces/login/v1/removecookies/index"

## Index

### Variables

* [REL_PATH_REMOVECOOKIES](#_18958968e7577a9f4c4895d615f9c9d97256a3fee757a047a29cf131498c9281)

---

## Variables

<a id="rel_path_removecookies"></a>

### `<Const>` REL_PATH_REMOVECOOKIES

**● REL_PATH_REMOVECOOKIES**: *"login/v1/removecookies"* = "login/v1/removecookies"

*Defined in interfaces/login/v1/removecookies/index.ts:2*

___


<a name="_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/messages"](#_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d)

# External module: "interfaces/messages/messages"

## Index

### Interfaces

* [SdkErrorResponse](#_086b3d020659d0b203a76fb384ec0a29e5345e41b306a7498860a6ce8ca20739)
* [SdkMessageHandler](#_d29994d1f4237c48503e64e0e98425525f1efc635109e6df19220af2194744df)
* [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

### Type aliases

* [SdkMessageHandlerCallback](#_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d)

---

## Type aliases

<a id="sdkmessagehandlercallback"></a>

###  SdkMessageHandlerCallback

**Ƭ SdkMessageHandlerCallback**: *`function`*

*Defined in interfaces/messages/messages.ts:21*

#### Type declaration
▸(aPayload: *[SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*, aEvent: *`MessageEvent`*):  `PromiseLike`<[SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)> &#124; [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd) &#124; `null` &#124; `undefined`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd) |
| aEvent | `MessageEvent` |

**Returns:**  `PromiseLike`<[SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)> &#124; [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd) &#124; `null` &#124; `undefined`

___


<a name="_622733230f0c6ad31bf56b396da59767cf483237891a5434c9ede42f171aa5c5"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.navigate.by.path.message"](#_622733230f0c6ad31bf56b396da59767cf483237891a5434c9ede42f171aa5c5)

# External module: "interfaces/messages/sdk.navigate.by.path.message"

## Index

### Interfaces

* [SdkNavigateByPathEvent](#_1dcc2ad2f5df6ea8bfd2cabb6709007d77b095a2ec0e92a5a8d3abc63d256dd1)
* [SdkNavigateByPathResponse](#_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9)

### Variables

* [SDK_NAVIGATE_BY_PATH_EVENT_TYPE](#_622733230f0c6ad31bf56b396da59767cf483237891a5434c9ede42f171aa5c5)

---

## Variables

<a id="sdk_navigate_by_path_event_type"></a>

### `<Const>` SDK_NAVIGATE_BY_PATH_EVENT_TYPE

**● SDK_NAVIGATE_BY_PATH_EVENT_TYPE**: *"WchSdk.router.navigateByPath"* = "WchSdk.router.navigateByPath"

*Defined in interfaces/messages/sdk.navigate.by.path.message.ts:7*

___


<a name="_3f4345d27805e6adac090f349258646fff6b3b4347fddefa018197689cd77bad"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.refresh.message"](#_3f4345d27805e6adac090f349258646fff6b3b4347fddefa018197689cd77bad)

# External module: "interfaces/messages/sdk.refresh.message"

## Index

### Interfaces

* [SdkRefreshEvent](#_6e19d0241f945546e7d814b0b404f7f822fe6ac3829c8befa07642ac9fefca6d)

### Variables

* [SDK_REFRESH_EVENT_TYPE](#_3f4345d27805e6adac090f349258646fff6b3b4347fddefa018197689cd77bad)

---

## Variables

<a id="sdk_refresh_event_type"></a>

### `<Const>` SDK_REFRESH_EVENT_TYPE

**● SDK_REFRESH_EVENT_TYPE**: *"WchSdk.refresh"* = "WchSdk.refresh"

*Defined in interfaces/messages/sdk.refresh.message.ts:7*

___


<a name="_45c8d94271d8381ed7d9c3f48e023774f189ee7539fe3ab3a487a84b0f6a89ce"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.set.mode.message"](#_45c8d94271d8381ed7d9c3f48e023774f189ee7539fe3ab3a487a84b0f6a89ce)

# External module: "interfaces/messages/sdk.set.mode.message"

## Index

### Interfaces

* [SdkSetModeEvent](#_12ff6d595ed1cd54201221967438a86ebdcb29f9cb9fcac6292e471641d0bb19)
* [SdkSetModeResponse](#_de536a463d8d61d47aba443cf5397f699b9aa251c39505548bdb668d693e2d3d)

### Variables

* [SDK_SET_MODE_EVENT_TYPE](#_45c8d94271d8381ed7d9c3f48e023774f189ee7539fe3ab3a487a84b0f6a89ce)

---

## Variables

<a id="sdk_set_mode_event_type"></a>

### `<Const>` SDK_SET_MODE_EVENT_TYPE

**● SDK_SET_MODE_EVENT_TYPE**: *"WchSdk.setMode"* = "WchSdk.setMode"

*Defined in interfaces/messages/sdk.set.mode.message.ts:8*

___


<a name="_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.active.route.message"](#_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c)

# External module: "interfaces/messages/sdk.subscribe.active.route.message"

## Index

### Interfaces

* [SdkActiveRouteEvent](#_35b435adfda44c74039da62c0ae2e275f9fcfe65d9941a8eecad21c3ca0bc63d)
* [SdkSubscribeActiveRouteEvent](#_1f82288a8a1b3d2c5eb456cb5bd196b8f04b66e79dce7fe2ab4fb936faf3f133)
* [SdkSubscribeActiveRouteEventResponse](#_313d9363cd04b91697f16ae3964e960a91746a082666347a530f3b4b62d13d70)

### Variables

* [SDK_ACTIVE_ROUTE_EVENT_TYPE](#_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c)
* [SDK_SUBSCRIBE_ACTIVE_ROUTE_EVENT_TYPE](#_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c)

---

## Variables

<a id="sdk_active_route_event_type"></a>

### `<Const>` SDK_ACTIVE_ROUTE_EVENT_TYPE

**● SDK_ACTIVE_ROUTE_EVENT_TYPE**: *"WchSdk.router.activeRoute"* = "WchSdk.router.activeRoute"

*Defined in interfaces/messages/sdk.subscribe.active.route.message.ts:18*

___
<a id="sdk_subscribe_active_route_event_type"></a>

### `<Const>` SDK_SUBSCRIBE_ACTIVE_ROUTE_EVENT_TYPE

**● SDK_SUBSCRIBE_ACTIVE_ROUTE_EVENT_TYPE**: *"WchSdk.router.activeRoute.subscribe"* = "WchSdk.router.activeRoute.subscribe"

*Defined in interfaces/messages/sdk.subscribe.active.route.message.ts:9*

___


<a name="_4faf6361999930d706d52f519fde3d28ef55a5f91cd3180996f94d0f11483c10"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.message"](#_4faf6361999930d706d52f519fde3d28ef55a5f91cd3180996f94d0f11483c10)

# External module: "interfaces/messages/sdk.subscribe.message"

## Index

### Interfaces

* [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)
* [SdkUnsubscribeEvent](#_f253b0386d8b073ba9279a14b7e4702de71a2427d9a4adb1e24c5e7bd72f108e)

### Variables

* [SDK_UNSUBSCRIBE_EVENT_TYPE](#_4faf6361999930d706d52f519fde3d28ef55a5f91cd3180996f94d0f11483c10)

---

## Variables

<a id="sdk_unsubscribe_event_type"></a>

### `<Const>` SDK_UNSUBSCRIBE_EVENT_TYPE

**● SDK_UNSUBSCRIBE_EVENT_TYPE**: *"WchSdk.unsubscribe"* = "WchSdk.unsubscribe"

*Defined in interfaces/messages/sdk.subscribe.message.ts:15*

___


<a name="_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.mode.message"](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032)

# External module: "interfaces/messages/sdk.subscribe.mode.message"

## Index

### Enumerations

* [SdkMode](#_58deb21a3fe224d894883ce6ea9ecf0ec4183ea802602780353ac74891563901)

### Interfaces

* [SdkModeEvent](#_6de4be53e442c5725517437c7b6799ce5fa3eeabc3d67a20dd4252b3c9e9626a)
* [SdkSubscribeModeEvent](#_8d6eaafe0bac757f9a69a4d1b9a6fcf5500f4a0c271e3e9d0cc6faa894201057)
* [SdkSubscribeModeEventResponse](#_eb1b6f5b4c265b848da74af201051e4301c1d32d43c1c025bb1536603fbce955)

### Variables

* [SDK_MODE_EVENT_TYPE](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032)
* [SDK_SUBSCRIBE_MODE_EVENT_TYPE](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032)

---

## Variables

<a id="sdk_mode_event_type"></a>

### `<Const>` SDK_MODE_EVENT_TYPE

**● SDK_MODE_EVENT_TYPE**: *"WchSdk.mode"* = "WchSdk.mode"

*Defined in interfaces/messages/sdk.subscribe.mode.message.ts:22*

___
<a id="sdk_subscribe_mode_event_type"></a>

### `<Const>` SDK_SUBSCRIBE_MODE_EVENT_TYPE

**● SDK_SUBSCRIBE_MODE_EVENT_TYPE**: *"WchSdk.mode.subscribe"* = "WchSdk.mode.subscribe"

*Defined in interfaces/messages/sdk.subscribe.mode.message.ts:8*

___


<a name="_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.route.message"](#_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b)

# External module: "interfaces/messages/sdk.subscribe.route.message"

## Index

### Interfaces

* [SdkRouteEvent](#_72d1c3c929c08f1efa25131c130a3d81c521cb306e5fe9f48b7fba0e54406aed)
* [SdkSubscribeRouteEvent](#_925fdce9c03599c31cc6fdd7e0feecd3ef276321b127b2f99e31af04a12fe426)
* [SdkSubscribeRouteEventResponse](#_1ae7a9f7479052d83894f76819394c62a4260d8d5174db506d09074c0cbde382)

### Variables

* [SDK_ROUTE_EVENT_TYPE](#_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b)
* [SDK_SUBSCRIBE_ROUTE_EVENT_TYPE](#_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b)

---

## Variables

<a id="sdk_route_event_type"></a>

### `<Const>` SDK_ROUTE_EVENT_TYPE

**● SDK_ROUTE_EVENT_TYPE**: *"WchSdk.router.route"* = "WchSdk.router.route"

*Defined in interfaces/messages/sdk.subscribe.route.message.ts:23*

___
<a id="sdk_subscribe_route_event_type"></a>

### `<Const>` SDK_SUBSCRIBE_ROUTE_EVENT_TYPE

**● SDK_SUBSCRIBE_ROUTE_EVENT_TYPE**: *"WchSdk.router.route.subscribe"* = "WchSdk.router.route.subscribe"

*Defined in interfaces/messages/sdk.subscribe.route.message.ts:9*

___


<a name="_45c541ae696659e96d969ecb6cb661833a94f1395541d0f1824511ca1a48ea92"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/query"](#_45c541ae696659e96d969ecb6cb661833a94f1395541d0f1824511ca1a48ea92)

# External module: "interfaces/query"

## Index

### Interfaces

* [Query](#_b0717a0b8bd1bdb56ccd3fd8535dae36bfd2b812165b5ff234dd6233b3994888)

### Type aliases

* [QueryValue](#_45c541ae696659e96d969ecb6cb661833a94f1395541d0f1824511ca1a48ea92)

---

## Type aliases

<a id="queryvalue"></a>

###  QueryValue

**Ƭ QueryValue**: * `string` &#124; `number` &#124; `boolean`
*

*Defined in interfaces/query.ts:4*

___


<a name="_48e8df5998eaafe94429d1e273e001ad85e19cbbdc9904eb084c209d9b16628b"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/registry/v1/currenttenant/index"](#_48e8df5998eaafe94429d1e273e001ad85e19cbbdc9904eb084c209d9b16628b)

# External module: "interfaces/registry/v1/currenttenant/index"

## Index

### Variables

* [REL_PATH_CURRENT_TENANT](#_48e8df5998eaafe94429d1e273e001ad85e19cbbdc9904eb084c209d9b16628b)

---

## Variables

<a id="rel_path_current_tenant"></a>

### `<Const>` REL_PATH_CURRENT_TENANT

**● REL_PATH_CURRENT_TENANT**: *"registry/v1/currenttenant"* = "registry/v1/currenttenant"

*Defined in interfaces/registry/v1/currenttenant/index.ts:2*

___


<a name="_877e2ce0cc1e815e6e0c2332f26ea2eafaa3b05dad4eff1acc8a0796fe37703c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/sdk/router/router"](#_877e2ce0cc1e815e6e0c2332f26ea2eafaa3b05dad4eff1acc8a0796fe37703c)

# External module: "interfaces/sdk/router/router"

## Index

### Interfaces

* [WchSdkRouter](#_446c12901aa836656c4f602ece4da7d668ed48a7d79ea9f410193dd52cf7997b)

---


<a name="_8bafd0c044de202782302356d37bcf05c205090fb4f91611d867bfe41fa9305f"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/sdk/sdk"](#_8bafd0c044de202782302356d37bcf05c205090fb4f91611d867bfe41fa9305f)

# External module: "interfaces/sdk/sdk"

## Index

### Interfaces

* [WchSdk](#_b1755e7911185d570d469df872e7b85e64f291a0f73a1c29fbc6d90f40df2915)

### Variables

* [WCH_SDK_MODULE_NAME](#_8bafd0c044de202782302356d37bcf05c205090fb4f91611d867bfe41fa9305f)

---

## Variables

<a id="wch_sdk_module_name"></a>

### `<Const>` WCH_SDK_MODULE_NAME

**● WCH_SDK_MODULE_NAME**: *"WchSdk"* = "WchSdk"

*Defined in interfaces/sdk/sdk.ts:7*

___


<a name="_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/sdk/search/search"](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8)

# External module: "interfaces/sdk/search/search"

## Index

### Interfaces

* [WchSdkSearch](#_db9743bab70b83e1fc4f3425934a50ee733f4d6b2c4f5502dc57855a29dadfc2)

### Type aliases

* [QueryInput](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8)

---

## Type aliases

<a id="queryinput"></a>

###  QueryInput

**Ƭ QueryInput**: * `string` &#124; `string`[] &#124; `null` &#124; `undefined` &#124; `URLSearchParams` &#124; [Query](#_b0717a0b8bd1bdb56ccd3fd8535dae36bfd2b812165b5ff234dd6233b3994888)
*

*Defined in interfaces/sdk/search/search.ts:7*

___


<a name="_699e57ae41eef21c9f67f14fe8f82ab9b0d9f99ffebf0824e4d75776a1527230"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/sdk/version/version"](#_699e57ae41eef21c9f67f14fe8f82ab9b0d9f99ffebf0824e4d75776a1527230)

# External module: "interfaces/sdk/version/version"

## Index

### Interfaces

* [WchSdkVersion](#_9ef2b7ea5108c90255a4dd52cd81a89e1780782376be4de71629a62a2f9c3906)

---


<a name="_dc2f7042bfb04a1659e8376926cfafdbf79cd46142cd56ef5f33644ae1ac7931"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/user-profile/v1/users/currentuser/index"](#_dc2f7042bfb04a1659e8376926cfafdbf79cd46142cd56ef5f33644ae1ac7931)

# External module: "interfaces/user-profile/v1/users/currentuser/index"

## Index

### Variables

* [REGEXP_ANONYMOUS_USER_ID](#_dc2f7042bfb04a1659e8376926cfafdbf79cd46142cd56ef5f33644ae1ac7931)
* [REL_PATH_CURRENT_USER](#_dc2f7042bfb04a1659e8376926cfafdbf79cd46142cd56ef5f33644ae1ac7931)

---

## Variables

<a id="regexp_anonymous_user_id"></a>

### `<Const>` REGEXP_ANONYMOUS_USER_ID

**● REGEXP_ANONYMOUS_USER_ID**: *`RegExp`* =  /^\w{8}-\w{4}-f\w{3}-\w{4}-\w{12}$/

*Defined in interfaces/user-profile/v1/users/currentuser/index.ts:2*

___
<a id="rel_path_current_user"></a>

### `<Const>` REL_PATH_CURRENT_USER

**● REL_PATH_CURRENT_USER**: *"user-profile/v1/users/currentuser"* = "user-profile/v1/users/currentuser"

*Defined in interfaces/user-profile/v1/users/currentuser/index.ts:1*

___


<a name="_ca2a71da2cd83d09268fcae3830fc011491b514bfb61f4a1a55553b14388d53a"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/hub-info/hub-info"](#_ca2a71da2cd83d09268fcae3830fc011491b514bfb61f4a1a55553b14388d53a)

# External module: "services/hub-info/hub-info"

## Index

### Interfaces

* [HubInfo](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d)

---


<a name="_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/hub-info/hub-info.config"](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d)

# External module: "services/hub-info/hub-info.config"

## Index

### Enumerations

* [CYCLE_HANDLING](#_bda36f5aea4d06bd64140dd9a15509d633074cab6ff5fd08a0207b4e03418730)

### Classes

* [HubInfoConfig](#_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907)

### Interfaces

* [HttpResourceOptions](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)

### Type aliases

* [HubInfoUrlProvider](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d)

---

## Type aliases

<a id="hubinfourlprovider"></a>

###  HubInfoUrlProvider

**Ƭ HubInfoUrlProvider**: * `null` &#124; `undefined` &#124; `URL` &#124; `string` &#124; `function`
*

*Defined in services/hub-info/hub-info.config.ts:33*

___


<a name="_4cbc0ba789efa769fbf2a19947a0e8773ce45da9610f3caff324b33ad67a4cdb"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/info/url.config"](#_4cbc0ba789efa769fbf2a19947a0e8773ce45da9610f3caff324b33ad67a4cdb)

# External module: "services/info/url.config"

## Index

### Interfaces

* [UrlConfig](#_e15d865cc46822109f3eca052d8c218fbc94f028748b684a7cbe967e9cc1fad2)

---


<a name="_ede8ea0fddcda0580eb2bbf4c926b2864731cceeae82765e14e145c093c72fef"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/logging/logger.service"](#_ede8ea0fddcda0580eb2bbf4c926b2864731cceeae82765e14e145c093c72fef)

# External module: "services/logging/logger.service"

## Index

### Interfaces

* [LoggerService](#_48b4d517639a70866875cf1d1c9b9424bc374956657a0d37f0ebf3084c1af70c)

---


<a name="_bf82eb0c990fed72cb6202e6637de386337fcd5333c02a2a11eec69abda51324"></a>
# Logging

The logger interfaces allow to plug custom loggers via the `LoggerFactory`. In addition they expose a simple logger interface, modelled after the standard console logger.

<a name="_93acaf358afd2719ba9b61156e5a1692b35bde21ef30536d187fc22f02dbc33e"></a>
# Delivery

Typescript definitions of the [WCH Delivery APIs](https://developer.ibm.com/api/view/dx-prod:ibm-watson-content-hub:title-IBM_Watson_Content_Hub).
<a name="_68e84d440988b4bf8d61b2879ed7ad2d519769630167e4b8e0da3e7c3a44ea39"></a>
# WchSdk

The SDK defines the plain JS WCH SDK APIs .

## Properties

* [router](#_0557eb1307e18251a07c49f9eee2260c7f975c23eae7e0d6fdba3bc0c1662083)
* [version](#_b0a3f94cae004a78e2ce40a0220853a2c7b3d876b525909f1f03d6212be15ca6) the current version of the SDK, including a version number and the build date

## Methods

* `refresh()`: causes the currently displayed data to be refreshed

The SDK is available on the global window object

```javascript
window.WchSdk
```

## Cross Origin Eventing

The SDK supports [WebMessaging](https://www.w3.org/TR/webmessaging/) to allow communication across frames via the [postMessage](https://www.w3.org/TR/webmessaging/#dom-window-postmessage) functionality. Each message sent to the SDK needs to contain a `type` and an `id` field. The type is used to identify the meaning of the message, the id to allow the caller to correlate potential responses.

Responses to messages sent to the iframe (e.g. messages back from the SDK to the parent frame) can optionally use [channelMessaging](https://www.w3.org/TR/webmessaging/#channel-messaging). If the first element of the transfer object contains a [messagePort](https://www.w3.org/TR/webmessaging/#messageport), this will be used for reply messages or notifications. Else these replies will be sent against the parent window, directly.

### Supported Message Types

* `WchSdk.refresh`: refreshes the data currently displayed by the application. The message has no response.
* `WchSdk.router.navigateByPath`: navigates to the specified path. Responds with a `WchSdk.router.navigateByPathResponse` response. Takes:
    * `path`: path to navigate to
* `WchSdk.router.activeRoute.subscribe`: subscribes a listener for changes in the active route (i.e. navigations). The event will be responsed by a response containing a handle that can be used to unsubscribe. Whenever a navigation occurs, the SDK will send a `WchSdk.router.activeRoute` message to the caller.
* `WchSdk.router.route.subscribe`: subscribes a listener for changes for a given route. The event will be responsed by a response containing a handle that can be used to unsubscribe. Whenever the route changes, comes into existence or is deleted, the SDK will send a `WchSdk.router.route` message to the caller. Takes:
    * `route`: a string or string array that describes the route to listen to. If the value is a string, then it must be the escaped path, starting with a slash but not ending with a slash. If it is a string array, each value represents the unescaped path segment, the segments to not contain slashes.
* `WchSdk.unsubscribe`: unsubscribes from a subscription given the subscription handle
    * `handle`: the subscription handle

### Supported Response Types

* `WchSdk.router.navigateByPathResponse`: sent as a response to a `WchSdk.router.navigateByPath` message from the SDK to the caller. Replicates the caller message fields and in addition:
    * `success`: true if the navigation completed, else false
    * `error`: an optional error object
* `WchSdk.router.activeRoute.subscribeResponse`: sent as a response to `WchSdk.router.activeRoute.subscribe`.
    * `handle`: handle to the subscription, can be used to unsubscribe
* `WchSdk.router.route.subscribeResponse`: sent as a response to `WchSdk.router.route.subscribe`.
    * `handle`: handle to the subscription, can be used to unsubscribe
* `WchSdk.router.activeRoute`: sent from the SDK to the subscriber for modifications in the navigation.
    * `page`: The selected page. Will be `null` if this is the last event (e.g. because of an application shutdown)

## Examples

### Listen for Navigation Events

This example shows how a parent frame can listen for navigation events of an SPA. The example uses [channelMessaging](https://www.w3.org/TR/webmessaging/#channel-messaging) to establish a direct communication channel from the SDK to the parent frame. Navigation events will be sent via this channel.

Note that the use of a channel is not required. If no channel is passed in, the navigation events will be sent directly to the parent window via [postMessage](https://www.w3.org/TR/webmessaging/#dom-window-postmessage).

The example doe NOT show how to unsubscribe.

```javascript
/**
 * Message sent to the SDK to subscribe for navigation notifications
*/
var msg = {
	type: 'WchSdk.router.activeRoute.subscribe',
	id: 'someid'
};

// use a message channel to receive the responses
var channel = new MessageChannel();

/** Perform  the subscription, transfer one end of the channel to the SDK.
 * Note that the second parameter is the origin of the iframe.
*/
myframe.contentWindow.postMessage(msg, "http://localhost:4200", [channel.port2]);

/**
 * Listen for changes in the navigation
 * We expect two types of callbacks here, one for each navigation event
 * and a response sending the subscription handle, so we can unsubscribe later.
 */
channel.port1.addEventListener('message', msg => {
  // check for the message type
  const data = msg.data;
  if (data.type === 'WchSdk.router.activeRoute') {
    // log the active route
	console.log('navigation in iframe', data.page.route);
  } else
  if (data.type === 'WchSdk.router.activeRoute.subscribeResponse') {
	console.log('subscription handle', data.handle);
  }

});
// start the bi-directional communication
channel.port1.start();
```

<a name="_0457e4c7a4d5f3d3229398309f2c7232155d4eab86b58baf4b4a1f08b68e9ac0"></a>
# Messaging

## Cross Origin Eventing

The SDK supports [WebMessaging](https://www.w3.org/TR/webmessaging/) to allow communication across frames via the [postMessage](https://www.w3.org/TR/webmessaging/#dom-window-postmessage) functionality. Each message sent to the SDK needs to contain a `type` and an `id` field. The type is used to identify the meaning of the message, the id to allow the caller to correlate potential responses.

Responses to messages sent to the iframe (e.g. messages back from the SDK to the parent frame) can optionally use [channelMessaging](https://www.w3.org/TR/webmessaging/#channel-messaging). If the first element of the transfer object contains a [messagePort](https://www.w3.org/TR/webmessaging/#messageport), this will be used for reply messages or notifications. Else these replies will be sent against the parent window, directly.

### Supported Message Types

* `WchSdk.refresh`: refreshes the data currently displayed by the application. The message has no response.
* `WchSdk.router.navigateByPath`: navigates to the specified path. Responds with a `WchSdk.router.navigateByPathResponse` response. Takes:
    * `path`: path to navigate to
* `WchSdk.router.activeRoute.subscribe`: subscribes a listener for changes in the active route (i.e. navigations). The event will be responsed by a response containing a handle that can be used to unsubscribe. Whenever a navigation occurs, the SDK will send a `WchSdk.router.activeRoute` message to the caller.
* `WchSdk.router.route.subscribe`: subscribes a listener for changes for a given route. The event will be responsed by a response containing a handle that can be used to unsubscribe. Whenever the route changes, comes into existence or is deleted, the SDK will send a `WchSdk.router.route` message to the caller. Takes:
    * `route`: a string or string array that describes the route to listen to. If the value is a string, then it must be the escaped path, starting with a slash but not ending with a slash. If it is a string array, each value represents the unescaped path segment, the segments to not contain slashes.
* `WchSdk.unsubscribe`: unsubscribes from a subscription given the subscription handle
    * `handle`: the subscription handle

### Supported Response Types

* `WchSdk.router.navigateByPathResponse`: sent as a response to a `WchSdk.router.navigateByPath` message from the SDK to the caller. Replicates the caller message fields and in addition:
    * `success`: true if the navigation completed, else false
    * `error`: an optional error object
* `WchSdk.router.activeRoute.subscribeResponse`: sent as a response to `WchSdk.router.activeRoute.subscribe`.
    * `handle`: handle to the subscription, can be used to unsubscribe
* `WchSdk.router.route.subscribeResponse`: sent as a response to `WchSdk.router.route.subscribe`.
    * `handle`: handle to the subscription, can be used to unsubscribe
* `WchSdk.router.activeRoute`: sent from the SDK to the subscriber for modifications in the navigation.
    * `page`: The selected page. Will be `null` if this is the last event (e.g. because of an application shutdown)

## Examples

### Listen for Navigation Events

This example shows how a parent frame can listen for navigation events of an SPA. The example uses [channelMessaging](https://www.w3.org/TR/webmessaging/#channel-messaging) to establish a direct communication channel from the SDK to the parent frame. Navigation events will be sent via this channel.

Note that the use of a channel is not required. If no channel is passed in, the navigation events will be sent directly to the parent window via [postMessage](https://www.w3.org/TR/webmessaging/#dom-window-postmessage).

The example doe NOT show how to unsubscribe.

```javascript
/**
 * Message sent to the SDK to subscribe for navigation notifications
*/
var msg = {
	type: 'WchSdk.router.activeRoute.subscribe',
	id: 'someid'
};

// use a message channel to receive the responses
var channel = new MessageChannel();

/** Perform  the subscription, transfer one end of the channel to the SDK.
 * Note that the second parameter is the origin of the iframe.
*/
myframe.contentWindow.postMessage(msg, "http://localhost:4200", [channel.port2]);

/**
 * Listen for changes in the navigation
 * We expect two types of callbacks here, one for each navigation event
 * and a response sending the subscription handle, so we can unsubscribe later.
 */
channel.port1.addEventListener('message', msg => {
  // check for the message type
  const data = msg.data;
  if (data.type === 'WchSdk.router.activeRoute') {
    // log the active route
	console.log('navigation in iframe', data.page.route);
  } else
  if (data.type === 'WchSdk.router.activeRoute.subscribeResponse') {
	console.log('subscription handle', data.handle);
  }

});
// start the bi-directional communication
channel.port1.start();
```

<a name="_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0"></a>

#  ibm-wch-sdk-api

## Index

### External modules

* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["interfaces/delivery/v1/base.item"](#_afea4de06c609f7c30a48d607bac01c287499a38006e896a4ab08b7906ab3063)
* ["interfaces/delivery/v1/content/content.item"](#_d75f2e857f4e8c971c4cd86c6565c11a7568bdc75398b7313b79819084ebd704)
* ["interfaces/delivery/v1/content/elements"](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)
* ["interfaces/delivery/v1/error/error"](#_97744c5cae9eea4935d84ca50d2bab30609b14b5d990690fe5302cc7e058e330)
* ["interfaces/delivery/v1/layout/layout"](#_4de850970270efdab4162e42efbd88d3ad575c083a61d4d5fc758dc7eb20bc83)
* ["interfaces/delivery/v1/rendering/context/content.item.with.layout"](#_3e1c601d1e4286ba832c387e66c883b4817df33635e5da74b484b94f9500630d)
* ["interfaces/delivery/v1/rendering/context/extended.context"](#_4e96fea3bf624583a56132c09ee4c876a6d082a2c1c5700653e004424d47adcd)
* ["interfaces/delivery/v1/rendering/context/hub.context"](#_44d86ea768b4a35533f1c78c3f087054bc447e1a105b98f4dbed4e70991f8bdf)
* ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7)
* ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf)
* ["interfaces/delivery/v1/site/site"](#_6145bb40d03cc106e28e159900a0b95f824dab273a47422cd988b271036aecd2)
* ["interfaces/delivery/v1/site/site.child"](#_e94ec2e15f2b437470df7ce154dd6040a61cc5e3df5c6491c685cc7f5c12048a)
* ["interfaces/delivery/v1/site/site.context"](#_7a3c20cbecc6cb9f80b672797a7d6dac6f4c1b6d37af31ef5e6a0e89e682ceb5)
* ["interfaces/delivery/v1/site/site.page"](#_90f532b0241c23c8dde8016164afd8bdd88c7ea5c5820966323cd4d7faa4f136)
* ["interfaces/delivery/v1/user/user"](#_ed80d3696a6bd211bf927dd55e15ca9bcdb1c9237cfd1a121010aa7d2c3592c0)
* ["interfaces/delivery/v1/users/currentuser/constants"](#_ae0cfb6a465c55bfbc2ca945e917786a557433065cc9189a74dde34a5f4d8177)
* ["interfaces/logging/logger"](#_fe515c9b90a4f17a73ce5bc44ed848d7fe5703aea6dfbc28e957c75e091b2a2d)
* ["interfaces/logging/logger.factory"](#_94fa52231da6493363f588763c848f4f7cecf66fe1eb52d61a78d5e4301457a6)
* ["interfaces/login/v1/basicauth/index"](#_dac65c77b0cb0cc52d6d682d26bc9b87600989892e9f3a7ef16dada57362d18e)
* ["interfaces/login/v1/redirect/index"](#_4c3b6c3954cc5a4b95cd9788e728eac76d01e2003836bc5806ba2949f210375f)
* ["interfaces/login/v1/removecookies/index"](#_18958968e7577a9f4c4895d615f9c9d97256a3fee757a047a29cf131498c9281)
* ["interfaces/messages/messages"](#_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d)
* ["interfaces/messages/sdk.navigate.by.path.message"](#_622733230f0c6ad31bf56b396da59767cf483237891a5434c9ede42f171aa5c5)
* ["interfaces/messages/sdk.refresh.message"](#_3f4345d27805e6adac090f349258646fff6b3b4347fddefa018197689cd77bad)
* ["interfaces/messages/sdk.set.mode.message"](#_45c8d94271d8381ed7d9c3f48e023774f189ee7539fe3ab3a487a84b0f6a89ce)
* ["interfaces/messages/sdk.subscribe.active.route.message"](#_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c)
* ["interfaces/messages/sdk.subscribe.message"](#_4faf6361999930d706d52f519fde3d28ef55a5f91cd3180996f94d0f11483c10)
* ["interfaces/messages/sdk.subscribe.mode.message"](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032)
* ["interfaces/messages/sdk.subscribe.route.message"](#_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b)
* ["interfaces/query"](#_45c541ae696659e96d969ecb6cb661833a94f1395541d0f1824511ca1a48ea92)
* ["interfaces/registry/v1/currenttenant/index"](#_48e8df5998eaafe94429d1e273e001ad85e19cbbdc9904eb084c209d9b16628b)
* ["interfaces/sdk/router/router"](#_877e2ce0cc1e815e6e0c2332f26ea2eafaa3b05dad4eff1acc8a0796fe37703c)
* ["interfaces/sdk/sdk"](#_8bafd0c044de202782302356d37bcf05c205090fb4f91611d867bfe41fa9305f)
* ["interfaces/sdk/search/search"](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8)
* ["interfaces/sdk/version/version"](#_699e57ae41eef21c9f67f14fe8f82ab9b0d9f99ffebf0824e4d75776a1527230)
* ["interfaces/user-profile/v1/users/currentuser/index"](#_dc2f7042bfb04a1659e8376926cfafdbf79cd46142cd56ef5f33644ae1ac7931)
* ["services/hub-info/hub-info"](#_ca2a71da2cd83d09268fcae3830fc011491b514bfb61f4a1a55553b14388d53a)
* ["services/hub-info/hub-info.config"](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d)
* ["services/info/url.config"](#_4cbc0ba789efa769fbf2a19947a0e8773ce45da9610f3caff324b33ad67a4cdb)
* ["services/logging/logger.service"](#_ede8ea0fddcda0580eb2bbf4c926b2864731cceeae82765e14e145c093c72fef)

---


<a name="_2af626f2e7ddd4cf63232c734b3502acca4855b128e8582868de477e0b3e7ab5"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/base.item"](#_afea4de06c609f7c30a48d607bac01c287499a38006e896a4ab08b7906ab3063) > [DraftStatus](#_2af626f2e7ddd4cf63232c734b3502acca4855b128e8582868de477e0b3e7ab5)

# Enumeration: DraftStatus

Possible values for draft status

## Index

### Enumeration members

* [APPROVED](#_2af626f2e7ddd4cf63232c734b3502acca4855b128e8582868de477e0b3e7ab5)
* [IN_PROGRESS](#_2af626f2e7ddd4cf63232c734b3502acca4855b128e8582868de477e0b3e7ab5)
* [IN_REVIEW](#_2af626f2e7ddd4cf63232c734b3502acca4855b128e8582868de477e0b3e7ab5)

---

## Enumeration members

<a id="approved"></a>

###  APPROVED

**APPROVED**:  = "approved"

*Defined in interfaces/delivery/v1/base.item.ts:9*

___
<a id="in_progress"></a>

###  IN_PROGRESS

**IN_PROGRESS**:  = "in-progress"

*Defined in interfaces/delivery/v1/base.item.ts:7*

___
<a id="in_review"></a>

###  IN_REVIEW

**IN_REVIEW**:  = "in-review"

*Defined in interfaces/delivery/v1/base.item.ts:8*

___


<a name="_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/base.item"](#_afea4de06c609f7c30a48d607bac01c287499a38006e896a4ab08b7906ab3063) > [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)

# Interface: BaseDeliveryItem

Base interface for all items

## Hierarchy

**BaseDeliveryItem**

↳  [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)

↳  [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)

## Index

### Properties

* [classification](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)
* [created](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)
* [creatorId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)
* [description](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)
* [id](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)
* [lastModified](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)
* [lastModifierId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)
* [name](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)
* [rev](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)

---

## Properties

<a id="classification"></a>

### `<Optional>` classification

**● classification**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:35*

___
<a id="created"></a>

### `<Optional>` created

**● created**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:50*

___
<a id="creatorid"></a>

### `<Optional>` creatorId

**● creatorId**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:52*

___
<a id="description"></a>

### `<Optional>` description

**● description**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:57*

___
<a id="id"></a>

### `<Optional>` id

**● id**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:20*

___
<a id="lastmodified"></a>

### `<Optional>` lastModified

**● lastModified**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:40*

___
<a id="lastmodifierid"></a>

### `<Optional>` lastModifierId

**● lastModifierId**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:45*

___
<a id="name"></a>

### `<Optional>` name

**● name**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:30*

___
<a id="rev"></a>

### `<Optional>` rev

**● rev**: *`string`*

*Defined in interfaces/delivery/v1/base.item.ts:25*

___


<a name="_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/content/content.item"](#_d75f2e857f4e8c971c4cd86c6565c11a7568bdc75398b7313b79819084ebd704) > [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)

# Interface: ContentItem

## Hierarchy

 [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)

**↳ ContentItem**

↳  [ContentItemWithLayout](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)

## Index

### Properties

* [classification](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [created](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [creatorId](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [description](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [draftId](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [draftStatus](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [elements](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [id](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [lastModified](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [lastModifierId](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [locale](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [name](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [rev](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [tags](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [type](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)
* [typeId](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)

---

## Properties

<a id="classification"></a>

### `<Optional>` classification

**● classification**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[classification](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:35*

___
<a id="created"></a>

### `<Optional>` created

**● created**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[created](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:50*

___
<a id="creatorid"></a>

### `<Optional>` creatorId

**● creatorId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[creatorId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:52*

___
<a id="description"></a>

### `<Optional>` description

**● description**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[description](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:57*

___
<a id="draftid"></a>

### `<Optional>` draftId

**● draftId**: *`string`*

*Defined in interfaces/delivery/v1/content/content.item.ts:12*

TBD

___
<a id="draftstatus"></a>

### `<Optional>` draftStatus

**● draftStatus**: * "pending" &#124; "approved"
*

*Defined in interfaces/delivery/v1/content/content.item.ts:17*

TBD

___
<a id="elements"></a>

###  elements

**● elements**: *`object`*

*Defined in interfaces/delivery/v1/content/content.item.ts:41*

#### Type declaration

[key: `string`]: `any`

___
<a id="id"></a>

### `<Optional>` id

**● id**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[id](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:20*

___
<a id="lastmodified"></a>

### `<Optional>` lastModified

**● lastModified**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModified](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:40*

___
<a id="lastmodifierid"></a>

### `<Optional>` lastModifierId

**● lastModifierId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModifierId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:45*

___
<a id="locale"></a>

### `<Optional>` locale

**● locale**: *`string`*

*Defined in interfaces/delivery/v1/content/content.item.ts:27*

___
<a id="name"></a>

### `<Optional>` name

**● name**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[name](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:30*

___
<a id="rev"></a>

### `<Optional>` rev

**● rev**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[rev](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:25*

___
<a id="tags"></a>

### `<Optional>` tags

**● tags**: *`Array`<`string`>*

*Defined in interfaces/delivery/v1/content/content.item.ts:32*

___
<a id="type"></a>

### `<Optional>` type

**● type**: *`string`*

*Defined in interfaces/delivery/v1/content/content.item.ts:48*

___
<a id="typeid"></a>

### `<Optional>` typeId

**● typeId**: *`string`*

*Defined in interfaces/delivery/v1/content/content.item.ts:22*

___


<a name="_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/error/error"](#_97744c5cae9eea4935d84ca50d2bab30609b14b5d990690fe5302cc7e058e330) > [ErrorDetail](#_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d)

# Interface: ErrorDetail

## Hierarchy

**ErrorDetail**

## Index

### Properties

* [locale](#_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d)
* [message](#_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d)
* [name](#_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d)
* [parameters](#_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d)
* [stack](#_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d)

---

## Properties

<a id="locale"></a>

###  locale

**● locale**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:5*

___
<a id="message"></a>

###  message

**● message**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:4*

___
<a id="name"></a>

###  name

**● name**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:3*

___
<a id="parameters"></a>

###  parameters

**● parameters**: *`any`*

*Defined in interfaces/delivery/v1/error/error.ts:6*

___
<a id="stack"></a>

### `<Optional>` stack

**● stack**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:7*

___


<a name="_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/error/error"](#_97744c5cae9eea4935d84ca50d2bab30609b14b5d990690fe5302cc7e058e330) > [ErrorResponse](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)

# Interface: ErrorResponse

JSON structure of an error response

## Hierarchy

**ErrorResponse**

## Index

### Properties

* [description](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)
* [errors](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)
* [message](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)
* [requestId](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)
* [service](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)
* [statusCode](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)
* [version](#_df6ef1b718dde816ff0af5745fb6cf3bb75ee31ebca4c241ac7c6b66ac98bd10)

---

## Properties

<a id="description"></a>

###  description

**● description**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:17*

___
<a id="errors"></a>

###  errors

**● errors**: *[ErrorDetail](#_df96b42e7e859fdb7ce8949add81150afd82db679899a52088941dc947e6d57d)[]*

*Defined in interfaces/delivery/v1/error/error.ts:18*

___
<a id="message"></a>

###  message

**● message**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:19*

___
<a id="requestid"></a>

###  requestId

**● requestId**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:14*

___
<a id="service"></a>

###  service

**● service**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:15*

___
<a id="statuscode"></a>

###  statusCode

**● statusCode**: *`number`*

*Defined in interfaces/delivery/v1/error/error.ts:20*

___
<a id="version"></a>

###  version

**● version**: *`string`*

*Defined in interfaces/delivery/v1/error/error.ts:16*

___


<a name="_64042f4865a37637bcab39d2a8ac86f5077885c81f515da8695361102851740c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/layout/layout"](#_4de850970270efdab4162e42efbd88d3ad575c083a61d4d5fc758dc7eb20bc83) > [Layout](#_64042f4865a37637bcab39d2a8ac86f5077885c81f515da8695361102851740c)

# Interface: Layout

## Hierarchy

**Layout**

## Index

### Properties

* [template](#_64042f4865a37637bcab39d2a8ac86f5077885c81f515da8695361102851740c)
* [templateType](#_64042f4865a37637bcab39d2a8ac86f5077885c81f515da8695361102851740c)

---

## Properties

<a id="template"></a>

###  template

**● template**: *`string`*

*Defined in interfaces/delivery/v1/layout/layout.ts:5*

___
<a id="templatetype"></a>

###  templateType

**● templateType**: *`string`*

*Defined in interfaces/delivery/v1/layout/layout.ts:4*

___


<a name="_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/content.item.with.layout"](#_3e1c601d1e4286ba832c387e66c883b4817df33635e5da74b484b94f9500630d) > [ContentItemWithLayout](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)

# Interface: ContentItemWithLayout

## Hierarchy

↳  [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)

**↳ ContentItemWithLayout**

↳  [RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)

## Index

### Properties

* [classification](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [created](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [creatorId](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [description](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [draftId](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [draftStatus](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [elements](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [id](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [lastModified](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [lastModifierId](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [layouts](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [locale](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [name](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [rev](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [tags](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [type](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)
* [typeId](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)

---

## Properties

<a id="classification"></a>

### `<Optional>` classification

**● classification**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[classification](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:35*

___
<a id="created"></a>

### `<Optional>` created

**● created**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[created](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:50*

___
<a id="creatorid"></a>

### `<Optional>` creatorId

**● creatorId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[creatorId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:52*

___
<a id="description"></a>

### `<Optional>` description

**● description**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[description](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:57*

___
<a id="draftid"></a>

### `<Optional>` draftId

**● draftId**: *`string`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[draftId](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:12*

TBD

___
<a id="draftstatus"></a>

### `<Optional>` draftStatus

**● draftStatus**: * "pending" &#124; "approved"
*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[draftStatus](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:17*

TBD

___
<a id="elements"></a>

###  elements

**● elements**: *`object`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[elements](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:41*

#### Type declaration

[key: `string`]: `any`

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Overrides [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[id](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/rendering/context/content.item.with.layout.ts:10*

___
<a id="lastmodified"></a>

### `<Optional>` lastModified

**● lastModified**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModified](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:40*

___
<a id="lastmodifierid"></a>

### `<Optional>` lastModifierId

**● lastModifierId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModifierId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:45*

___
<a id="layouts"></a>

###  layouts

**● layouts**: *`object`*

*Defined in interfaces/delivery/v1/rendering/context/content.item.with.layout.ts:16*

#### Type declaration

[layoutMode: `string`]: [Layout](#_64042f4865a37637bcab39d2a8ac86f5077885c81f515da8695361102851740c)

___
<a id="locale"></a>

### `<Optional>` locale

**● locale**: *`string`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[locale](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:27*

___
<a id="name"></a>

### `<Optional>` name

**● name**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[name](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:30*

___
<a id="rev"></a>

### `<Optional>` rev

**● rev**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[rev](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:25*

___
<a id="tags"></a>

### `<Optional>` tags

**● tags**: *`Array`<`string`>*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[tags](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:32*

___
<a id="type"></a>

### `<Optional>` type

**● type**: *`string`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[type](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:48*

___
<a id="typeid"></a>

### `<Optional>` typeId

**● typeId**: *`string`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[typeId](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:22*

___


<a name="_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/extended.context"](#_4e96fea3bf624583a56132c09ee4c876a6d082a2c1c5700653e004424d47adcd) > [ExtendedContext](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)

# Interface: ExtendedContext

## Hierarchy

 [SiteContext](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)

**↳ ExtendedContext**

## Index

### Properties

* [breadcrumb](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)
* [children](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)
* [hub](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)
* [parent](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)
* [sibling](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)
* [site](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)

---

## Properties

<a id="breadcrumb"></a>

###  breadcrumb

**● breadcrumb**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)[]*

*Inherited from [SiteContext](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67).[breadcrumb](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)*

*Defined in interfaces/delivery/v1/site/site.context.ts:8*

___
<a id="children"></a>

###  children

**● children**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)[]*

*Inherited from [SiteContext](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67).[children](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)*

*Defined in interfaces/delivery/v1/site/site.context.ts:9*

___
<a id="hub"></a>

### `<Optional>` hub

**● hub**: *[HubContext](#_4799ac267139f3d5886c0d9cb6bef396c39c6fd21495b7b8234e07775b24a36a)*

*Defined in interfaces/delivery/v1/rendering/context/extended.context.ts:6*

___
<a id="parent"></a>

### `<Optional>` parent

**● parent**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Inherited from [SiteContext](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67).[parent](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)*

*Defined in interfaces/delivery/v1/site/site.context.ts:6*

___
<a id="sibling"></a>

###  sibling

**● sibling**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)[]*

*Inherited from [SiteContext](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67).[sibling](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)*

*Defined in interfaces/delivery/v1/site/site.context.ts:7*

___
<a id="site"></a>

###  site

**● site**: *[Site](#_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000)*

*Inherited from [SiteContext](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67).[site](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)*

*Defined in interfaces/delivery/v1/site/site.context.ts:10*

___


<a name="_4799ac267139f3d5886c0d9cb6bef396c39c6fd21495b7b8234e07775b24a36a"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/hub.context"](#_44d86ea768b4a35533f1c78c3f087054bc447e1a105b98f4dbed4e70991f8bdf) > [HubContext](#_4799ac267139f3d5886c0d9cb6bef396c39c6fd21495b7b8234e07775b24a36a)

# Interface: HubContext

## Hierarchy

**HubContext**

## Index

### Properties

* [apiUrl](#_4799ac267139f3d5886c0d9cb6bef396c39c6fd21495b7b8234e07775b24a36a)
* [deliveryUrl](#_4799ac267139f3d5886c0d9cb6bef396c39c6fd21495b7b8234e07775b24a36a)
* [isPreviewMode](#_4799ac267139f3d5886c0d9cb6bef396c39c6fd21495b7b8234e07775b24a36a)

---

## Properties

<a id="apiurl"></a>

###  apiUrl

**● apiUrl**: *`URL`*

*Defined in interfaces/delivery/v1/rendering/context/hub.context.ts:10*

___
<a id="deliveryurl"></a>

###  deliveryUrl

**● deliveryUrl**: *`URL`*

*Defined in interfaces/delivery/v1/rendering/context/hub.context.ts:17*

___
<a id="ispreviewmode"></a>

### `<Optional>` isPreviewMode

**● isPreviewMode**: *`boolean`*

*Defined in interfaces/delivery/v1/rendering/context/hub.context.ts:22*

___


<a name="_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

# Interface: AbstractElement

## Hierarchy

**AbstractElement**

↳  [TextElement](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c)

↳  [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)

↳  [OptionSelectionElement](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18)

↳  [FormattedTextElement](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7)

↳  [NumberElement](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156)

↳  [ToggleElement](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142)

↳  [LinkElement](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6)

↳  [DateElement](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09)

↳  [CategoryElement](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)

↳  [FileElement](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540)

↳  [VideoElement](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73)

↳  [ImageElement](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76)

↳  [ReferenceElement](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6)

↳  [LocationElement](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89)

## Index

### Properties

* [elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *[ELEMENT_TYPE](#_53ab38fecc2ce33e007e93e84a5fe552d57efc24a6ba174a84f98f0fe343f9c8)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:7*

___


<a name="_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Asset](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)

# Interface: Asset

## Hierarchy

**Asset**

## Index

### Properties

* [fileName](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)
* [fileSize](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)
* [height](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)
* [id](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)
* [mediaType](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)
* [resourceUri](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)
* [width](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)

---

## Properties

<a id="filename"></a>

###  fileName

**● fileName**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:245*

___
<a id="filesize"></a>

###  fileSize

**● fileSize**: *`number`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:244*

___
<a id="height"></a>

###  height

**● height**: *`number`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:249*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:242*

___
<a id="mediatype"></a>

###  mediaType

**● mediaType**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:246*

___
<a id="resourceuri"></a>

###  resourceUri

**● resourceUri**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:243*

___
<a id="width"></a>

###  width

**● width**: *`number`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:248*

___


<a name="_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Category](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)

# Interface: Category

## Hierarchy

**Category**

↳  [CategoryElement](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)

## Index

### Properties

* [categories](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)
* [categoryIds](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)
* [categoryPaths](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)

---

## Properties

<a id="categories"></a>

### `<Optional>` categories

**● categories**: *`string`[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:221*

___
<a id="categoryids"></a>

### `<Optional>` categoryIds

**● categoryIds**: *`string`[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:220*

___
<a id="categorypaths"></a>

### `<Optional>` categoryPaths

**● categoryPaths**: *`string`[][]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:223*

___


<a name="_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [CategoryElement](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)

# Interface: CategoryElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

 [Category](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)

**↳ CategoryElement**

## Index

### Properties

* [categories](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)
* [categoryIds](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)
* [categoryPaths](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)
* [elementType](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)

---

## Properties

<a id="categories"></a>

### `<Optional>` categories

**● categories**: *`string`[]*

*Inherited from [Category](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f).[categories](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:221*

___
<a id="categoryids"></a>

### `<Optional>` categoryIds

**● categoryIds**: *`string`[]*

*Inherited from [Category](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f).[categoryIds](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:220*

___
<a id="categorypaths"></a>

### `<Optional>` categoryPaths

**● categoryPaths**: *`string`[][]*

*Inherited from [Category](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f).[categoryPaths](#_1ec63bced966fada4cbbee454ecefad080da8afa33aab0a1c280f3eed2027f1f)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:223*

___
<a id="elementtype"></a>

###  elementType

**● elementType**: *"category"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:238*

___


<a name="_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [DateElement](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09)

# Interface: DateElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ DateElement**

↳  [SingleDateElement](#_93dc8bc3c92170f26ea7331b7046bd044219dd702fcaeb1f9da4842d174eaf74)

↳  [MultiDateElement](#_2b57ec9f1dfd5f28bc48893458cd9f7947f1e4643b404025339b053b6cfa6ce0)

## Index

### Properties

* [elementType](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"datetime"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:191*

___


<a name="_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)

# Interface: ElementMap

## Type parameters
#### T 
## Hierarchy

**ElementMap**

## Indexable

\[key: `string`\]:&nbsp;`T`
## Index

---


<a name="_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)

# Interface: File

## Hierarchy

**File**

↳  [SingleFileElement](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177)

## Index

### Properties

* [asset](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)
* [url](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)

---

## Properties

<a id="asset"></a>

### `<Optional>` asset

**● asset**: *[Asset](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:259*

___
<a id="url"></a>

### `<Optional>` url

**● url**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:260*

___


<a name="_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [FileElement](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540)

# Interface: FileElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ FileElement**

↳  [SingleFileElement](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177)

↳  [MultiFileElement](#_3187c1cfda9f25e464c46d0bb76399746b93d61cb8f007d9aa604890af2a4b25)

## Index

### Properties

* [elementType](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"file"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:267*

___


<a name="_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [FormattedTextElement](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7)

# Interface: FormattedTextElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ FormattedTextElement**

↳  [SingleFormattedTextElement](#_f615a73ccc2555e6868d97b20d9c402cabf1da5de6e7b289cf39aece105b6eab)

↳  [MultiFormattedTextElement](#_b933c37b4644209fa53f66920d5c56400a74d302b7d0b5c025935d6cbb70b6d0)

## Index

### Properties

* [elementType](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"formattedtext"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:102*

___


<a name="_f223c9e6a8ba7a2285a96195622e4afdcadf8851a3591bdcd96ae40db7fe6310"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Group](#_f223c9e6a8ba7a2285a96195622e4afdcadf8851a3591bdcd96ae40db7fe6310)

# Interface: Group

Interface that represents a grouping of elements

## Hierarchy

**Group**

## Indexable

\[key: `string`\]:&nbsp;[Element](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7)
Interface that represents a grouping of elements

## Index

---


<a name="_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)

# Interface: GroupElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ GroupElement**

↳  [SingleGroupElement](#_222b6931f0cca029d0a37348535a172f4619bbb38dea2f8a860cf482a3572e6a)

↳  [MultiGroupElement](#_f7c66899364f4f31e9bb4d2393648295f1eaee3384a6c426d3176b1691442177)

## Index

### Properties

* [elementType](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)
* [typeRef](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"group"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:42*

___
<a id="typeref"></a>

###  typeRef

**● typeRef**: *[TypeRef](#_72e90345ad5c3500a6241f71e3c6d1d3dd28e2e278561692727a43ab3aa7bc64)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:44*

___


<a name="_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)

# Interface: Image

## Hierarchy

**Image**

↳  [SingleImageElement](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)

## Index

### Properties

* [altText](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)
* [asset](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)
* [renditions](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)
* [url](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)

---

## Properties

<a id="alttext"></a>

### `<Optional>` altText

**● altText**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:330*

___
<a id="asset"></a>

### `<Optional>` asset

**● asset**: *[Asset](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:329*

___
<a id="renditions"></a>

### `<Optional>` renditions

**● renditions**: *`object`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:328*

#### Type declaration

[key: `string`]: [Rendition](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)

___
<a id="url"></a>

### `<Optional>` url

**● url**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:331*

___


<a name="_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [ImageElement](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76)

# Interface: ImageElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ ImageElement**

↳  [SingleImageElement](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)

↳  [MultiImageElement](#_80ca3145a4f74a3b4b17ce9213bf5020a18731f72e22f8d1c318b7a91e7ae883)

## Index

### Properties

* [elementType](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"image"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:338*

___


<a name="_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)

# Interface: Link

## Hierarchy

**Link**

↳  [SingleLinkElement](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)

## Index

### Properties

* [linkDescription](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)
* [linkText](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)
* [linkURL](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)

---

## Properties

<a id="linkdescription"></a>

### `<Optional>` linkDescription

**● linkDescription**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:164*

___
<a id="linktext"></a>

### `<Optional>` linkText

**● linkText**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:163*

___
<a id="linkurl"></a>

### `<Optional>` linkURL

**● linkURL**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:162*

___


<a name="_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [LinkElement](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6)

# Interface: LinkElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ LinkElement**

↳  [SingleLinkElement](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)

↳  [MultiLinkElement](#_78af407458457107666257b4333774457c69d3ac0bc5622d4d3d2a87a7f518d2)

## Index

### Properties

* [elementType](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"link"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:171*

___


<a name="_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Location](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8)

# Interface: Location

## Hierarchy

**Location**

↳  [LocationElement](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89)

## Index

### Properties

* [latitude](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8)
* [longitude](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8)

---

## Properties

<a id="latitude"></a>

### `<Optional>` latitude

**● latitude**: *`number`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:375*

___
<a id="longitude"></a>

### `<Optional>` longitude

**● longitude**: *`number`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:376*

___


<a name="_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [LocationElement](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89)

# Interface: LocationElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

 [Location](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8)

**↳ LocationElement**

## Index

### Properties

* [elementType](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89)
* [latitude](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89)
* [longitude](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"location"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:380*

___
<a id="latitude"></a>

### `<Optional>` latitude

**● latitude**: *`number`*

*Inherited from [Location](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8).[latitude](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:375*

___
<a id="longitude"></a>

### `<Optional>` longitude

**● longitude**: *`number`*

*Inherited from [Location](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8).[longitude](#_b70dbd211a1d6d53591fd1de66831937aea94a7ae51d79a361b803d99e311fe8)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:376*

___


<a name="_2b57ec9f1dfd5f28bc48893458cd9f7947f1e4643b404025339b053b6cfa6ce0"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiDateElement](#_2b57ec9f1dfd5f28bc48893458cd9f7947f1e4643b404025339b053b6cfa6ce0)

# Interface: MultiDateElement

## Hierarchy

↳  [DateElement](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09)

**↳ MultiDateElement**

## Index

### Properties

* [elementType](#_2b57ec9f1dfd5f28bc48893458cd9f7947f1e4643b404025339b053b6cfa6ce0)
* [values](#_2b57ec9f1dfd5f28bc48893458cd9f7947f1e4643b404025339b053b6cfa6ce0)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"datetime"*

*Inherited from [DateElement](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09).[elementType](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:191*

___
<a id="values"></a>

###  values

**● values**: *`string`[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:205*

___


<a name="_3187c1cfda9f25e464c46d0bb76399746b93d61cb8f007d9aa604890af2a4b25"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiFileElement](#_3187c1cfda9f25e464c46d0bb76399746b93d61cb8f007d9aa604890af2a4b25)

# Interface: MultiFileElement

## Hierarchy

↳  [FileElement](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540)

**↳ MultiFileElement**

## Index

### Properties

* [elementType](#_3187c1cfda9f25e464c46d0bb76399746b93d61cb8f007d9aa604890af2a4b25)
* [values](#_3187c1cfda9f25e464c46d0bb76399746b93d61cb8f007d9aa604890af2a4b25)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"file"*

*Inherited from [FileElement](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540).[elementType](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:267*

___
<a id="values"></a>

###  values

**● values**: *[File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:284*

___


<a name="_b933c37b4644209fa53f66920d5c56400a74d302b7d0b5c025935d6cbb70b6d0"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiFormattedTextElement](#_b933c37b4644209fa53f66920d5c56400a74d302b7d0b5c025935d6cbb70b6d0)

# Interface: MultiFormattedTextElement

## Hierarchy

↳  [FormattedTextElement](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7)

**↳ MultiFormattedTextElement**

## Index

### Properties

* [elementType](#_b933c37b4644209fa53f66920d5c56400a74d302b7d0b5c025935d6cbb70b6d0)
* [values](#_b933c37b4644209fa53f66920d5c56400a74d302b7d0b5c025935d6cbb70b6d0)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"formattedtext"*

*Inherited from [FormattedTextElement](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7).[elementType](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:102*

___
<a id="values"></a>

###  values

**● values**: *`string`[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:116*

___


<a name="_f7c66899364f4f31e9bb4d2393648295f1eaee3384a6c426d3176b1691442177"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiGroupElement](#_f7c66899364f4f31e9bb4d2393648295f1eaee3384a6c426d3176b1691442177)

# Interface: MultiGroupElement

## Hierarchy

↳  [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)

**↳ MultiGroupElement**

## Index

### Properties

* [elementType](#_f7c66899364f4f31e9bb4d2393648295f1eaee3384a6c426d3176b1691442177)
* [typeRef](#_f7c66899364f4f31e9bb4d2393648295f1eaee3384a6c426d3176b1691442177)
* [values](#_f7c66899364f4f31e9bb4d2393648295f1eaee3384a6c426d3176b1691442177)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"group"*

*Inherited from [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3).[elementType](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:42*

___
<a id="typeref"></a>

###  typeRef

**● typeRef**: *[TypeRef](#_72e90345ad5c3500a6241f71e3c6d1d3dd28e2e278561692727a43ab3aa7bc64)*

*Inherited from [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3).[typeRef](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:44*

___
<a id="values"></a>

###  values

**● values**: *[Group](#_f223c9e6a8ba7a2285a96195622e4afdcadf8851a3591bdcd96ae40db7fe6310)[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:66*

___


<a name="_80ca3145a4f74a3b4b17ce9213bf5020a18731f72e22f8d1c318b7a91e7ae883"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiImageElement](#_80ca3145a4f74a3b4b17ce9213bf5020a18731f72e22f8d1c318b7a91e7ae883)

# Interface: MultiImageElement

## Hierarchy

↳  [ImageElement](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76)

**↳ MultiImageElement**

## Index

### Properties

* [elementType](#_80ca3145a4f74a3b4b17ce9213bf5020a18731f72e22f8d1c318b7a91e7ae883)
* [values](#_80ca3145a4f74a3b4b17ce9213bf5020a18731f72e22f8d1c318b7a91e7ae883)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"image"*

*Inherited from [ImageElement](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76).[elementType](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:338*

___
<a id="values"></a>

###  values

**● values**: *[Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:356*

___


<a name="_78af407458457107666257b4333774457c69d3ac0bc5622d4d3d2a87a7f518d2"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiLinkElement](#_78af407458457107666257b4333774457c69d3ac0bc5622d4d3d2a87a7f518d2)

# Interface: MultiLinkElement

## Hierarchy

↳  [LinkElement](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6)

**↳ MultiLinkElement**

## Index

### Properties

* [elementType](#_78af407458457107666257b4333774457c69d3ac0bc5622d4d3d2a87a7f518d2)
* [values](#_78af407458457107666257b4333774457c69d3ac0bc5622d4d3d2a87a7f518d2)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"link"*

*Inherited from [LinkElement](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6).[elementType](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:171*

___
<a id="values"></a>

###  values

**● values**: *[Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:184*

___


<a name="_36840cbb62256490ae648db8e86fd4ff02348b8e7e649268f6f4d0a7a00cfb91"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiNumberElement](#_36840cbb62256490ae648db8e86fd4ff02348b8e7e649268f6f4d0a7a00cfb91)

# Interface: MultiNumberElement

## Hierarchy

↳  [NumberElement](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156)

**↳ MultiNumberElement**

## Index

### Properties

* [elementType](#_36840cbb62256490ae648db8e86fd4ff02348b8e7e649268f6f4d0a7a00cfb91)
* [values](#_36840cbb62256490ae648db8e86fd4ff02348b8e7e649268f6f4d0a7a00cfb91)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"number"*

*Inherited from [NumberElement](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156).[elementType](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:123*

___
<a id="values"></a>

###  values

**● values**: *`number`[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:137*

___


<a name="_bec62da677db1391c471eadaf28a48379eb7d2755e23776cfca243910f24dd2f"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiOptionSelectionElement](#_bec62da677db1391c471eadaf28a48379eb7d2755e23776cfca243910f24dd2f)

# Interface: MultiOptionSelectionElement

## Hierarchy

↳  [OptionSelectionElement](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18)

**↳ MultiOptionSelectionElement**

## Index

### Properties

* [elementType](#_bec62da677db1391c471eadaf28a48379eb7d2755e23776cfca243910f24dd2f)
* [values](#_bec62da677db1391c471eadaf28a48379eb7d2755e23776cfca243910f24dd2f)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"optionselection"*

*Inherited from [OptionSelectionElement](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18).[elementType](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:81*

___
<a id="values"></a>

###  values

**● values**: *[OptionSelection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:95*

___


<a name="_9fef3a937860227119a6b87f53cd2e16b9ca82fda073bfbcfa58a8450bb27aa3"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiReferenceElement](#_9fef3a937860227119a6b87f53cd2e16b9ca82fda073bfbcfa58a8450bb27aa3)

# Interface: MultiReferenceElement

## Hierarchy

↳  [ReferenceElement](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6)

**↳ MultiReferenceElement**

## Index

### Properties

* [elementType](#_9fef3a937860227119a6b87f53cd2e16b9ca82fda073bfbcfa58a8450bb27aa3)
* [values](#_9fef3a937860227119a6b87f53cd2e16b9ca82fda073bfbcfa58a8450bb27aa3)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"reference"*

*Inherited from [ReferenceElement](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6).[elementType](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:363*

___
<a id="values"></a>

###  values

**● values**: *[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:371*

___


<a name="_c925b289d9f663cd56895cf293d44de6f0bd91724de0c176a1109a0c89cc0d54"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiTextElement](#_c925b289d9f663cd56895cf293d44de6f0bd91724de0c176a1109a0c89cc0d54)

# Interface: MultiTextElement

## Hierarchy

↳  [TextElement](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c)

**↳ MultiTextElement**

## Index

### Properties

* [elementType](#_c925b289d9f663cd56895cf293d44de6f0bd91724de0c176a1109a0c89cc0d54)
* [values](#_c925b289d9f663cd56895cf293d44de6f0bd91724de0c176a1109a0c89cc0d54)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"text"*

*Inherited from [TextElement](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c).[elementType](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:14*

___
<a id="values"></a>

###  values

**● values**: *`string`[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:28*

___


<a name="_f023a7b354c99dab41f5c33babb4fbc62ed86de5f9e118a52ef1aba7a26e47ad"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiToggleElement](#_f023a7b354c99dab41f5c33babb4fbc62ed86de5f9e118a52ef1aba7a26e47ad)

# Interface: MultiToggleElement

## Hierarchy

↳  [ToggleElement](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142)

**↳ MultiToggleElement**

## Index

### Properties

* [elementType](#_f023a7b354c99dab41f5c33babb4fbc62ed86de5f9e118a52ef1aba7a26e47ad)
* [values](#_f023a7b354c99dab41f5c33babb4fbc62ed86de5f9e118a52ef1aba7a26e47ad)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"toggle"*

*Inherited from [ToggleElement](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142).[elementType](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:144*

___
<a id="values"></a>

###  values

**● values**: *`boolean`[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:158*

___


<a name="_8fd3b140a17fbefe86a0404bf4c51a46f28fc1d4bf2275e68992a1bfb55b368d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [MultiVideoElement](#_8fd3b140a17fbefe86a0404bf4c51a46f28fc1d4bf2275e68992a1bfb55b368d)

# Interface: MultiVideoElement

## Hierarchy

↳  [VideoElement](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73)

**↳ MultiVideoElement**

## Index

### Properties

* [elementType](#_8fd3b140a17fbefe86a0404bf4c51a46f28fc1d4bf2275e68992a1bfb55b368d)
* [values](#_8fd3b140a17fbefe86a0404bf4c51a46f28fc1d4bf2275e68992a1bfb55b368d)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"video"*

*Inherited from [VideoElement](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73).[elementType](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:298*

___
<a id="values"></a>

###  values

**● values**: *[Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)[]*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:315*

___


<a name="_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [NumberElement](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156)

# Interface: NumberElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ NumberElement**

↳  [SingleNumberElement](#_af320b1ae3dfe67d140be94c36b9b7705adff5d9a8b0f4410b6b21768bb48899)

↳  [MultiNumberElement](#_36840cbb62256490ae648db8e86fd4ff02348b8e7e649268f6f4d0a7a00cfb91)

## Index

### Properties

* [elementType](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"number"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:123*

___


<a name="_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [OptionSelection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)

# Interface: OptionSelection

Representation of a selection

## Hierarchy

**OptionSelection**

## Index

### Properties

* [label](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)
* [selection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)

---

## Properties

<a id="label"></a>

### `<Optional>` label

**● label**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:73*

___
<a id="selection"></a>

###  selection

**● selection**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:74*

___


<a name="_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [OptionSelectionElement](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18)

# Interface: OptionSelectionElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ OptionSelectionElement**

↳  [SingleOptionSelectionElement](#_e357f4427f30e0f8622a4e0a6f24666a3b08f3ca538635575cef7ea99912729b)

↳  [MultiOptionSelectionElement](#_bec62da677db1391c471eadaf28a48379eb7d2755e23776cfca243910f24dd2f)

## Index

### Properties

* [elementType](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"optionselection"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:81*

___


<a name="_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [ReferenceElement](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6)

# Interface: ReferenceElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ ReferenceElement**

↳  [SingleReferenceElement](#_e5c5486e7981bfd35c72721c070d84617e14b02e6c4b9854e682cbebfea8b1bf)

↳  [MultiReferenceElement](#_9fef3a937860227119a6b87f53cd2e16b9ca82fda073bfbcfa58a8450bb27aa3)

## Index

### Properties

* [elementType](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"reference"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:363*

___


<a name="_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)

# Interface: RenderingContext

## Hierarchy

↳  [ContentItemWithLayout](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)

**↳ RenderingContext**

## Index

### Properties

* [category](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [classification](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [context](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [created](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [creatorId](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [date](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [dates](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [description](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [draftId](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [draftStatus](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [elements](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [file](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [files](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [formattedtext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [formattedtexts](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [group](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [groups](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [id](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [image](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [images](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [lastModified](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [lastModifierId](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [layouts](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [link](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [links](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [locale](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [location](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [markups](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [name](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [number](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [numbers](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [optionselection](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [optionselections](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [reference](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [references](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [rev](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [tags](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [text](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [texts](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [toggle](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [toggles](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [type](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [typeId](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [video](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)
* [videos](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)

---

## Properties

<a id="category"></a>

### `<Optional>` category

**● category**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[CategoryElement](#_0499f758f7fe1cf895888a90e31036fb3d2a7d7adcd22bd4bdf29e0331d7787f)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:431*

___
<a id="classification"></a>

### `<Optional>` classification

**● classification**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[classification](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:35*

___
<a id="context"></a>

###  context

**● context**: *[ExtendedContext](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:436*

___
<a id="created"></a>

### `<Optional>` created

**● created**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[created](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:50*

___
<a id="creatorid"></a>

### `<Optional>` creatorId

**● creatorId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[creatorId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:52*

___
<a id="date"></a>

### `<Optional>` date

**● date**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`Date`>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:417*

___
<a id="dates"></a>

### `<Optional>` dates

**● dates**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`Date`[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:418*

___
<a id="description"></a>

### `<Optional>` description

**● description**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[description](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:57*

___
<a id="draftid"></a>

### `<Optional>` draftId

**● draftId**: *`string`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[draftId](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:12*

TBD

___
<a id="draftstatus"></a>

### `<Optional>` draftStatus

**● draftStatus**: * "pending" &#124; "approved"
*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[draftStatus](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:17*

TBD

___
<a id="elements"></a>

###  elements

**● elements**: *`object`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[elements](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:41*

#### Type declaration

[key: `string`]: `any`

___
<a id="file"></a>

### `<Optional>` file

**● file**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[SingleFileElement](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:421*

___
<a id="files"></a>

### `<Optional>` files

**● files**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:422*

___
<a id="formattedtext"></a>

### `<Optional>` formattedtext

**● formattedtext**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`string`>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:411*

___
<a id="formattedtexts"></a>

### `<Optional>` formattedtexts

**● formattedtexts**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`string`[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:412*

___
<a id="group"></a>

### `<Optional>` group

**● group**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`any`>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:413*

___
<a id="groups"></a>

### `<Optional>` groups

**● groups**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`any`[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:414*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [ContentItemWithLayout](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb).[id](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)*

*Overrides [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[id](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/rendering/context/content.item.with.layout.ts:10*

___
<a id="image"></a>

### `<Optional>` image

**● image**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[SingleImageElement](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:415*

___
<a id="images"></a>

### `<Optional>` images

**● images**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:416*

___
<a id="lastmodified"></a>

### `<Optional>` lastModified

**● lastModified**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModified](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:40*

___
<a id="lastmodifierid"></a>

### `<Optional>` lastModifierId

**● lastModifierId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModifierId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:45*

___
<a id="layouts"></a>

###  layouts

**● layouts**: *`object`*

*Inherited from [ContentItemWithLayout](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb).[layouts](#_24a9d314fc6decf66dc18e9ad3ed750e06dbe2f805afcac40c49d656d86032fb)*

*Defined in interfaces/delivery/v1/rendering/context/content.item.with.layout.ts:16*

#### Type declaration

[layoutMode: `string`]: [Layout](#_64042f4865a37637bcab39d2a8ac86f5077885c81f515da8695361102851740c)

___
<a id="link"></a>

### `<Optional>` link

**● link**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[SingleLinkElement](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:425*

___
<a id="links"></a>

### `<Optional>` links

**● links**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:426*

___
<a id="locale"></a>

### `<Optional>` locale

**● locale**: *`string`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[locale](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:27*

___
<a id="location"></a>

### `<Optional>` location

**● location**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[LocationElement](#_442bb5e6cad51686e25ad952b255c41f05b7fcf670b0eb08687e5d13232b5c89)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:432*

___
<a id="markups"></a>

###  markups

**● markups**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`string`>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:434*

___
<a id="name"></a>

### `<Optional>` name

**● name**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[name](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:30*

___
<a id="number"></a>

### `<Optional>` number

**● number**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`number`>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:409*

___
<a id="numbers"></a>

### `<Optional>` numbers

**● numbers**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`number`[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:410*

___
<a id="optionselection"></a>

### `<Optional>` optionselection

**● optionselection**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[OptionSelection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:427*

___
<a id="optionselections"></a>

### `<Optional>` optionselections

**● optionselections**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[OptionSelection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:428*

___
<a id="reference"></a>

### `<Optional>` reference

**● reference**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:429*

___
<a id="references"></a>

### `<Optional>` references

**● references**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:430*

___
<a id="rev"></a>

### `<Optional>` rev

**● rev**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[rev](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:25*

___
<a id="tags"></a>

### `<Optional>` tags

**● tags**: *`Array`<`string`>*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[tags](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:32*

___
<a id="text"></a>

### `<Optional>` text

**● text**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`string`>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:407*

___
<a id="texts"></a>

### `<Optional>` texts

**● texts**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`string`[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:408*

___
<a id="toggle"></a>

### `<Optional>` toggle

**● toggle**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`boolean`>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:423*

___
<a id="toggles"></a>

### `<Optional>` toggles

**● toggles**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<`boolean`[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:424*

___
<a id="type"></a>

### `<Optional>` type

**● type**: *`string`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[type](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:48*

___
<a id="typeid"></a>

### `<Optional>` typeId

**● typeId**: *`string`*

*Inherited from [ContentItem](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677).[typeId](#_5cfde784307d314cbb9053ad8f919777f23df9cb4aaf6b7dca18161a72fb6677)*

*Defined in interfaces/delivery/v1/content/content.item.ts:22*

___
<a id="video"></a>

### `<Optional>` video

**● video**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[SingleVideoElement](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:419*

___
<a id="videos"></a>

### `<Optional>` videos

**● videos**: *[ElementMap](#_491a0ce6c8494bb80e99bc8f7dfe1fa360c39d2c9b0d221e3d50ef093943c85c)<[Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)[]>*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:420*

___


<a name="_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Rendition](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)

# Interface: Rendition

## Hierarchy

**Rendition**

## Index

### Properties

* [height](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)
* [renditionId](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)
* [source](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)
* [url](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)
* [width](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)

---

## Properties

<a id="height"></a>

###  height

**● height**: *`number`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:324*

___
<a id="renditionid"></a>

###  renditionId

**● renditionId**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:319*

___
<a id="source"></a>

###  source

**● source**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:320*

___
<a id="url"></a>

###  url

**● url**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:322*

___
<a id="width"></a>

###  width

**● width**: *`number`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:323*

___


<a name="_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Resource](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)

# Interface: Resource

## Hierarchy

**Resource**

## Index

### Properties

* [fileName](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)
* [resourceId](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)
* [resourceUri](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)

---

## Properties

<a id="filename"></a>

###  fileName

**● fileName**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:255*

___
<a id="resourceid"></a>

###  resourceId

**● resourceId**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:253*

___
<a id="resourceuri"></a>

###  resourceUri

**● resourceUri**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:254*

___


<a name="_93dc8bc3c92170f26ea7331b7046bd044219dd702fcaeb1f9da4842d174eaf74"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleDateElement](#_93dc8bc3c92170f26ea7331b7046bd044219dd702fcaeb1f9da4842d174eaf74)

# Interface: SingleDateElement

## Hierarchy

↳  [DateElement](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09)

**↳ SingleDateElement**

## Index

### Properties

* [elementType](#_93dc8bc3c92170f26ea7331b7046bd044219dd702fcaeb1f9da4842d174eaf74)
* [value](#_93dc8bc3c92170f26ea7331b7046bd044219dd702fcaeb1f9da4842d174eaf74)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"datetime"*

*Inherited from [DateElement](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09).[elementType](#_3dcc8f7d110cb35506a19123a4b70bbd77c06211899828c2c590809441a9bb09)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:191*

___
<a id="value"></a>

###  value

**● value**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:198*

___


<a name="_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleFileElement](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177)

# Interface: SingleFileElement

## Hierarchy

↳  [FileElement](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540)

 [File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)

**↳ SingleFileElement**

## Index

### Properties

* [asset](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177)
* [elementType](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177)
* [url](#_0a117b9a3d64a48657fb32da3bde73b1f660c43e952aa1a7a429179b71ce8177)

---

## Properties

<a id="asset"></a>

### `<Optional>` asset

**● asset**: *[Asset](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)*

*Inherited from [File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506).[asset](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:259*

___
<a id="elementtype"></a>

###  elementType

**● elementType**: *"file"*

*Inherited from [FileElement](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540).[elementType](#_54f8ac6fe856bb154d190f0bfe3b735df79a4f2219925eb27ba26a217f687540)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:267*

___
<a id="url"></a>

### `<Optional>` url

**● url**: *`string`*

*Inherited from [File](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506).[url](#_6e5064f603b60d60060c099239de9aa7f242b70d589a9883f90ce3dcc0d4b506)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:260*

___


<a name="_f615a73ccc2555e6868d97b20d9c402cabf1da5de6e7b289cf39aece105b6eab"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleFormattedTextElement](#_f615a73ccc2555e6868d97b20d9c402cabf1da5de6e7b289cf39aece105b6eab)

# Interface: SingleFormattedTextElement

## Hierarchy

↳  [FormattedTextElement](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7)

**↳ SingleFormattedTextElement**

## Index

### Properties

* [elementType](#_f615a73ccc2555e6868d97b20d9c402cabf1da5de6e7b289cf39aece105b6eab)
* [value](#_f615a73ccc2555e6868d97b20d9c402cabf1da5de6e7b289cf39aece105b6eab)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"formattedtext"*

*Inherited from [FormattedTextElement](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7).[elementType](#_d52e114cb418058d5f1ab04e3fdf9faeb5e03f998bd98fa2cfbec3e3fb249ee7)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:102*

___
<a id="value"></a>

###  value

**● value**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:109*

___


<a name="_222b6931f0cca029d0a37348535a172f4619bbb38dea2f8a860cf482a3572e6a"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleGroupElement](#_222b6931f0cca029d0a37348535a172f4619bbb38dea2f8a860cf482a3572e6a)

# Interface: SingleGroupElement

## Hierarchy

↳  [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)

**↳ SingleGroupElement**

## Index

### Properties

* [elementType](#_222b6931f0cca029d0a37348535a172f4619bbb38dea2f8a860cf482a3572e6a)
* [typeRef](#_222b6931f0cca029d0a37348535a172f4619bbb38dea2f8a860cf482a3572e6a)
* [value](#_222b6931f0cca029d0a37348535a172f4619bbb38dea2f8a860cf482a3572e6a)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"group"*

*Inherited from [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3).[elementType](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:42*

___
<a id="typeref"></a>

###  typeRef

**● typeRef**: *[TypeRef](#_72e90345ad5c3500a6241f71e3c6d1d3dd28e2e278561692727a43ab3aa7bc64)*

*Inherited from [GroupElement](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3).[typeRef](#_fbcebf588db789e954e28c4df87ff23e78b5fb28c2e386124b8bc93428d13db3)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:44*

___
<a id="value"></a>

###  value

**● value**: *[Group](#_f223c9e6a8ba7a2285a96195622e4afdcadf8851a3591bdcd96ae40db7fe6310)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:59*

___


<a name="_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleImageElement](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)

# Interface: SingleImageElement

## Hierarchy

↳  [ImageElement](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76)

 [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)

**↳ SingleImageElement**

## Index

### Properties

* [altText](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)
* [asset](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)
* [elementType](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)
* [renditions](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)
* [url](#_45790e258d3ac8f8c6ebc0ae291425b4fb37e4c130c0e08cb28336904b8fe46c)

---

## Properties

<a id="alttext"></a>

### `<Optional>` altText

**● altText**: *`string`*

*Inherited from [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a).[altText](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:330*

___
<a id="asset"></a>

### `<Optional>` asset

**● asset**: *[Asset](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)*

*Inherited from [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a).[asset](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:329*

___
<a id="elementtype"></a>

###  elementType

**● elementType**: *"image"*

*Inherited from [ImageElement](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76).[elementType](#_36eea96b3bbee1f3df4068fe46479c45ffb9f5636f09e63bdd588b0815acba76)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:338*

___
<a id="renditions"></a>

### `<Optional>` renditions

**● renditions**: *`object`*

*Inherited from [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a).[renditions](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:328*

#### Type declaration

[key: `string`]: [Rendition](#_0fa645ab4dc91906d07fe59b5a98629aadc222a270fa56c505f6dea06e36c47f)

___
<a id="url"></a>

### `<Optional>` url

**● url**: *`string`*

*Inherited from [Image](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a).[url](#_a969c122f0eb66f14e88365866d2be50537d2b32ea5ebffa518b79f3c134e73a)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:331*

___


<a name="_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleLinkElement](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)

# Interface: SingleLinkElement

## Hierarchy

↳  [LinkElement](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6)

 [Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)

**↳ SingleLinkElement**

## Index

### Properties

* [elementType](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)
* [linkDescription](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)
* [linkText](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)
* [linkURL](#_fd1f03fd26a9c0a19661b2ba932736ddc2a756abe495f1866dbaa23cff618344)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"link"*

*Inherited from [LinkElement](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6).[elementType](#_8470e08dc1886d316869d513606370f6b6970911596218d3fa3ce32c9545f0a6)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:171*

___
<a id="linkdescription"></a>

### `<Optional>` linkDescription

**● linkDescription**: *`string`*

*Inherited from [Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7).[linkDescription](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:164*

___
<a id="linktext"></a>

### `<Optional>` linkText

**● linkText**: *`string`*

*Inherited from [Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7).[linkText](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:163*

___
<a id="linkurl"></a>

### `<Optional>` linkURL

**● linkURL**: *`string`*

*Inherited from [Link](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7).[linkURL](#_0b2df82fc8810b1c31aef6c9cac9be4ee600bd4cb2ac7b61562f58ac4d0ce2b7)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:162*

___


<a name="_af320b1ae3dfe67d140be94c36b9b7705adff5d9a8b0f4410b6b21768bb48899"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleNumberElement](#_af320b1ae3dfe67d140be94c36b9b7705adff5d9a8b0f4410b6b21768bb48899)

# Interface: SingleNumberElement

## Hierarchy

↳  [NumberElement](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156)

**↳ SingleNumberElement**

## Index

### Properties

* [elementType](#_af320b1ae3dfe67d140be94c36b9b7705adff5d9a8b0f4410b6b21768bb48899)
* [value](#_af320b1ae3dfe67d140be94c36b9b7705adff5d9a8b0f4410b6b21768bb48899)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"number"*

*Inherited from [NumberElement](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156).[elementType](#_2debdf02c4190926a597a407d6b66702ecef9da33d939953b7053b39d3df7156)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:123*

___
<a id="value"></a>

###  value

**● value**: *`number`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:130*

___


<a name="_e357f4427f30e0f8622a4e0a6f24666a3b08f3ca538635575cef7ea99912729b"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleOptionSelectionElement](#_e357f4427f30e0f8622a4e0a6f24666a3b08f3ca538635575cef7ea99912729b)

# Interface: SingleOptionSelectionElement

## Hierarchy

↳  [OptionSelectionElement](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18)

**↳ SingleOptionSelectionElement**

## Index

### Properties

* [elementType](#_e357f4427f30e0f8622a4e0a6f24666a3b08f3ca538635575cef7ea99912729b)
* [value](#_e357f4427f30e0f8622a4e0a6f24666a3b08f3ca538635575cef7ea99912729b)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"optionselection"*

*Inherited from [OptionSelectionElement](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18).[elementType](#_38740dd7ed81503dcdfacf776abae6c8ec932e0c21411a72481e631e4887ba18)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:81*

___
<a id="value"></a>

###  value

**● value**: *[OptionSelection](#_1d37f5e95bbf41b664636133719f39054535bc8980d01a7267c2f9a31893ac8c)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:88*

___


<a name="_e5c5486e7981bfd35c72721c070d84617e14b02e6c4b9854e682cbebfea8b1bf"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleReferenceElement](#_e5c5486e7981bfd35c72721c070d84617e14b02e6c4b9854e682cbebfea8b1bf)

# Interface: SingleReferenceElement

## Hierarchy

↳  [ReferenceElement](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6)

**↳ SingleReferenceElement**

## Index

### Properties

* [elementType](#_e5c5486e7981bfd35c72721c070d84617e14b02e6c4b9854e682cbebfea8b1bf)
* [value](#_e5c5486e7981bfd35c72721c070d84617e14b02e6c4b9854e682cbebfea8b1bf)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"reference"*

*Inherited from [ReferenceElement](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6).[elementType](#_bd6224ab393d9ef1b45e7ac57213b5cc4f0d9119677d38e76d30d244eeb3c1d6)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:363*

___
<a id="value"></a>

###  value

**● value**: *[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:367*

___


<a name="_c71214e31a75cf8303591bc5088d69405026c036159ac98f107f9e47839e7d32"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleTextElement](#_c71214e31a75cf8303591bc5088d69405026c036159ac98f107f9e47839e7d32)

# Interface: SingleTextElement

## Hierarchy

↳  [TextElement](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c)

**↳ SingleTextElement**

## Index

### Properties

* [elementType](#_c71214e31a75cf8303591bc5088d69405026c036159ac98f107f9e47839e7d32)
* [value](#_c71214e31a75cf8303591bc5088d69405026c036159ac98f107f9e47839e7d32)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"text"*

*Inherited from [TextElement](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c).[elementType](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:14*

___
<a id="value"></a>

###  value

**● value**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:21*

___


<a name="_a6566fa719ef6b265d7fdf7b118b4b5a6e9e4dc7d406712ca492ecd1f5222a0a"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleToggleElement](#_a6566fa719ef6b265d7fdf7b118b4b5a6e9e4dc7d406712ca492ecd1f5222a0a)

# Interface: SingleToggleElement

## Hierarchy

↳  [ToggleElement](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142)

**↳ SingleToggleElement**

## Index

### Properties

* [elementType](#_a6566fa719ef6b265d7fdf7b118b4b5a6e9e4dc7d406712ca492ecd1f5222a0a)
* [value](#_a6566fa719ef6b265d7fdf7b118b4b5a6e9e4dc7d406712ca492ecd1f5222a0a)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"toggle"*

*Inherited from [ToggleElement](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142).[elementType](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:144*

___
<a id="value"></a>

###  value

**● value**: *`boolean`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:151*

___


<a name="_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [SingleVideoElement](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)

# Interface: SingleVideoElement

## Hierarchy

↳  [VideoElement](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73)

 [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)

**↳ SingleVideoElement**

## Index

### Properties

* [asset](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)
* [caption](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)
* [elementType](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)
* [thumbnail](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)
* [url](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)

---

## Properties

<a id="asset"></a>

### `<Optional>` asset

**● asset**: *[Asset](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)*

*Inherited from [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d).[asset](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:290*

___
<a id="caption"></a>

### `<Optional>` caption

**● caption**: *[Resource](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)*

*Inherited from [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d).[caption](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:288*

___
<a id="elementtype"></a>

###  elementType

**● elementType**: *"video"*

*Inherited from [VideoElement](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73).[elementType](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73)*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:298*

___
<a id="thumbnail"></a>

### `<Optional>` thumbnail

**● thumbnail**: *[Resource](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)*

*Inherited from [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d).[thumbnail](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:289*

___
<a id="url"></a>

### `<Optional>` url

**● url**: *`string`*

*Inherited from [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d).[url](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:291*

___


<a name="_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [TextElement](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c)

# Interface: TextElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ TextElement**

↳  [SingleTextElement](#_c71214e31a75cf8303591bc5088d69405026c036159ac98f107f9e47839e7d32)

↳  [MultiTextElement](#_c925b289d9f663cd56895cf293d44de6f0bd91724de0c176a1109a0c89cc0d54)

## Index

### Properties

* [elementType](#_e57794eb7f14736e519f6a60620e3a9f1fe98bca5f49bb32875b6bf5bd2c789c)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"text"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:14*

___


<a name="_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [ToggleElement](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142)

# Interface: ToggleElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ ToggleElement**

↳  [SingleToggleElement](#_a6566fa719ef6b265d7fdf7b118b4b5a6e9e4dc7d406712ca492ecd1f5222a0a)

↳  [MultiToggleElement](#_f023a7b354c99dab41f5c33babb4fbc62ed86de5f9e118a52ef1aba7a26e47ad)

## Index

### Properties

* [elementType](#_aec7107935f4e761743e7be97087f02548e164a1e224ebe0754622a407abb142)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"toggle"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:144*

___


<a name="_72e90345ad5c3500a6241f71e3c6d1d3dd28e2e278561692727a43ab3aa7bc64"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [TypeRef](#_72e90345ad5c3500a6241f71e3c6d1d3dd28e2e278561692727a43ab3aa7bc64)

# Interface: TypeRef

Reference to a content type

## Hierarchy

**TypeRef**

## Index

### Properties

* [id](#_72e90345ad5c3500a6241f71e3c6d1d3dd28e2e278561692727a43ab3aa7bc64)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:35*

___


<a name="_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [Video](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)

# Interface: Video

## Hierarchy

**Video**

↳  [SingleVideoElement](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)

## Index

### Properties

* [asset](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)
* [caption](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)
* [thumbnail](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)
* [url](#_e2f44afc51ed573897a7e516a2365019f66f3d9bd20128e87afd24543d18439d)

---

## Properties

<a id="asset"></a>

### `<Optional>` asset

**● asset**: *[Asset](#_972e831208a5b9c80a476ebc0efc9fa22bc8ef09799d7fe1ff9bfb9c8e27f8c9)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:290*

___
<a id="caption"></a>

### `<Optional>` caption

**● caption**: *[Resource](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:288*

___
<a id="thumbnail"></a>

### `<Optional>` thumbnail

**● thumbnail**: *[Resource](#_90dbcd674e572da0b3a833c40701f5e5cdf418d5f34f1836bb188b47bbcd128e)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:289*

___
<a id="url"></a>

### `<Optional>` url

**● url**: *`string`*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:291*

___


<a name="_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/rendering/context/rendering.context"](#_0185f15535291ba2d99f8860819d4bdc90c5c488c9b3d156f70d0aac973bd1b7) > [VideoElement](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73)

# Interface: VideoElement

## Hierarchy

 [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)

**↳ VideoElement**

↳  [SingleVideoElement](#_9509da65c039d1256ebbc83094a2794700c58263605b811ef5ecfbb5813c3d71)

↳  [MultiVideoElement](#_8fd3b140a17fbefe86a0404bf4c51a46f28fc1d4bf2275e68992a1bfb55b368d)

## Index

### Properties

* [elementType](#_0c9e6f8d672ec45a3041cac7c90a83cf10b7803db4b5011630f989044ac28b73)

---

## Properties

<a id="elementtype"></a>

###  elementType

**● elementType**: *"video"*

*Overrides [AbstractElement](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63).[elementType](#_2bda7c1e69fb0ce5980275e4c86d63af53ca3828c047a2e798f504c533edfe63)*

*Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:298*

___


<a name="_f1e2a6f45ddaedd9474e21f536e5d992fa5fa44853bf1fc9d6040279230145cf"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf) > [PageSearchResult](#_f1e2a6f45ddaedd9474e21f536e5d992fa5fa44853bf1fc9d6040279230145cf)

# Interface: PageSearchResult

## Hierarchy

 [SearchResult](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f)<[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)>

**↳ PageSearchResult**

## Index

### Properties

* [document](#_f1e2a6f45ddaedd9474e21f536e5d992fa5fa44853bf1fc9d6040279230145cf)

---

## Properties

<a id="document"></a>

###  document

**● document**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Overrides [SearchResult](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f).[document](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f)*

*Defined in interfaces/delivery/v1/search/search.result.ts:14*

___


<a name="_8ab884cdc475a46f409f9714cdd0fae9e0bd14bd4a26d7241dc0f9e5993bd975"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf) > [RenderingContextQueryResult](#_8ab884cdc475a46f409f9714cdd0fae9e0bd14bd4a26d7241dc0f9e5993bd975)

# Interface: RenderingContextQueryResult

## Hierarchy

**RenderingContextQueryResult**

## Index

### Properties

* [numFound](#_8ab884cdc475a46f409f9714cdd0fae9e0bd14bd4a26d7241dc0f9e5993bd975)
* [renderingContexts](#_8ab884cdc475a46f409f9714cdd0fae9e0bd14bd4a26d7241dc0f9e5993bd975)

---

## Properties

<a id="numfound"></a>

###  numFound

**● numFound**: *`number`*

*Defined in interfaces/delivery/v1/search/search.result.ts:24*

___
<a id="renderingcontexts"></a>

###  renderingContexts

**● renderingContexts**: *[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)[]*

*Defined in interfaces/delivery/v1/search/search.result.ts:26*

___


<a name="_0da8e0ee755c3653ef1ac0645e9676ab4ba6f9512404b63a0ee8ac655b1a4846"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf) > [RenderingContextSearchResult](#_0da8e0ee755c3653ef1ac0645e9676ab4ba6f9512404b63a0ee8ac655b1a4846)

# Interface: RenderingContextSearchResult

## Hierarchy

 [SearchResult](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f)<[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)>

**↳ RenderingContextSearchResult**

## Index

### Properties

* [document](#_0da8e0ee755c3653ef1ac0645e9676ab4ba6f9512404b63a0ee8ac655b1a4846)

---

## Properties

<a id="document"></a>

###  document

**● document**: *[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)*

*Overrides [SearchResult](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f).[document](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f)*

*Defined in interfaces/delivery/v1/search/search.result.ts:10*

___


<a name="_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf) > [SearchResult](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f)

# Interface: SearchResult

## Type parameters
#### T 
## Hierarchy

**SearchResult**

↳  [RenderingContextSearchResult](#_0da8e0ee755c3653ef1ac0645e9676ab4ba6f9512404b63a0ee8ac655b1a4846)

↳  [PageSearchResult](#_f1e2a6f45ddaedd9474e21f536e5d992fa5fa44853bf1fc9d6040279230145cf)

## Index

### Properties

* [document](#_0d5e0a3f89264b324ff64228d2a8d8f59c8266d58b4e46a5e35443ab38e02a3f)

---

## Properties

<a id="document"></a>

###  document

**● document**: *`T`*

*Defined in interfaces/delivery/v1/search/search.result.ts:6*

___


<a name="_12c67d7429a19401c081b1ad2073b6ec0c6bd1228051de2c1e513935c3bccb9c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf) > [SearchResults](#_12c67d7429a19401c081b1ad2073b6ec0c6bd1228051de2c1e513935c3bccb9c)

# Interface: SearchResults

## Type parameters
#### T 
## Hierarchy

**SearchResults**

## Index

### Properties

* [documents](#_12c67d7429a19401c081b1ad2073b6ec0c6bd1228051de2c1e513935c3bccb9c)
* [numFound](#_12c67d7429a19401c081b1ad2073b6ec0c6bd1228051de2c1e513935c3bccb9c)

---

## Properties

<a id="documents"></a>

### `<Optional>` documents

**● documents**: *`T`[]*

*Defined in interfaces/delivery/v1/search/search.result.ts:19*

___
<a id="numfound"></a>

###  numFound

**● numFound**: *`number`*

*Defined in interfaces/delivery/v1/search/search.result.ts:18*

___


<a name="_0bb838053c0a65d4b266eb8188b988de622519d5ac81ee7dc310486dd8ff26f9"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/search/search.result"](#_8e52c01a44fd4fb6290031f0a2d2302388e668375c584002312eeccc0fe78bdf) > [SitePagesQueryResult](#_0bb838053c0a65d4b266eb8188b988de622519d5ac81ee7dc310486dd8ff26f9)

# Interface: SitePagesQueryResult

## Hierarchy

**SitePagesQueryResult**

## Index

### Properties

* [numFound](#_0bb838053c0a65d4b266eb8188b988de622519d5ac81ee7dc310486dd8ff26f9)
* [sitePages](#_0bb838053c0a65d4b266eb8188b988de622519d5ac81ee7dc310486dd8ff26f9)

---

## Properties

<a id="numfound"></a>

###  numFound

**● numFound**: *`number`*

*Defined in interfaces/delivery/v1/search/search.result.ts:31*

___
<a id="sitepages"></a>

###  sitePages

**● sitePages**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)[]*

*Defined in interfaces/delivery/v1/search/search.result.ts:33*

___


<a name="_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site"](#_6145bb40d03cc106e28e159900a0b95f824dab273a47422cd988b271036aecd2) > [Site](#_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000)

# Interface: Site

## Hierarchy

 [SiteRoot](#_304b6432baca923435e7277682bb8f27afe6a84efaf7d6b77f8e3062b270ebd2)

**↳ Site**

## Index

### Properties

* [id](#_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000)
* [name](#_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000)
* [pages](#_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Defined in interfaces/delivery/v1/site/site.ts:7*

___
<a id="name"></a>

### `<Optional>` name

**● name**: *`string`*

*Defined in interfaces/delivery/v1/site/site.ts:8*

___
<a id="pages"></a>

###  pages

**● pages**: *[SiteChild](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)[]*

*Defined in interfaces/delivery/v1/site/site.ts:9*

___


<a name="_304b6432baca923435e7277682bb8f27afe6a84efaf7d6b77f8e3062b270ebd2"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site"](#_6145bb40d03cc106e28e159900a0b95f824dab273a47422cd988b271036aecd2) > [SiteRoot](#_304b6432baca923435e7277682bb8f27afe6a84efaf7d6b77f8e3062b270ebd2)

# Interface: SiteRoot

## Hierarchy

**SiteRoot**

↳  [Site](#_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000)

## Index

---


<a name="_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site.child"](#_e94ec2e15f2b437470df7ce154dd6040a61cc5e3df5c6491c685cc7f5c12048a) > [SiteChild](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)

# Interface: SiteChild

## Hierarchy

↳  [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)

**↳ SiteChild**

## Index

### Properties

* [children](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [classification](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [contentId](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [contentStatus](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [contentTypeId](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [created](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [creatorId](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [decodedRoute](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [description](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [externalContext](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [hideFromNavigation](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [id](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [lastModified](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [lastModifierId](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [name](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [parentId](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [rev](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [route](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)
* [title](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)

---

## Properties

<a id="children"></a>

###  children

**● children**: *[SiteChild](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)[]*

*Defined in interfaces/delivery/v1/site/site.child.ts:5*

___
<a id="classification"></a>

### `<Optional>` classification

**● classification**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[classification](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:35*

___
<a id="contentid"></a>

###  contentId

**● contentId**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[contentId](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:11*

___
<a id="contentstatus"></a>

###  contentStatus

**● contentStatus**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[contentStatus](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:6*

___
<a id="contenttypeid"></a>

###  contentTypeId

**● contentTypeId**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[contentTypeId](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:7*

___
<a id="created"></a>

### `<Optional>` created

**● created**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[created](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:50*

___
<a id="creatorid"></a>

### `<Optional>` creatorId

**● creatorId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[creatorId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:52*

___
<a id="decodedroute"></a>

###  decodedRoute

**● decodedRoute**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[decodedRoute](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:9*

___
<a id="description"></a>

### `<Optional>` description

**● description**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[description](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Overrides [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[description](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/site/site.page.ts:14*

___
<a id="externalcontext"></a>

### `<Optional>` externalContext

**● externalContext**: *`any`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[externalContext](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:16*

___
<a id="hidefromnavigation"></a>

###  hideFromNavigation

**● hideFromNavigation**: *`boolean`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[hideFromNavigation](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:15*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[id](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Overrides [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[id](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/site/site.page.ts:5*

___
<a id="lastmodified"></a>

### `<Optional>` lastModified

**● lastModified**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModified](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:40*

___
<a id="lastmodifierid"></a>

### `<Optional>` lastModifierId

**● lastModifierId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModifierId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:45*

___
<a id="name"></a>

###  name

**● name**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[name](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Overrides [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[name](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/site/site.page.ts:10*

___
<a id="parentid"></a>

### `<Optional>` parentId

**● parentId**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[parentId](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:13*

___
<a id="rev"></a>

### `<Optional>` rev

**● rev**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[rev](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:25*

___
<a id="route"></a>

###  route

**● route**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[route](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:8*

___
<a id="title"></a>

### `<Optional>` title

**● title**: *`string`*

*Inherited from [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3).[title](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.page.ts:12*

___


<a name="_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site.context"](#_7a3c20cbecc6cb9f80b672797a7d6dac6f4c1b6d37af31ef5e6a0e89e682ceb5) > [SiteContext](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)

# Interface: SiteContext

## Hierarchy

**SiteContext**

↳  [ExtendedContext](#_21e05187b5e7b8211316c81961c61406802dbb6eda5e303b685d129b33e4ce19)

## Index

### Properties

* [breadcrumb](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)
* [children](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)
* [parent](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)
* [sibling](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)
* [site](#_c0de0a8a8297e49645b4f7084158634a382194ac00b48ffd07db34c81d296e67)

---

## Properties

<a id="breadcrumb"></a>

###  breadcrumb

**● breadcrumb**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)[]*

*Defined in interfaces/delivery/v1/site/site.context.ts:8*

___
<a id="children"></a>

###  children

**● children**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)[]*

*Defined in interfaces/delivery/v1/site/site.context.ts:9*

___
<a id="parent"></a>

### `<Optional>` parent

**● parent**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/delivery/v1/site/site.context.ts:6*

___
<a id="sibling"></a>

###  sibling

**● sibling**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)[]*

*Defined in interfaces/delivery/v1/site/site.context.ts:7*

___
<a id="site"></a>

###  site

**● site**: *[Site](#_9537ba1714d8fec19693121cf288eac89f98d9f480df9e9981586250f116d000)*

*Defined in interfaces/delivery/v1/site/site.context.ts:10*

___


<a name="_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/user/user"](#_ed80d3696a6bd211bf927dd55e15ca9bcdb1c9237cfd1a121010aa7d2c3592c0) > [User](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)

# Interface: User

## Hierarchy

**User**

## Index

### Properties

* [created](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [creator](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [displayName](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [externalId](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [firstName](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [id](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [lastLogin](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [lastModified](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [lastModifier](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [lastName](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)
* [roles](#_2e465686aa38974e18b8cbc93e2e90d2ffe99dfdc3c11d7962f6a4e2cc5ee769)

---

## Properties

<a id="created"></a>

### `<Optional>` created

**● created**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:27*

___
<a id="creator"></a>

### `<Optional>` creator

**● creator**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:29*

___
<a id="displayname"></a>

### `<Optional>` displayName

**● displayName**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:18*

___
<a id="externalid"></a>

###  externalId

**● externalId**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:9*

___
<a id="firstname"></a>

### `<Optional>` firstName

**● firstName**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:12*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:6*

___
<a id="lastlogin"></a>

### `<Optional>` lastLogin

**● lastLogin**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:24*

___
<a id="lastmodified"></a>

### `<Optional>` lastModified

**● lastModified**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:32*

___
<a id="lastmodifier"></a>

### `<Optional>` lastModifier

**● lastModifier**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:34*

___
<a id="lastname"></a>

### `<Optional>` lastName

**● lastName**: *`string`*

*Defined in interfaces/delivery/v1/user/user.ts:15*

___
<a id="roles"></a>

###  roles

**● roles**: *`string`[]*

*Defined in interfaces/delivery/v1/user/user.ts:21*

___


<a name="_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/delivery/v1/site/site.page"](#_90f532b0241c23c8dde8016164afd8bdd88c7ea5c5820966323cd4d7faa4f136) > [SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)

# Interface: SitePage

## Hierarchy

 [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)

**↳ SitePage**

↳  [SiteChild](#_e5a94736b92c39c8db0cf7f21f9bcdd987f2a6d92b47ed8b98ab225b333444ce)

## Index

### Properties

* [classification](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [contentId](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [contentStatus](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [contentTypeId](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [created](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [creatorId](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [decodedRoute](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [description](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [externalContext](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [hideFromNavigation](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [id](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [lastModified](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [lastModifierId](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [name](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [parentId](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [rev](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [route](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)
* [title](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)

---

## Properties

<a id="classification"></a>

### `<Optional>` classification

**● classification**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[classification](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:35*

___
<a id="contentid"></a>

###  contentId

**● contentId**: *`string`*

*Defined in interfaces/delivery/v1/site/site.page.ts:11*

___
<a id="contentstatus"></a>

###  contentStatus

**● contentStatus**: *`string`*

*Defined in interfaces/delivery/v1/site/site.page.ts:6*

___
<a id="contenttypeid"></a>

###  contentTypeId

**● contentTypeId**: *`string`*

*Defined in interfaces/delivery/v1/site/site.page.ts:7*

___
<a id="created"></a>

### `<Optional>` created

**● created**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[created](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:50*

___
<a id="creatorid"></a>

### `<Optional>` creatorId

**● creatorId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[creatorId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:52*

___
<a id="decodedroute"></a>

###  decodedRoute

**● decodedRoute**: *`string`*

*Defined in interfaces/delivery/v1/site/site.page.ts:9*

___
<a id="description"></a>

### `<Optional>` description

**● description**: *`string`*

*Overrides [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[description](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/site/site.page.ts:14*

___
<a id="externalcontext"></a>

### `<Optional>` externalContext

**● externalContext**: *`any`*

*Defined in interfaces/delivery/v1/site/site.page.ts:16*

___
<a id="hidefromnavigation"></a>

###  hideFromNavigation

**● hideFromNavigation**: *`boolean`*

*Defined in interfaces/delivery/v1/site/site.page.ts:15*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Overrides [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[id](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/site/site.page.ts:5*

___
<a id="lastmodified"></a>

### `<Optional>` lastModified

**● lastModified**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModified](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:40*

___
<a id="lastmodifierid"></a>

### `<Optional>` lastModifierId

**● lastModifierId**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[lastModifierId](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:45*

___
<a id="name"></a>

###  name

**● name**: *`string`*

*Overrides [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[name](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/site/site.page.ts:10*

___
<a id="parentid"></a>

### `<Optional>` parentId

**● parentId**: *`string`*

*Defined in interfaces/delivery/v1/site/site.page.ts:13*

___
<a id="rev"></a>

### `<Optional>` rev

**● rev**: *`string`*

*Inherited from [BaseDeliveryItem](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c).[rev](#_3047b44915adf372daa016647b94568b1955d8e22b01b36c5cae56754bc9132c)*

*Defined in interfaces/delivery/v1/base.item.ts:25*

___
<a id="route"></a>

###  route

**● route**: *`string`*

*Defined in interfaces/delivery/v1/site/site.page.ts:8*

___
<a id="title"></a>

### `<Optional>` title

**● title**: *`string`*

*Defined in interfaces/delivery/v1/site/site.page.ts:12*

___


<a name="_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/logging/logger"](#_fe515c9b90a4f17a73ce5bc44ed848d7fe5703aea6dfbc28e957c75e091b2a2d) > [Logger](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)

# Interface: Logger

## Hierarchy

**Logger**

## Index

### Methods

* [error](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)
* [info](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)
* [warn](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)

---

## Methods

<a id="error"></a>

###  error

▸ **error**(msg: *`string`*, ...data: *`any`[]*): `void`

*Defined in interfaces/logging/logger.ts:10*

**Parameters:**

| Param | Type |
| ------ | ------ |
| msg | `string` |
| `Rest` data | `any`[] |

**Returns:** `void`

___
<a id="info"></a>

###  info

▸ **info**(msg: *`string`*, ...data: *`any`[]*): `void`

*Defined in interfaces/logging/logger.ts:11*

**Parameters:**

| Param | Type |
| ------ | ------ |
| msg | `string` |
| `Rest` data | `any`[] |

**Returns:** `void`

___
<a id="warn"></a>

###  warn

▸ **warn**(msg: *`string`*, ...data: *`any`[]*): `void`

*Defined in interfaces/logging/logger.ts:12*

**Parameters:**

| Param | Type |
| ------ | ------ |
| msg | `string` |
| `Rest` data | `any`[] |

**Returns:** `void`

___


<a name="_dba062739a32acb9737be551381453ab80c56905ec8eac65a7079e5c03a112a1"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/logging/logger.factory"](#_94fa52231da6493363f588763c848f4f7cecf66fe1eb52d61a78d5e4301457a6) > [DynamicLoggerFactory](#_dba062739a32acb9737be551381453ab80c56905ec8eac65a7079e5c03a112a1)

# Interface: DynamicLoggerFactory

## Hierarchy

**DynamicLoggerFactory**

## Index

### Methods

* [get](#_dba062739a32acb9737be551381453ab80c56905ec8eac65a7079e5c03a112a1)

---

## Methods

<a id="get"></a>

###  get

▸ **get**(): `Observable`<[LoggerFactory](#_cf0baec94532e589ab96e8937533c72487e558033c4282cc9a514478cc5770aa)>

*Defined in interfaces/logging/logger.factory.ts:34*

**Returns:** `Observable`<[LoggerFactory](#_cf0baec94532e589ab96e8937533c72487e558033c4282cc9a514478cc5770aa)>

___


<a name="_cf0baec94532e589ab96e8937533c72487e558033c4282cc9a514478cc5770aa"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/logging/logger.factory"](#_94fa52231da6493363f588763c848f4f7cecf66fe1eb52d61a78d5e4301457a6) > [LoggerFactory](#_cf0baec94532e589ab96e8937533c72487e558033c4282cc9a514478cc5770aa)

# Interface: LoggerFactory

## Hierarchy

**LoggerFactory**

## Index

### Methods

* [create](#_cf0baec94532e589ab96e8937533c72487e558033c4282cc9a514478cc5770aa)

---

## Methods

<a id="create"></a>

###  create

▸ **create**(name: *`string`*): [Logger](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)

*Defined in interfaces/logging/logger.factory.ts:19*

**Parameters:**

| Param | Type |
| ------ | ------ |
| name | `string` |

**Returns:** [Logger](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)

___


<a name="_1dcc2ad2f5df6ea8bfd2cabb6709007d77b095a2ec0e92a5a8d3abc63d256dd1"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.navigate.by.path.message"](#_622733230f0c6ad31bf56b396da59767cf483237891a5434c9ede42f171aa5c5) > [SdkNavigateByPathEvent](#_1dcc2ad2f5df6ea8bfd2cabb6709007d77b095a2ec0e92a5a8d3abc63d256dd1)

# Interface: SdkNavigateByPathEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkNavigateByPathEvent**

## Index

### Properties

* [id](#_1dcc2ad2f5df6ea8bfd2cabb6709007d77b095a2ec0e92a5a8d3abc63d256dd1)
* [path](#_1dcc2ad2f5df6ea8bfd2cabb6709007d77b095a2ec0e92a5a8d3abc63d256dd1)
* [type](#_1dcc2ad2f5df6ea8bfd2cabb6709007d77b095a2ec0e92a5a8d3abc63d256dd1)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="path"></a>

###  path

**● path**: *`string`*

*Defined in interfaces/messages/sdk.navigate.by.path.message.ts:12*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.router.navigateByPath"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.navigate.by.path.message.ts:10*

___


<a name="_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.navigate.by.path.message"](#_622733230f0c6ad31bf56b396da59767cf483237891a5434c9ede42f171aa5c5) > [SdkNavigateByPathResponse](#_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9)

# Interface: SdkNavigateByPathResponse

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkNavigateByPathResponse**

## Index

### Properties

* [error](#_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9)
* [id](#_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9)
* [path](#_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9)
* [success](#_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9)
* [type](#_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9)

---

## Properties

<a id="error"></a>

### `<Optional>` error

**● error**: *`any`*

*Defined in interfaces/messages/sdk.navigate.by.path.message.ts:24*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="path"></a>

###  path

**● path**: *`string`*

*Defined in interfaces/messages/sdk.navigate.by.path.message.ts:20*

___
<a id="success"></a>

###  success

**● success**: *`boolean`*

*Defined in interfaces/messages/sdk.navigate.by.path.message.ts:22*

___
<a id="type"></a>

###  type

**● type**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:10*

___


<a name="_35b435adfda44c74039da62c0ae2e275f9fcfe65d9941a8eecad21c3ca0bc63d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.active.route.message"](#_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c) > [SdkActiveRouteEvent](#_35b435adfda44c74039da62c0ae2e275f9fcfe65d9941a8eecad21c3ca0bc63d)

# Interface: SdkActiveRouteEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkActiveRouteEvent**

## Index

### Properties

* [id](#_35b435adfda44c74039da62c0ae2e275f9fcfe65d9941a8eecad21c3ca0bc63d)
* [page](#_35b435adfda44c74039da62c0ae2e275f9fcfe65d9941a8eecad21c3ca0bc63d)
* [type](#_35b435adfda44c74039da62c0ae2e275f9fcfe65d9941a8eecad21c3ca0bc63d)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="page"></a>

###  page

**● page**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/messages/sdk.subscribe.active.route.message.ts:23*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.router.activeRoute"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.subscribe.active.route.message.ts:21*

___


<a name="_1f82288a8a1b3d2c5eb456cb5bd196b8f04b66e79dce7fe2ab4fb936faf3f133"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.active.route.message"](#_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c) > [SdkSubscribeActiveRouteEvent](#_1f82288a8a1b3d2c5eb456cb5bd196b8f04b66e79dce7fe2ab4fb936faf3f133)

# Interface: SdkSubscribeActiveRouteEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkSubscribeActiveRouteEvent**

## Index

### Properties

* [id](#_1f82288a8a1b3d2c5eb456cb5bd196b8f04b66e79dce7fe2ab4fb936faf3f133)
* [type](#_1f82288a8a1b3d2c5eb456cb5bd196b8f04b66e79dce7fe2ab4fb936faf3f133)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.router.activeRoute.subscribe"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.subscribe.active.route.message.ts:12*

___


<a name="_313d9363cd04b91697f16ae3964e960a91746a082666347a530f3b4b62d13d70"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.active.route.message"](#_0bfd9145d77565759691fbe9149f28e4df6a531e11b92937f2d4e96b2af6243c) > [SdkSubscribeActiveRouteEventResponse](#_313d9363cd04b91697f16ae3964e960a91746a082666347a530f3b4b62d13d70)

# Interface: SdkSubscribeActiveRouteEventResponse

## Hierarchy

↳  [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)

**↳ SdkSubscribeActiveRouteEventResponse**

## Index

### Properties

* [handle](#_313d9363cd04b91697f16ae3964e960a91746a082666347a530f3b4b62d13d70)
* [id](#_313d9363cd04b91697f16ae3964e960a91746a082666347a530f3b4b62d13d70)
* [type](#_313d9363cd04b91697f16ae3964e960a91746a082666347a530f3b4b62d13d70)

---

## Properties

<a id="handle"></a>

###  handle

**● handle**: *`string`*

*Inherited from [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25).[handle](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)*

*Defined in interfaces/messages/sdk.subscribe.message.ts:9*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:10*

___


<a name="_12ff6d595ed1cd54201221967438a86ebdcb29f9cb9fcac6292e471641d0bb19"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.set.mode.message"](#_45c8d94271d8381ed7d9c3f48e023774f189ee7539fe3ab3a487a84b0f6a89ce) > [SdkSetModeEvent](#_12ff6d595ed1cd54201221967438a86ebdcb29f9cb9fcac6292e471641d0bb19)

# Interface: SdkSetModeEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkSetModeEvent**

## Index

### Properties

* [id](#_12ff6d595ed1cd54201221967438a86ebdcb29f9cb9fcac6292e471641d0bb19)
* [mode](#_12ff6d595ed1cd54201221967438a86ebdcb29f9cb9fcac6292e471641d0bb19)
* [type](#_12ff6d595ed1cd54201221967438a86ebdcb29f9cb9fcac6292e471641d0bb19)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="mode"></a>

###  mode

**● mode**: *[SdkMode](#_58deb21a3fe224d894883ce6ea9ecf0ec4183ea802602780353ac74891563901)*

*Defined in interfaces/messages/sdk.set.mode.message.ts:13*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.setMode"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.set.mode.message.ts:11*

___


<a name="_de536a463d8d61d47aba443cf5397f699b9aa251c39505548bdb668d693e2d3d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.set.mode.message"](#_45c8d94271d8381ed7d9c3f48e023774f189ee7539fe3ab3a487a84b0f6a89ce) > [SdkSetModeResponse](#_de536a463d8d61d47aba443cf5397f699b9aa251c39505548bdb668d693e2d3d)

# Interface: SdkSetModeResponse

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkSetModeResponse**

## Index

### Properties

* [error](#_de536a463d8d61d47aba443cf5397f699b9aa251c39505548bdb668d693e2d3d)
* [id](#_de536a463d8d61d47aba443cf5397f699b9aa251c39505548bdb668d693e2d3d)
* [mode](#_de536a463d8d61d47aba443cf5397f699b9aa251c39505548bdb668d693e2d3d)
* [type](#_de536a463d8d61d47aba443cf5397f699b9aa251c39505548bdb668d693e2d3d)

---

## Properties

<a id="error"></a>

### `<Optional>` error

**● error**: *`any`*

*Defined in interfaces/messages/sdk.set.mode.message.ts:23*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="mode"></a>

###  mode

**● mode**: *[SdkMode](#_58deb21a3fe224d894883ce6ea9ecf0ec4183ea802602780353ac74891563901)*

*Defined in interfaces/messages/sdk.set.mode.message.ts:21*

___
<a id="type"></a>

###  type

**● type**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:10*

___


<a name="_086b3d020659d0b203a76fb384ec0a29e5345e41b306a7498860a6ce8ca20739"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/messages"](#_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d) > [SdkErrorResponse](#_086b3d020659d0b203a76fb384ec0a29e5345e41b306a7498860a6ce8ca20739)

# Interface: SdkErrorResponse

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkErrorResponse**

## Index

### Properties

* [error](#_086b3d020659d0b203a76fb384ec0a29e5345e41b306a7498860a6ce8ca20739)
* [id](#_086b3d020659d0b203a76fb384ec0a29e5345e41b306a7498860a6ce8ca20739)
* [type](#_086b3d020659d0b203a76fb384ec0a29e5345e41b306a7498860a6ce8ca20739)

---

## Properties

<a id="error"></a>

###  error

**● error**: *`any`*

*Defined in interfaces/messages/messages.ts:18*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:10*

___


<a name="_d29994d1f4237c48503e64e0e98425525f1efc635109e6df19220af2194744df"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/messages"](#_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d) > [SdkMessageHandler](#_d29994d1f4237c48503e64e0e98425525f1efc635109e6df19220af2194744df)

# Interface: SdkMessageHandler

## Hierarchy

**SdkMessageHandler**

## Index

### Properties

* [handle](#_d29994d1f4237c48503e64e0e98425525f1efc635109e6df19220af2194744df)

---

## Properties

<a id="handle"></a>

###  handle

**● handle**: *[SdkMessageHandlerCallback](#_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d)*

*Defined in interfaces/messages/messages.ts:24*

___


<a name="_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/messages"](#_c0236f9b65609ed7da11b640e2d5d2eea74041a4f3af94848df3eac57bdef25d) > [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

# Interface: SdkMessagePayload

## Hierarchy

**SdkMessagePayload**

↳  [SdkErrorResponse](#_086b3d020659d0b203a76fb384ec0a29e5345e41b306a7498860a6ce8ca20739)

↳  [SdkRefreshEvent](#_6e19d0241f945546e7d814b0b404f7f822fe6ac3829c8befa07642ac9fefca6d)

↳  [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)

↳  [SdkUnsubscribeEvent](#_f253b0386d8b073ba9279a14b7e4702de71a2427d9a4adb1e24c5e7bd72f108e)

↳  [SdkSubscribeModeEvent](#_8d6eaafe0bac757f9a69a4d1b9a6fcf5500f4a0c271e3e9d0cc6faa894201057)

↳  [SdkModeEvent](#_6de4be53e442c5725517437c7b6799ce5fa3eeabc3d67a20dd4252b3c9e9626a)

↳  [SdkSetModeEvent](#_12ff6d595ed1cd54201221967438a86ebdcb29f9cb9fcac6292e471641d0bb19)

↳  [SdkSetModeResponse](#_de536a463d8d61d47aba443cf5397f699b9aa251c39505548bdb668d693e2d3d)

↳  [SdkNavigateByPathEvent](#_1dcc2ad2f5df6ea8bfd2cabb6709007d77b095a2ec0e92a5a8d3abc63d256dd1)

↳  [SdkNavigateByPathResponse](#_c38333a12290e77f06fa081b4fdb99e349bc81e02a8d3dee1502f7e1ebdc7db9)

↳  [SdkSubscribeActiveRouteEvent](#_1f82288a8a1b3d2c5eb456cb5bd196b8f04b66e79dce7fe2ab4fb936faf3f133)

↳  [SdkActiveRouteEvent](#_35b435adfda44c74039da62c0ae2e275f9fcfe65d9941a8eecad21c3ca0bc63d)

↳  [SdkSubscribeRouteEvent](#_925fdce9c03599c31cc6fdd7e0feecd3ef276321b127b2f99e31af04a12fe426)

↳  [SdkRouteEvent](#_72d1c3c929c08f1efa25131c130a3d81c521cb306e5fe9f48b7fba0e54406aed)

## Index

### Properties

* [id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)
* [type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *`string`*

*Defined in interfaces/messages/messages.ts:10*

___


<a name="_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.message"](#_4faf6361999930d706d52f519fde3d28ef55a5f91cd3180996f94d0f11483c10) > [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)

# Interface: SdkSubscribeEventResponse

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkSubscribeEventResponse**

↳  [SdkSubscribeModeEventResponse](#_eb1b6f5b4c265b848da74af201051e4301c1d32d43c1c025bb1536603fbce955)

↳  [SdkSubscribeActiveRouteEventResponse](#_313d9363cd04b91697f16ae3964e960a91746a082666347a530f3b4b62d13d70)

↳  [SdkSubscribeRouteEventResponse](#_1ae7a9f7479052d83894f76819394c62a4260d8d5174db506d09074c0cbde382)

## Index

### Properties

* [handle](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)
* [id](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)
* [type](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)

---

## Properties

<a id="handle"></a>

###  handle

**● handle**: *`string`*

*Defined in interfaces/messages/sdk.subscribe.message.ts:9*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:10*

___


<a name="_f253b0386d8b073ba9279a14b7e4702de71a2427d9a4adb1e24c5e7bd72f108e"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.message"](#_4faf6361999930d706d52f519fde3d28ef55a5f91cd3180996f94d0f11483c10) > [SdkUnsubscribeEvent](#_f253b0386d8b073ba9279a14b7e4702de71a2427d9a4adb1e24c5e7bd72f108e)

# Interface: SdkUnsubscribeEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkUnsubscribeEvent**

## Index

### Properties

* [handle](#_f253b0386d8b073ba9279a14b7e4702de71a2427d9a4adb1e24c5e7bd72f108e)
* [id](#_f253b0386d8b073ba9279a14b7e4702de71a2427d9a4adb1e24c5e7bd72f108e)
* [type](#_f253b0386d8b073ba9279a14b7e4702de71a2427d9a4adb1e24c5e7bd72f108e)

---

## Properties

<a id="handle"></a>

###  handle

**● handle**: *`string`*

*Defined in interfaces/messages/sdk.subscribe.message.ts:20*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.unsubscribe"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.subscribe.message.ts:18*

___


<a name="_6e19d0241f945546e7d814b0b404f7f822fe6ac3829c8befa07642ac9fefca6d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.refresh.message"](#_3f4345d27805e6adac090f349258646fff6b3b4347fddefa018197689cd77bad) > [SdkRefreshEvent](#_6e19d0241f945546e7d814b0b404f7f822fe6ac3829c8befa07642ac9fefca6d)

# Interface: SdkRefreshEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkRefreshEvent**

## Index

### Properties

* [id](#_6e19d0241f945546e7d814b0b404f7f822fe6ac3829c8befa07642ac9fefca6d)
* [type](#_6e19d0241f945546e7d814b0b404f7f822fe6ac3829c8befa07642ac9fefca6d)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.refresh"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.refresh.message.ts:10*

___


<a name="_58deb21a3fe224d894883ce6ea9ecf0ec4183ea802602780353ac74891563901"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.mode.message"](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032) > [SdkMode](#_58deb21a3fe224d894883ce6ea9ecf0ec4183ea802602780353ac74891563901)

# Enumeration: SdkMode

## Index

### Enumeration members

* [PROTECTED](#_58deb21a3fe224d894883ce6ea9ecf0ec4183ea802602780353ac74891563901)
* [PUBLIC](#_58deb21a3fe224d894883ce6ea9ecf0ec4183ea802602780353ac74891563901)

---

## Enumeration members

<a id="protected"></a>

###  PROTECTED

**PROTECTED**:  = "protected"

*Defined in interfaces/messages/sdk.subscribe.mode.message.ts:16*

___
<a id="public"></a>

###  PUBLIC

**PUBLIC**:  = "public"

*Defined in interfaces/messages/sdk.subscribe.mode.message.ts:15*

___


<a name="_6de4be53e442c5725517437c7b6799ce5fa3eeabc3d67a20dd4252b3c9e9626a"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.mode.message"](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032) > [SdkModeEvent](#_6de4be53e442c5725517437c7b6799ce5fa3eeabc3d67a20dd4252b3c9e9626a)

# Interface: SdkModeEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkModeEvent**

## Index

### Properties

* [id](#_6de4be53e442c5725517437c7b6799ce5fa3eeabc3d67a20dd4252b3c9e9626a)
* [mode](#_6de4be53e442c5725517437c7b6799ce5fa3eeabc3d67a20dd4252b3c9e9626a)
* [type](#_6de4be53e442c5725517437c7b6799ce5fa3eeabc3d67a20dd4252b3c9e9626a)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="mode"></a>

###  mode

**● mode**: *[SdkMode](#_58deb21a3fe224d894883ce6ea9ecf0ec4183ea802602780353ac74891563901)*

*Defined in interfaces/messages/sdk.subscribe.mode.message.ts:27*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.mode"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.subscribe.mode.message.ts:25*

___


<a name="_8d6eaafe0bac757f9a69a4d1b9a6fcf5500f4a0c271e3e9d0cc6faa894201057"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.mode.message"](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032) > [SdkSubscribeModeEvent](#_8d6eaafe0bac757f9a69a4d1b9a6fcf5500f4a0c271e3e9d0cc6faa894201057)

# Interface: SdkSubscribeModeEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkSubscribeModeEvent**

## Index

### Properties

* [id](#_8d6eaafe0bac757f9a69a4d1b9a6fcf5500f4a0c271e3e9d0cc6faa894201057)
* [type](#_8d6eaafe0bac757f9a69a4d1b9a6fcf5500f4a0c271e3e9d0cc6faa894201057)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.mode.subscribe"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.subscribe.mode.message.ts:11*

___


<a name="_eb1b6f5b4c265b848da74af201051e4301c1d32d43c1c025bb1536603fbce955"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.mode.message"](#_6e87dc92f05001bc726d5b24a618833cce52446e471000f766625d6d7bebb032) > [SdkSubscribeModeEventResponse](#_eb1b6f5b4c265b848da74af201051e4301c1d32d43c1c025bb1536603fbce955)

# Interface: SdkSubscribeModeEventResponse

## Hierarchy

↳  [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)

**↳ SdkSubscribeModeEventResponse**

## Index

### Properties

* [handle](#_eb1b6f5b4c265b848da74af201051e4301c1d32d43c1c025bb1536603fbce955)
* [id](#_eb1b6f5b4c265b848da74af201051e4301c1d32d43c1c025bb1536603fbce955)
* [type](#_eb1b6f5b4c265b848da74af201051e4301c1d32d43c1c025bb1536603fbce955)

---

## Properties

<a id="handle"></a>

###  handle

**● handle**: *`string`*

*Inherited from [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25).[handle](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)*

*Defined in interfaces/messages/sdk.subscribe.message.ts:9*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:10*

___


<a name="_72d1c3c929c08f1efa25131c130a3d81c521cb306e5fe9f48b7fba0e54406aed"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.route.message"](#_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b) > [SdkRouteEvent](#_72d1c3c929c08f1efa25131c130a3d81c521cb306e5fe9f48b7fba0e54406aed)

# Interface: SdkRouteEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkRouteEvent**

## Index

### Properties

* [id](#_72d1c3c929c08f1efa25131c130a3d81c521cb306e5fe9f48b7fba0e54406aed)
* [page](#_72d1c3c929c08f1efa25131c130a3d81c521cb306e5fe9f48b7fba0e54406aed)
* [route](#_72d1c3c929c08f1efa25131c130a3d81c521cb306e5fe9f48b7fba0e54406aed)
* [type](#_72d1c3c929c08f1efa25131c130a3d81c521cb306e5fe9f48b7fba0e54406aed)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="page"></a>

###  page

**● page**: *[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)*

*Defined in interfaces/messages/sdk.subscribe.route.message.ts:30*

___
<a id="route"></a>

###  route

**● route**: *`string`*

*Defined in interfaces/messages/sdk.subscribe.route.message.ts:28*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.router.route"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.subscribe.route.message.ts:26*

___


<a name="_925fdce9c03599c31cc6fdd7e0feecd3ef276321b127b2f99e31af04a12fe426"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.route.message"](#_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b) > [SdkSubscribeRouteEvent](#_925fdce9c03599c31cc6fdd7e0feecd3ef276321b127b2f99e31af04a12fe426)

# Interface: SdkSubscribeRouteEvent

## Hierarchy

 [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)

**↳ SdkSubscribeRouteEvent**

## Index

### Properties

* [id](#_925fdce9c03599c31cc6fdd7e0feecd3ef276321b127b2f99e31af04a12fe426)
* [route](#_925fdce9c03599c31cc6fdd7e0feecd3ef276321b127b2f99e31af04a12fe426)
* [type](#_925fdce9c03599c31cc6fdd7e0feecd3ef276321b127b2f99e31af04a12fe426)

---

## Properties

<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="route"></a>

###  route

**● route**: * `string` &#124; `string`[]
*

*Defined in interfaces/messages/sdk.subscribe.route.message.ts:17*

___
<a id="type"></a>

###  type

**● type**: *"WchSdk.router.route.subscribe"*

*Overrides [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/sdk.subscribe.route.message.ts:12*

___


<a name="_1ae7a9f7479052d83894f76819394c62a4260d8d5174db506d09074c0cbde382"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/messages/sdk.subscribe.route.message"](#_a2a7dee242d086f0db45ba4bcbfa3442b2c8c73a275d29269ace243290a5893b) > [SdkSubscribeRouteEventResponse](#_1ae7a9f7479052d83894f76819394c62a4260d8d5174db506d09074c0cbde382)

# Interface: SdkSubscribeRouteEventResponse

## Hierarchy

↳  [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)

**↳ SdkSubscribeRouteEventResponse**

## Index

### Properties

* [handle](#_1ae7a9f7479052d83894f76819394c62a4260d8d5174db506d09074c0cbde382)
* [id](#_1ae7a9f7479052d83894f76819394c62a4260d8d5174db506d09074c0cbde382)
* [type](#_1ae7a9f7479052d83894f76819394c62a4260d8d5174db506d09074c0cbde382)

---

## Properties

<a id="handle"></a>

###  handle

**● handle**: *`string`*

*Inherited from [SdkSubscribeEventResponse](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25).[handle](#_3fdd32e4cedbca5dc8922ec49e70b6017359b38dd41941e7debad83c3166da25)*

*Defined in interfaces/messages/sdk.subscribe.message.ts:9*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[id](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:8*

___
<a id="type"></a>

###  type

**● type**: *`string`*

*Inherited from [SdkMessagePayload](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd).[type](#_5c5c34dd9b85c2b4b067451db5e3e8604288f2d3f985951b987d6b259655abdd)*

*Defined in interfaces/messages/messages.ts:10*

___


<a name="_b0717a0b8bd1bdb56ccd3fd8535dae36bfd2b812165b5ff234dd6233b3994888"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/query"](#_45c541ae696659e96d969ecb6cb661833a94f1395541d0f1824511ca1a48ea92) > [Query](#_b0717a0b8bd1bdb56ccd3fd8535dae36bfd2b812165b5ff234dd6233b3994888)

# Interface: Query

## Hierarchy

**Query**

## Indexable

\[key: `string`\]:&nbsp; [QueryValue](#_45c541ae696659e96d969ecb6cb661833a94f1395541d0f1824511ca1a48ea92) &#124; [QueryValue](#_45c541ae696659e96d969ecb6cb661833a94f1395541d0f1824511ca1a48ea92)[]

## Index

---


<a name="_446c12901aa836656c4f602ece4da7d668ed48a7d79ea9f410193dd52cf7997b"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/sdk/router/router"](#_877e2ce0cc1e815e6e0c2332f26ea2eafaa3b05dad4eff1acc8a0796fe37703c) > [WchSdkRouter](#_446c12901aa836656c4f602ece4da7d668ed48a7d79ea9f410193dd52cf7997b)

# Interface: WchSdkRouter

## Hierarchy

**WchSdkRouter**

## Index

### Properties

* [activeRenderingContext](#_446c12901aa836656c4f602ece4da7d668ed48a7d79ea9f410193dd52cf7997b)
* [activeRoute](#_446c12901aa836656c4f602ece4da7d668ed48a7d79ea9f410193dd52cf7997b)
* [navigateByPath](#_446c12901aa836656c4f602ece4da7d668ed48a7d79ea9f410193dd52cf7997b)

---

## Properties

<a id="activerenderingcontext"></a>

###  activeRenderingContext

**● activeRenderingContext**: *`function`*

*Defined in interfaces/sdk/router/router.ts:23*

#### Type declaration
▸(): `Observable`<[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)>

**Returns:** `Observable`<[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)>

___
<a id="activeroute"></a>

###  activeRoute

**● activeRoute**: *`function`*

*Defined in interfaces/sdk/router/router.ts:16*

#### Type declaration
▸(): `Observable`<[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)>

**Returns:** `Observable`<[SitePage](#_3489c84b285921dcea8595aafe6e94fc4b56c935df21af6a67197d18eeec0ff3)>

___
<a id="navigatebypath"></a>

###  navigateByPath

**● navigateByPath**: *`function`*

*Defined in interfaces/sdk/router/router.ts:9*

#### Type declaration
▸(aPath: *`string`*): `PromiseLike`<`boolean`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPath | `string` |

**Returns:** `PromiseLike`<`boolean`>

___


<a name="_b1755e7911185d570d469df872e7b85e64f291a0f73a1c29fbc6d90f40df2915"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/sdk/sdk"](#_8bafd0c044de202782302356d37bcf05c205090fb4f91611d867bfe41fa9305f) > [WchSdk](#_b1755e7911185d570d469df872e7b85e64f291a0f73a1c29fbc6d90f40df2915)

# Interface: WchSdk

## Hierarchy

**WchSdk**

## Index

### Properties

* [logger](#_b1755e7911185d570d469df872e7b85e64f291a0f73a1c29fbc6d90f40df2915)
* [refresh](#_b1755e7911185d570d469df872e7b85e64f291a0f73a1c29fbc6d90f40df2915)
* [router](#_b1755e7911185d570d469df872e7b85e64f291a0f73a1c29fbc6d90f40df2915)
* [search](#_b1755e7911185d570d469df872e7b85e64f291a0f73a1c29fbc6d90f40df2915)
* [version](#_b1755e7911185d570d469df872e7b85e64f291a0f73a1c29fbc6d90f40df2915)

---

## Properties

<a id="logger"></a>

### `<Optional>` logger

**● logger**: *[LoggerService](#_48b4d517639a70866875cf1d1c9b9424bc374956657a0d37f0ebf3084c1af70c)*

*Defined in interfaces/sdk/sdk.ts:28*

Returns a factory to access loggers

___
<a id="refresh"></a>

###  refresh

**● refresh**: *`function`*

*Defined in interfaces/sdk/sdk.ts:14*

#### Type declaration
▸(): `void`

**Returns:** `void`

___
<a id="router"></a>

###  router

**● router**: *[WchSdkRouter](#_446c12901aa836656c4f602ece4da7d668ed48a7d79ea9f410193dd52cf7997b)*

*Defined in interfaces/sdk/sdk.ts:16*

___
<a id="search"></a>

### `<Optional>` search

**● search**: *[WchSdkSearch](#_db9743bab70b83e1fc4f3425934a50ee733f4d6b2c4f5502dc57855a29dadfc2)*

*Defined in interfaces/sdk/sdk.ts:33*

Optional search service

___
<a id="version"></a>

###  version

**● version**: *[WchSdkVersion](#_9ef2b7ea5108c90255a4dd52cd81a89e1780782376be4de71629a62a2f9c3906)*

*Defined in interfaces/sdk/sdk.ts:23*

___


<a name="_db9743bab70b83e1fc4f3425934a50ee733f4d6b2c4f5502dc57855a29dadfc2"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/sdk/search/search"](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8) > [WchSdkSearch](#_db9743bab70b83e1fc4f3425934a50ee733f4d6b2c4f5502dc57855a29dadfc2)

# Interface: WchSdkSearch

## Hierarchy

**WchSdkSearch**

## Index

### Properties

* [getRenderingContextById](#_db9743bab70b83e1fc4f3425934a50ee733f4d6b2c4f5502dc57855a29dadfc2)
* [getRenderingContexts](#_db9743bab70b83e1fc4f3425934a50ee733f4d6b2c4f5502dc57855a29dadfc2)
* [getSitePages](#_db9743bab70b83e1fc4f3425934a50ee733f4d6b2c4f5502dc57855a29dadfc2)

---

## Properties

<a id="getrenderingcontextbyid"></a>

###  getRenderingContextById

**● getRenderingContextById**: *`function`*

*Defined in interfaces/sdk/search/search.ts:19*

Locates the rendering context identified by the ID
*__param__*: the ID of the content item

*__param__*: optionally the levels of the rendering context to resolve

*__returns__*: the query result

#### Type declaration
▸(aId: *`string`*, aLevels?: *`number`*): `Observable`<[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aId | `string` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<[RenderingContext](#_c2c081d17c3faf9991d765254c9d930ff579901507941c69e2dcf9858fe1ec42)>

___
<a id="getrenderingcontexts"></a>

###  getRenderingContexts

**● getRenderingContexts**: *`function`*

*Defined in interfaces/sdk/search/search.ts:30*

Locates all rendering contexts that match a particular query. It is not necessary to add the classification to the query, it will automatically only apply to content for the current site
*__param__*: the query input, e.g. a string or a plain java object

*__param__*: optionally the levels of the rendering context to resolve

*__returns__*: the query result

#### Type declaration
▸(aValue: *[QueryInput](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8)*, aLevels?: *`number`*): `Observable`<[RenderingContextQueryResult](#_8ab884cdc475a46f409f9714cdd0fae9e0bd14bd4a26d7241dc0f9e5993bd975)>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | [QueryInput](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8) |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<[RenderingContextQueryResult](#_8ab884cdc475a46f409f9714cdd0fae9e0bd14bd4a26d7241dc0f9e5993bd975)>

___
<a id="getsitepages"></a>

###  getSitePages

**● getSitePages**: *`function`*

*Defined in interfaces/sdk/search/search.ts:40*

Locates all pages that match a particular query. It is not necessary to add the classification to the query, it will automatically only apply to pages for the current site
*__param__*: the query input, e.g. a string or a plain java object

*__returns__*: the query result

#### Type declaration
▸(aValue: *[QueryInput](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8)*): `Observable`<[SitePagesQueryResult](#_0bb838053c0a65d4b266eb8188b988de622519d5ac81ee7dc310486dd8ff26f9)>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | [QueryInput](#_3e3ae36698fe209577ce4f34e4361b1c159bd153360ecdd429ff1a2e36b3e1b8) |

**Returns:** `Observable`<[SitePagesQueryResult](#_0bb838053c0a65d4b266eb8188b988de622519d5ac81ee7dc310486dd8ff26f9)>

___


<a name="_9ef2b7ea5108c90255a4dd52cd81a89e1780782376be4de71629a62a2f9c3906"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["interfaces/sdk/version/version"](#_699e57ae41eef21c9f67f14fe8f82ab9b0d9f99ffebf0824e4d75776a1527230) > [WchSdkVersion](#_9ef2b7ea5108c90255a4dd52cd81a89e1780782376be4de71629a62a2f9c3906)

# Interface: WchSdkVersion

Defines the version number and the build date of the SDK.

## Hierarchy

**WchSdkVersion**

## Index

### Properties

* [build](#_9ef2b7ea5108c90255a4dd52cd81a89e1780782376be4de71629a62a2f9c3906)
* [version](#_9ef2b7ea5108c90255a4dd52cd81a89e1780782376be4de71629a62a2f9c3906)

---

## Properties

<a id="build"></a>

###  build

**● build**: *`Date`*

*Defined in interfaces/sdk/version/version.ts:10*

___
<a id="version"></a>

###  version

**● version**: *`object`*

*Defined in interfaces/sdk/version/version.ts:8*

#### Type declaration

 major: `string`

 minor: `string`

 patch: `string`

___


<a name="_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/hub-info/hub-info"](#_ca2a71da2cd83d09268fcae3830fc011491b514bfb61f4a1a55553b14388d53a) > [HubInfo](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d)

# Interface: HubInfo

## Hierarchy

**HubInfo**

↳  [UrlConfig](#_e15d865cc46822109f3eca052d8c218fbc94f028748b684a7cbe967e9cc1fad2)

## Index

### Properties

* [apiUrl](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d)
* [deliveryUrl](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d)

---

## Properties

<a id="apiurl"></a>

###  apiUrl

**● apiUrl**: * `URL` &#124; `string`
*

*Defined in services/hub-info/hub-info.ts:13*

___
<a id="deliveryurl"></a>

###  deliveryUrl

**● deliveryUrl**: * `URL` &#124; `string`
*

*Defined in services/hub-info/hub-info.ts:20*

___


<a name="_e15d865cc46822109f3eca052d8c218fbc94f028748b684a7cbe967e9cc1fad2"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/info/url.config"](#_4cbc0ba789efa769fbf2a19947a0e8773ce45da9610f3caff324b33ad67a4cdb) > [UrlConfig](#_e15d865cc46822109f3eca052d8c218fbc94f028748b684a7cbe967e9cc1fad2)

# Interface: UrlConfig

Exposes the URL configuration to the client

## Hierarchy

 [HubInfo](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d)

**↳ UrlConfig**

## Index

### Properties

* [apiUrl](#_e15d865cc46822109f3eca052d8c218fbc94f028748b684a7cbe967e9cc1fad2)
* [baseUrl](#_e15d865cc46822109f3eca052d8c218fbc94f028748b684a7cbe967e9cc1fad2)
* [deliveryUrl](#_e15d865cc46822109f3eca052d8c218fbc94f028748b684a7cbe967e9cc1fad2)
* [isPreviewMode](#_e15d865cc46822109f3eca052d8c218fbc94f028748b684a7cbe967e9cc1fad2)

---

## Properties

<a id="apiurl"></a>

###  apiUrl

**● apiUrl**: *`URL`*

*Overrides [HubInfo](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d).[apiUrl](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d)*

*Defined in services/info/url.config.ts:9*

The base URL used to access WCH APIs. The URL ends with a slash.

___
<a id="baseurl"></a>

### `<Optional>` baseUrl

**● baseUrl**: *`URL`*

*Defined in services/info/url.config.ts:21*

The base URL of the host the application is running on. This can be undefined if the application is rendered standalone as part of the universal renderer.

___
<a id="deliveryurl"></a>

###  deliveryUrl

**● deliveryUrl**: *`URL`*

*Overrides [HubInfo](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d).[deliveryUrl](#_d23670af942899e7ffb4b729c58717f2d9ccd6e36f33b4aa378f5a6e79f5610d)*

*Defined in services/info/url.config.ts:12*

The base URL used to access WCH delivery resources. The URL ends with a slash.

___
<a id="ispreviewmode"></a>

###  isPreviewMode

**● isPreviewMode**: *`boolean`*

*Defined in services/info/url.config.ts:15*

True if the system runs in preview mode, else false.

___


<a name="_48b4d517639a70866875cf1d1c9b9424bc374956657a0d37f0ebf3084c1af70c"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/logging/logger.service"](#_ede8ea0fddcda0580eb2bbf4c926b2864731cceeae82765e14e145c093c72fef) > [LoggerService](#_48b4d517639a70866875cf1d1c9b9424bc374956657a0d37f0ebf3084c1af70c)

# Interface: LoggerService

Service to return a logger for a given name. Calling the getter multiple times with the same name will return the same instance of the logger.

## Hierarchy

**LoggerService**

## Index

### Properties

* [get](#_48b4d517639a70866875cf1d1c9b9424bc374956657a0d37f0ebf3084c1af70c)

---

## Properties

<a id="get"></a>

###  get

**● get**: *`function`*

*Defined in services/logging/logger.service.ts:16*

Returns a logger for the given name
*__param__*: name of the logger

*__returns__*: the logger singleton for this name

#### Type declaration
▸(name: *`string`*): [Logger](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)

**Parameters:**

| Param | Type |
| ------ | ------ |
| name | `string` |

**Returns:** [Logger](#_f9378ce7dbde961f86412cb5850d50da0e7afce68e40ac2eb34d5bdacdde195b)

___


<a name="_bda36f5aea4d06bd64140dd9a15509d633074cab6ff5fd08a0207b4e03418730"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/hub-info/hub-info.config"](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d) > [CYCLE_HANDLING](#_bda36f5aea4d06bd64140dd9a15509d633074cab6ff5fd08a0207b4e03418730)

# Enumeration: CYCLE_HANDLING

## Index

### Enumeration members

* [BREAK](#_bda36f5aea4d06bd64140dd9a15509d633074cab6ff5fd08a0207b4e03418730)
* [RESOLVE](#_bda36f5aea4d06bd64140dd9a15509d633074cab6ff5fd08a0207b4e03418730)

---

## Enumeration members

<a id="break"></a>

###  BREAK

**BREAK**: 

*Defined in services/hub-info/hub-info.config.ts:40*

___
<a id="resolve"></a>

###  RESOLVE

**RESOLVE**: 

*Defined in services/hub-info/hub-info.config.ts:42*

___


<a name="_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/hub-info/hub-info.config"](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d) > [HubInfoConfig](#_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907)

# Class: HubInfoConfig

## Hierarchy

**HubInfoConfig**

## Index

### Properties

* [apiUrl](#_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907)
* [cycleHandlingStrategy](#_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907)
* [deliveryUrl](#_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907)
* [fetchLevels](#_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907)
* [httpOptions](#_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907)
* [httpPreviewOptions](#_7568542de00fea5f1b62a968c3106d754637e8397976964d418582749c204907)

---

## Properties

<a id="apiurl"></a>

### `<Optional>` apiUrl

**● apiUrl**: *[HubInfoUrlProvider](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d)*

*Defined in services/hub-info/hub-info.config.ts:56*

___
<a id="cyclehandlingstrategy"></a>

### `<Optional>` cycleHandlingStrategy

**● cycleHandlingStrategy**: * [CYCLE_HANDLING](#_bda36f5aea4d06bd64140dd9a15509d633074cab6ff5fd08a0207b4e03418730) &#124; `string`
*

*Defined in services/hub-info/hub-info.config.ts:88*

___
<a id="deliveryurl"></a>

### `<Optional>` deliveryUrl

**● deliveryUrl**: *[HubInfoUrlProvider](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d)*

*Defined in services/hub-info/hub-info.config.ts:63*

___
<a id="fetchlevels"></a>

### `<Optional>` fetchLevels

**● fetchLevels**: *`number`*

*Defined in services/hub-info/hub-info.config.ts:94*

___
<a id="httpoptions"></a>

### `<Optional>` httpOptions

**● httpOptions**: *[HttpResourceOptions](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)*

*Defined in services/hub-info/hub-info.config.ts:68*

___
<a id="httppreviewoptions"></a>

### `<Optional>` httpPreviewOptions

**● httpPreviewOptions**: *[HttpResourceOptions](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)*

*Defined in services/hub-info/hub-info.config.ts:73*

___


<a name="_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702"></a>
[ibm-wch-sdk-api](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/hub-info/hub-info.config"](#_11aa2e11ab967a4542da7ede8877202646015ebf4f5745f6f972bd11dcfa139d) > [HttpResourceOptions](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)

# Interface: HttpResourceOptions

## Hierarchy

**HttpResourceOptions**

## Index

### Properties

* [pollTime](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)
* [pollTimeVariation](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)
* [retries](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)
* [useApi](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)
* [useBootstrap](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)
* [useJsonP](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)
* [useLocalStorage](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)
* [usePolling](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)
* [useStaticResources](#_ae2dc7b72f1c236187b64e59ccfa6a992576c92f9d877abdc308b014af5f1702)

---

## Properties

<a id="polltime"></a>

### `<Optional>` pollTime

**● pollTime**: *`number`*

*Defined in services/hub-info/hub-info.config.ts:3*

___
<a id="polltimevariation"></a>

### `<Optional>` pollTimeVariation

**● pollTimeVariation**: *`number`*

*Defined in services/hub-info/hub-info.config.ts:2*

___
<a id="retries"></a>

### `<Optional>` retries

**● retries**: *`number`*

*Defined in services/hub-info/hub-info.config.ts:4*

___
<a id="useapi"></a>

### `<Optional>` useApi

**● useApi**: *`boolean`*

*Defined in services/hub-info/hub-info.config.ts:20*

___
<a id="usebootstrap"></a>

### `<Optional>` useBootstrap

**● useBootstrap**: *`boolean`*

*Defined in services/hub-info/hub-info.config.ts:12*

___
<a id="usejsonp"></a>

### `<Optional>` useJsonP

**● useJsonP**: *`boolean`*

*Defined in services/hub-info/hub-info.config.ts:24*

___
<a id="uselocalstorage"></a>

### `<Optional>` useLocalStorage

**● useLocalStorage**: *`boolean`*

*Defined in services/hub-info/hub-info.config.ts:8*

___
<a id="usepolling"></a>

### `<Optional>` usePolling

**● usePolling**: *`boolean`*

*Defined in services/hub-info/hub-info.config.ts:28*

___
<a id="usestaticresources"></a>

### `<Optional>` useStaticResources

**● useStaticResources**: *`boolean`*

*Defined in services/hub-info/hub-info.config.ts:16*

___


<a name="_0557eb1307e18251a07c49f9eee2260c7f975c23eae7e0d6fdba3bc0c1662083"></a>
# WchSdkRouter

The SDK router allows to navigate to WCH pages or components.

## Methods

* `navigateByPath(path: string): PromiseLike<boolean>`: navigates to a WCH component given its path. The path can be read from the site information in the [RenderingContext](#_906e04b82a255a705cd1d41db3203c7fabc2ca96596c041a7d4dd4975bf6554d). The return value indicates when this navigation has completed.
* `activeRoute(): Observable<SitePage>`: returns the active route in form of a page reference
* `activeRenderingContext(): Observable<RenderingContext>`: returns the active rendering context
<a name="_b0a3f94cae004a78e2ce40a0220853a2c7b3d876b525909f1f03d6212be15ca6"></a>
# WchSdkVersion

Defines version number and build date.
<a name="_906e04b82a255a705cd1d41db3203c7fabc2ca96596c041a7d4dd4975bf6554d"></a>
## RenderingContext

Refer to the [design document](https://github.ibm.com/DX/squad-publishing-runtime/wiki/Rendering-Context) or the [documentation](https://developer.ibm.com/customer-engagement/docs/wch/rendering/) for more details about the structure.

The basic structure of elements is described in the [Authoring content](https://developer.ibm.com/customer-engagement/docs/wch/authoring-content/) section.

---
_Source: https://npm.io/package/ibm-wch-sdk-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._