ibm-wch-sdk-api

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

Details

Refer to the documentation.

Changes

CHANGELOG

Class documentation

Refer to the documentation.

Usage

Install the module via

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

API

• services
• interfaces

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

ibm-wch-sdk-api

Index

External modules

• "index"
• "interfaces/delivery/v1/base.item"
• "interfaces/delivery/v1/content/content.item"
• "interfaces/delivery/v1/content/elements"
• "interfaces/delivery/v1/error/error"
• "interfaces/delivery/v1/layout/layout"
• "interfaces/delivery/v1/rendering/context/content.item.with.layout"
• "interfaces/delivery/v1/rendering/context/extended.context"
• "interfaces/delivery/v1/rendering/context/hub.context"
• "interfaces/delivery/v1/rendering/context/rendering.context"
• "interfaces/delivery/v1/search/search.result"
• "interfaces/delivery/v1/site/site"
• "interfaces/delivery/v1/site/site.child"
• "interfaces/delivery/v1/site/site.context"
• "interfaces/delivery/v1/site/site.page"
• "interfaces/delivery/v1/user/user"
• "interfaces/delivery/v1/users/currentuser/constants"
• "interfaces/logging/logger"
• "interfaces/logging/logger.factory"
• "interfaces/login/v1/basicauth/index"
• "interfaces/login/v1/redirect/index"
• "interfaces/login/v1/removecookies/index"
• "interfaces/messages/messages"
• "interfaces/messages/sdk.navigate.by.path.message"
• "interfaces/messages/sdk.refresh.message"
• "interfaces/messages/sdk.set.mode.message"
• "interfaces/messages/sdk.subscribe.active.route.message"
• "interfaces/messages/sdk.subscribe.message"
• "interfaces/messages/sdk.subscribe.mode.message"
• "interfaces/messages/sdk.subscribe.route.message"
• "interfaces/query"
• "interfaces/registry/v1/currenttenant/index"
• "interfaces/sdk/router/router"
• "interfaces/sdk/sdk"
• "interfaces/sdk/search/search"
• "interfaces/sdk/version/version"
• "interfaces/user-profile/v1/users/currentuser/index"
• "services/hub-info/hub-info"
• "services/hub-info/hub-info.config"
• "services/info/url.config"
• "services/logging/logger.service"

---

Services

• [logging][./logging/]
• [info][./info/]

Interfaces

• logging
• delivery
• sdk
• messages ibm-wch-sdk-api > "index"

External module: "index"

Index

---

ibm-wch-sdk-api > "interfaces/delivery/v1/base.item"

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

Index

Enumerations

• DraftStatus

Interfaces

• BaseDeliveryItem

---

ibm-wch-sdk-api > "interfaces/delivery/v1/content/content.item"

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

Index

Interfaces

• ContentItem

---

ibm-wch-sdk-api > "interfaces/delivery/v1/content/elements"

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

Index

Type aliases

• ELEMENT_TYPE

Variables

• _ELEMENT_TYPE_CATEGORY
• _ELEMENT_TYPE_DATE
• _ELEMENT_TYPE_FILE
• _ELEMENT_TYPE_FORMATTED_TEXT
• _ELEMENT_TYPE_GROUP
• _ELEMENT_TYPE_IMAGE
• _ELEMENT_TYPE_LINK
• _ELEMENT_TYPE_LOCATION
• _ELEMENT_TYPE_NUMBER
• _ELEMENT_TYPE_OPTION_SELECTION
• _ELEMENT_TYPE_REFERENCE
• _ELEMENT_TYPE_TEXT
• _ELEMENT_TYPE_TOGGLE
• _ELEMENT_TYPE_VIDEO

---

Type aliases

ELEMENT_TYPE

Ƭ ELEMENT_TYPE: * "text" | "number" | "toggle" | "formattedtext" | "link" | "datetime" | "file" | "video" | "image" | "reference" | "category" | "location" | "optionselection" | "group" *

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

---

Variables

<Const> _ELEMENT_TYPE_CATEGORY

● _ELEMENT_TYPE_CATEGORY: "category" = "category"

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

---

<Const> _ELEMENT_TYPE_DATE

● _ELEMENT_TYPE_DATE: "datetime" = "datetime"

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

---

<Const> _ELEMENT_TYPE_FILE

● _ELEMENT_TYPE_FILE: "file" = "file"

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

---

<Const> _ELEMENT_TYPE_FORMATTED_TEXT

● _ELEMENT_TYPE_FORMATTED_TEXT: "formattedtext" = "formattedtext"

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

---

<Const> _ELEMENT_TYPE_GROUP

● _ELEMENT_TYPE_GROUP: "group" = "group"

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

---

<Const> _ELEMENT_TYPE_IMAGE

● _ELEMENT_TYPE_IMAGE: "image" = "image"

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

---

<Const> _ELEMENT_TYPE_LINK

● _ELEMENT_TYPE_LINK: "link" = "link"

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

---

<Const> _ELEMENT_TYPE_LOCATION

● _ELEMENT_TYPE_LOCATION: "location" = "location"

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

---

<Const> _ELEMENT_TYPE_NUMBER

● _ELEMENT_TYPE_NUMBER: "number" = "number"

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

---

<Const> _ELEMENT_TYPE_OPTION_SELECTION

● _ELEMENT_TYPE_OPTION_SELECTION: "optionselection" = "optionselection"

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

---

<Const> _ELEMENT_TYPE_REFERENCE

● _ELEMENT_TYPE_REFERENCE: "reference" = "reference"

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

---

<Const> _ELEMENT_TYPE_TEXT

● _ELEMENT_TYPE_TEXT: "text" = "text"

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

---

<Const> _ELEMENT_TYPE_TOGGLE

● _ELEMENT_TYPE_TOGGLE: "toggle" = "toggle"

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

---

<Const> _ELEMENT_TYPE_VIDEO

● _ELEMENT_TYPE_VIDEO: "video" = "video"

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/error/error"

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

Index

Interfaces

• ErrorDetail
• ErrorResponse

---

ibm-wch-sdk-api > "interfaces/delivery/v1/layout/layout"

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

Index

Interfaces

• Layout

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/content.item.with.layout"

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

Index

Interfaces

• ContentItemWithLayout

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/extended.context"

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

Index

Interfaces

• ExtendedContext

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/hub.context"

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

Index

Interfaces

• HubContext

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context"

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

Index

Interfaces

• AbstractElement
• Asset
• Category
• CategoryElement
• DateElement
• ElementMap
• File
• FileElement
• FormattedTextElement
• Group
• GroupElement
• Image
• ImageElement
• Link
• LinkElement
• Location
• LocationElement
• MultiDateElement
• MultiFileElement
• MultiFormattedTextElement
• MultiGroupElement
• MultiImageElement
• MultiLinkElement
• MultiNumberElement
• MultiOptionSelectionElement
• MultiReferenceElement
• MultiTextElement
• MultiToggleElement
• MultiVideoElement
• NumberElement
• OptionSelection
• OptionSelectionElement
• ReferenceElement
• RenderingContext
• Rendition
• Resource
• SingleDateElement
• SingleFileElement
• SingleFormattedTextElement
• SingleGroupElement
• SingleImageElement
• SingleLinkElement
• SingleNumberElement
• SingleOptionSelectionElement
• SingleReferenceElement
• SingleTextElement
• SingleToggleElement
• SingleVideoElement
• TextElement
• ToggleElement
• TypeRef
• Video
• VideoElement

Type aliases

• Element
• GroupType
• SimpleType

---

Type aliases

Element

Ƭ Element: * LocationElement | SingleReferenceElement | MultiReferenceElement | SingleImageElement | MultiImageElement | SingleVideoElement | MultiVideoElement | SingleFileElement | MultiFileElement | SingleToggleElement | MultiToggleElement | SingleTextElement | MultiTextElement | SingleNumberElement | MultiNumberElement | SingleLinkElement | MultiLinkElement | SingleFormattedTextElement | MultiFormattedTextElement | SingleOptionSelectionElement | MultiOptionSelectionElement | SingleDateElement | MultiDateElement | SingleGroupElement | MultiGroupElement *

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

---

GroupType

Ƭ GroupType: ElementMap<SimpleType>

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

---

SimpleType

Ƭ SimpleType: * string | string[] | number | number[] | Image | Image[] | Date | Date[] | Video | Video[] | File | File[] | boolean | boolean[] | Link | Link[] | OptionSelection | OptionSelection[] | RenderingContext | RenderingContext[] | Category | Location | object *

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/search/search.result"

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

Index

Interfaces

• PageSearchResult
• RenderingContextQueryResult
• RenderingContextSearchResult
• SearchResult
• SearchResults
• SitePagesQueryResult

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site"

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

Index

Interfaces

• Site
• SiteRoot

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site.child"

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

Index

Interfaces

• SiteChild

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site.context"

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

Index

Interfaces

• SiteContext

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site.page"

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

Index

Interfaces

• SitePage

---

ibm-wch-sdk-api > "interfaces/delivery/v1/user/user"

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

Index

Interfaces

• User

---

