@ibm-wch-sdk/api v9.0.10076

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

Added

• New config option "siteId" to configure a site identifier

6.0.69

Changed

• Support for Angular 6

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/authoring/index"
• "interfaces/authoring/v1/base.item"
• "interfaces/authoring/v1/content/content.item"
• "interfaces/authoring/v1/content/index"
• "interfaces/authoring/v1/index"
• "interfaces/authoring/v1/layout/index"
• "interfaces/authoring/v1/layout/layout"
• "interfaces/authoring/v1/types/index"
• "interfaces/authoring/v1/types/type"
• "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/i18n/index"
• "interfaces/i18n/localized"
• "interfaces/index"
• "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/page/active.page"
• "services/rendering/rendering.context.interceptor"
• "services/rendering/rendering.context.provider"

Services

• logging
• info

Interfaces

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

External module: "index"

Index

@ibm-wch-sdk/api > "interfaces/authoring/index"

External module: "interfaces/authoring/index"

Index

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

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

Index

Enumerations

• DraftStatus
• Status

Interfaces

• BaseAuthoringItem

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

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

Index

Interfaces

• AuthoringContentItem
• AuthoringContentItemThumbnail

Type aliases

• AUTHORING_CONTENT_ITEM_KIND

Type aliases

AUTHORING_CONTENT_ITEM_KIND

Ƭ AUTHORING_CONTENT_ITEM_KIND: "page" | "landing-page" | "catalog-page"

Defined in interfaces/authoring/v1/content/content.item.ts:5

@ibm-wch-sdk/api > "interfaces/authoring/v1/content/index"

External module: "interfaces/authoring/v1/content/index"

Index

@ibm-wch-sdk/api > "interfaces/authoring/v1/index"

External module: "interfaces/authoring/v1/index"

Index

@ibm-wch-sdk/api > "interfaces/authoring/v1/layout/index"

External module: "interfaces/authoring/v1/layout/index"

Index

@ibm-wch-sdk/api > "interfaces/authoring/v1/layout/layout"

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

Index

Interfaces

• AuthoringLayout
• AuthoringSelectedLayout

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/index"

External module: "interfaces/authoring/v1/types/index"

Index

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type"

External module: "interfaces/authoring/v1/types/type"

Index

Interfaces

• AuthoringCategoryElement
• AuthoringCommerceProductCategoryElement
• AuthoringCommerceProductElement
• AuthoringContentThumbnail
• AuthoringDatetimeElement
• AuthoringElement
• AuthoringFileElement
• AuthoringFormattedTextElement
• AuthoringGroupElement
• AuthoringImageElement
• AuthoringLinkElement
• AuthoringLocationElement
• AuthoringNumberElement
• AuthoringOption
• AuthoringOptionSelectionElement
• AuthoringPlaceholder
• AuthoringReferenceElement
• AuthoringTextElement
• AuthoringThumbnail
• AuthoringToggleElement
• AuthoringType
• AuthoringUiExtensions
• AuthoringVariableTypeElement
• AuthoringVideoElement

Type aliases

• AUTHORING_ELEMENT_DATETIME_SEARCH_KEY
• AUTHORING_ELEMENT_FILE_TYPE
• AUTHORING_ELEMENT_IMAGE_TYPE
• AUTHORING_ELEMENT_LOCATION_SEARCH_KEY
• AUTHORING_ELEMENT_NUMBER_SEARCH_KEY
• AUTHORING_ELEMENT_ROLE
• AUTHORING_ELEMENT_TEXT_SEARCH_KEY
• AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY
• AUTHORING_ELEMENT_VIDEO_TYPE
• AUTHORING_TYPE_KIND

Variables

• REL_PATH_TYPE_BY_ID

Type aliases

AUTHORING_ELEMENT_DATETIME_SEARCH_KEY

Ƭ AUTHORING_ELEMENT_DATETIME_SEARCH_KEY: "date1" | "date2" | "sortableDate1" | "sortableDate2"

Defined in interfaces/authoring/v1/types/type.ts:142

AUTHORING_ELEMENT_FILE_TYPE

Ƭ AUTHORING_ELEMENT_FILE_TYPE: "plain-text" | "presentation" | "rich-document" | "spreadsheet" | "pdf-document"

Defined in interfaces/authoring/v1/types/type.ts:124

AUTHORING_ELEMENT_IMAGE_TYPE

Ƭ AUTHORING_ELEMENT_IMAGE_TYPE: "jpg" | "jpeg" | "png" | "gif" | "svg"

Defined in interfaces/authoring/v1/types/type.ts:95

AUTHORING_ELEMENT_LOCATION_SEARCH_KEY

