npm package: @ibm-wch-sdk/services
Description: Software development kit to simplify the development of Angular based single page applications against Watson Content Hub.
Latest version: 6.0.524

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

Exposes framework independent APIs to support the implementation of [ibm-wch-sdk-ng](https://www.npmjs.com/package/ibm-wch-sdk-ng) and similar SDK.

## Details

Refer to the [documentation](#_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375).

## Changes

[CHANGELOG](#_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512)

## Class documentation

Refer to the [documentation](#_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b).

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

TBD

<a name="_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512"></a>
# Changelog

## Current

### Added

* Added typecheck methods for the new `group` element type
* New `getCategoryLeaf` helper function
* Initial version
<a name="_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b"></a>

#  @ibm-wch-sdk/services

## Index

### External modules

* ["http/http.service.on.ajax"](#_6b8b8fd55d436ad51a77d6803b3f4c1f1de5414202007d737e1b6b3d4f8fbb60)
* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["router/hash.route"](#_4fc4ec3106b769c4ce08cfd5b71d5bffe9d0467abffdbfb3fb184a5b2c0205ff)
* ["router/router.state"](#_db1e75558d47fd9c4892f608597cced38457ae8d3ab7c5ab5f0b841cad85ca98)
* ["sdk/wch.sdk"](#_71a26e79b27a6d21fe6cb623ed8649c97ce9eb9fc76349abb1871a5ebf4f0fc9)
* ["sdk/wch.sdk.logger"](#_299079a4f7266ed423ed530c6d430272ddcf2ae49f4f29c26eb1d63fc4ee1fc5)
* ["sdk/wch.sdk.router"](#_7d57cd13ceb907a0f60a149f8b18f200fa9f8063110fb9e7c12c5e70ec66a390)
* ["sdk/wch.sdk.search"](#_00fbd580b5dbc07e3b4fb0d11f09b06e6ee5813a3ee672371f01ff6ae9b6fc6a)
* ["sdk/wch.sdk.version"](#_540ffafde5dde6a26c1e60612788742ca0eca5b9a2ba3b106a0808be451c13ef)
* ["services/services"](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819)
* ["url/urls.service"](#_020882e7750e72537060028786c27691f4d574e745eb538fd64b886f233305b3)
* ["version"](#_99dec4bde79405c04fb886c872bdc6dafdcd0ba313ac8208f7d4e803dac28909)
* ["wch/wch.service"](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)

---


<a name="_6b8b8fd55d436ad51a77d6803b3f4c1f1de5414202007d737e1b6b3d4f8fbb60"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["http/http.service.on.ajax"](#_6b8b8fd55d436ad51a77d6803b3f4c1f1de5414202007d737e1b6b3d4f8fbb60)

# External module: "http/http.service.on.ajax"

## Index

### Functions

* [createHttpServiceOnAjax](#_6b8b8fd55d436ad51a77d6803b3f4c1f1de5414202007d737e1b6b3d4f8fbb60)

---

## Functions

<a id="createhttpserviceonajax"></a>

###  createHttpServiceOnAjax

▸ **createHttpServiceOnAjax**(): `HttpService`

*Defined in http/http.service.on.ajax.ts:13*

Implements the {@link HttpService} interface on top of the rxjs ajax implementation.

**Returns:** `HttpService`
service implementation

___


<a name="_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)

# External module: "index"

## Index

---


<a name="_4fc4ec3106b769c4ce08cfd5b71d5bffe9d0467abffdbfb3fb184a5b2c0205ff"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["router/hash.route"](#_4fc4ec3106b769c4ce08cfd5b71d5bffe9d0467abffdbfb3fb184a5b2c0205ff)

# External module: "router/hash.route"

## Index

### Functions

* [_parseHash](#_4fc4ec3106b769c4ce08cfd5b71d5bffe9d0467abffdbfb3fb184a5b2c0205ff)
* [createHashRouter](#_4fc4ec3106b769c4ce08cfd5b71d5bffe9d0467abffdbfb3fb184a5b2c0205ff)

---

## Functions

<a id="_parsehash"></a>

###  _parseHash

▸ **_parseHash**(aHash: *`string`*): `string`[]

*Defined in router/hash.route.ts:19*

Parses the hash into a decoded list of segments

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aHash | `string` |  the hash of the URL, starting with a # |

**Returns:** `string`[]
the decoded segments

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

###  createHashRouter

▸ **createHashRouter**(aWindow?: *`Window`*): [RouterState](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a)

*Defined in router/hash.route.ts:30*

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aWindow | `Window` |

**Returns:** [RouterState](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a)

___


<a name="_db1e75558d47fd9c4892f608597cced38457ae8d3ab7c5ab5f0b841cad85ca98"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["router/router.state"](#_db1e75558d47fd9c4892f608597cced38457ae8d3ab7c5ab5f0b841cad85ca98)

# External module: "router/router.state"

## Index

### Interfaces

* [RouterState](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a)

---


<a name="_71a26e79b27a6d21fe6cb623ed8649c97ce9eb9fc76349abb1871a5ebf4f0fc9"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk"](#_71a26e79b27a6d21fe6cb623ed8649c97ce9eb9fc76349abb1871a5ebf4f0fc9)

# External module: "sdk/wch.sdk"

## Index

### Classes

* [WchSdkImpl](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)

### Variables

* [_MESSAGE_EVENT](#_71a26e79b27a6d21fe6cb623ed8649c97ce9eb9fc76349abb1871a5ebf4f0fc9)

---

## Variables

<a id="_message_event"></a>

### `<Const>` _MESSAGE_EVENT

**● _MESSAGE_EVENT**: *"message"* = "message"

*Defined in sdk/wch.sdk.ts:29*

___


<a name="_299079a4f7266ed423ed530c6d430272ddcf2ae49f4f29c26eb1d63fc4ee1fc5"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk.logger"](#_299079a4f7266ed423ed530c6d430272ddcf2ae49f4f29c26eb1d63fc4ee1fc5)

# External module: "sdk/wch.sdk.logger"

## Index

### Classes

* [WchSdkLoggerService](#_76f248797f508d905ac2696c9fcdae685b3d56ab303acdc28616a42a6c04ab90)

---


<a name="_7d57cd13ceb907a0f60a149f8b18f200fa9f8063110fb9e7c12c5e70ec66a390"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk.router"](#_7d57cd13ceb907a0f60a149f8b18f200fa9f8063110fb9e7c12c5e70ec66a390)

# External module: "sdk/wch.sdk.router"

## Index

### Classes

* [WchSdkRouterImpl](#_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f)

### Functions

* [_parsePath](#_7d57cd13ceb907a0f60a149f8b18f200fa9f8063110fb9e7c12c5e70ec66a390)

---

## Functions

<a id="_parsepath"></a>

###  _parsePath

▸ **_parsePath**(aPath: *`string`*): `string`[]

*Defined in sdk/wch.sdk.router.ts:20*

Parses the hash into a decoded list of segments

**Parameters:**

| Name | Type |
| ------ | ------ |
| aPath | `string` |

**Returns:** `string`[]
the decoded segments

___


<a name="_00fbd580b5dbc07e3b4fb0d11f09b06e6ee5813a3ee672371f01ff6ae9b6fc6a"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk.search"](#_00fbd580b5dbc07e3b4fb0d11f09b06e6ee5813a3ee672371f01ff6ae9b6fc6a)

# External module: "sdk/wch.sdk.search"

## Index

### Classes

* [WchSdkSearchImpl](#_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6)

---


<a name="_540ffafde5dde6a26c1e60612788742ca0eca5b9a2ba3b106a0808be451c13ef"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk.version"](#_540ffafde5dde6a26c1e60612788742ca0eca5b9a2ba3b106a0808be451c13ef)

# External module: "sdk/wch.sdk.version"

## Index

### Classes

* [WchSdkVersionImpl](#_cf9d9214ebe2607e9fa15631929d1dfe29f78ef4777a40a1b864ccd063117950)

---


<a name="_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/services"](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819)

# External module: "services/services"

## Index

### Interfaces

* [SdkServices](#_2106bf2ee1613a02a955fd045de727cae155c280619495494911ba2bfc826b98)

### Variables

* [DEFAULT_PUBLIC_URL](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819)
* [INSTANCE](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819)
* [_MESSAGE_EVENT](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819)

### Functions

* [getSdkInstance](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819)
* [initSdk](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819)

---

## Variables

<a id="default_public_url"></a>

### `<Const>` DEFAULT_PUBLIC_URL

**● DEFAULT_PUBLIC_URL**: *`true`* = true

*Defined in services/services.ts:18*

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

### `<Let>` INSTANCE

**● INSTANCE**: *[WchSdkImpl](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)* =  null

*Defined in services/services.ts:27*

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

### `<Const>` _MESSAGE_EVENT

**● _MESSAGE_EVENT**: *"message"* = "message"

*Defined in services/services.ts:25*

___

## Functions

<a id="getsdkinstance"></a>

###  getSdkInstance

▸ **getSdkInstance**(aRoot?: *`Window`*): `WchSdk`

*Defined in services/services.ts:29*

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aRoot | `Window` |

**Returns:** `WchSdk`

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

###  initSdk

▸ **initSdk**(aConfig: *`HubInfoConfig`*, aRoot?: *`Window`*): `WchSdk`

*Defined in services/services.ts:36*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aConfig | `HubInfoConfig` |
| `Optional` aRoot | `Window` |

**Returns:** `WchSdk`

___


<a name="_020882e7750e72537060028786c27691f4d574e745eb538fd64b886f233305b3"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["url/urls.service"](#_020882e7750e72537060028786c27691f4d574e745eb538fd64b886f233305b3)

# External module: "url/urls.service"

## Index

### Classes

* [UrlsService](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)

### Functions

* [_ensureTrailingSlash](#_020882e7750e72537060028786c27691f4d574e745eb538fd64b886f233305b3)
* [_normalizeUrl](#_020882e7750e72537060028786c27691f4d574e745eb538fd64b886f233305b3)

---

## Functions

<a id="_ensuretrailingslash"></a>

###  _ensureTrailingSlash

▸ **_ensureTrailingSlash**(aUrl: *`string`*): `string`

*Defined in url/urls.service.ts:17*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aUrl | `string` |

**Returns:** `string`

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

###  _normalizeUrl

▸ **_normalizeUrl**(aUrl: *`URL`*): `URL`

*Defined in url/urls.service.ts:27*

Ensures that the path of the URL object has a trailing slash

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| aUrl | `URL` |  the URL object |

**Returns:** `URL`
the normalized URL

___


<a name="_99dec4bde79405c04fb886c872bdc6dafdcd0ba313ac8208f7d4e803dac28909"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["version"](#_99dec4bde79405c04fb886c872bdc6dafdcd0ba313ac8208f7d4e803dac28909)

# External module: "version"

## Index

### Object literals

* [VERSION](#_99dec4bde79405c04fb886c872bdc6dafdcd0ba313ac8208f7d4e803dac28909)

---

## Object literals

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

### `<Const>` VERSION

**VERSION**: *`object`*

*Defined in version.ts:1*

<a id="version.build"></a>

####  build

**● build**: *`string`* = "01a021c9-8427-4cdd-bdd1-18ad1dda695d"

*Defined in version.ts:3*

___
<a id="version.version-1"></a>

####  version

**● version**: *`string`* = "f507579f-a7b0-4d70-9027-87aa5e35b020"

*Defined in version.ts:2*

___

___


<a name="_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["wch/wch.service"](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)

# External module: "wch/wch.service"

## Index

### Classes

* [WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)

---


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

#  @ibm-wch-sdk/services

## Index

### External modules

* ["http/http.service.on.ajax"](#_6b8b8fd55d436ad51a77d6803b3f4c1f1de5414202007d737e1b6b3d4f8fbb60)
* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["router/hash.route"](#_4fc4ec3106b769c4ce08cfd5b71d5bffe9d0467abffdbfb3fb184a5b2c0205ff)
* ["router/router.state"](#_db1e75558d47fd9c4892f608597cced38457ae8d3ab7c5ab5f0b841cad85ca98)
* ["sdk/wch.sdk"](#_71a26e79b27a6d21fe6cb623ed8649c97ce9eb9fc76349abb1871a5ebf4f0fc9)
* ["sdk/wch.sdk.logger"](#_299079a4f7266ed423ed530c6d430272ddcf2ae49f4f29c26eb1d63fc4ee1fc5)
* ["sdk/wch.sdk.router"](#_7d57cd13ceb907a0f60a149f8b18f200fa9f8063110fb9e7c12c5e70ec66a390)
* ["sdk/wch.sdk.search"](#_00fbd580b5dbc07e3b4fb0d11f09b06e6ee5813a3ee672371f01ff6ae9b6fc6a)
* ["sdk/wch.sdk.version"](#_540ffafde5dde6a26c1e60612788742ca0eca5b9a2ba3b106a0808be451c13ef)
* ["services/services"](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819)
* ["url/urls.service"](#_020882e7750e72537060028786c27691f4d574e745eb538fd64b886f233305b3)
* ["version"](#_99dec4bde79405c04fb886c872bdc6dafdcd0ba313ac8208f7d4e803dac28909)
* ["wch/wch.service"](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)

---


<a name="_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["router/router.state"](#_db1e75558d47fd9c4892f608597cced38457ae8d3ab7c5ab5f0b841cad85ca98) > [RouterState](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a)

# Interface: RouterState

Simple implementation of the router state that decodes the current route from the URL

## Hierarchy

**RouterState**

## Index

### Properties

* [change](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a)
* [onChanged](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a)

---

## Properties

<a id="change"></a>

###  change

**● change**: *`Consumer`<`string`[]>*

*Defined in router/router.state.ts:19*

Triggers a change in navigation

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

###  onChanged

**● onChanged**: *`Observable`<`string`[]>*

*Defined in router/router.state.ts:14*

Callback invoked whenever the current route changes. The value is a parsed and unescaped list of URL segments

___


<a name="_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk"](#_71a26e79b27a6d21fe6cb623ed8649c97ce9eb9fc76349abb1871a5ebf4f0fc9) > [WchSdkImpl](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)

# Class: WchSdkImpl

## Hierarchy

**WchSdkImpl**

## Implements

* `WchSdk`

## Index

### Constructors

* [constructor](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)

### Properties

* [dispose](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)
* [logger](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)
* [refresh](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)
* [router](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)
* [search](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)
* [version](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new WchSdkImpl**(aRouter: *[RouterState](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a)*, aService: *[WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)*, aWindow?: *`Window`*): [WchSdkImpl](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)

*Defined in sdk/wch.sdk.ts:61*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aRouter | [RouterState](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a) |
| aService | [WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944) |
| `Optional` aWindow | `Window` |

**Returns:** [WchSdkImpl](#_58b921cce047639bc4909114140e72a9eb9736bba088db33533ad96b9ad5d1bc)

___

## Properties

<a id="dispose"></a>

###  dispose

**● dispose**: *`function`*

*Defined in sdk/wch.sdk.ts:33*

#### Type declaration
▸(): `void`

**Returns:** `void`

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

###  logger

**● logger**: *`LoggerService`*

*Defined in sdk/wch.sdk.ts:54*

Returns a factory to access loggers

*__returns__*: the logger service

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

###  refresh

**● refresh**: *`function`*

*Defined in sdk/wch.sdk.ts:38*

Refreshes the rendering context and all JSON data that is currently displayed

#### Type declaration
▸(): `void`

**Returns:** `void`

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

###  router

**● router**: *`WchSdkRouter`*

*Defined in sdk/wch.sdk.ts:40*

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

###  search

**● search**: *`WchSdkSearch`*

*Defined in sdk/wch.sdk.ts:61*

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

###  version

**● version**: *`WchSdkVersion`*

*Defined in sdk/wch.sdk.ts:47*

___


<a name="_76f248797f508d905ac2696c9fcdae685b3d56ab303acdc28616a42a6c04ab90"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk.logger"](#_299079a4f7266ed423ed530c6d430272ddcf2ae49f4f29c26eb1d63fc4ee1fc5) > [WchSdkLoggerService](#_76f248797f508d905ac2696c9fcdae685b3d56ab303acdc28616a42a6c04ab90)

# Class: WchSdkLoggerService

## Hierarchy

**WchSdkLoggerService**

## Implements

* `LoggerService`

## Index

### Constructors

* [constructor](#_76f248797f508d905ac2696c9fcdae685b3d56ab303acdc28616a42a6c04ab90)

### Properties

* [get](#_76f248797f508d905ac2696c9fcdae685b3d56ab303acdc28616a42a6c04ab90)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new WchSdkLoggerService**(): [WchSdkLoggerService](#_76f248797f508d905ac2696c9fcdae685b3d56ab303acdc28616a42a6c04ab90)

*Defined in sdk/wch.sdk.logger.ts:11*

**Returns:** [WchSdkLoggerService](#_76f248797f508d905ac2696c9fcdae685b3d56ab303acdc28616a42a6c04ab90)

___

## Properties

<a id="get"></a>

###  get

**● get**: *`function`*

*Defined in sdk/wch.sdk.logger.ts:11*

Returns a logger for the given name

*__param__*: name of the logger

*__returns__*: the logger singleton for this name

#### Type declaration
▸(name: *`string`*): `Logger`

**Parameters:**

| Name | Type |
| ------ | ------ |
| name | `string` |

**Returns:** `Logger`

___


<a name="_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk.router"](#_7d57cd13ceb907a0f60a149f8b18f200fa9f8063110fb9e7c12c5e70ec66a390) > [WchSdkRouterImpl](#_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f)

# Class: WchSdkRouterImpl

## Hierarchy

**WchSdkRouterImpl**

## Implements

* `WchSdkRouter`

## Index

### Constructors

* [constructor](#_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f)

### Properties

* [activeRenderingContext](#_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f)
* [activeRoute](#_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f)
* [navigateByPath](#_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new WchSdkRouterImpl**(aRouter: *[RouterState](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a)*, aService: *[WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)*): [WchSdkRouterImpl](#_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f)

*Defined in sdk/wch.sdk.router.ts:46*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aRouter | [RouterState](#_a22acaa33638904bd32cc391da5552e2f0765692d475deca7fde3541fb777b8a) |
| aService | [WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944) |

**Returns:** [WchSdkRouterImpl](#_94c7b55cd3b37405235f752b9d4987cbe45708a139229ffc7204355ae741944f)

___

## Properties

<a id="activerenderingcontext"></a>

###  activeRenderingContext

**● activeRenderingContext**: *`function`*

*Defined in sdk/wch.sdk.router.ts:46*

#### Type declaration
▸(): `Observable`<`RenderingContext`>

**Returns:** `Observable`<`RenderingContext`>

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

###  activeRoute

**● activeRoute**: *`function`*

*Defined in sdk/wch.sdk.router.ts:39*

#### Type declaration
▸(): `Observable`<`SitePage`>

**Returns:** `Observable`<`SitePage`>

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

###  navigateByPath

**● navigateByPath**: *`function`*

*Defined in sdk/wch.sdk.router.ts:32*

#### Type declaration
▸(aPath: *`string`*): `PromiseLike`<`boolean`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aPath | `string` |

**Returns:** `PromiseLike`<`boolean`>

___


<a name="_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk.search"](#_00fbd580b5dbc07e3b4fb0d11f09b06e6ee5813a3ee672371f01ff6ae9b6fc6a) > [WchSdkSearchImpl](#_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6)

# Class: WchSdkSearchImpl

## Hierarchy

**WchSdkSearchImpl**

## Implements

* `WchSdkSearch`

## Index

### Constructors

* [constructor](#_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6)

### Properties

* [getRenderingContextById](#_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6)
* [getRenderingContexts](#_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6)
* [getSitePages](#_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new WchSdkSearchImpl**(aWchService: *[WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)*): [WchSdkSearchImpl](#_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6)

*Defined in sdk/wch.sdk.search.ts:23*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aWchService | [WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944) |

**Returns:** [WchSdkSearchImpl](#_af68449a15358e42fcfbfbb7994f4f3ac847ca181ef35c27dece2fb01d9af7d6)

___

## Properties

<a id="getrenderingcontextbyid"></a>

###  getRenderingContextById

**● getRenderingContextById**: *`function`*

*Defined in sdk/wch.sdk.search.ts:15*

#### Type declaration
▸(aId: *`string`*, aLevels?: *`number`*): `Observable`<`RenderingContext`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aId | `string` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContext`>

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

###  getRenderingContexts

**● getRenderingContexts**: *`function`*

*Defined in sdk/wch.sdk.search.ts:19*

#### Type declaration
▸(aValue: *`QueryInput`*, aLevels?: *`number`*): `Observable`<`RenderingContextQueryResult`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aValue | `QueryInput` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContextQueryResult`>

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

###  getSitePages

**● getSitePages**: *`function`*

*Defined in sdk/wch.sdk.search.ts:23*

#### Type declaration
▸(aValue: *`QueryInput`*): `Observable`<`SitePagesQueryResult`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aValue | `QueryInput` |

**Returns:** `Observable`<`SitePagesQueryResult`>

___


<a name="_cf9d9214ebe2607e9fa15631929d1dfe29f78ef4777a40a1b864ccd063117950"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["sdk/wch.sdk.version"](#_540ffafde5dde6a26c1e60612788742ca0eca5b9a2ba3b106a0808be451c13ef) > [WchSdkVersionImpl](#_cf9d9214ebe2607e9fa15631929d1dfe29f78ef4777a40a1b864ccd063117950)

# Class: WchSdkVersionImpl

## Hierarchy

**WchSdkVersionImpl**

## Implements

* `WchSdkVersion`

## Index

### Constructors

* [constructor](#_cf9d9214ebe2607e9fa15631929d1dfe29f78ef4777a40a1b864ccd063117950)

### Properties

* [build](#_cf9d9214ebe2607e9fa15631929d1dfe29f78ef4777a40a1b864ccd063117950)
* [version](#_cf9d9214ebe2607e9fa15631929d1dfe29f78ef4777a40a1b864ccd063117950)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new WchSdkVersionImpl**(): [WchSdkVersionImpl](#_cf9d9214ebe2607e9fa15631929d1dfe29f78ef4777a40a1b864ccd063117950)

*Defined in sdk/wch.sdk.version.ts:13*

**Returns:** [WchSdkVersionImpl](#_cf9d9214ebe2607e9fa15631929d1dfe29f78ef4777a40a1b864ccd063117950)

___

## Properties

<a id="build"></a>

###  build

**● build**: *`Date`*

*Defined in sdk/wch.sdk.version.ts:13*

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

###  version

**● version**: *`object`*

*Defined in sdk/wch.sdk.version.ts:6*

#### Type declaration

 major: `string`

 minor: `string`

 patch: `string`

___


<a name="_2106bf2ee1613a02a955fd045de727cae155c280619495494911ba2bfc826b98"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["services/services"](#_8b0bdb3ab8b718c7f61e8e546ed88bffb298ff84c4b4fb417becf171c9114819) > [SdkServices](#_2106bf2ee1613a02a955fd045de727cae155c280619495494911ba2bfc826b98)

# Interface: SdkServices

## Hierarchy

**SdkServices**

## Index

### Properties

* [activePage](#_2106bf2ee1613a02a955fd045de727cae155c280619495494911ba2bfc826b98)
* [urlConfig](#_2106bf2ee1613a02a955fd045de727cae155c280619495494911ba2bfc826b98)

---

## Properties

<a id="activepage"></a>

###  activePage

**● activePage**: *`Observable`<`RenderingContext`>*

*Defined in services/services.ts:22*

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

###  urlConfig

**● urlConfig**: *`UrlConfig`*

*Defined in services/services.ts:21*

___


<a name="_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["url/urls.service"](#_020882e7750e72537060028786c27691f4d574e745eb538fd64b886f233305b3) > [UrlsService](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)

# Class: UrlsService

## Hierarchy

**UrlsService**

## Implements

* `UrlConfig`

## Index

### Constructors

* [constructor](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)

### Properties

* [apiUrl](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)
* [baseUrl](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)
* [deliveryUrl](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)
* [isPreviewMode](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new UrlsService**(aConfig: *`HubInfoConfig`*, aWindow?: *`Window`*): [UrlsService](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)

*Defined in url/urls.service.ts:52*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aConfig | `HubInfoConfig` |
| `Optional` aWindow | `Window` |

**Returns:** [UrlsService](#_1e1a7493ef84441b96fe39e1dd09b46595a56497a8f6e76bed8294a0920176a5)

___

## Properties

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

###  apiUrl

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

*Defined in url/urls.service.ts:38*

The API URL to content hub

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

### `<Optional>` baseUrl

**● baseUrl**: *`URL`*

*Defined in url/urls.service.ts:49*

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`*

*Defined in url/urls.service.ts:43*

The Delivery URL to content hub

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

###  isPreviewMode

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

*Defined in url/urls.service.ts:52*

True if the system runs in preview mode, else false.

___


<a name="_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944"></a>
[@ibm-wch-sdk/services](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["wch/wch.service"](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d) > [WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)

# Class: WchService

## Hierarchy

 `InternalWchService`

**↳ WchService**

## Index

### Constructors

* [constructor](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)

### Properties

* [createPollingTrigger](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [dispose](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getApiUrl](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getCorsWhitelist](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getDeliverOrigin](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getDeliveryUrl](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getJsonResource](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getRenderingContextById](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getRenderingContextByPage](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getRenderingContextByPath](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getRenderingContextByUrlSegments](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getRenderingContextForAppConfig](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getRenderingContextsByQuery](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getSitePagesByQuery](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [getTextResource](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [isPreviewMode](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [resolveRenderingContext](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)
* [triggerRefresh](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new WchService**(aHttp: *`HttpService`*, wchConfig: *`HubInfoConfig`*, aUrlService: *`UrlConfig`*, clientStorage: *`ClientStorage`*, usePublicUrl: *`Observable`<`boolean`>*): [WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)

*Overrides InternalWchService.__constructor*

*Defined in wch/wch.service.ts:6*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aHttp | `HttpService` |
| wchConfig | `HubInfoConfig` |
| aUrlService | `UrlConfig` |
| clientStorage | `ClientStorage` |
| usePublicUrl | `Observable`<`boolean`> |

**Returns:** [WchService](#_71ba4ce6936a1c2789a907b0dc740d2ac81b56ddd4ccf4e0c49d2db3a06d3944)

___

## Properties

<a id="createpollingtrigger"></a>

### `<Protected>` createPollingTrigger

**● createPollingTrigger**: *`function`*

*Inherited from InternalWchService.createPollingTrigger*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:23*

#### Type declaration
▸(aOptions?: *`HttpResourceOptions`*): `Observable`<`any`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aOptions | `HttpResourceOptions` |

**Returns:** `Observable`<`any`>

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

###  dispose

**● dispose**: *`function`*

*Inherited from InternalWchService.dispose*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:6*

#### Type declaration
▸(): `void`

**Returns:** `void`

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

###  getApiUrl

**● getApiUrl**: *`function`*

*Inherited from InternalWchService.getApiUrl*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:8*

#### Type declaration
▸(): `URL`

**Returns:** `URL`

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

###  getCorsWhitelist

**● getCorsWhitelist**: *`function`*

*Inherited from InternalWchService.getCorsWhitelist*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:19*

#### Type declaration
▸(): `Observable`<`string`[]>

**Returns:** `Observable`<`string`[]>

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

###  getDeliverOrigin

**● getDeliverOrigin**: *`function`*

*Inherited from InternalWchService.getDeliverOrigin*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:11*

#### Type declaration
▸(): `string`

**Returns:** `string`

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

###  getDeliveryUrl

**● getDeliveryUrl**: *`function`*

*Inherited from InternalWchService.getDeliveryUrl*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:9*

#### Type declaration
▸(): `URL`

**Returns:** `URL`

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

###  getJsonResource

**● getJsonResource**: *`function`*

*Inherited from InternalWchService.getJsonResource*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:20*

#### Type declaration
▸<`T`>(aUrl: *`string`*, aOptions?: *`HttpResourceOptions`*): `Observable`<`T`>

**Type parameters:**

#### T 
**Parameters:**

| Name | Type |
| ------ | ------ |
| aUrl | `string` |
| `Optional` aOptions | `HttpResourceOptions` |

**Returns:** `Observable`<`T`>

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

###  getRenderingContextById

**● getRenderingContextById**: *`function`*

*Inherited from InternalWchService.getRenderingContextById*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:12*

#### Type declaration
▸(aID: *`string` \| `null` \| `undefined`*, aLevels?: *`number`*): `Observable`<`RenderingContext` \| `null` \| `undefined`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aID | `string` \| `null` \| `undefined` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContext` \| `null` \| `undefined`>

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

###  getRenderingContextByPage

**● getRenderingContextByPage**: *`function`*

*Inherited from InternalWchService.getRenderingContextByPage*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:15*

#### Type declaration
▸(aPage: *`SitePage`*, aLevels?: *`number`*): `Observable`<`RenderingContext` \| `null` \| `undefined`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aPage | `SitePage` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContext` \| `null` \| `undefined`>

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

###  getRenderingContextByPath

**● getRenderingContextByPath**: *`function`*

*Inherited from InternalWchService.getRenderingContextByPath*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:14*

#### Type declaration
▸(aPath: *`string`*, aLevels?: *`number`*): `Observable`<`RenderingContext` \| `null` \| `undefined`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aPath | `string` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContext` \| `null` \| `undefined`>

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

###  getRenderingContextByUrlSegments

**● getRenderingContextByUrlSegments**: *`function`*

*Inherited from InternalWchService.getRenderingContextByUrlSegments*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:13*

#### Type declaration
▸(aSegments: *`string`[]*, aLevels?: *`number`*): `Observable`<`RenderingContext` \| `null` \| `undefined`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aSegments | `string`[] |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContext` \| `null` \| `undefined`>

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

###  getRenderingContextForAppConfig

**● getRenderingContextForAppConfig**: *`function`*

*Inherited from InternalWchService.getRenderingContextForAppConfig*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:16*

#### Type declaration
▸(aLevels?: *`number`*): `Observable`<`RenderingContext`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContext`>

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

###  getRenderingContextsByQuery

**● getRenderingContextsByQuery**: *`function`*

*Inherited from InternalWchService.getRenderingContextsByQuery*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:17*

#### Type declaration
▸(aQuery: *`string`*, aLevels?: *`number`*): `Observable`<`RenderingContextQueryResult`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aQuery | `string` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContextQueryResult`>

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

###  getSitePagesByQuery

**● getSitePagesByQuery**: *`function`*

*Inherited from InternalWchService.getSitePagesByQuery*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:18*

#### Type declaration
▸(aQuery: *`string`*): `Observable`<`SitePagesQueryResult`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aQuery | `string` |

**Returns:** `Observable`<`SitePagesQueryResult`>

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

###  getTextResource

**● getTextResource**: *`function`*

*Inherited from InternalWchService.getTextResource*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:21*

#### Type declaration
▸(aUrl: *`string`*, aOptions?: *`HttpResourceOptions`*): `Observable`<`string`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| aUrl | `string` |
| `Optional` aOptions | `HttpResourceOptions` |

**Returns:** `Observable`<`string`>

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

###  isPreviewMode

**● isPreviewMode**: *`function`*

*Inherited from InternalWchService.isPreviewMode*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:10*

#### Type declaration
▸(): `boolean`

**Returns:** `boolean`

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

###  resolveRenderingContext

**● resolveRenderingContext**: *`function`*

*Inherited from InternalWchService.resolveRenderingContext*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:22*

#### Type declaration
▸(aRenderingContext?: *`RenderingContext`*, aStrategy?: *`CYCLE_HANDLING`*): `Observable`<`RenderingContext` \| `null` \| `undefined`>

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` aRenderingContext | `RenderingContext` |
| `Optional` aStrategy | `CYCLE_HANDLING` |

**Returns:** `Observable`<`RenderingContext` \| `null` \| `undefined`>

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

###  triggerRefresh

**● triggerRefresh**: *`function`*

*Inherited from InternalWchService.triggerRefresh*

*Defined in /usr/build/node_modules/@ibm-wch-sdk/utils/src/wch/wch.service.d.ts:7*

#### Type declaration
▸(): `void`

**Returns:** `void`

___