ibm-wch-sdk-api > "interfaces/delivery/v1/users/currentuser/constants"

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

Index

Variables

• REL_PATH_CURRENT_USER

---

Variables

<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

---

ibm-wch-sdk-api > "interfaces/logging/logger"

External module: "interfaces/logging/logger"

Index

Interfaces

• Logger

---

ibm-wch-sdk-api > "interfaces/logging/logger.factory"

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

Index

Interfaces

• DynamicLoggerFactory
• LoggerFactory

---

ibm-wch-sdk-api > "interfaces/login/v1/basicauth/index"

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

Index

Variables

• HEADER_BASICAUTH_TENANT_ID
• KEY_BASICAUTH_LOGIN_PASSWORD
• KEY_BASICAUTH_LOGIN_USERNAME
• REL_PATH_BASICAUTH_LOGIN

---

Variables

<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

---

<Const> KEY_BASICAUTH_LOGIN_PASSWORD

● KEY_BASICAUTH_LOGIN_PASSWORD: "j_password" = "j_password"

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

---

<Const> KEY_BASICAUTH_LOGIN_USERNAME

● KEY_BASICAUTH_LOGIN_USERNAME: "j_username" = "j_username"

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

---

<Const> REL_PATH_BASICAUTH_LOGIN

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

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

---

ibm-wch-sdk-api > "interfaces/login/v1/redirect/index"

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

Index

Variables

• PARAM_REDIRECT_LOGIN_TARGET_TENANT
• PARAM_REDIRECT_LOGIN_TARGET_URL
• REL_PATH_REDIRECT_LOGIN

---

Variables

<Const> PARAM_REDIRECT_LOGIN_TARGET_TENANT

● PARAM_REDIRECT_LOGIN_TARGET_TENANT: "targetTenant" = "targetTenant"

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

---

<Const> PARAM_REDIRECT_LOGIN_TARGET_URL

● PARAM_REDIRECT_LOGIN_TARGET_URL: "targetUrl" = "targetUrl"

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

---

<Const> REL_PATH_REDIRECT_LOGIN

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

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

---

ibm-wch-sdk-api > "interfaces/login/v1/removecookies/index"

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

Index

Variables

• REL_PATH_REMOVECOOKIES

---

Variables

<Const> REL_PATH_REMOVECOOKIES

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

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

---

ibm-wch-sdk-api > "interfaces/messages/messages"

External module: "interfaces/messages/messages"

Index

Interfaces

• SdkErrorResponse
• SdkMessageHandler
• SdkMessagePayload

Type aliases

• SdkMessageHandlerCallback

---

Type aliases

SdkMessageHandlerCallback

Ƭ SdkMessageHandlerCallback: function

Defined in interfaces/messages/messages.ts:21

Type declaration

▸(aPayload: SdkMessagePayload, aEvent: MessageEvent): PromiseLike<SdkMessagePayload> | SdkMessagePayload | null | undefined

Parameters:

Param	Type
aPayload	SdkMessagePayload
aEvent	MessageEvent

Returns: PromiseLike<SdkMessagePayload> | SdkMessagePayload | null | undefined

---

ibm-wch-sdk-api > "interfaces/messages/sdk.navigate.by.path.message"

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

Index

Interfaces

• SdkNavigateByPathEvent
• SdkNavigateByPathResponse

Variables

• SDK_NAVIGATE_BY_PATH_EVENT_TYPE

---

Variables

<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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.refresh.message"

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

Index

Interfaces

• SdkRefreshEvent

Variables

• SDK_REFRESH_EVENT_TYPE

---

Variables

<Const> SDK_REFRESH_EVENT_TYPE

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

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.set.mode.message"

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

Index

Interfaces

• SdkSetModeEvent
• SdkSetModeResponse

Variables

• SDK_SET_MODE_EVENT_TYPE

---

Variables

<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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.active.route.message"

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

Index

Interfaces

• SdkActiveRouteEvent
• SdkSubscribeActiveRouteEvent
• SdkSubscribeActiveRouteEventResponse

Variables

• SDK_ACTIVE_ROUTE_EVENT_TYPE
• SDK_SUBSCRIBE_ACTIVE_ROUTE_EVENT_TYPE

---

Variables

<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

---

<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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.message"

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

Index

Interfaces

• SdkSubscribeEventResponse
• SdkUnsubscribeEvent

Variables

• SDK_UNSUBSCRIBE_EVENT_TYPE

---

Variables

<Const> SDK_UNSUBSCRIBE_EVENT_TYPE

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

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.mode.message"

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

Index

Enumerations

• SdkMode

Interfaces

• SdkModeEvent
• SdkSubscribeModeEvent
• SdkSubscribeModeEventResponse

Variables

• SDK_MODE_EVENT_TYPE
• SDK_SUBSCRIBE_MODE_EVENT_TYPE

---

Variables

<Const> SDK_MODE_EVENT_TYPE

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

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

---

<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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.route.message"

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

Index

Interfaces

• SdkRouteEvent
• SdkSubscribeRouteEvent
• SdkSubscribeRouteEventResponse

Variables

• SDK_ROUTE_EVENT_TYPE
• SDK_SUBSCRIBE_ROUTE_EVENT_TYPE

---

Variables

<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

---

<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

---

ibm-wch-sdk-api > "interfaces/query"

External module: "interfaces/query"

Index

Interfaces

• Query

Type aliases

• QueryValue

---

Type aliases

QueryValue

Ƭ QueryValue: * string | number | boolean *

Defined in interfaces/query.ts:4

---

ibm-wch-sdk-api > "interfaces/registry/v1/currenttenant/index"

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

Index

Variables

• REL_PATH_CURRENT_TENANT

---

Variables

<Const> REL_PATH_CURRENT_TENANT

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

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

---

ibm-wch-sdk-api > "interfaces/sdk/router/router"

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

Index

Interfaces

• WchSdkRouter

---

ibm-wch-sdk-api > "interfaces/sdk/sdk"

External module: "interfaces/sdk/sdk"

Index

Interfaces

• WchSdk

Variables

• WCH_SDK_MODULE_NAME

---

Variables

<Const> WCH_SDK_MODULE_NAME

● WCH_SDK_MODULE_NAME: "WchSdk" = "WchSdk"

Defined in interfaces/sdk/sdk.ts:7

---

ibm-wch-sdk-api > "interfaces/sdk/search/search"

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

Index

Interfaces

• WchSdkSearch

Type aliases

• QueryInput

---

Type aliases

QueryInput

Ƭ QueryInput: * string | string[] | null | undefined | URLSearchParams | Query *

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

---

ibm-wch-sdk-api > "interfaces/sdk/version/version"

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

Index

Interfaces

• WchSdkVersion

---

ibm-wch-sdk-api > "interfaces/user-profile/v1/users/currentuser/index"

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

Index

Variables

• REGEXP_ANONYMOUS_USER_ID
• REL_PATH_CURRENT_USER

---

Variables

<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

---

<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

---

ibm-wch-sdk-api > "services/hub-info/hub-info"

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

Index

Interfaces

• HubInfo

---

ibm-wch-sdk-api > "services/hub-info/hub-info.config"

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

Index

Enumerations

• CYCLE_HANDLING

Classes

• HubInfoConfig

Interfaces

• HttpResourceOptions

Type aliases

• HubInfoUrlProvider

---

Type aliases

HubInfoUrlProvider

Ƭ HubInfoUrlProvider: * null | undefined | URL | string | function *

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

---

ibm-wch-sdk-api > "services/info/url.config"

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

Index

Interfaces

• UrlConfig

---

ibm-wch-sdk-api > "services/logging/logger.service"

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

Index

Interfaces

• LoggerService

---

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.

Delivery

Typescript definitions of the WCH Delivery APIs.

WchSdk

The SDK defines the plain JS WCH SDK APIs .

Properties

• router
• version 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

window.WchSdk

Cross Origin Eventing

The SDK supports WebMessaging to allow communication across frames via the 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. If the first element of the transfer object contains a 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 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.

The example doe NOT show how to unsubscribe.