Ƭ AUTHORING_ELEMENT_LOCATION_SEARCH_KEY: "location1"

Defined in interfaces/authoring/v1/types/type.ts:167

AUTHORING_ELEMENT_NUMBER_SEARCH_KEY

Ƭ AUTHORING_ELEMENT_NUMBER_SEARCH_KEY: "number1" | "number2" | "sortableNumber1" | "sortableNumber2"

Defined in interfaces/authoring/v1/types/type.ts:35

AUTHORING_ELEMENT_ROLE

Ƭ AUTHORING_ELEMENT_ROLE: "content" | "configuration"

Defined in interfaces/authoring/v1/types/type.ts:23

AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Ƭ AUTHORING_ELEMENT_TEXT_SEARCH_KEY: "string1" | "string2" | "string3" | "string4" | "sortableString1" | "sortableString2" | "sortableString3" | "sortableString4"

Defined in interfaces/authoring/v1/types/type.ts:25

AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY

Ƭ AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY: "boolean1" | "boolean2"

Defined in interfaces/authoring/v1/types/type.ts:159

AUTHORING_ELEMENT_VIDEO_TYPE

Ƭ AUTHORING_ELEMENT_VIDEO_TYPE: "mp4" | "mov"

Defined in interfaces/authoring/v1/types/type.ts:110

AUTHORING_TYPE_KIND

Ƭ AUTHORING_TYPE_KIND: "standalone" | "page" | "embedded" | "landing-page" | "catalog-page" | "custom-ui"

Defined in interfaces/authoring/v1/types/type.ts:10

Possible values kind

Variables

<Const> REL_PATH_TYPE_BY_ID

● REL_PATH_TYPE_BY_ID: "authoring/v1/types/" = "authoring/v1/types/"

Defined in interfaces/authoring/v1/types/type.ts:5

@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_PRODUCT
• _ELEMENT_TYPE_REFERENCE
• _ELEMENT_TYPE_TEXT
• _ELEMENT_TYPE_TOGGLE
• _ELEMENT_TYPE_VARIABLE
• _ELEMENT_TYPE_VIDEO

Type aliases

ELEMENT_TYPE

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

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

Variables

<Const> _ELEMENT_TYPE_CATEGORY

● _ELEMENT_TYPE_CATEGORY: "category" = "category"

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

<Const> _ELEMENT_TYPE_DATE

● _ELEMENT_TYPE_DATE: "datetime" = "datetime"

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

<Const> _ELEMENT_TYPE_FILE

● _ELEMENT_TYPE_FILE: "file" = "file"

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

<Const> _ELEMENT_TYPE_FORMATTED_TEXT

● _ELEMENT_TYPE_FORMATTED_TEXT: "formattedtext" = "formattedtext"

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

<Const> _ELEMENT_TYPE_GROUP

● _ELEMENT_TYPE_GROUP: "group" = "group"

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

<Const> _ELEMENT_TYPE_IMAGE

● _ELEMENT_TYPE_IMAGE: "image" = "image"

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

<Const> _ELEMENT_TYPE_LINK

● _ELEMENT_TYPE_LINK: "link" = "link"

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

<Const> _ELEMENT_TYPE_LOCATION

● _ELEMENT_TYPE_LOCATION: "location" = "location"

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

<Const> _ELEMENT_TYPE_NUMBER

● _ELEMENT_TYPE_NUMBER: "number" = "number"

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

<Const> _ELEMENT_TYPE_OPTION_SELECTION

● _ELEMENT_TYPE_OPTION_SELECTION: "optionselection" = "optionselection"

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

<Const> _ELEMENT_TYPE_PRODUCT

● _ELEMENT_TYPE_PRODUCT: "product" = "product"

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

<Const> _ELEMENT_TYPE_REFERENCE

● _ELEMENT_TYPE_REFERENCE: "reference" = "reference"

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

<Const> _ELEMENT_TYPE_TEXT

● _ELEMENT_TYPE_TEXT: "text" = "text"

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

<Const> _ELEMENT_TYPE_TOGGLE

● _ELEMENT_TYPE_TOGGLE: "toggle" = "toggle"

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

<Const> _ELEMENT_TYPE_VARIABLE

● _ELEMENT_TYPE_VARIABLE: "variabletype" = "variabletype"

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

<Const> _ELEMENT_TYPE_VIDEO

● _ELEMENT_TYPE_VIDEO: "video" = "video"

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

@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
• MultiProductElement
• MultiReferenceElement
• MultiTextElement
• MultiToggleElement
• MultiVideoElement
• NumberElement
• OptionSelection
• OptionSelectionElement
• ProductElement
• ReferenceElement
• RenderingContext
• Rendition
• Resource
• SingleDateElement
• SingleFileElement
• SingleFormattedTextElement
• SingleGroupElement
• SingleImageElement
• SingleLinkElement
• SingleNumberElement
• SingleOptionSelectionElement
• SingleProductElement
• 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 | SingleProductElement | MultiProductElement | SingleNumberElement | MultiNumberElement | SingleLinkElement | MultiLinkElement | SingleFormattedTextElement | MultiFormattedTextElement | SingleOptionSelectionElement | MultiOptionSelectionElement | SingleDateElement | MultiDateElement | SingleGroupElement | MultiGroupElement

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

GroupType

Ƭ GroupType: ElementMap<SimpleType>

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

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:434

@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/i18n/index"

External module: "interfaces/i18n/index"

Index

@ibm-wch-sdk/api > "interfaces/i18n/localized"

External module: "interfaces/i18n/localized"

Index

Type aliases

• Locale
• Localized
• LocalizedContext
• LocalizedText

Type aliases

Locale

Ƭ Locale: string

Defined in interfaces/i18n/localized.ts:4

Helper type to identify a locale in the interfaces

Localized

Ƭ Localized: LocalizedText[]

Defined in interfaces/i18n/localized.ts:14

Object supporting localizations

LocalizedContext

Ƭ LocalizedContext: Record<Locale, number>

Defined in interfaces/i18n/localized.ts:20

Localization context that describes the relevance of a locale, this is typically derived from the accept language header

LocalizedText

Ƭ LocalizedText: [string, Locale]

Defined in interfaces/i18n/localized.ts:9

Text with attached locale

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

External module: "interfaces/index"

Index

@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:

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:10

@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

Interfaces

• HttpResourceOptions
• HubInfoConfig

Type aliases

• HubInfoUrlProvider

Type aliases

HubInfoUrlProvider

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

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

Defines the provider of a URL, either as a URL, a string or a callback that generates either

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

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

Index

Interfaces

• UrlConfig

Variables

• WCH_CONFIG_API_URL
• WCH_CONFIG_BASE_URL
• WCH_CONFIG_DELIVERY_URL

Variables

<Const> WCH_CONFIG_API_URL

● WCH_CONFIG_API_URL: "wch-config-api-url" = "wch-config-api-url"

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

Name of the 'rel' attribute of a link element used to configure the API URL

<Const> WCH_CONFIG_BASE_URL

● WCH_CONFIG_BASE_URL: "wch-config-base-url" = "wch-config-base-url"

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

Name of the 'rel' attribute of a link element used to configure the base URL

<Const> WCH_CONFIG_DELIVERY_URL

● WCH_CONFIG_DELIVERY_URL: "wch-config-delivery-url" = "wch-config-delivery-url"

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

Name of the 'rel' attribute of a link element used to configure the delivery URL

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

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

Index

Interfaces

• LoggerService

@ibm-wch-sdk/api > "services/page/active.page"

External module: "services/page/active.page"

Index

Interfaces

• ActivePage

@ibm-wch-sdk/api > "services/rendering/rendering.context.interceptor"

External module: "services/rendering/rendering.context.interceptor"

Index

Interfaces

• RenderingContextInterceptor

@ibm-wch-sdk/api > "services/rendering/rendering.context.provider"

External module: "services/rendering/rendering.context.provider"

Index

Interfaces

• RenderingContextProvider

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/authoring/index"
• "interfaces/authoring/v1/base.item"
• "interfaces/authoring/v1/content/content.item"
• "interfaces/authoring/v1/content/index"
• "interfaces/authoring/v1/index"
• "interfaces/authoring/v1/layout/index"
• "interfaces/authoring/v1/layout/layout"
• "interfaces/authoring/v1/types/index"
• "interfaces/authoring/v1/types/type"
• "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/i18n/index"
• "interfaces/i18n/localized"
• "interfaces/index"
• "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/page/active.page"
• "services/rendering/rendering.context.interceptor"
• "services/rendering/rendering.context.provider"

@ibm-wch-sdk/api > "interfaces/authoring/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/authoring/v1/base.item.ts:15

IN_PROGRESS

IN_PROGRESS: = "in-progress"

Defined in interfaces/authoring/v1/base.item.ts:13

IN_REVIEW

IN_REVIEW: = "in-review"

Defined in interfaces/authoring/v1/base.item.ts:14

@ibm-wch-sdk/api > "interfaces/authoring/v1/base.item" > Status

Enumeration: Status

Index

Enumeration members

• DRAFT
• READY
• RETIRED

Enumeration members

DRAFT

DRAFT: = "draft"

Defined in interfaces/authoring/v1/base.item.ts:4

READY

READY: = "ready"

Defined in interfaces/authoring/v1/base.item.ts:5