/**
 * 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();

Messaging

Cross Origin Eventing

The SDK supports WebMessaging to allow communication across frames via the 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. If the first element of the transfer object contains a 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 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.

The example doe NOT show how to unsubscribe.

/**
 * 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();

ibm-wch-sdk-api

Index

External modules

• "index"
• "interfaces/delivery/v1/base.item"
• "interfaces/delivery/v1/content/content.item"
• "interfaces/delivery/v1/content/elements"
• "interfaces/delivery/v1/error/error"
• "interfaces/delivery/v1/layout/layout"
• "interfaces/delivery/v1/rendering/context/content.item.with.layout"
• "interfaces/delivery/v1/rendering/context/extended.context"
• "interfaces/delivery/v1/rendering/context/hub.context"
• "interfaces/delivery/v1/rendering/context/rendering.context"
• "interfaces/delivery/v1/search/search.result"
• "interfaces/delivery/v1/site/site"
• "interfaces/delivery/v1/site/site.child"
• "interfaces/delivery/v1/site/site.context"
• "interfaces/delivery/v1/site/site.page"
• "interfaces/delivery/v1/user/user"
• "interfaces/delivery/v1/users/currentuser/constants"
• "interfaces/logging/logger"
• "interfaces/logging/logger.factory"
• "interfaces/login/v1/basicauth/index"
• "interfaces/login/v1/redirect/index"
• "interfaces/login/v1/removecookies/index"
• "interfaces/messages/messages"
• "interfaces/messages/sdk.navigate.by.path.message"
• "interfaces/messages/sdk.refresh.message"
• "interfaces/messages/sdk.set.mode.message"
• "interfaces/messages/sdk.subscribe.active.route.message"
• "interfaces/messages/sdk.subscribe.message"
• "interfaces/messages/sdk.subscribe.mode.message"
• "interfaces/messages/sdk.subscribe.route.message"
• "interfaces/query"
• "interfaces/registry/v1/currenttenant/index"
• "interfaces/sdk/router/router"
• "interfaces/sdk/sdk"
• "interfaces/sdk/search/search"
• "interfaces/sdk/version/version"
• "interfaces/user-profile/v1/users/currentuser/index"
• "services/hub-info/hub-info"
• "services/hub-info/hub-info.config"
• "services/info/url.config"
• "services/logging/logger.service"

---

ibm-wch-sdk-api > "interfaces/delivery/v1/base.item" > DraftStatus

Enumeration: DraftStatus

Possible values for draft status

Index

Enumeration members

• APPROVED
• IN_PROGRESS
• IN_REVIEW

---

Enumeration members

APPROVED

APPROVED: = "approved"

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

---

IN_PROGRESS

IN_PROGRESS: = "in-progress"

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

---

IN_REVIEW

IN_REVIEW: = "in-review"

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/base.item" > BaseDeliveryItem

Interface: BaseDeliveryItem

Base interface for all items

Hierarchy

BaseDeliveryItem

↳ ContentItem

↳ SitePage

Index

Properties

• classification
• created
• creatorId
• description
• id
• lastModified
• lastModifierId
• name
• rev

---

Properties

<Optional> classification

● classification: string

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

---

<Optional> created

● created: string

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

---

<Optional> creatorId

● creatorId: string

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

---

<Optional> description

● description: string

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

---

<Optional> id

● id: string

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

---

<Optional> lastModified

● lastModified: string

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

---

<Optional> lastModifierId

● lastModifierId: string

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

---

<Optional> name

● name: string

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

---

<Optional> rev

● rev: string

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/content/content.item" > ContentItem

Interface: ContentItem

Hierarchy

BaseDeliveryItem

↳ ContentItem

↳ ContentItemWithLayout

Index

Properties

• classification
• created
• creatorId
• description
• draftId
• draftStatus
• elements
• id
• lastModified
• lastModifierId
• locale
• name
• rev
• tags
• type
• typeId

---

Properties

<Optional> classification

● classification: string

Inherited from BaseDeliveryItem.classification

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

---

<Optional> created

● created: string

Inherited from BaseDeliveryItem.created

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

---

<Optional> creatorId

● creatorId: string

Inherited from BaseDeliveryItem.creatorId

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

---

<Optional> description

● description: string

Inherited from BaseDeliveryItem.description

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

---

<Optional> draftId

● draftId: string

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

TBD

---

<Optional> draftStatus

● draftStatus: * "pending" | "approved" *

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

TBD

---

elements

● elements: object

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

Type declaration

---

<Optional> id

● id: string

Inherited from BaseDeliveryItem.id

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

---

<Optional> lastModified

● lastModified: string

Inherited from BaseDeliveryItem.lastModified

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

---

<Optional> lastModifierId

● lastModifierId: string

Inherited from BaseDeliveryItem.lastModifierId

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

---

<Optional> locale

● locale: string

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

---

<Optional> name

● name: string

Inherited from BaseDeliveryItem.name

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

---

<Optional> rev

● rev: string

Inherited from BaseDeliveryItem.rev

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

---

<Optional> tags

● tags: Array<string>

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

---

<Optional> type

● type: string

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

---

<Optional> typeId

● typeId: string

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/error/error" > ErrorDetail

Interface: ErrorDetail

Hierarchy

ErrorDetail

Index

Properties

• locale
• message
• name
• parameters
• stack

---

Properties

locale

● locale: string

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

---

message

● message: string

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

---

name

● name: string

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

---

parameters

● parameters: any

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

---

<Optional> stack

● stack: string

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/error/error" > ErrorResponse

Interface: ErrorResponse

JSON structure of an error response

Hierarchy

ErrorResponse

Index

Properties

• description
• errors
• message
• requestId
• service
• statusCode
• version

---

Properties

description

● description: string

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

---

errors

● errors: ErrorDetail[]

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

---

message

● message: string

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

---

requestId

● requestId: string

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

---

service

● service: string

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

---

statusCode

● statusCode: number

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

---

version

● version: string

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/layout/layout" > Layout

Interface: Layout

Hierarchy

Layout

Index

Properties

• template
• templateType

---

Properties

template

● template: string

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

---

templateType

● templateType: string

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/content.item.with.layout" > ContentItemWithLayout

Interface: ContentItemWithLayout

Hierarchy

↳ ContentItem

↳ ContentItemWithLayout

↳ RenderingContext

Index

Properties

• classification
• created
• creatorId
• description
• draftId
• draftStatus
• elements
• id
• lastModified
• lastModifierId
• layouts
• locale
• name
• rev
• tags
• type
• typeId

---

Properties

<Optional> classification

● classification: string

Inherited from BaseDeliveryItem.classification

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

---

<Optional> created

● created: string

Inherited from BaseDeliveryItem.created

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

---

<Optional> creatorId

● creatorId: string

Inherited from BaseDeliveryItem.creatorId

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

---

<Optional> description

● description: string

Inherited from BaseDeliveryItem.description

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

---

<Optional> draftId

● draftId: string

Inherited from ContentItem.draftId

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

TBD

---

<Optional> draftStatus

● draftStatus: * "pending" | "approved" *

Inherited from ContentItem.draftStatus

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

TBD

---

elements

● elements: object

Inherited from ContentItem.elements

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

Type declaration

---

id

● id: string

Overrides BaseDeliveryItem.id

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

---

<Optional> lastModified

● lastModified: string

Inherited from BaseDeliveryItem.lastModified

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

---

<Optional> lastModifierId

● lastModifierId: string

Inherited from BaseDeliveryItem.lastModifierId

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

---

layouts

● layouts: object

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

Type declaration

---

<Optional> locale

● locale: string

Inherited from ContentItem.locale

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

---

<Optional> name

● name: string

Inherited from BaseDeliveryItem.name

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

---

<Optional> rev

● rev: string

Inherited from BaseDeliveryItem.rev

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

---

<Optional> tags

● tags: Array<string>

Inherited from ContentItem.tags

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

---

<Optional> type

● type: string

Inherited from ContentItem.type

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

---

<Optional> typeId

● typeId: string

Inherited from ContentItem.typeId

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/extended.context" > ExtendedContext

Interface: ExtendedContext

Hierarchy

SiteContext

↳ ExtendedContext

Index

Properties

• breadcrumb
• children
• hub
• parent
• sibling
• site

---

Properties

breadcrumb

● breadcrumb: SitePage[]

Inherited from SiteContext.breadcrumb

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

---

children

● children: SitePage[]

Inherited from SiteContext.children

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

---

<Optional> hub

● hub: HubContext

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

---

<Optional> parent

● parent: SitePage

Inherited from SiteContext.parent

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

---

sibling

● sibling: SitePage[]

Inherited from SiteContext.sibling

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

---

site

● site: Site

Inherited from SiteContext.site

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/hub.context" > HubContext

Interface: HubContext

Hierarchy

HubContext

Index

Properties

• apiUrl
• deliveryUrl
• isPreviewMode

---

Properties

apiUrl

● apiUrl: URL

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

---

deliveryUrl

● deliveryUrl: URL

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

---

<Optional> isPreviewMode

● isPreviewMode: boolean

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > AbstractElement

Interface: AbstractElement

Hierarchy

AbstractElement

↳ TextElement

↳ GroupElement

↳ OptionSelectionElement

↳ FormattedTextElement

↳ NumberElement

↳ ToggleElement

↳ LinkElement

↳ DateElement

↳ CategoryElement

↳ FileElement

↳ VideoElement

↳ ImageElement

↳ ReferenceElement

↳ LocationElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: ELEMENT_TYPE

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Asset

Interface: Asset

Hierarchy

Asset

Index

Properties

• fileName
• fileSize
• height
• id
• mediaType
• resourceUri
• width

---

Properties

fileName

● fileName: string

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

---

fileSize

● fileSize: number

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

---

height

● height: number

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

---

id

● id: string

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

---

mediaType

● mediaType: string

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

---

resourceUri

● resourceUri: string

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

---

width

● width: number

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Category

Interface: Category

Hierarchy

Category

↳ CategoryElement

Index

Properties

• categories
• categoryIds
• categoryPaths

---

Properties

<Optional> categories

● categories: string[]

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

---

<Optional> categoryIds

● categoryIds: string[]

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

---

<Optional> categoryPaths

● categoryPaths: string[][]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > CategoryElement

Interface: CategoryElement

Hierarchy

AbstractElement

Category

↳ CategoryElement

Index

Properties

• categories
• categoryIds
• categoryPaths
• elementType

---

Properties

<Optional> categories

● categories: string[]

Inherited from Category.categories

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

---

<Optional> categoryIds

● categoryIds: string[]

Inherited from Category.categoryIds

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

---

<Optional> categoryPaths

● categoryPaths: string[][]

Inherited from Category.categoryPaths

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

---

elementType

● elementType: "category"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > DateElement

Interface: DateElement

Hierarchy

AbstractElement

↳ DateElement

↳ SingleDateElement

↳ MultiDateElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "datetime"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > ElementMap

Interface: ElementMap

Type parameters

T

Hierarchy

ElementMap

Indexable

[key: string]: T

Index

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > File

Interface: File

Hierarchy

File

↳ SingleFileElement

Index

Properties

• asset
• url

---

Properties

<Optional> asset

● asset: Asset

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

---

<Optional> url

● url: string

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > FileElement

Interface: FileElement

Hierarchy

AbstractElement

↳ FileElement

↳ SingleFileElement

↳ MultiFileElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "file"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > FormattedTextElement

Interface: FormattedTextElement

Hierarchy

AbstractElement

↳ FormattedTextElement

↳ SingleFormattedTextElement

↳ MultiFormattedTextElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "formattedtext"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Group

Interface: Group

Interface that represents a grouping of elements

Hierarchy

Group

Indexable

[key: string]: Element Interface that represents a grouping of elements

Index

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > GroupElement

Interface: GroupElement

Hierarchy

AbstractElement

↳ GroupElement

↳ SingleGroupElement

↳ MultiGroupElement

Index

Properties

• elementType
• typeRef

---

Properties

elementType

● elementType: "group"

Overrides AbstractElement.elementType

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

---

typeRef

● typeRef: TypeRef

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Image

Interface: Image

Hierarchy

Image

↳ SingleImageElement

Index

Properties

• altText
• asset
• renditions
• url

---

Properties

<Optional> altText

● altText: string

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

---

<Optional> asset

● asset: Asset

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

---

<Optional> renditions

● renditions: object

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

Type declaration

---

<Optional> url

● url: string

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > ImageElement

Interface: ImageElement

Hierarchy

AbstractElement

↳ ImageElement

↳ SingleImageElement

↳ MultiImageElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "image"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Link

Interface: Link

Hierarchy

Link

↳ SingleLinkElement

Index

Properties

• linkDescription
• linkText
• linkURL

---

Properties

<Optional> linkDescription

● linkDescription: string

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

---

<Optional> linkText

● linkText: string

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

---

<Optional> linkURL

● linkURL: string

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > LinkElement

Interface: LinkElement

Hierarchy

AbstractElement

↳ LinkElement

↳ SingleLinkElement

↳ MultiLinkElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "link"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Location

Interface: Location

Hierarchy

Location

↳ LocationElement

Index

Properties

• latitude
• longitude

---

Properties

<Optional> latitude

● latitude: number

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

---

<Optional> longitude

● longitude: number

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > LocationElement

Interface: LocationElement

Hierarchy

AbstractElement

Location

↳ LocationElement

Index

Properties

• elementType
• latitude
• longitude

---

Properties

elementType

● elementType: "location"

Overrides AbstractElement.elementType

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

---

<Optional> latitude

● latitude: number

Inherited from Location.latitude

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

---

<Optional> longitude

● longitude: number

Inherited from Location.longitude

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiDateElement

Interface: MultiDateElement

Hierarchy

↳ DateElement

↳ MultiDateElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "datetime"

Inherited from DateElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: string[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiFileElement

Interface: MultiFileElement

Hierarchy

↳ FileElement

↳ MultiFileElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "file"

Inherited from FileElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: File[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiFormattedTextElement

Interface: MultiFormattedTextElement

Hierarchy

↳ FormattedTextElement

↳ MultiFormattedTextElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "formattedtext"

Inherited from FormattedTextElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: string[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiGroupElement

Interface: MultiGroupElement

Hierarchy

↳ GroupElement

↳ MultiGroupElement

Index

Properties

• elementType
• typeRef
• values

---

Properties

elementType

● elementType: "group"

Inherited from GroupElement.elementType

Overrides AbstractElement.elementType

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

---

typeRef

● typeRef: TypeRef

Inherited from GroupElement.typeRef

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

---

values

● values: Group[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiImageElement

Interface: MultiImageElement

Hierarchy

↳ ImageElement

↳ MultiImageElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "image"

Inherited from ImageElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: Image[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiLinkElement

Interface: MultiLinkElement

Hierarchy

↳ LinkElement

↳ MultiLinkElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "link"

Inherited from LinkElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: Link[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiNumberElement

Interface: MultiNumberElement

Hierarchy

↳ NumberElement

↳ MultiNumberElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "number"

Inherited from NumberElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: number[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiOptionSelectionElement

Interface: MultiOptionSelectionElement

Hierarchy

↳ OptionSelectionElement

↳ MultiOptionSelectionElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "optionselection"

Inherited from OptionSelectionElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: OptionSelection[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiReferenceElement

Interface: MultiReferenceElement

Hierarchy

↳ ReferenceElement

↳ MultiReferenceElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "reference"

Inherited from ReferenceElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: RenderingContext[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiTextElement

Interface: MultiTextElement

Hierarchy

↳ TextElement

↳ MultiTextElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "text"

Inherited from TextElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: string[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiToggleElement

Interface: MultiToggleElement

Hierarchy

↳ ToggleElement

↳ MultiToggleElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "toggle"

Inherited from ToggleElement.elementType

Overrides AbstractElement.elementType

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

---

values

● values: boolean[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > MultiVideoElement

Interface: MultiVideoElement

Hierarchy

↳ VideoElement

↳ MultiVideoElement

Index

Properties

• elementType
• values

---

Properties

elementType

● elementType: "video"

Inherited from VideoElement.elementType

Overrides AbstractElement.elementType

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:298

---

values

● values: Video[]

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:315

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > NumberElement

Interface: NumberElement

Hierarchy

AbstractElement

↳ NumberElement

↳ SingleNumberElement

↳ MultiNumberElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "number"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > OptionSelection

Interface: OptionSelection

Representation of a selection

Hierarchy

OptionSelection

Index

Properties

• label
• selection

---

Properties

<Optional> label

● label: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:73

---

selection

● selection: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:74

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > OptionSelectionElement

Interface: OptionSelectionElement

Hierarchy

AbstractElement

↳ OptionSelectionElement

↳ SingleOptionSelectionElement

↳ MultiOptionSelectionElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "optionselection"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > ReferenceElement

Interface: ReferenceElement

Hierarchy

AbstractElement

↳ ReferenceElement

↳ SingleReferenceElement

↳ MultiReferenceElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "reference"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > RenderingContext

Interface: RenderingContext

Hierarchy

↳ ContentItemWithLayout

↳ RenderingContext

Index

Properties

• category
• classification
• context
• created
• creatorId
• date
• dates
• description
• draftId
• draftStatus
• elements
• file
• files
• formattedtext
• formattedtexts
• group
• groups
• id
• image
• images
• lastModified
• lastModifierId
• layouts
• link
• links
• locale
• location
• markups
• name
• number
• numbers
• optionselection
• optionselections
• reference
• references
• rev
• tags
• text
• texts
• toggle
• toggles
• type
• typeId
• video
• videos

---

Properties

<Optional> category

● category: ElementMap<CategoryElement>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:431

---

<Optional> classification

● classification: string

Inherited from BaseDeliveryItem.classification

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

---

context

● context: ExtendedContext

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:436

---

<Optional> created

● created: string

Inherited from BaseDeliveryItem.created

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

---

<Optional> creatorId

● creatorId: string

Inherited from BaseDeliveryItem.creatorId

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

---

<Optional> date

● date: ElementMap<Date>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:417

---

<Optional> dates

● dates: ElementMap<Date[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:418

---

<Optional> description

● description: string

Inherited from BaseDeliveryItem.description

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

---

<Optional> draftId

● draftId: string

Inherited from ContentItem.draftId

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

TBD

---

<Optional> draftStatus

● draftStatus: * "pending" | "approved" *

Inherited from ContentItem.draftStatus

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

TBD

---

elements

● elements: object

Inherited from ContentItem.elements

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

Type declaration

---

<Optional> file

● file: ElementMap<SingleFileElement>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:421

---

<Optional> files

● files: ElementMap<File[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:422

---

<Optional> formattedtext

● formattedtext: ElementMap<string>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:411

---

<Optional> formattedtexts

● formattedtexts: ElementMap<string[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:412

---

<Optional> group

● group: ElementMap<any>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:413

---

<Optional> groups

● groups: ElementMap<any[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:414

---

id

● id: string

Inherited from ContentItemWithLayout.id

Overrides BaseDeliveryItem.id

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

---

<Optional> image

● image: ElementMap<SingleImageElement>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:415

---

<Optional> images

● images: ElementMap<Image[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:416

---

<Optional> lastModified

● lastModified: string

Inherited from BaseDeliveryItem.lastModified

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

---

<Optional> lastModifierId

● lastModifierId: string

Inherited from BaseDeliveryItem.lastModifierId

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

---

layouts

● layouts: object

Inherited from ContentItemWithLayout.layouts

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

Type declaration

---

<Optional> link

● link: ElementMap<SingleLinkElement>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:425

---

<Optional> links

● links: ElementMap<Link[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:426

---

<Optional> locale

● locale: string

Inherited from ContentItem.locale

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

---

<Optional> location

● location: ElementMap<LocationElement>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:432

---

markups

● markups: ElementMap<string>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:434

---

<Optional> name

● name: string

Inherited from BaseDeliveryItem.name

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

---

<Optional> number

● number: ElementMap<number>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:409

---

<Optional> numbers

● numbers: ElementMap<number[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:410

---

<Optional> optionselection

● optionselection: ElementMap<OptionSelection>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:427

---

<Optional> optionselections

● optionselections: ElementMap<OptionSelection[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:428

---

<Optional> reference

● reference: ElementMap<RenderingContext>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:429

---

<Optional> references

● references: ElementMap<RenderingContext[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:430

---

<Optional> rev

● rev: string

Inherited from BaseDeliveryItem.rev

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

---

<Optional> tags

● tags: Array<string>

Inherited from ContentItem.tags

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

---

<Optional> text

● text: ElementMap<string>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:407

---

<Optional> texts

● texts: ElementMap<string[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:408

---

<Optional> toggle

● toggle: ElementMap<boolean>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:423

---

<Optional> toggles

● toggles: ElementMap<boolean[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:424

---

<Optional> type

● type: string

Inherited from ContentItem.type

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

---

<Optional> typeId

● typeId: string

Inherited from ContentItem.typeId

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

---

<Optional> video

● video: ElementMap<SingleVideoElement>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:419

---

<Optional> videos

● videos: ElementMap<Video[]>

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:420

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Rendition

Interface: Rendition

Hierarchy

Rendition

Index

Properties

• height
• renditionId
• source
• url
• width

---

Properties

height

● height: number

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:324

---

renditionId

● renditionId: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:319

---

source

● source: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:320

---

url

● url: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:322

---

width

● width: number

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:323

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Resource

Interface: Resource

Hierarchy

Resource

Index

Properties

• fileName
• resourceId
• resourceUri

---

Properties

fileName

● fileName: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:255

---

resourceId

● resourceId: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:253

---

resourceUri

● resourceUri: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:254

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleDateElement

Interface: SingleDateElement

Hierarchy

↳ DateElement

↳ SingleDateElement

Index

Properties

• elementType
• value

---

Properties

elementType

● elementType: "datetime"

Inherited from DateElement.elementType

Overrides AbstractElement.elementType

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

---

value

● value: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:198

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleFileElement

Interface: SingleFileElement

Hierarchy

↳ FileElement

File

↳ SingleFileElement

Index

Properties

• asset
• elementType
• url

---

Properties

<Optional> asset

● asset: Asset

Inherited from File.asset

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

---

elementType

● elementType: "file"

Inherited from FileElement.elementType

Overrides AbstractElement.elementType

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

---

<Optional> url

● url: string

Inherited from File.url

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleFormattedTextElement

Interface: SingleFormattedTextElement

Hierarchy

↳ FormattedTextElement

↳ SingleFormattedTextElement

Index

Properties

• elementType
• value

---

Properties

elementType

● elementType: "formattedtext"

Inherited from FormattedTextElement.elementType

Overrides AbstractElement.elementType

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

---

value

● value: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:109

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleGroupElement

Interface: SingleGroupElement

Hierarchy

↳ GroupElement

↳ SingleGroupElement

Index

Properties

• elementType
• typeRef
• value

---

Properties

elementType

● elementType: "group"

Inherited from GroupElement.elementType

Overrides AbstractElement.elementType

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

---

typeRef

● typeRef: TypeRef

Inherited from GroupElement.typeRef

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

---

value

● value: Group

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:59

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleImageElement

Interface: SingleImageElement

Hierarchy

↳ ImageElement

Image

↳ SingleImageElement

Index

Properties

• altText
• asset
• elementType
• renditions
• url

---

Properties

<Optional> altText

● altText: string

Inherited from Image.altText

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

---

<Optional> asset

● asset: Asset

Inherited from Image.asset

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

---

elementType

● elementType: "image"

Inherited from ImageElement.elementType

Overrides AbstractElement.elementType

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

---

<Optional> renditions

● renditions: object

Inherited from Image.renditions

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

Type declaration

---

<Optional> url

● url: string

Inherited from Image.url

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleLinkElement

Interface: SingleLinkElement

Hierarchy

↳ LinkElement

Link

↳ SingleLinkElement

Index

Properties

• elementType
• linkDescription
• linkText
• linkURL

---

Properties

elementType

● elementType: "link"

Inherited from LinkElement.elementType

Overrides AbstractElement.elementType

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

---

<Optional> linkDescription

● linkDescription: string

Inherited from Link.linkDescription

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

---

<Optional> linkText

● linkText: string

Inherited from Link.linkText

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

---

<Optional> linkURL

● linkURL: string

Inherited from Link.linkURL

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleNumberElement

Interface: SingleNumberElement

Hierarchy

↳ NumberElement

↳ SingleNumberElement

Index

Properties

• elementType
• value

---

Properties

elementType

● elementType: "number"

Inherited from NumberElement.elementType

Overrides AbstractElement.elementType

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

---

value

● value: number

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:130

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleOptionSelectionElement

Interface: SingleOptionSelectionElement

Hierarchy

↳ OptionSelectionElement

↳ SingleOptionSelectionElement

Index

Properties

• elementType
• value

---

Properties

elementType

● elementType: "optionselection"

Inherited from OptionSelectionElement.elementType

Overrides AbstractElement.elementType

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

---

value

● value: OptionSelection

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:88

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleReferenceElement

Interface: SingleReferenceElement

Hierarchy

↳ ReferenceElement

↳ SingleReferenceElement

Index

Properties

• elementType
• value

---

Properties

elementType

● elementType: "reference"

Inherited from ReferenceElement.elementType

Overrides AbstractElement.elementType

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

---

value

● value: RenderingContext

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:367

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleTextElement

Interface: SingleTextElement

Hierarchy

↳ TextElement

↳ SingleTextElement

Index

Properties

• elementType
• value

---

Properties

elementType

● elementType: "text"

Inherited from TextElement.elementType

Overrides AbstractElement.elementType

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

---

value

● value: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:21

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleToggleElement

Interface: SingleToggleElement

Hierarchy

↳ ToggleElement

↳ SingleToggleElement

Index

Properties

• elementType
• value

---

Properties

elementType

● elementType: "toggle"

Inherited from ToggleElement.elementType

Overrides AbstractElement.elementType

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

---

value

● value: boolean

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:151

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > SingleVideoElement

Interface: SingleVideoElement

Hierarchy

↳ VideoElement

Video

↳ SingleVideoElement

Index

Properties

• asset
• caption
• elementType
• thumbnail
• url

---

Properties

<Optional> asset

● asset: Asset

Inherited from Video.asset

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:290

---

<Optional> caption

● caption: Resource

Inherited from Video.caption

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:288

---

elementType

● elementType: "video"

Inherited from VideoElement.elementType

Overrides AbstractElement.elementType

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:298

---

<Optional> thumbnail

● thumbnail: Resource

Inherited from Video.thumbnail

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:289

---

<Optional> url

● url: string

Inherited from Video.url

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:291

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > TextElement

Interface: TextElement

Hierarchy

AbstractElement

↳ TextElement

↳ SingleTextElement

↳ MultiTextElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "text"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > ToggleElement

Interface: ToggleElement

Hierarchy

AbstractElement

↳ ToggleElement

↳ SingleToggleElement

↳ MultiToggleElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "toggle"

Overrides AbstractElement.elementType

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > TypeRef

Interface: TypeRef

Reference to a content type

Hierarchy

TypeRef

Index

Properties

• id

---

Properties

id

● id: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:35

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > Video

Interface: Video

Hierarchy

Video

↳ SingleVideoElement

Index

Properties

• asset
• caption
• thumbnail
• url

---

Properties

<Optional> asset

● asset: Asset

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:290

---

<Optional> caption

● caption: Resource

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:288

---

<Optional> thumbnail

● thumbnail: Resource

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:289

---

<Optional> url

● url: string

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:291

---

ibm-wch-sdk-api > "interfaces/delivery/v1/rendering/context/rendering.context" > VideoElement

Interface: VideoElement

Hierarchy

AbstractElement

↳ VideoElement

↳ SingleVideoElement

↳ MultiVideoElement

Index

Properties

• elementType

---

Properties

elementType

● elementType: "video"

Overrides AbstractElement.elementType

Defined in interfaces/delivery/v1/rendering/context/rendering.context.ts:298

---

ibm-wch-sdk-api > "interfaces/delivery/v1/search/search.result" > PageSearchResult

Interface: PageSearchResult

Hierarchy

SearchResult<SitePage>

↳ PageSearchResult

Index

Properties

• document

---

Properties

document

● document: SitePage

Overrides SearchResult.document

Defined in interfaces/delivery/v1/search/search.result.ts:14

---

ibm-wch-sdk-api > "interfaces/delivery/v1/search/search.result" > RenderingContextQueryResult

Interface: RenderingContextQueryResult

Hierarchy

RenderingContextQueryResult

Index

Properties

• numFound
• renderingContexts

---

Properties

numFound

● numFound: number

Defined in interfaces/delivery/v1/search/search.result.ts:24

---

renderingContexts

● renderingContexts: RenderingContext[]

Defined in interfaces/delivery/v1/search/search.result.ts:26

---

ibm-wch-sdk-api > "interfaces/delivery/v1/search/search.result" > RenderingContextSearchResult

Interface: RenderingContextSearchResult

Hierarchy

SearchResult<RenderingContext>

↳ RenderingContextSearchResult

Index

Properties

• document

---

Properties

document

● document: RenderingContext

Overrides SearchResult.document

Defined in interfaces/delivery/v1/search/search.result.ts:10

---

ibm-wch-sdk-api > "interfaces/delivery/v1/search/search.result" > SearchResult

Interface: SearchResult

Type parameters

T

Hierarchy

SearchResult

↳ RenderingContextSearchResult

↳ PageSearchResult

Index

Properties

• document

---

Properties

document

● document: T

Defined in interfaces/delivery/v1/search/search.result.ts:6

---

ibm-wch-sdk-api > "interfaces/delivery/v1/search/search.result" > SearchResults

Interface: SearchResults

Type parameters

T

Hierarchy

SearchResults

Index

Properties

• documents
• numFound

---

Properties

<Optional> documents

● documents: T[]

Defined in interfaces/delivery/v1/search/search.result.ts:19

---

numFound

● numFound: number

Defined in interfaces/delivery/v1/search/search.result.ts:18

---

ibm-wch-sdk-api > "interfaces/delivery/v1/search/search.result" > SitePagesQueryResult

Interface: SitePagesQueryResult

Hierarchy

SitePagesQueryResult

Index

Properties

• numFound
• sitePages

---

Properties

numFound

● numFound: number

Defined in interfaces/delivery/v1/search/search.result.ts:31

---

sitePages

● sitePages: SitePage[]

Defined in interfaces/delivery/v1/search/search.result.ts:33

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site" > Site

Interface: Site

Hierarchy

SiteRoot

↳ Site

Index

Properties

• id
• name
• pages

---

Properties

id

● id: string

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

---

<Optional> name

● name: string

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

---

pages

● pages: SiteChild[]

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site" > SiteRoot

Interface: SiteRoot

Hierarchy

SiteRoot

↳ Site

Index

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site.child" > SiteChild

Interface: SiteChild

Hierarchy

↳ SitePage

↳ SiteChild

Index

Properties

• children
• classification
• contentId
• contentStatus
• contentTypeId
• created
• creatorId
• decodedRoute
• description
• externalContext
• hideFromNavigation
• id
• lastModified
• lastModifierId
• name
• parentId
• rev
• route
• title

---

Properties

children

● children: SiteChild[]

Defined in interfaces/delivery/v1/site/site.child.ts:5

---

<Optional> classification

● classification: string

Inherited from BaseDeliveryItem.classification

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

---

contentId

● contentId: string

Inherited from SitePage.contentId

Defined in interfaces/delivery/v1/site/site.page.ts:11

---

contentStatus

● contentStatus: string

Inherited from SitePage.contentStatus

Defined in interfaces/delivery/v1/site/site.page.ts:6

---

contentTypeId

● contentTypeId: string

Inherited from SitePage.contentTypeId

Defined in interfaces/delivery/v1/site/site.page.ts:7

---

<Optional> created

● created: string

Inherited from BaseDeliveryItem.created

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

---

<Optional> creatorId

● creatorId: string

Inherited from BaseDeliveryItem.creatorId

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

---

decodedRoute

● decodedRoute: string

Inherited from SitePage.decodedRoute

Defined in interfaces/delivery/v1/site/site.page.ts:9

---

<Optional> description

● description: string

Inherited from SitePage.description

Overrides BaseDeliveryItem.description

Defined in interfaces/delivery/v1/site/site.page.ts:14

---

<Optional> externalContext

● externalContext: any

Inherited from SitePage.externalContext

Defined in interfaces/delivery/v1/site/site.page.ts:16

---

hideFromNavigation

● hideFromNavigation: boolean

Inherited from SitePage.hideFromNavigation

Defined in interfaces/delivery/v1/site/site.page.ts:15

---

id

● id: string

Inherited from SitePage.id

Overrides BaseDeliveryItem.id

Defined in interfaces/delivery/v1/site/site.page.ts:5

---

<Optional> lastModified

● lastModified: string

Inherited from BaseDeliveryItem.lastModified

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

---

<Optional> lastModifierId

● lastModifierId: string

Inherited from BaseDeliveryItem.lastModifierId

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

---

name

● name: string

Inherited from SitePage.name

Overrides BaseDeliveryItem.name

Defined in interfaces/delivery/v1/site/site.page.ts:10

---

<Optional> parentId

● parentId: string

Inherited from SitePage.parentId

Defined in interfaces/delivery/v1/site/site.page.ts:13

---

<Optional> rev

● rev: string

Inherited from BaseDeliveryItem.rev

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

---

route

● route: string

Inherited from SitePage.route

Defined in interfaces/delivery/v1/site/site.page.ts:8

---

<Optional> title

● title: string

Inherited from SitePage.title

Defined in interfaces/delivery/v1/site/site.page.ts:12

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site.context" > SiteContext

Interface: SiteContext

Hierarchy

SiteContext

↳ ExtendedContext

Index

Properties

• breadcrumb
• children
• parent
• sibling
• site

---

Properties

breadcrumb

● breadcrumb: SitePage[]

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

---

children

● children: SitePage[]

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

---

<Optional> parent

● parent: SitePage

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

---

sibling

● sibling: SitePage[]

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

---

site

● site: Site

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

---

ibm-wch-sdk-api > "interfaces/delivery/v1/user/user" > User

Interface: User

Hierarchy

User

Index

Properties

• created
• creator
• displayName
• externalId
• firstName
• id
• lastLogin
• lastModified
• lastModifier
• lastName
• roles

---

Properties

<Optional> created

● created: string

Defined in interfaces/delivery/v1/user/user.ts:27

---

<Optional> creator

● creator: string

Defined in interfaces/delivery/v1/user/user.ts:29

---

<Optional> displayName

● displayName: string

Defined in interfaces/delivery/v1/user/user.ts:18

---

externalId

● externalId: string

Defined in interfaces/delivery/v1/user/user.ts:9

---

<Optional> firstName

● firstName: string

Defined in interfaces/delivery/v1/user/user.ts:12

---

id

● id: string

Defined in interfaces/delivery/v1/user/user.ts:6

---

<Optional> lastLogin

● lastLogin: string

Defined in interfaces/delivery/v1/user/user.ts:24

---

<Optional> lastModified

● lastModified: string

Defined in interfaces/delivery/v1/user/user.ts:32

---

<Optional> lastModifier

● lastModifier: string

Defined in interfaces/delivery/v1/user/user.ts:34

---

<Optional> lastName

● lastName: string

Defined in interfaces/delivery/v1/user/user.ts:15

---

roles

● roles: string[]

Defined in interfaces/delivery/v1/user/user.ts:21

---

ibm-wch-sdk-api > "interfaces/delivery/v1/site/site.page" > SitePage

Interface: SitePage

Hierarchy

BaseDeliveryItem

↳ SitePage

↳ SiteChild

Index

Properties

• classification
• contentId
• contentStatus
• contentTypeId
• created
• creatorId
• decodedRoute
• description
• externalContext
• hideFromNavigation
• id
• lastModified
• lastModifierId
• name
• parentId
• rev
• route
• title

---

Properties

<Optional> classification

● classification: string

Inherited from BaseDeliveryItem.classification

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

---

contentId

● contentId: string

Defined in interfaces/delivery/v1/site/site.page.ts:11

---

contentStatus

● contentStatus: string

Defined in interfaces/delivery/v1/site/site.page.ts:6

---

contentTypeId

● contentTypeId: string

Defined in interfaces/delivery/v1/site/site.page.ts:7

---

<Optional> created

● created: string

Inherited from BaseDeliveryItem.created

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

---

<Optional> creatorId

● creatorId: string

Inherited from BaseDeliveryItem.creatorId

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

---

decodedRoute

● decodedRoute: string

Defined in interfaces/delivery/v1/site/site.page.ts:9

---

<Optional> description

● description: string

Overrides BaseDeliveryItem.description

Defined in interfaces/delivery/v1/site/site.page.ts:14

---

<Optional> externalContext

● externalContext: any

Defined in interfaces/delivery/v1/site/site.page.ts:16

---

hideFromNavigation

● hideFromNavigation: boolean

Defined in interfaces/delivery/v1/site/site.page.ts:15

---

id

● id: string

Overrides BaseDeliveryItem.id

Defined in interfaces/delivery/v1/site/site.page.ts:5

---

<Optional> lastModified

● lastModified: string

Inherited from BaseDeliveryItem.lastModified

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

---

<Optional> lastModifierId

● lastModifierId: string

Inherited from BaseDeliveryItem.lastModifierId

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

---

name

● name: string

Overrides BaseDeliveryItem.name

Defined in interfaces/delivery/v1/site/site.page.ts:10

---

<Optional> parentId

● parentId: string

Defined in interfaces/delivery/v1/site/site.page.ts:13

---

<Optional> rev

● rev: string

Inherited from BaseDeliveryItem.rev

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

---

route

● route: string

Defined in interfaces/delivery/v1/site/site.page.ts:8

---

<Optional> title

● title: string

Defined in interfaces/delivery/v1/site/site.page.ts:12

---

ibm-wch-sdk-api > "interfaces/logging/logger" > Logger

Interface: Logger

Hierarchy

Logger

Index

Methods

• error
• info
• warn

---

Methods

error

▸ error(msg: string, ...data: any[]): void

Defined in interfaces/logging/logger.ts:10

Parameters:

Param	Type
msg	string
Rest data	any[]

Returns: void

---

info

▸ info(msg: string, ...data: any[]): void

Defined in interfaces/logging/logger.ts:11

Parameters:

Param	Type
msg	string
Rest data	any[]

Returns: void

---

warn

▸ warn(msg: string, ...data: any[]): void

Defined in interfaces/logging/logger.ts:12

Parameters:

Param	Type
msg	string
Rest data	any[]

Returns: void

---

ibm-wch-sdk-api > "interfaces/logging/logger.factory" > DynamicLoggerFactory

Interface: DynamicLoggerFactory

Hierarchy

DynamicLoggerFactory

Index

Methods

• get

---

Methods

get

▸ get(): Observable<LoggerFactory>

Defined in interfaces/logging/logger.factory.ts:34

Returns: Observable<LoggerFactory>

---

ibm-wch-sdk-api > "interfaces/logging/logger.factory" > LoggerFactory

Interface: LoggerFactory

Hierarchy

LoggerFactory

Index

Methods

• create

---

Methods

create

▸ create(name: string): Logger

Defined in interfaces/logging/logger.factory.ts:19

Parameters:

Param	Type
name	string

Returns: Logger

---

ibm-wch-sdk-api > "interfaces/messages/sdk.navigate.by.path.message" > SdkNavigateByPathEvent

Interface: SdkNavigateByPathEvent

Hierarchy

SdkMessagePayload

↳ SdkNavigateByPathEvent

Index

Properties

• id
• path
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

path

● path: string

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

---

type

● type: "WchSdk.router.navigateByPath"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.navigate.by.path.message" > SdkNavigateByPathResponse

Interface: SdkNavigateByPathResponse

Hierarchy

SdkMessagePayload

↳ SdkNavigateByPathResponse

Index

Properties

• error
• id
• path
• success
• type

---

Properties

<Optional> error

● error: any

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

---

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

path

● path: string

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

---

success

● success: boolean

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

---

type

● type: string

Inherited from SdkMessagePayload.type

Defined in interfaces/messages/messages.ts:10

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.active.route.message" > SdkActiveRouteEvent

Interface: SdkActiveRouteEvent

Hierarchy

SdkMessagePayload

↳ SdkActiveRouteEvent

Index

Properties

• id
• page
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

page

● page: SitePage

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

---

type

● type: "WchSdk.router.activeRoute"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.active.route.message" > SdkSubscribeActiveRouteEvent

Interface: SdkSubscribeActiveRouteEvent

Hierarchy

SdkMessagePayload

↳ SdkSubscribeActiveRouteEvent

Index

Properties

• id
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: "WchSdk.router.activeRoute.subscribe"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.active.route.message" > SdkSubscribeActiveRouteEventResponse

Interface: SdkSubscribeActiveRouteEventResponse

Hierarchy

↳ SdkSubscribeEventResponse

↳ SdkSubscribeActiveRouteEventResponse

Index

Properties

• handle
• id
• type

---

Properties

handle

● handle: string

Inherited from SdkSubscribeEventResponse.handle

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

---

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: string

Inherited from SdkMessagePayload.type

Defined in interfaces/messages/messages.ts:10

---

ibm-wch-sdk-api > "interfaces/messages/sdk.set.mode.message" > SdkSetModeEvent

Interface: SdkSetModeEvent

Hierarchy

SdkMessagePayload

↳ SdkSetModeEvent

Index

Properties

• id
• mode
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

mode

● mode: SdkMode

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

---

type

● type: "WchSdk.setMode"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.set.mode.message" > SdkSetModeResponse

Interface: SdkSetModeResponse

Hierarchy

SdkMessagePayload

↳ SdkSetModeResponse

Index

Properties

• error
• id
• mode
• type

---

Properties

<Optional> error

● error: any

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

---

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

mode

● mode: SdkMode

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

---

type

● type: string

Inherited from SdkMessagePayload.type

Defined in interfaces/messages/messages.ts:10

---

ibm-wch-sdk-api > "interfaces/messages/messages" > SdkErrorResponse

Interface: SdkErrorResponse

Hierarchy

SdkMessagePayload

↳ SdkErrorResponse

Index

Properties

• error
• id
• type

---

Properties

error

● error: any

Defined in interfaces/messages/messages.ts:18

---

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: string

Inherited from SdkMessagePayload.type

Defined in interfaces/messages/messages.ts:10

---

ibm-wch-sdk-api > "interfaces/messages/messages" > SdkMessageHandler

Interface: SdkMessageHandler

Hierarchy

SdkMessageHandler

Index

Properties

• handle

---

Properties

handle

● handle: SdkMessageHandlerCallback

Defined in interfaces/messages/messages.ts:24

---

ibm-wch-sdk-api > "interfaces/messages/messages" > SdkMessagePayload

Interface: SdkMessagePayload

Hierarchy

SdkMessagePayload

↳ SdkErrorResponse

↳ SdkRefreshEvent

↳ SdkSubscribeEventResponse

↳ SdkUnsubscribeEvent

↳ SdkSubscribeModeEvent

↳ SdkModeEvent

↳ SdkSetModeEvent

↳ SdkSetModeResponse

↳ SdkNavigateByPathEvent

↳ SdkNavigateByPathResponse

↳ SdkSubscribeActiveRouteEvent

↳ SdkActiveRouteEvent

↳ SdkSubscribeRouteEvent

↳ SdkRouteEvent

Index

Properties

• id
• type

---

Properties

id

● id: string

Defined in interfaces/messages/messages.ts:8

---

type

● type: string

Defined in interfaces/messages/messages.ts:10

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.message" > SdkSubscribeEventResponse

Interface: SdkSubscribeEventResponse

Hierarchy

SdkMessagePayload

↳ SdkSubscribeEventResponse

↳ SdkSubscribeModeEventResponse

↳ SdkSubscribeActiveRouteEventResponse

↳ SdkSubscribeRouteEventResponse

Index

Properties

• handle
• id
• type

---

Properties

handle

● handle: string

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

---

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: string

Inherited from SdkMessagePayload.type

Defined in interfaces/messages/messages.ts:10

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.message" > SdkUnsubscribeEvent

Interface: SdkUnsubscribeEvent

Hierarchy

SdkMessagePayload

↳ SdkUnsubscribeEvent

Index

Properties

• handle
• id
• type

---

Properties

handle

● handle: string

Defined in interfaces/messages/sdk.subscribe.message.ts:20

---

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: "WchSdk.unsubscribe"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.refresh.message" > SdkRefreshEvent

Interface: SdkRefreshEvent

Hierarchy

SdkMessagePayload

↳ SdkRefreshEvent

Index

Properties

• id
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: "WchSdk.refresh"

Overrides SdkMessagePayload.type

Defined in interfaces/messages/sdk.refresh.message.ts:10

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.mode.message" > SdkMode

Enumeration: SdkMode

Index

Enumeration members

• PROTECTED
• PUBLIC

---

Enumeration members

PROTECTED

PROTECTED: = "protected"

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

---

PUBLIC

PUBLIC: = "public"

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.mode.message" > SdkModeEvent

Interface: SdkModeEvent

Hierarchy

SdkMessagePayload

↳ SdkModeEvent

Index

Properties

• id
• mode
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

mode

● mode: SdkMode

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

---

type

● type: "WchSdk.mode"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.mode.message" > SdkSubscribeModeEvent

Interface: SdkSubscribeModeEvent

Hierarchy

SdkMessagePayload

↳ SdkSubscribeModeEvent

Index

Properties

• id
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: "WchSdk.mode.subscribe"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.mode.message" > SdkSubscribeModeEventResponse

Interface: SdkSubscribeModeEventResponse

Hierarchy

↳ SdkSubscribeEventResponse

↳ SdkSubscribeModeEventResponse

Index

Properties

• handle
• id
• type

---

Properties

handle

● handle: string

Inherited from SdkSubscribeEventResponse.handle

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

---

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: string

Inherited from SdkMessagePayload.type

Defined in interfaces/messages/messages.ts:10

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.route.message" > SdkRouteEvent

Interface: SdkRouteEvent

Hierarchy

SdkMessagePayload

↳ SdkRouteEvent

Index

Properties

• id
• page
• route
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

page

● page: SitePage

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

---

route

● route: string

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

---

type

● type: "WchSdk.router.route"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.route.message" > SdkSubscribeRouteEvent

Interface: SdkSubscribeRouteEvent

Hierarchy

SdkMessagePayload

↳ SdkSubscribeRouteEvent

Index

Properties

• id
• route
• type

---

Properties

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

route

● route: * string | string[] *

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

---

type

● type: "WchSdk.router.route.subscribe"

Overrides SdkMessagePayload.type

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

---

ibm-wch-sdk-api > "interfaces/messages/sdk.subscribe.route.message" > SdkSubscribeRouteEventResponse

Interface: SdkSubscribeRouteEventResponse

Hierarchy

↳ SdkSubscribeEventResponse

↳ SdkSubscribeRouteEventResponse

Index

Properties

• handle
• id
• type

---

Properties

handle

● handle: string

Inherited from SdkSubscribeEventResponse.handle

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

---

id

● id: string

Inherited from SdkMessagePayload.id

Defined in interfaces/messages/messages.ts:8

---

type

● type: string

Inherited from SdkMessagePayload.type

Defined in interfaces/messages/messages.ts:10

---

ibm-wch-sdk-api > "interfaces/query" > Query

Interface: Query

Hierarchy

Query

Indexable

[key: string]:  QueryValue | QueryValue[]

Index

---

ibm-wch-sdk-api > "interfaces/sdk/router/router" > WchSdkRouter

Interface: WchSdkRouter

Hierarchy

WchSdkRouter

Index

Properties

• activeRenderingContext
• activeRoute
• navigateByPath

---

Properties

activeRenderingContext

● activeRenderingContext: function

Defined in interfaces/sdk/router/router.ts:23

Type declaration

▸(): Observable<RenderingContext>

Returns: Observable<RenderingContext>

---

activeRoute

● activeRoute: function

Defined in interfaces/sdk/router/router.ts:16

Type declaration

▸(): Observable<SitePage>

Returns: Observable<SitePage>

---

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>

---

ibm-wch-sdk-api > "interfaces/sdk/sdk" > WchSdk

Interface: WchSdk

Hierarchy

WchSdk

Index

Properties

• logger
• refresh
• router
• search
• version

---

Properties

<Optional> logger

● logger: LoggerService

Defined in interfaces/sdk/sdk.ts:28

Returns a factory to access loggers

---

refresh

● refresh: function

Defined in interfaces/sdk/sdk.ts:14

Type declaration

▸(): void

Returns: void

---

router

● router: WchSdkRouter

Defined in interfaces/sdk/sdk.ts:16

---

<Optional> search

● search: WchSdkSearch

Defined in interfaces/sdk/sdk.ts:33

Optional search service

---

version

● version: WchSdkVersion

Defined in interfaces/sdk/sdk.ts:23

---

ibm-wch-sdk-api > "interfaces/sdk/search/search" > WchSdkSearch

Interface: WchSdkSearch

Hierarchy

WchSdkSearch

Index

Properties

• getRenderingContextById
• getRenderingContexts
• getSitePages

---

Properties

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>

Parameters:

Param	Type
aId	string
Optional aLevels	number

Returns: Observable<RenderingContext>

---

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, aLevels?: number): Observable<RenderingContextQueryResult>

Parameters:

Param	Type
aValue	QueryInput
Optional aLevels	number

Returns: Observable<RenderingContextQueryResult>

---

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): Observable<SitePagesQueryResult>

Parameters:

Param	Type
aValue	QueryInput

Returns: Observable<SitePagesQueryResult>

---

ibm-wch-sdk-api > "interfaces/sdk/version/version" > WchSdkVersion

Interface: WchSdkVersion

Defines the version number and the build date of the SDK.

Hierarchy

WchSdkVersion

Index

Properties

• build
• version

---

Properties

build

● build: Date

Defined in interfaces/sdk/version/version.ts:10

---

version

● version: object

Defined in interfaces/sdk/version/version.ts:8

Type declaration

major: string

minor: string

patch: string

---

ibm-wch-sdk-api > "services/hub-info/hub-info" > HubInfo

Interface: HubInfo

Hierarchy

HubInfo

↳ UrlConfig

Index

Properties

• apiUrl
• deliveryUrl

---

Properties

apiUrl

● apiUrl: * URL | string *

Defined in services/hub-info/hub-info.ts:13

---

deliveryUrl

● deliveryUrl: * URL | string *

Defined in services/hub-info/hub-info.ts:20

---

ibm-wch-sdk-api > "services/info/url.config" > UrlConfig

Interface: UrlConfig

Exposes the URL configuration to the client

Hierarchy

HubInfo

↳ UrlConfig

Index

Properties

• apiUrl
• baseUrl
• deliveryUrl
• isPreviewMode

---

Properties

apiUrl

● apiUrl: URL

Overrides HubInfo.apiUrl

Defined in services/info/url.config.ts:9

The base URL used to access WCH APIs. The URL ends with a slash.

---

<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.

---

deliveryUrl

● deliveryUrl: URL

Overrides HubInfo.deliveryUrl

Defined in services/info/url.config.ts:12

The base URL used to access WCH delivery resources. The URL ends with a slash.

---

isPreviewMode

● isPreviewMode: boolean

Defined in services/info/url.config.ts:15

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

---

ibm-wch-sdk-api > "services/logging/logger.service" > LoggerService

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

---

Properties

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

Parameters:

Param	Type
name	string

Returns: Logger

---

ibm-wch-sdk-api > "services/hub-info/hub-info.config" > CYCLE_HANDLING

Enumeration: CYCLE_HANDLING

Index

Enumeration members

• BREAK
• RESOLVE

---

Enumeration members

BREAK

BREAK:

Defined in services/hub-info/hub-info.config.ts:40

---

RESOLVE

RESOLVE:

Defined in services/hub-info/hub-info.config.ts:42

---

ibm-wch-sdk-api > "services/hub-info/hub-info.config" > HubInfoConfig

Class: HubInfoConfig

Hierarchy

HubInfoConfig

Index

Properties

• apiUrl
• cycleHandlingStrategy
• deliveryUrl
• fetchLevels
• httpOptions
• httpPreviewOptions

---

Properties

<Optional> apiUrl

● apiUrl: HubInfoUrlProvider

Defined in services/hub-info/hub-info.config.ts:56

---

<Optional> cycleHandlingStrategy

● cycleHandlingStrategy: * CYCLE_HANDLING | string *

Defined in services/hub-info/hub-info.config.ts:88

---

<Optional> deliveryUrl

● deliveryUrl: HubInfoUrlProvider

Defined in services/hub-info/hub-info.config.ts:63

---

<Optional> fetchLevels

● fetchLevels: number

Defined in services/hub-info/hub-info.config.ts:94

---

<Optional> httpOptions

● httpOptions: HttpResourceOptions

Defined in services/hub-info/hub-info.config.ts:68

---

<Optional> httpPreviewOptions

● httpPreviewOptions: HttpResourceOptions

Defined in services/hub-info/hub-info.config.ts:73

---

ibm-wch-sdk-api > "services/hub-info/hub-info.config" > HttpResourceOptions

Interface: HttpResourceOptions

Hierarchy

HttpResourceOptions

Index

Properties

• pollTime
• pollTimeVariation
• retries
• useApi
• useBootstrap
• useJsonP
• useLocalStorage
• usePolling
• useStaticResources

---

Properties

<Optional> pollTime

● pollTime: number

Defined in services/hub-info/hub-info.config.ts:3

---

<Optional> pollTimeVariation

● pollTimeVariation: number

Defined in services/hub-info/hub-info.config.ts:2

---

<Optional> retries

● retries: number

Defined in services/hub-info/hub-info.config.ts:4

---

<Optional> useApi

● useApi: boolean

Defined in services/hub-info/hub-info.config.ts:20

---

<Optional> useBootstrap

● useBootstrap: boolean

Defined in services/hub-info/hub-info.config.ts:12

---

<Optional> useJsonP

● useJsonP: boolean

Defined in services/hub-info/hub-info.config.ts:24

---

<Optional> useLocalStorage

● useLocalStorage: boolean

Defined in services/hub-info/hub-info.config.ts:8

---

<Optional> usePolling

● usePolling: boolean

Defined in services/hub-info/hub-info.config.ts:28

---

<Optional> useStaticResources

● useStaticResources: boolean

Defined in services/hub-info/hub-info.config.ts:16

---

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. 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

WchSdkVersion

Defines version number and build date.

RenderingContext

Refer to the design document or the documentation for more details about the structure.

The basic structure of elements is described in the Authoring content section.