RETIRED

RETIRED: = "retired"

Defined in interfaces/authoring/v1/base.item.ts:6

@ibm-wch-sdk/api > "interfaces/authoring/v1/base.item" > BaseAuthoringItem

Interface: BaseAuthoringItem

Base interface for all items

Hierarchy

BaseAuthoringItem

↳ AuthoringType

↳ AuthoringContentItem

Index

Properties

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

Properties

<Optional> classification

● classification: string

Defined in interfaces/authoring/v1/base.item.ts:42

The classification defines the document type. For content items, all documents are classified as "content".

<Optional> created

● created: string

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

The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.

<Optional> creatorId

● creatorId: string

Defined in interfaces/authoring/v1/base.item.ts:59

<Optional> description

● description: string

Defined in interfaces/authoring/v1/base.item.ts:64

The description of the item.

<Optional> id

● id: string

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

The ID of the content item.

<Optional> lastModified

● lastModified: string

Defined in interfaces/authoring/v1/base.item.ts:47

The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.

<Optional> lastModifierId

● lastModifierId: string

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

name of user for now, this property may change once user management is defined (read only).

name

● name: string

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

The name of the content item.

<Optional> path

● path: string

Defined in interfaces/authoring/v1/base.item.ts:37

<Optional> rev

● rev: string

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

The current revision of the document.

@ibm-wch-sdk/api > "interfaces/authoring/v1/content/content.item" > AuthoringContentItem

Interface: AuthoringContentItem

Hierarchy

BaseAuthoringItem

↳ AuthoringContentItem

Index

Properties

• classification
• created
• creatorId
• deliveryAccess
• description
• draftStatus
• elements
• form
• id
• keywords
• kind
• lastModified
• lastModifier
• lastModifierId
• linkedDocId
• links
• locale
• name
• path
• projectId
• projects
• publishing
• rev
• review
• reviewHistory
• reviewId
• schema
• selectedLayouts
• status
• systemModified
• tags
• thumbnail
• type
• typeId
• valid

Properties

classification

● classification: "content"

Overrides BaseAuthoringItem.classification

Defined in interfaces/authoring/v1/content/content.item.ts:16

<Optional> created

● created: string

Inherited from BaseAuthoringItem.created

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

The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.

<Optional> creatorId

● creatorId: string

Inherited from BaseAuthoringItem.creatorId

Defined in interfaces/authoring/v1/base.item.ts:59

<Optional> deliveryAccess

● deliveryAccess: "secured"

Defined in interfaces/authoring/v1/content/content.item.ts:39

<Optional> description

● description: string

Inherited from BaseAuthoringItem.description

Defined in interfaces/authoring/v1/base.item.ts:64

The description of the item.

<Optional> draftStatus

● draftStatus: DraftStatus

Defined in interfaces/authoring/v1/content/content.item.ts:29

<Optional> elements

● elements: Record<string, any>

Defined in interfaces/authoring/v1/content/content.item.ts:34

<Optional> form

● form: any[]

Defined in interfaces/authoring/v1/content/content.item.ts:33

<Optional> id

● id: string

Inherited from BaseAuthoringItem.id

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

The ID of the content item.

<Optional> keywords

● keywords: string[]

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

<Optional> kind

● kind: AUTHORING_CONTENT_ITEM_KIND[]

Defined in interfaces/authoring/v1/content/content.item.ts:37

<Optional> lastModified

● lastModified: string

Overrides BaseAuthoringItem.lastModified

Defined in interfaces/authoring/v1/content/content.item.ts:23

<Optional> lastModifier

● lastModifier: string

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

<Optional> lastModifierId

● lastModifierId: string

Overrides BaseAuthoringItem.lastModifierId

Defined in interfaces/authoring/v1/content/content.item.ts:21

<Optional> linkedDocId

● linkedDocId: string

Defined in interfaces/authoring/v1/content/content.item.ts:25

<Optional> links

● links: Record<string, any>

Defined in interfaces/authoring/v1/content/content.item.ts:31

<Optional> locale

● locale: string

Defined in interfaces/authoring/v1/content/content.item.ts:20

name

● name: string

Inherited from BaseAuthoringItem.name

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

The name of the content item.

<Optional> path

● path: string

Inherited from BaseAuthoringItem.path

Defined in interfaces/authoring/v1/base.item.ts:37

<Optional> projectId

● projectId: string

Defined in interfaces/authoring/v1/content/content.item.ts:15

<Optional> projects

● projects: string[]

Defined in interfaces/authoring/v1/content/content.item.ts:42

<Optional> publishing

● publishing: Record<string, any>

Defined in interfaces/authoring/v1/content/content.item.ts:38

<Optional> rev

● rev: string

Inherited from BaseAuthoringItem.rev

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

The current revision of the document.

<Optional> review

● review: Record<string, any>

Defined in interfaces/authoring/v1/content/content.item.ts:36

<Optional> reviewHistory

● reviewHistory: string[]

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

<Optional> reviewId

● reviewId: string

Defined in interfaces/authoring/v1/content/content.item.ts:40

<Optional> schema

● schema: Record<string, any>

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

<Optional> selectedLayouts

● selectedLayouts: AuthoringSelectedLayout[]

Defined in interfaces/authoring/v1/content/content.item.ts:30

status

● status: Status

Defined in interfaces/authoring/v1/content/content.item.ts:28

<Optional> systemModified

● systemModified: string

Defined in interfaces/authoring/v1/content/content.item.ts:24

<Optional> tags

● tags: string[]

Defined in interfaces/authoring/v1/content/content.item.ts:26

<Optional> thumbnail

● thumbnail: AuthoringContentItemThumbnail

Defined in interfaces/authoring/v1/content/content.item.ts:19

<Optional> type

● type: string

Defined in interfaces/authoring/v1/content/content.item.ts:18

typeId

● typeId: string

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

<Optional> valid

● valid: boolean

Defined in interfaces/authoring/v1/content/content.item.ts:35

@ibm-wch-sdk/api > "interfaces/authoring/v1/content/content.item" > AuthoringContentItemThumbnail

Interface: AuthoringContentItemThumbnail

Hierarchy

AuthoringThumbnail

↳ AuthoringContentItemThumbnail

Index

Properties

• id
• path
• url

Properties

id

● id: string

Overrides AuthoringThumbnail.id

Defined in interfaces/authoring/v1/content/content.item.ts:11

<Optional> path

● path: string

Inherited from AuthoringThumbnail.path

Defined in interfaces/authoring/v1/types/type.ts:220

<Optional> url

● url: string

Inherited from AuthoringThumbnail.url

Defined in interfaces/authoring/v1/types/type.ts:221

@ibm-wch-sdk/api > "interfaces/authoring/v1/layout/layout" > AuthoringLayout

Interface: AuthoringLayout

Hierarchy

AuthoringLayout

Index

Properties

• id
• name
• path

Properties

id

● id: string

Defined in interfaces/authoring/v1/layout/layout.ts:2

<Optional> name

● name: string

Defined in interfaces/authoring/v1/layout/layout.ts:3

<Optional> path

● path: string

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

@ibm-wch-sdk/api > "interfaces/authoring/v1/layout/layout" > AuthoringSelectedLayout

Interface: AuthoringSelectedLayout

Hierarchy

AuthoringSelectedLayout

Index

Properties

• layout
• layoutMode

Properties

layout

● layout: AuthoringLayout

Defined in interfaces/authoring/v1/layout/layout.ts:9

<Optional> layoutMode

● layoutMode: string

Defined in interfaces/authoring/v1/layout/layout.ts:8

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringCategoryElement

Interface: AuthoringCategoryElement

Hierarchy

AuthoringElement

↳ AuthoringCategoryElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• restrictedParents
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "category"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:175

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> restrictedParents

● restrictedParents: string[]

Defined in interfaces/authoring/v1/types/type.ts:177

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:176

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringCommerceProductCategoryElement

Interface: AuthoringCommerceProductCategoryElement

Hierarchy

AuthoringElement

↳ AuthoringCommerceProductCategoryElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• restrictedParent
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "productcategory"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:207

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> restrictedParent

● restrictedParent: string

Defined in interfaces/authoring/v1/types/type.ts:209

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:208

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringCommerceProductElement

Interface: AuthoringCommerceProductElement

Hierarchy

AuthoringElement

↳ AuthoringCommerceProductElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• restrictedCategories
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "product"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:213

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> restrictedCategories

● restrictedCategories: string[]

Defined in interfaces/authoring/v1/types/type.ts:215

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:214

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringContentThumbnail

Interface: AuthoringContentThumbnail

Hierarchy

AuthoringContentThumbnail

Index

Properties

• imageElement
• source

Properties

<Optional> imageElement

● imageElement: string

Defined in interfaces/authoring/v1/types/type.ts:226

source

● source: "imageElementOrType" | "imageElement" | "type" | "none"

Defined in interfaces/authoring/v1/types/type.ts:225

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringDatetimeElement

Interface: AuthoringDatetimeElement

Hierarchy

AuthoringElement

↳ AuthoringDatetimeElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• fieldType
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "datetime"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:149

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> fieldType

● fieldType: "date" | "date-time"

Defined in interfaces/authoring/v1/types/type.ts:150

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_DATETIME_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:151

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringElement

Interface: AuthoringElement

Hierarchy

AuthoringElement

↳ AuthoringTextElement

↳ AuthoringNumberElement

↳ AuthoringImageElement

↳ AuthoringVideoElement

↳ AuthoringReferenceElement

↳ AuthoringFileElement

↳ AuthoringLinkElement

↳ AuthoringDatetimeElement

↳ AuthoringFormattedTextElement

↳ AuthoringToggleElement

↳ AuthoringLocationElement

↳ AuthoringCategoryElement

↳ AuthoringOptionSelectionElement

↳ AuthoringVariableTypeElement

↳ AuthoringGroupElement

↳ AuthoringCommerceProductCategoryElement

↳ AuthoringCommerceProductElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: ELEMENT_TYPE | "productcategory" | "product"

Defined in interfaces/authoring/v1/types/type.ts:43

Specifies the type of this element.

<Optional> fieldLabel

● fieldLabel: string

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringFileElement

Interface: AuthoringFileElement

Hierarchy

AuthoringElement

↳ AuthoringFileElement

Index

Properties

• acceptType
• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> acceptType

● acceptType: AUTHORING_ELEMENT_FILE_TYPE[]

Defined in interfaces/authoring/v1/types/type.ts:133

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "file"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:132

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:134

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringFormattedTextElement

Interface: AuthoringFormattedTextElement

Hierarchy

AuthoringElement

↳ AuthoringFormattedTextElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "formattedtext"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:155

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:156

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringGroupElement

Interface: AuthoringGroupElement

Hierarchy

AuthoringElement

↳ AuthoringGroupElement

Index

Properties

• allowMultipleValues
• elementType
• elements
• fieldLabel
• helpText
• icon
• key
• kind
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• typeRef
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "group"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:198

<Optional> elements

● elements: any[]

Defined in interfaces/authoring/v1/types/type.ts:201

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

<Optional> icon

● icon: ELEMENT_TYPE

Defined in interfaces/authoring/v1/types/type.ts:202

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

<Optional> kind

● kind: AUTHORING_TYPE_KIND[]

Defined in interfaces/authoring/v1/types/type.ts:200

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

typeRef

● typeRef: TypeRef

Defined in interfaces/authoring/v1/types/type.ts:199

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringImageElement

Interface: AuthoringImageElement

Hierarchy

AuthoringElement

↳ AuthoringImageElement

Index

Properties

• acceptType
• allowMultipleValues
• elementType
• fieldLabel
• helpText
• imageProfile
• imageProfileId
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> acceptType

● acceptType: AUTHORING_ELEMENT_IMAGE_TYPE[]

Defined in interfaces/authoring/v1/types/type.ts:104

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "image"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:103

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

<Optional> imageProfile

● imageProfile: Record<string, any>

Defined in interfaces/authoring/v1/types/type.ts:107

<Optional> imageProfileId

● imageProfileId: string

Defined in interfaces/authoring/v1/types/type.ts:106

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:105

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringLinkElement

Interface: AuthoringLinkElement

Hierarchy

AuthoringElement

↳ AuthoringLinkElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "link"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:138

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:139

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringLocationElement

Interface: AuthoringLocationElement

Hierarchy

AuthoringElement

↳ AuthoringLocationElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "location"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:170

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_LOCATION_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:171

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringNumberElement

Interface: AuthoringNumberElement

Hierarchy

AuthoringElement

↳ AuthoringNumberElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• fieldType
• helpText
• key
• label
• maximum
• maximumValues
• minimum
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "number"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:88

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> fieldType

● fieldType: "integer" | "decimal"

Defined in interfaces/authoring/v1/types/type.ts:89

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximum

● maximum: number

Defined in interfaces/authoring/v1/types/type.ts:92

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimum

● minimum: number

Defined in interfaces/authoring/v1/types/type.ts:91

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_NUMBER_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:90

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringOption

Interface: AuthoringOption

Hierarchy

AuthoringOption

Index

Properties

• label
• selection

Properties

label

● label: string

Defined in interfaces/authoring/v1/types/type.ts:181

selection

● selection: string

Defined in interfaces/authoring/v1/types/type.ts:182

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringOptionSelectionElement

Interface: AuthoringOptionSelectionElement

Hierarchy

AuthoringElement

↳ AuthoringOptionSelectionElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• options
• placeholder
• required
• restrictedParents
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "optionselection"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:186

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> options

● options: AuthoringOption[]

Defined in interfaces/authoring/v1/types/type.ts:189

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> restrictedParents

● restrictedParents: string[]

Defined in interfaces/authoring/v1/types/type.ts:188

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:187

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringPlaceholder

Interface: AuthoringPlaceholder

Hierarchy

AuthoringPlaceholder

Index

Properties

• show
• text

Properties

<Optional> show

● show: boolean

Defined in interfaces/authoring/v1/types/type.ts:19

<Optional> text

● text: string

Defined in interfaces/authoring/v1/types/type.ts:20

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringReferenceElement

Interface: AuthoringReferenceElement

Hierarchy

AuthoringElement

↳ AuthoringReferenceElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• restrictTypes
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "reference"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:119

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> restrictTypes

● restrictTypes: TypeRef

Defined in interfaces/authoring/v1/types/type.ts:121

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:120

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringTextElement

Interface: AuthoringTextElement

Hierarchy

AuthoringElement

↳ AuthoringTextElement

Index

Properties

• allowMultipleValues
• displayHeight
• displayType
• displayWidth
• elementType
• fieldLabel
• helpText
• key
• label
• maxLength
• maximumValues
• minLength
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

<Optional> displayHeight

● displayHeight: number

Defined in interfaces/authoring/v1/types/type.ts:84

<Optional> displayType

● displayType: "singleLine" | "multiLine"

Defined in interfaces/authoring/v1/types/type.ts:82

<Optional> displayWidth

● displayWidth: number

Defined in interfaces/authoring/v1/types/type.ts:83

elementType

● elementType: "text"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:78

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maxLength

● maxLength: number

Defined in interfaces/authoring/v1/types/type.ts:81

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minLength

● minLength: number

Defined in interfaces/authoring/v1/types/type.ts:80

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:79

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringThumbnail

Interface: AuthoringThumbnail

Hierarchy

AuthoringThumbnail

↳ AuthoringContentItemThumbnail

Index

Properties

• id
• path
• url

Properties

<Optional> id

● id: string

Defined in interfaces/authoring/v1/types/type.ts:219

<Optional> path

● path: string

Defined in interfaces/authoring/v1/types/type.ts:220

<Optional> url

● url: string

Defined in interfaces/authoring/v1/types/type.ts:221

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringToggleElement

Interface: AuthoringToggleElement

Hierarchy

AuthoringElement

↳ AuthoringToggleElement

Index

Properties

• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• searchKey
• statement
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "toggle"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:162

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:163

<Optional> statement

● statement: string

Defined in interfaces/authoring/v1/types/type.ts:164

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringType

Interface: AuthoringType

Hierarchy

BaseAuthoringItem

TypeRef

↳ AuthoringType

Index

Properties

• _revisions
• classification
• contentThumbnail
• created
• creatorId
• description
• elements
• icon
• id
• kind
• lastModified
• lastModifierId
• linkedDocId
• name
• path
• rev
• status
• tags
• thumbnail
• uiExtensions

Properties

<Optional> _revisions

● _revisions: Record<string, any>

Defined in interfaces/authoring/v1/types/type.ts:270

Unknown semantic

classification

● classification: "content-type"

Overrides BaseAuthoringItem.classification

Defined in interfaces/authoring/v1/types/type.ts:275

Fixed classification

<Optional> contentThumbnail

● contentThumbnail: AuthoringContentThumbnail

Defined in interfaces/authoring/v1/types/type.ts:260

Optional content thumbnail for the type

<Optional> created

● created: string

Inherited from BaseAuthoringItem.created

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

The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.

<Optional> creatorId

● creatorId: string

Inherited from BaseAuthoringItem.creatorId

Defined in interfaces/authoring/v1/base.item.ts:59

<Optional> description

● description: string

Inherited from BaseAuthoringItem.description

Overrides TypeRef.description

Defined in interfaces/authoring/v1/base.item.ts:64

The description of the item.

elements

● elements: AuthoringElement[]

Defined in interfaces/authoring/v1/types/type.ts:285

Elements on the type, strange that this is an array and not a map

<Optional> icon

● icon: ELEMENT_TYPE

Defined in interfaces/authoring/v1/types/type.ts:247

Optional icon to be used for the type

id

● id: string

Overrides BaseAuthoringItem.id

Defined in interfaces/authoring/v1/types/type.ts:237

The ID of the type

<Optional> kind

● kind: AUTHORING_TYPE_KIND[]

Defined in interfaces/authoring/v1/types/type.ts:280

Lisz of possible kinds for the authoring type

<Optional> lastModified

● lastModified: string

Inherited from BaseAuthoringItem.lastModified

Defined in interfaces/authoring/v1/base.item.ts:47

The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.

<Optional> lastModifierId

● lastModifierId: string

Inherited from BaseAuthoringItem.lastModifierId

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

name of user for now, this property may change once user management is defined (read only).

<Optional> linkedDocId

● linkedDocId: string

Defined in interfaces/authoring/v1/types/type.ts:255

name

● name: string

Overrides BaseAuthoringItem.name

Defined in interfaces/authoring/v1/types/type.ts:242

The name of the type

<Optional> path

● path: string

Inherited from BaseAuthoringItem.path

Defined in interfaces/authoring/v1/base.item.ts:37

<Optional> rev

● rev: string

Inherited from BaseAuthoringItem.rev

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

The current revision of the document.

status

● status: Status

Defined in interfaces/authoring/v1/types/type.ts:249

<Optional> tags

● tags: string[]

Defined in interfaces/authoring/v1/types/type.ts:253

<Optional> thumbnail

● thumbnail: AuthoringThumbnail

Defined in interfaces/authoring/v1/types/type.ts:265

Optional thumbnail for the type

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Defined in interfaces/authoring/v1/types/type.ts:251

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringUiExtensions

Interface: AuthoringUiExtensions

Hierarchy

AuthoringUiExtensions

Index

Properties

• element

Properties

<Optional> element

● element: string

Defined in interfaces/authoring/v1/types/type.ts:230

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringVariableTypeElement

Interface: AuthoringVariableTypeElement

Hierarchy

AuthoringElement

↳ AuthoringVariableTypeElement

Index

Properties

• allowMultipleValues
• elementType
• elements
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• uiExtensions

Properties

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "variabletype"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:193

elements

● elements: Record<string, any>[]

Defined in interfaces/authoring/v1/types/type.ts:194

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@ibm-wch-sdk/api > "interfaces/authoring/v1/types/type" > AuthoringVideoElement

Interface: AuthoringVideoElement

Hierarchy

AuthoringElement

↳ AuthoringVideoElement

Index

Properties

• acceptType
• allowMultipleValues
• elementType
• fieldLabel
• helpText
• key
• label
• maximumValues
• minimumValues
• placeholder
• required
• role
• searchKey
• uiExtensions

Properties

<Optional> acceptType

● acceptType: AUTHORING_ELEMENT_VIDEO_TYPE[]

Defined in interfaces/authoring/v1/types/type.ts:114

<Optional> allowMultipleValues

● allowMultipleValues: boolean

Inherited from AuthoringElement.allowMultipleValues

Defined in interfaces/authoring/v1/types/type.ts:56

Indicates whether content items using this content-type can contain multiple values of this element. Valid for all element types except category, toggle and location.

elementType

● elementType: "video"

Overrides AuthoringElement.elementType

Defined in interfaces/authoring/v1/types/type.ts:113

<Optional> fieldLabel

● fieldLabel: string

Inherited from AuthoringElement.fieldLabel

Defined in interfaces/authoring/v1/types/type.ts:65

When allowMultipleValues is true, specifies a display name for each value within the multi valued list.

<Optional> helpText

● helpText: string

Inherited from AuthoringElement.helpText

Defined in interfaces/authoring/v1/types/type.ts:68

The informational text to show the content author when setting the value of this element.

key

● key: string

Inherited from AuthoringElement.key

Defined in interfaces/authoring/v1/types/type.ts:49

The element identifer. Within content items, elements are referred to by key only.

label

● label: string

Inherited from AuthoringElement.label

Defined in interfaces/authoring/v1/types/type.ts:46

The display name of the element.

<Optional> maximumValues

● maximumValues: number

Inherited from AuthoringElement.maximumValues

Defined in interfaces/authoring/v1/types/type.ts:62

When allowMulitpleValues is true, indicates the maximum number of values are that allowed.

<Optional> minimumValues

● minimumValues: number

Inherited from AuthoringElement.minimumValues

Defined in interfaces/authoring/v1/types/type.ts:59

When allowMulitpleValues is true, indicates the minimum number of values are that required.

<Optional> placeholder

● placeholder: AuthoringPlaceholder

Inherited from AuthoringElement.placeholder

Defined in interfaces/authoring/v1/types/type.ts:70

<Optional> required

● required: boolean

Inherited from AuthoringElement.required

Defined in interfaces/authoring/v1/types/type.ts:52

Indicates whether content items must specify a value for this element.

<Optional> role

● role: AUTHORING_ELEMENT_ROLE[]

Inherited from AuthoringElement.role

Defined in interfaces/authoring/v1/types/type.ts:72

<Optional> searchKey

● searchKey: AUTHORING_ELEMENT_TEXT_SEARCH_KEY

Defined in interfaces/authoring/v1/types/type.ts:115

<Optional> uiExtensions

● uiExtensions: AuthoringUiExtensions

Inherited from AuthoringElement.uiExtensions

Defined in interfaces/authoring/v1/types/type.ts:74

@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/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