Neptunian Parity Mnemonic

    @acoustic-content-sdk/api
    TypeScript icon, indicating that this package has built-in type declarations

    9.0.10076 • Public • Published

    npm

    Interfaces and constants to support the Acoustic sites SDK and related modules.

    API Documentation

    Home > @acoustic-content-sdk/api

    api package

    Interfaces and constants to support the Acoustic sites SDK and related modules.

    Enumerations

    Enumeration Description
    CYCLE_HANDLING Cycle handling strategy
    DraftStatus Possible values for draft status
    SdkMode
    Status
    TENANT_TIER

    Functions

    Function Description
    createVersion(aVersionString, aBuildDate) Constructs a version object from a version string and a build date
    createVersionString(aVersion) Converts the version object into a version string

    Interfaces

    Interface Description
    AbstractElement
    ActivePage
    ActivePageV2
    Asset
    AssetPublishApproval
    AuthoringAsset
    AuthoringAssetMetadata
    AuthoringAssetProfileRendition
    AuthoringCategoryElement
    AuthoringCommerceProductCategoryElement
    AuthoringCommerceProductElement
    AuthoringContentItem
    AuthoringContentItemThumbnail
    AuthoringContentThumbnail
    AuthoringDatetimeElement
    AuthoringElement
    AuthoringFileElement
    AuthoringFormattedTextElement
    AuthoringGroup
    AuthoringGroupElement
    AuthoringImage
    AuthoringImageElement
    AuthoringLayout
    AuthoringLayoutItem
    AuthoringLayoutMapping
    AuthoringLayoutMappingLayout
    AuthoringLayoutMappingMapping
    AuthoringLayoutMappingType
    AuthoringLinkElement
    AuthoringLocationElement
    AuthoringNumberElement
    AuthoringOption
    AuthoringOptionSelectionElement
    AuthoringPlaceholder
    AuthoringReference
    AuthoringReferenceElement
    AuthoringReferenceValue
    AuthoringSelectedLayout
    AuthoringText
    AuthoringTextElement
    AuthoringThumbnail
    AuthoringToggleElement
    AuthoringType
    AuthoringUiExtensions
    AuthoringVariableTypeElement
    AuthoringVideo
    AuthoringVideoElement
    AuthStatus Exposes the authentication status
    BaseAuthoringItem Base interface for all items
    BaseDeliveryItem Base interface for all items
    Category Category is a reference element. The contents that are stored in the category element are references to categories created in content hub. When ?include=metadata is used, the categories property is included which has the full name path for each selected category.Note: When you set categories on the category element, you need to add the UUID of the category to the categoryIds property. The categories property, which returns the name path of the category is a read-only property and is not used when the content is updated. If you set it during an update, it is ignored.
    CategoryElement Category is a reference element. The contents that are stored in the category element are references to categories created in content hub. When ?include=metadata is used, the categories property is included which has the full name path for each selected category.Note: When you set categories on the category element, you need to add the UUID of the category to the categoryIds property. The categories property, which returns the name path of the category is a read-only property and is not used when the content is updated. If you set it during an update, it is ignored.
    ContentItem Representation of a generic content item.
    ContentItemWithLayout
    ContentPublishApproval
    DateElement Common base class for all date elements
    DeliveryAccess
    DeliveryAsset
    DeliveryCategoryElement
    DeliveryContentItem
    DeliveryContentMetadata Common fields in all metadata records
    DeliveryFileElement
    DeliveryGroupElement
    DeliveryGroupElementMetadata
    DeliveryImageAsset
    DeliveryImageCrop
    DeliveryImageElement
    DeliveryImageRendition
    DeliveryImageTransform
    DeliveryLayoutRef
    DeliveryLinkElement
    DeliveryLocationElement
    DeliveryReferenceElement
    DeliveryReferenceElementMetadata
    DeliverySelectedLayout
    DeliveryThumbnail
    DeliveryVideoElement
    DynamicLoggerFactory Instantiator for loggers. Clients of the SDK can use this interface to inject their custom logger implementation.
    ElementMap
    ElementWithMarkup
    ErrorDetail
    ErrorResponse JSON structure of an error response
    ExtendedContext
    ExtendedContextV2
    File
    FileElement Common base class for all file elements
    FormattedTextElement Common base class for all text elements
    Group Interface that represents a grouping of elements
    GroupElement Common base class for all group elements
    HttpResourceOptions
    HubContext
    HubInfo Exposes information required to access the content hub REST API. This information can be obtained via the 'Watson Content Hub information' section.
    HubInfoConfig Base class for services providing hub information. We need a base class to be able to specify this service as injectable
    IbmCommerce
    Image
    ImageElement Common base class for all image elements
    Layout Representation of a layout descriptor in the delivery artifacts
    Link
    LinkElement Common base class for all link elements
    Location
    LocationElement
    Logger Abstraction of the logger interface, trying to be as generic as possible. The identity of the logger is passed at creation time via the factory. Note that this interface is compatible to the console instance.
    LoggerFactory Instantiator for loggers. Clients of the SDK can use this interface to inject their custom logger implementation.
    LoggerService Service to return a logger for a given name. Calling the getter multiple times with the same name will return the same instance of the logger.
    MultiDateElement Date element uses a string property, the value must be an ISO 8601 date time.
    MultiFileElement
    MultiFormattedTextElement The text element holds text value in a JSON string.
    MultiGroupElement The text element holds text value in a JSON string.
    MultiImageElement
    MultiLinkElement Link element has three text fields linkURL, linkText, and linkDescription.
    MultiNumberElement The Number element stores the value in the JSON as a number type.
    MultiOptionSelectionElement The text element holds text value in a JSON string.
    MultiProductElement The text element holds text value in a JSON string.
    MultiReferenceElement
    MultiTextElement The text element holds text value in a JSON string.
    MultiToggleElement Toggle just uses JSON Boolean.
    MultiVideoElement
    NumberElement Common base class for all number elements
    OptionSelection Representation of a selection
    OptionSelectionElement Common base class for all options election elements
    PageSearchResult
    ProductElement
    Query
    ReferenceElement Common base class for all reference elements
    RenderingContext
    RenderingContextGroupElement
    RenderingContextInterceptor Interceptor that can expose transforms for the rendering contexts.
    RenderingContextProvider
    RenderingContextProviderV2
    RenderingContextQueryResult
    RenderingContextReferenceElement
    RenderingContextSearchResult
    RenderingContextV2
    Rendition
    Resource
    SdkActiveRouteEvent
    SdkErrorResponse Response sent when processing a message fails
    SdkMessageHandler
    SdkMessagePayload Base interfaces for events that can be sent to the SDK
    SdkModeEvent
    SdkNavigateByPathEvent
    SdkNavigateByPathResponse Response to the navigation event
    SdkRefreshEvent
    SdkRouteEvent
    SdkSetModeEvent
    SdkSetModeResponse Response to the set mode event
    SdkSubscribeActiveRouteEvent
    SdkSubscribeActiveRouteEventResponse
    SdkSubscribeEventResponse Response to a subscription
    SdkSubscribeModeEvent
    SdkSubscribeModeEventResponse
    SdkSubscribeRouteEvent
    SdkSubscribeRouteEventResponse
    SdkUnsubscribeEvent
    SearchResult
    SearchResults
    SingleDateElement Date element uses a string property, the value must be an ISO 8601 date time.
    SingleFileElement File element is the most basic asset reference element. It is a reference element that is used to point to an asset in content hub. Except for asset ID, all the other properties are read-only and are added from the asset at the time it is selected on a content.With asset references most of the properties are read-only and come from the asset. So when you set a file on file element you need to set the asset.id property. The other information is fetched automatically by the content service and stored in read-only fields.
    SingleFormattedTextElement The text element holds text value in a JSON string.
    SingleGroupElement The text element holds group value in a JSON string.
    SingleImageElement Image is one of the more complex elements and the following section describes a normal image without an image profile configured. For information on updating and formatting the image element, go to Updating image element format.Note: You are always selecting a rendition of an asset and not the asset directly. As a result interactions with image elements involve setting and updating a rendition reference. Most other fields that are displayed in image element are read only!
    SingleLinkElement Link element has three text fields linkURL, linkText, and linkDescription.
    SingleNumberElement The Number element stores the value in the JSON as a number type.
    SingleOptionSelectionElement The text element holds text value in a JSON string.
    SingleProductElement The text element holds text value in a JSON string.
    SingleReferenceElement
    SingleTextElement The text element holds text value in a JSON string.
    SingleToggleElement Toggle just uses JSON Boolean.
    SingleVideoElement Standard video element is similar to the file element. The video asset is represented in the asset section. Optionally a video asset can have a caption and a thumbnail as well, and in this case both of these point two resources in content hub. As mentioned with file, most of the properties here are inlined data from the asset/resource and is read-only. To update a video asset or its caption/thumbnail update the relevant asset/resource ID. The related information is retrieved again and added. Attempts to change the read-only fields are ignored.
    Site
    SiteChild
    SiteContext
    SiteDeliveryContentItem
    SiteNavigationDeliveryContentItem Delivery record for the site content item843fb991-7413-4517-bfcb-b59fc4b1f449
    SiteNavigationPage Reference to a page in the site navigation
    SitePage
    SitePagesQueryResult
    SiteRoot
    Tenant
    TextElement Common base class for all text elements
    ToggleElement Common base class for all toggle elements
    TypeRef Reference to a content type
    UrlConfig Exposes the URL configuration to the client.See HubInfoConfig
    User Representation of a user
    Video
    VideoElement Common base class for all video elements
    WchHttp
    WchSdk
    WchSdkRouter
    WchSdkSearch
    WchSdkVersion Defines the version number and the build date of the SDK.

    Variables

    Variable Description
    ACOUSTIC_CONFIG_API_URL Name of the 'rel' attribute of a link element used to configure the API URL
    ACOUSTIC_CONFIG_BASE_URL Name of the 'rel' attribute of a link element used to configure the base URL
    ACOUSTIC_CONFIG_RESOURCE_URL Name of the 'rel' attribute of a link element used to configure the delivery URL
    ACOUSTIC_SDK_MODULE_NAME
    CLASSIFICATION_ASSET
    CLASSIFICATION_CONTENT_TYPE
    CLASSIFICATION_CONTENT
    CLASSIFICATION_LAYOUT_MAPPING
    CLASSIFICATION_LAYOUT
    CLASSIFICATION_PAGE
    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
    HEADER_BASICAUTH_TENANT_ID
    KEY_ACCEPT_PRIVACY_NOTICE
    KEY_ACCESSOR
    KEY_ACOUSTIC_SEED
    KEY_BASICAUTH_LOGIN_PASSWORD
    KEY_BASICAUTH_LOGIN_USERNAME
    KEY_CREATOR_ID
    KEY_ELEMENT_TYPE
    KEY_ID
    KEY_METADATA
    KEY_NAME
    KEY_STATUS
    KEY_TYPE_ID
    KEY_TYPE_REF
    KEY_VALUE
    KEY_VALUES
    MODULE Module name
    PARAM_REDIRECT_LOGIN_TARGET_TENANT
    PARAM_REDIRECT_LOGIN_TARGET_URL
    REGEXP_ANONYMOUS_USER_ID
    REL_PATH_BASICAUTH_LOGIN
    REL_PATH_CURRENT_TENANT
    REL_PATH_CURRENT_USER
    REL_PATH_REDIRECT_LOGIN
    REL_PATH_REMOVECOOKIES
    REL_PATH_TYPE_BY_ID
    SDK_ACTIVE_ROUTE_EVENT_TYPE Event sent to denote a modification of the active route
    SDK_MODE_EVENT_TYPE Event sent to denote the active mode
    SDK_NAVIGATE_BY_PATH_EVENT_TYPE Event that triggers a navigation
    SDK_REFRESH_EVENT_TYPE Event that triggers a refresh
    SDK_ROUTE_EVENT_TYPE Event sent to denote a modification of the route
    SDK_SET_MODE_EVENT_TYPE Event that modifies the SDK mode between using public or private routes
    SDK_SUBSCRIBE_ACTIVE_ROUTE_EVENT_TYPE Event that subscribes a listener for an active route
    SDK_SUBSCRIBE_MODE_EVENT_TYPE Event that subscribes a listener for modes
    SDK_SUBSCRIBE_ROUTE_EVENT_TYPE Event that subscribes a listener for a specific route
    SDK_UNSUBSCRIBE_EVENT_TYPE Event that unsubscribes a listener
    SEARCH_FL_DOCUMENT Constant to get the full document from the search result
    VALUE_ACCEPT_PRIVACY_NOTICE
    VERSION Version and build number of the package

    Type Aliases

    Type Alias Description
    AUTHORING_CONTENT_ITEM_KIND
    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 Possible values kind
    CONTENT_ITEM_KIND
    DeliveryDateElement
    DeliveryElement
    DeliveryFileAsset
    DeliveryFormattedTextElement
    DeliveryImageMode
    DeliveryImageScale
    DeliveryLayout
    DeliveryLayoutMapping
    DeliveryNumberElement
    DeliveryOptionsElement
    DeliverySelectedLayouts
    DeliveryTextElement
    DeliveryToggleElement
    DeliveryType
    ELEMENT_TYPE
    Element An element is one of the following
    GroupType
    HubInfoUrlProvider
    Layouts Ordering of the layouts per layout mode
    Locale Helper type to identify a locale in the interfaces
    Localized Object supporting localizations
    LocalizedContext Localization context that describes the relevance of a locale, this is typically derived from the accept language header
    LocalizedText Text with attached locale
    MultiDeliveryElements
    MultiRenderingContextElements
    QueryInput
    QueryValue acceptable values for
    RenderingContextElements
    SdkMessageHandlerCallback
    SimpleType
    SingleDeliveryElements
    SingleRenderingContextElements
    SiteNavigation The list of root pages
    StaticHubInfoUrlProvider Defines the provider of a URL, either as a URL, a string or a callback that generates either

    Home > @acoustic-content-sdk/api > CYCLE_HANDLING

    CYCLE_HANDLING enum

    Cycle handling strategy

    Signature:

    export declare enum CYCLE_HANDLING 

    Enumeration Members

    Member Value Description
    BREAK 0 Stop rendering contexts at detected cycles
    RESOLVE 1 Resolve cycles by building cyclic in-memory structures

    Home > @acoustic-content-sdk/api > DraftStatus

    DraftStatus enum

    Possible values for draft status

    Signature:

    export declare enum DraftStatus 

    Enumeration Members

    Member Value Description
    APPROVED "approved"
    IN_PROGRESS "in-progress"
    IN_REVIEW "in-review"

    Home > @acoustic-content-sdk/api > SdkMode

    SdkMode enum

    Signature:

    export declare enum SdkMode 

    Enumeration Members

    Member Value Description
    PROTECTED "protected"
    PUBLIC "public"

    Home > @acoustic-content-sdk/api > Status

    Status enum

    Signature:

    export declare enum Status 

    Enumeration Members

    Member Value Description
    DRAFT "draft"
    READY "ready"
    RETIRED "retired"

    Home > @acoustic-content-sdk/api > TENANT_TIER

    TENANT_TIER enum

    Signature:

    export declare enum TENANT_TIER 

    Enumeration Members

    Member Value Description
    BASE "Base"
    PLUS "Plus"
    STANDARD "Standard"
    TRIAL "Trial"

    Home > @acoustic-content-sdk/api > createVersion

    createVersion() function

    Warning: This API is now obsolete.

    Constructs a version object from a version string and a build date

    Signature:

    export declare function createVersion(aVersionString: string, aBuildDate: string): WchSdkVersion;

    Parameters

    Parameter Type Description
    aVersionString string the version string such as in package json
    aBuildDate string the build date in ISO format

    Returns:

    WchSdkVersion

    the SDK version object

    Home > @acoustic-content-sdk/api > createVersionString

    createVersionString() function

    Converts the version object into a version string

    Signature:

    export declare function createVersionString(aVersion: WchSdkVersion): string;

    Parameters

    Parameter Type Description
    aVersion WchSdkVersion the version object

    Returns:

    string

    the version string

    Home > @acoustic-content-sdk/api > AbstractElement

    AbstractElement interface

    Signature:

    export interface AbstractElement 

    Properties

    Property Type Description
    elementType ELEMENT_TYPE

    Home > @acoustic-content-sdk/api > ActivePage

    ActivePage interface

    Signature:

    export interface ActivePage extends RenderingContextProvider 

    Properties

    Property Type Description
    onRenderingContext Observable<RenderingContext> Retrieves the rendering context for the content item rendered for the currently selected page.

    Home > @acoustic-content-sdk/api > ActivePageV2

    ActivePageV2 interface

    Signature:

    export interface ActivePageV2 extends RenderingContextProviderV2 

    Properties

    Property Type Description
    renderingContext$ Observable<RenderingContextV2> Retrieves the rendering context for the content item rendered for the currently selected page.

    Home > @acoustic-content-sdk/api > Asset

    Asset interface

    Signature:

    export interface Asset 

    Properties

    Property Type Description
    altText string
    fileName string
    fileSize number
    height number
    id string
    mediaType string
    resourceUri string
    width number added by delivery

    Home > @acoustic-content-sdk/api > AssetPublishApproval

    AssetPublishApproval interface

    Signature:

    export interface AssetPublishApproval 

    Properties

    Property Type Description
    enabled boolean True if mandatory approval is enabled
    exemptAssetTypes string[]

    Home > @acoustic-content-sdk/api > AuthoringAsset

    AuthoringAsset interface

    Signature:

    export interface AuthoringAsset extends BaseAuthoringItem 

    Properties

    Property Type Description
    altText string
    assetType string
    caption string
    classification 'asset' The classification defines the document type. For content items, all documents are classified as "content".
    digest string
    fileName string
    fileSize number
    isManaged boolean
    mediaType string
    metadata AuthoringAssetMetadata
    path string
    profileRenditions AuthoringAssetProfileRendition[]
    resource string

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata

    AuthoringAssetMetadata interface

    Signature:

    export interface AuthoringAssetMetadata 

    Properties

    Property Type Description
    camera any
    coverage any
    creator string
    description string
    headline string
    heigth number
    publisher string
    rights string
    source string
    subject string[]
    title string
    width number

    Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition

    AuthoringAssetProfileRendition interface

    Signature:

    export interface AuthoringAssetProfileRendition 

    Properties

    Property Type Description
    height number
    key string
    profileId string
    transform any
    uri string
    width number

    Home > @acoustic-content-sdk/api > AuthoringCategoryElement

    AuthoringCategoryElement interface

    Signature:

    export interface AuthoringCategoryElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'category'
    restrictedParents string[]
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringCommerceProductCategoryElement

    AuthoringCommerceProductCategoryElement interface

    Signature:

    export interface AuthoringCommerceProductCategoryElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'productcategory'
    restrictedParent string
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringCommerceProductElement

    AuthoringCommerceProductElement interface

    Signature:

    export interface AuthoringCommerceProductElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'product'
    restrictedCategories string[]
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringContentItem

    AuthoringContentItem interface

    Signature:

    export interface AuthoringContentItem extends BaseAuthoringItem 

    Properties

    Property Type Description
    classification 'content'
    deliveryAccess 'secured'
    draftStatus DraftStatus
    elements Record<string, any>
    form any[]
    id string
    keywords string[]
    kind AUTHORING_CONTENT_ITEM_KIND[]
    lastModified string
    lastModifier string
    lastModifierId string
    linkedDocId string
    links Record<string, any>
    locale string
    projectId string
    projects string[]
    publishing Record<string, any>
    review Record<string, any>
    reviewHistory string[]
    reviewId string
    schema Record<string, any>
    selectedLayouts AuthoringSelectedLayout[]
    status Status
    systemModified string
    tags string[]
    thumbnail AuthoringContentItemThumbnail
    type string
    typeId string
    valid boolean

    Home > @acoustic-content-sdk/api > AuthoringContentItemThumbnail

    AuthoringContentItemThumbnail interface

    Signature:

    export interface AuthoringContentItemThumbnail extends AuthoringThumbnail 

    Properties

    Property Type Description
    id string

    Home > @acoustic-content-sdk/api > AuthoringContentThumbnail

    AuthoringContentThumbnail interface

    Signature:

    export interface AuthoringContentThumbnail 

    Properties

    Property Type Description
    imageElement string
    source 'imageElementOrType' | 'imageElement' | 'type' | 'none'

    Home > @acoustic-content-sdk/api > AuthoringDatetimeElement

    AuthoringDatetimeElement interface

    Signature:

    export interface AuthoringDatetimeElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'datetime'
    fieldType 'date' | 'date-time'
    searchKey AUTHORING_ELEMENT_DATETIME_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringElement

    AuthoringElement interface

    Signature:

    export interface AuthoringElement 

    Properties

    Property Type Description
    allowMultipleValues boolean 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 ELEMENT_TYPE | 'productcategory' | 'product' Specifies the type of this element.
    fieldLabel string When allowMultipleValues is true, specifies a display name for each value within the multi valued list.
    helpText string The informational text to show the content author when setting the value of this element.
    key string The element identifer. Within content items, elements are referred to by key only.
    label string The display name of the element.
    maximumValues number When allowMulitpleValues is true, indicates the maximum number of values are that allowed.
    minimumValues number When allowMulitpleValues is true, indicates the minimum number of values are that required.
    placeholder AuthoringPlaceholder
    required boolean Indicates whether content items must specify a value for this element.
    role AUTHORING_ELEMENT_ROLE[]
    uiExtensions AuthoringUiExtensions

    Home > @acoustic-content-sdk/api > AuthoringFileElement

    AuthoringFileElement interface

    Signature:

    export interface AuthoringFileElement extends AuthoringElement 

    Properties

    Property Type Description
    acceptType AUTHORING_ELEMENT_FILE_TYPE[]
    elementType 'file'
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringFormattedTextElement

    AuthoringFormattedTextElement interface

    Signature:

    export interface AuthoringFormattedTextElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'formattedtext'
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringGroup

    AuthoringGroup interface

    Signature:

    export interface AuthoringGroup<T> 

    Properties

    Property Type Description
    elementType typeof ELEMENT_TYPE_GROUP
    typeRef AuthoringReferenceValue
    value T
    values T[]

    Home > @acoustic-content-sdk/api > AuthoringGroupElement

    AuthoringGroupElement interface

    Signature:

    export interface AuthoringGroupElement extends AuthoringElement 

    Properties

    Property Type Description
    elements any[]
    elementType 'group'
    icon ELEMENT_TYPE
    kind AUTHORING_TYPE_KIND[]
    typeRef TypeRef

    Home > @acoustic-content-sdk/api > AuthoringImage

    AuthoringImage interface

    Signature:

    export interface AuthoringImage 

    Properties

    Property Type Description
    elementType typeof ELEMENT_TYPE_IMAGE
    values Image[]

    Home > @acoustic-content-sdk/api > AuthoringImageElement

    AuthoringImageElement interface

    Signature:

    export interface AuthoringImageElement extends AuthoringElement 

    Properties

    Property Type Description
    acceptType AUTHORING_ELEMENT_IMAGE_TYPE[]
    elementType 'image'
    imageProfile Record<string, any>
    imageProfileId string
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringLayout

    AuthoringLayout interface

    Signature:

    export interface AuthoringLayout 

    Properties

    Property Type Description
    classification 'layout'
    id string
    name string
    path string

    Home > @acoustic-content-sdk/api > AuthoringLayoutItem

    AuthoringLayoutItem interface

    Signature:

    export interface AuthoringLayoutItem extends Layout 

    Properties

    Property Type Description
    classification 'layout'
    id string
    name string
    path string
    prerender boolean
    urlTemplate string

    Home > @acoustic-content-sdk/api > AuthoringLayoutMapping

    AuthoringLayoutMapping interface

    Signature:

    export interface AuthoringLayoutMapping extends BaseAuthoringItem 

    Properties

    Property Type Description
    _revisions Record<string, string>
    classification 'layout-mapping'
    created string
    creatorId string
    id string
    lastModified string
    lastModifierId string
    mappings AuthoringLayoutMappingMapping[]
    name string
    path string
    rev string
    tags string[]
    type AuthoringLayoutMappingType

    Home > @acoustic-content-sdk/api > AuthoringLayoutMappingLayout

    AuthoringLayoutMappingLayout interface

    Signature:

    export interface AuthoringLayoutMappingLayout 

    Properties

    Property Type Description
    id string
    name string

    Home > @acoustic-content-sdk/api > AuthoringLayoutMappingMapping

    AuthoringLayoutMappingMapping interface

    Signature:

    export interface AuthoringLayoutMappingMapping 

    Properties

    Property Type Description
    defaultLayout AuthoringLayoutMappingLayout
    layoutMode string
    layouts AuthoringLayoutMappingLayout[]

    Home > @acoustic-content-sdk/api > AuthoringLayoutMappingType

    AuthoringLayoutMappingType interface

    Signature:

    export interface AuthoringLayoutMappingType 

    Properties

    Property Type Description
    id string
    name string

    Home > @acoustic-content-sdk/api > AuthoringLinkElement

    AuthoringLinkElement interface

    Signature:

    export interface AuthoringLinkElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'link'
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringLocationElement

    AuthoringLocationElement interface

    Signature:

    export interface AuthoringLocationElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'location'
    searchKey AUTHORING_ELEMENT_LOCATION_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringNumberElement

    AuthoringNumberElement interface

    Signature:

    export interface AuthoringNumberElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'number'
    fieldType 'integer' | 'decimal'
    maximum number
    minimum number
    searchKey AUTHORING_ELEMENT_NUMBER_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringOption

    AuthoringOption interface

    Signature:

    export interface AuthoringOption 

    Properties

    Property Type Description
    label string
    selection string

    Home > @acoustic-content-sdk/api > AuthoringOptionSelectionElement

    AuthoringOptionSelectionElement interface

    Signature:

    export interface AuthoringOptionSelectionElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'optionselection'
    options AuthoringOption[]
    restrictedParents string[]
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringPlaceholder

    AuthoringPlaceholder interface

    Signature:

    export interface AuthoringPlaceholder 

    Properties

    Property Type Description
    show boolean
    text string

    Home > @acoustic-content-sdk/api > AuthoringReference

    AuthoringReference interface

    Signature:

    export interface AuthoringReference 

    Properties

    Property Type Description
    elementType typeof ELEMENT_TYPE_REFERENCE
    value AuthoringReferenceValue[]
    values AuthoringReferenceValue[]

    Home > @acoustic-content-sdk/api > AuthoringReferenceElement

    AuthoringReferenceElement interface

    Signature:

    export interface AuthoringReferenceElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'reference'
    restrictTypes TypeRef
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringReferenceValue

    AuthoringReferenceValue interface

    Signature:

    export interface AuthoringReferenceValue 

    Properties

    Property Type Description
    creatorId string
    id string
    name string
    status Status
    typeId string

    Home > @acoustic-content-sdk/api > AuthoringSelectedLayout

    AuthoringSelectedLayout interface

    Signature:

    export interface AuthoringSelectedLayout 

    Properties

    Property Type Description
    layout AuthoringLayout
    layoutMode string

    Home > @acoustic-content-sdk/api > AuthoringText

    AuthoringText interface

    Signature:

    export interface AuthoringText 

    Properties

    Property Type Description
    elementType typeof ELEMENT_TYPE_TEXT
    value string
    values string[]

    Home > @acoustic-content-sdk/api > AuthoringTextElement

    AuthoringTextElement interface

    Signature:

    export interface AuthoringTextElement extends AuthoringElement 

    Properties

    Property Type Description
    displayHeight number
    displayType 'singleLine' | 'multiLine'
    displayWidth number
    elementType 'text'
    maxLength number
    minLength number
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthoringThumbnail

    AuthoringThumbnail interface

    Signature:

    export interface AuthoringThumbnail 

    Properties

    Property Type Description
    id string
    path string
    url string

    Home > @acoustic-content-sdk/api > AuthoringToggleElement

    AuthoringToggleElement interface

    Signature:

    export interface AuthoringToggleElement extends AuthoringElement 

    Properties

    Property Type Description
    elementType 'toggle'
    searchKey AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY
    statement string

    Home > @acoustic-content-sdk/api > AuthoringType

    AuthoringType interface

    Signature:

    export interface AuthoringType extends BaseAuthoringItem 

    Properties

    Property Type Description
    _revisions Record<string, any> Unknown semantic
    categories string[]
    categoryIds string[]
    classification 'content-type' Fixed classification
    contentThumbnail AuthoringContentThumbnail Optional content thumbnail for the type
    elements AuthoringElement[] Elements on the type, strange that this is an array and not a map
    icon ELEMENT_TYPE Optional icon to be used for the type
    kind AUTHORING_TYPE_KIND[] Lisz of possible kinds for the authoring type
    linkedDocId string
    status Status
    tags string[]
    thumbnail AuthoringThumbnail Optional thumbnail for the type
    uiExtensions AuthoringUiExtensions

    Home > @acoustic-content-sdk/api > AuthoringUiExtensions

    AuthoringUiExtensions interface

    Signature:

    export interface AuthoringUiExtensions 

    Properties

    Property Type Description
    element string
    elementBuiltin string
    elementConfig any

    Home > @acoustic-content-sdk/api > AuthoringVariableTypeElement

    AuthoringVariableTypeElement interface

    Signature:

    export interface AuthoringVariableTypeElement extends AuthoringElement 

    Properties

    Property Type Description
    elements Record<string, any>[]
    elementType 'variabletype'

    Home > @acoustic-content-sdk/api > AuthoringVideo

    AuthoringVideo interface

    Signature:

    export interface AuthoringVideo 

    Properties

    Property Type Description
    elementType typeof ELEMENT_TYPE_VIDEO
    values Video[]

    Home > @acoustic-content-sdk/api > AuthoringVideoElement

    AuthoringVideoElement interface

    Signature:

    export interface AuthoringVideoElement extends AuthoringElement 

    Properties

    Property Type Description
    acceptType AUTHORING_ELEMENT_VIDEO_TYPE[]
    elementType 'video'
    searchKey AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    Home > @acoustic-content-sdk/api > AuthStatus

    AuthStatus interface

    Exposes the authentication status

    Signature:

    export interface AuthStatus 

    Properties

    Property Type Description
    authenticated$ Observable<boolean> Exposes the flag that tells if the system is authenticated. This is e.g. used to decide to use the delivery or mydelivery routes.

    Home > @acoustic-content-sdk/api > BaseAuthoringItem

    BaseAuthoringItem interface

    Base interface for all items

    Signature:

    export interface BaseAuthoringItem 

    Properties

    Property Type Description
    classification string The classification defines the document type. For content items, all documents are classified as "content".
    created string The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
    creatorId string
    description string The description of the item.
    id string The ID of the content item.
    lastModified string 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.
    lastModifierId string name of user for now, this property may change once user management is defined (read only).
    linkedDocId string Optionally the ID of the ready item
    name string The name of the content item.
    path string
    rev string The current revision of the document.

    Home > @acoustic-content-sdk/api > BaseDeliveryItem

    BaseDeliveryItem interface

    Base interface for all items

    Signature:

    export interface BaseDeliveryItem 

    Properties

    Property Type Description
    classification string The classification defines the document type. For content items, all documents are classified as "content".
    created string The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
    creatorId string
    description string The description of the item.
    id string The ID of the content item.
    lastModified string 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.
    lastModifierId string name of user for now, this property may change once user management is defined (read only).
    name string The name of the content item.
    rev string The current revision of the document.

    Home > @acoustic-content-sdk/api > Category

    Category interface

    Category is a reference element. The contents that are stored in the category element are references to categories created in content hub. When ?include=metadata is used, the categories property is included which has the full name path for each selected category.

    Note: When you set categories on the category element, you need to add the UUID of the category to the categoryIds property. The categories property, which returns the name path of the category is a read-only property and is not used when the content is updated. If you set it during an update, it is ignored.

    Signature:

    export interface Category 

    Properties

    Property Type Description
    categories string[]
    categoryIds string[]
    categoryPaths string[][] extension for the local rendering context for convenience

    Home > @acoustic-content-sdk/api > CategoryElement

    CategoryElement interface

    Category is a reference element. The contents that are stored in the category element are references to categories created in content hub. When ?include=metadata is used, the categories property is included which has the full name path for each selected category.

    Note: When you set categories on the category element, you need to add the UUID of the category to the categoryIds property. The categories property, which returns the name path of the category is a read-only property and is not used when the content is updated. If you set it during an update, it is ignored.

    Signature:

    export interface CategoryElement extends AbstractElement, Category 

    Properties

    Property Type Description
    elementType 'category'

    Home > @acoustic-content-sdk/api > ContentItem

    ContentItem interface

    Representation of a generic content item.

    Signature:

    export interface ContentItem extends BaseDeliveryItem 

    Properties

    Property Type Description
    draftId string TBD
    draftStatus DraftStatus TBD
    elements {
    [key: string]: any;
    }
    Defined by the type and capture in the schema given by the type, in a real content, this property will be filled with more information.Note, we are using any here, because union types are hard to handle in templates.
    kind CONTENT_ITEM_KIND[] Kind of a content item
    locale string locale of the document (e.g "en", or "de").
    projectId string The project ID
    tags Array<string> The tags describing the content item.
    type string this is the link to the content type document this content is based on.
    typeId string The ID of the content type this item belongs to.

    Home > @acoustic-content-sdk/api > ContentItemWithLayout

    ContentItemWithLayout interface

    Signature:

    export interface ContentItemWithLayout extends ContentItem 

    Properties

    Property Type Description
    id string The ID of the content item.
    layouts Layouts The layouts for the content item, ordered by mode. The 'default' mode always exists and denotes the default layout.
    selectedLayouts AuthoringSelectedLayout[] Optionally the explicitly assigned layouts

    Home > @acoustic-content-sdk/api > ContentPublishApproval

    ContentPublishApproval interface

    Signature:

    export interface ContentPublishApproval 

    Properties

    Property Type Description
    enabled boolean True if mandatory approval is enabled
    exemptContentTypes string[]

    Home > @acoustic-content-sdk/api > DateElement

    DateElement interface

    Common base class for all date elements

    Signature:

    export interface DateElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'datetime'

    Home > @acoustic-content-sdk/api > DeliveryAccess

    DeliveryAccess interface

    Signature:

    export interface DeliveryAccess 

    Properties

    Property Type Description
    assets string
    content string
    secureAlways boolean

    Home > @acoustic-content-sdk/api > DeliveryAsset

    DeliveryAsset interface

    Signature:

    export interface DeliveryAsset 

    Properties

    Property Type Description
    fileName string
    fileSize number
    id string
    mediaType string
    resourceUri string

    Home > @acoustic-content-sdk/api > DeliveryCategoryElement

    DeliveryCategoryElement interface

    Signature:

    export interface DeliveryCategoryElement 

    Properties

    Property Type Description
    categoryIds string[]
    categoryPath string[]

    Home > @acoustic-content-sdk/api > DeliveryContentItem

    DeliveryContentItem interface

    Signature:

    export interface DeliveryContentItem 

    Properties

    Property Type Description
    $metadata DeliveryContentMetadata Metadata record

    Home > @acoustic-content-sdk/api > DeliveryContentMetadata

    DeliveryContentMetadata interface

    Common fields in all metadata records

    Signature:

    export interface DeliveryContentMetadata 

    Properties

    Property Type Description
    accessor string Accessor that references the main element relative to the root of the authoring data structure
    classification 'content'
    created string
    creatorId string
    description string
    draftId string
    id string ID of the content item. For group items is this the ID of the hosting content item, for references it's the ID of the referenced item. This ID will always be a 'ready ID'.
    keywords string[]
    kind string[]
    lastModified string
    lastModifierId string
    locale string
    name string
    protectedUrl string
    rev string
    selectedLayouts DeliverySelectedLayouts
    systemModified string
    tags string[]
    thumbnail DeliveryThumbnail
    type string
    typeId string ID of the type of the content item. Note that for group elements this is the ID of the hosting content item, not of the type of the group element.
    url string

    Home > @acoustic-content-sdk/api > DeliveryFileElement

    DeliveryFileElement interface

    Signature:

    export interface DeliveryFileElement 

    Properties

    Property Type Description
    asset DeliveryFileAsset
    url string

    Home > @acoustic-content-sdk/api > DeliveryGroupElement

    DeliveryGroupElement interface

    Signature:

    export interface DeliveryGroupElement 

    Properties

    Property Type Description
    $metadata DeliveryGroupElementMetadata Optional metadata

    Home > @acoustic-content-sdk/api > DeliveryGroupElementMetadata

    DeliveryGroupElementMetadata interface

    Signature:

    export interface DeliveryGroupElementMetadata 

    Properties

    Property Type Description
    accessor string Accessor that references the group element relative to the root of the authoring data structure
    selectedLayouts DeliverySelectedLayouts Optionally the selected layouts for the group element

    Home > @acoustic-content-sdk/api > DeliveryImageAsset

    DeliveryImageAsset interface

    Signature:

    export interface DeliveryImageAsset extends DeliveryAsset 

    Properties

    Property Type Description
    altText string
    height number
    width number

    Home > @acoustic-content-sdk/api > DeliveryImageCrop

    DeliveryImageCrop interface

    Signature:

    export interface DeliveryImageCrop 

    Properties

    Property Type Description
    height number
    width number
    x number
    y number

    Home > @acoustic-content-sdk/api > DeliveryImageElement

    DeliveryImageElement interface

    Signature:

    export interface DeliveryImageElement 

    Properties

    Property Type Description
    asset DeliveryImageAsset
    mode DeliveryImageMode
    renditions Record<string, DeliveryImageRendition>
    url string

    Home > @acoustic-content-sdk/api > DeliveryImageRendition

    DeliveryImageRendition interface

    Signature:

    export interface DeliveryImageRendition 

    Properties

    Property Type Description
    height number
    source string
    transform DeliveryImageTransform
    url string
    width number

    Home > @acoustic-content-sdk/api > DeliveryImageTransform

    DeliveryImageTransform interface

    Signature:

    export interface DeliveryImageTransform 

    Properties

    Property Type Description
    crop DeliveryImageCrop
    scale DeliveryImageScale

    Home > @acoustic-content-sdk/api > DeliveryLayoutRef

    DeliveryLayoutRef interface

    Signature:

    export interface DeliveryLayoutRef 

    Properties

    Property Type Description
    id string

    Home > @acoustic-content-sdk/api > DeliveryLinkElement

    DeliveryLinkElement interface

    Signature:

    export interface DeliveryLinkElement 

    Properties

    Property Type Description
    linkDescription string
    linkText string
    linkURL string

    Home > @acoustic-content-sdk/api > DeliveryLocationElement

    DeliveryLocationElement interface

    Signature:

    export interface DeliveryLocationElement 

    Properties

    Property Type Description
    latitude number
    longitude number

    Home > @acoustic-content-sdk/api > DeliveryReferenceElement

    DeliveryReferenceElement interface

    Signature:

    export interface DeliveryReferenceElement 

    Properties

    Property Type Description
    $metadata DeliveryReferenceElementMetadata

    Home > @acoustic-content-sdk/api > DeliveryReferenceElementMetadata

    DeliveryReferenceElementMetadata interface

    Signature:

    export interface DeliveryReferenceElementMetadata extends Partial<DeliveryContentMetadata> 

    Properties

    Property Type Description
    id string

    Home > @acoustic-content-sdk/api > DeliverySelectedLayout

    DeliverySelectedLayout interface

    Signature:

    export interface DeliverySelectedLayout 

    Properties

    Property Type Description
    layout DeliveryLayoutRef

    Home > @acoustic-content-sdk/api > DeliveryThumbnail

    DeliveryThumbnail interface

    Signature:

    export interface DeliveryThumbnail 

    Properties

    Property Type Description
    id string
    url string

    Home > @acoustic-content-sdk/api > DeliveryVideoElement

    DeliveryVideoElement interface

    Signature:

    export interface DeliveryVideoElement 

    Home > @acoustic-content-sdk/api > DynamicLoggerFactory

    DynamicLoggerFactory interface

    Instantiator for loggers. Clients of the SDK can use this interface to inject their custom logger implementation.

    Signature:

    export interface DynamicLoggerFactory 

    Methods

    Method Description
    get() Returns a logger that is instantiated lazily (and potentially) multiple times.

    Home > @acoustic-content-sdk/api > ElementMap

    ElementMap interface

    Signature:

    export interface ElementMap<T> 

    Home > @acoustic-content-sdk/api > ElementWithMarkup

    ElementWithMarkup interface

    Signature:

    export interface ElementWithMarkup 

    Properties

    Property Type Description
    $markup string Optionally the markup for an element

    Home > @acoustic-content-sdk/api > ErrorDetail

    ErrorDetail interface

    Signature:

    export interface ErrorDetail 

    Properties

    Property Type Description
    locale string
    message string
    name string
    parameters any
    stack string

    Home > @acoustic-content-sdk/api > ErrorResponse

    ErrorResponse interface

    JSON structure of an error response

    Signature:

    export interface ErrorResponse 

    Properties

    Property Type Description
    description string
    errors ErrorDetail[]
    message string
    requestId string
    service string
    statusCode number
    version string

    Home > @acoustic-content-sdk/api > ExtendedContext

    ExtendedContext interface

    Signature:

    export interface ExtendedContext extends SiteContext 

    Properties

    Property Type Description
    hub HubContext

    Home > @acoustic-content-sdk/api > ExtendedContextV2

    ExtendedContextV2 interface

    Signature:

    export interface ExtendedContextV2 

    Properties

    Property Type Description
    editMode boolean Information about edit mode
    hub HubContext Information about URLs that can be used to access the REST APIs

    Home > @acoustic-content-sdk/api > File

    File interface

    Signature:

    export interface File 

    Properties

    Property Type Description
    asset Asset
    url string

    Home > @acoustic-content-sdk/api > FileElement

    FileElement interface

    Common base class for all file elements

    Signature:

    export interface FileElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'file'

    Home > @acoustic-content-sdk/api > FormattedTextElement

    FormattedTextElement interface

    Common base class for all text elements

    Signature:

    export interface FormattedTextElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'formattedtext'

    Home > @acoustic-content-sdk/api > Group

    Group interface

    Interface that represents a grouping of elements

    Signature:

    export interface Group 

    Home > @acoustic-content-sdk/api > GroupElement

    GroupElement interface

    Common base class for all group elements

    Signature:

    export interface GroupElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'group'
    layouts Layouts The layouts for the content item, ordered by mode. The 'default' mode always exists and denotes the default layout.
    selectedLayouts AuthoringSelectedLayout[] Optionally the explicitly assigned layouts
    typeRef TypeRef Reference to the actual type

    Home > @acoustic-content-sdk/api > HttpResourceOptions

    HttpResourceOptions interface

    Signature:

    export interface HttpResourceOptions 

    Properties

    Property Type Description
    pollTime number
    pollTimeVariation number
    retries number
    useApi boolean Optionally use REST to load resources, default is true
    useBootstrap boolean Optionally enable pre-loading from bootstrap, default is true
    useJsonP boolean Configure if we should use XHR or JSONp
    useLocalStorage boolean Optionally enable pre-loading from local storage, default is true
    usePolling boolean Configure if we should use polling at all, default is true
    useStaticResources boolean Optionally enable use of static resources, default is true

    Home > @acoustic-content-sdk/api > HubContext

    HubContext interface

    Signature:

    export interface HubContext 

    Properties

    Property Type Description
    apiUrl URL URL to access the API layer, e.g. 'https://my.digitalexperience.ibm.com/api/345563cf-a83c-40e5-a065-1d6ff36b05c1'Naming of this field according to the field in the rendering context
    isPreviewMode boolean Flag that indicates if the system is in preview mode.
    resourceUrl URL URL to access the delivery , e.g. 'https://my.digitalexperience.ibm.com/345563cf-a83c-40e5-a065-1d6ff36b05c1'Naming of this field according to the field in the rendering context

    Home > @acoustic-content-sdk/api > HubInfo

    HubInfo interface

    Exposes information required to access the content hub REST API. This information can be obtained via the 'Watson Content Hub information' section.

    Signature:

    export interface HubInfo 

    Properties

    Property Type Description
    apiUrl URL | string URL to access the API layer, e.g. 'https://my.digitalexperience.ibm.com/api/345563cf-a83c-40e5-a065-1d6ff36b05c1'Naming of this field according to the field in the rendering context
    resourceUrl URL | string URL to access the delivery , e.g. 'https://my.digitalexperience.ibm.com/345563cf-a83c-40e5-a065-1d6ff36b05c1'Naming of this field according to the field in the rendering context

    Home > @acoustic-content-sdk/api > HubInfoConfig

    HubInfoConfig interface

    Base class for services providing hub information. We need a base class to be able to specify this service as injectable

    Signature:

    export interface HubInfoConfig 

    Properties

    Property Type Description
    apiUrl HubInfoUrlProvider URL to access the API layerNaming of this field according to the field in the rendering context
    baseUrl HubInfoUrlProvider URL that represents the base URL of the path based routing of the application. This prefix will be preserved when generating and recognizing URLs. If this property is not configured, then it will be decoded from the window location.
    cycleHandlingStrategy CYCLE_HANDLING | string Optionally specify how the SDK is supposed to deal with cyclic references in the content data structure. Per default the rendering context will break cycles by representing the duplicate element in a reference path by an unresolved reference. When configuring the strategy to CYCLE_HANDLING.RESOLVE, the ContentrefComponent will use a resolved refence when rendering the context, instead of the unresolved reference. This bears the risk of an infinite loop during rendering. The actual rendering context objects will still not have cycles, so a JSON serialization of these objects will produce a valid result.Default is CYCLE_HANDLING.BREAK
    fetchLevels number Number of levels to fetch per request to the rendering context. If missing all levels will be fetched.
    httpOptions HttpResourceOptions Optionally specify how the SDK makes outbound requests
    httpPreviewOptions HttpResourceOptions Optionally specify how the SDK makes outbound requests for the preview case
    resourceUrl HubInfoUrlProvider URL to access the deliveryNaming of this field according to the field in the rendering context

    Home > @acoustic-content-sdk/api > IbmCommerce

    IbmCommerce interface

    Signature:

    export interface IbmCommerce 

    Properties

    Property Type Description
    apiGatewayHost string
    environmentType string
    liveSearchHost string
    liveTransactionHost string
    previewSearchHost string
    previewTransactionHost string
    tenantId string

    Home > @acoustic-content-sdk/api > Image

    Image interface

    Signature:

    export interface Image 

    Properties

    Property Type Description
    altText string
    asset Asset
    profiles string[]
    renditions {
    [key: string]: Rendition;
    }
    url string

    Home > @acoustic-content-sdk/api > ImageElement

    ImageElement interface

    Common base class for all image elements

    Signature:

    export interface ImageElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'image'

    Home > @acoustic-content-sdk/api > Layout

    Layout interface

    Representation of a layout descriptor in the delivery artifacts

    Signature:

    export interface Layout 

    Properties

    Property Type Description
    id string ID of the layout
    name string Name of the layout
    tags string[] Optional list of tags
    template string The template description, will be a selector for angular and a filename for handlebars
    templateType string The template type, either 'handlebars' or 'angular'

    Home > @acoustic-content-sdk/api > Link

    Link interface

    Signature:

    export interface Link 

    Properties

    Property Type Description
    linkDescription string
    linkText string
    linkURL string

    Home > @acoustic-content-sdk/api > LinkElement

    LinkElement interface

    Common base class for all link elements

    Signature:

    export interface LinkElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'link'

    Home > @acoustic-content-sdk/api > Location

    Location interface

    Signature:

    export interface Location 

    Properties

    Property Type Description
    latitude number
    longitude number

    Home > @acoustic-content-sdk/api > LocationElement

    LocationElement interface

    Signature:

    export interface LocationElement extends AbstractElement, Location 

    Properties

    Property Type Description
    elementType 'location'

    Home > @acoustic-content-sdk/api > Logger

    Logger interface

    Abstraction of the logger interface, trying to be as generic as possible. The identity of the logger is passed at creation time via the factory. Note that this interface is compatible to the console instance.

    Signature:

    export interface Logger 

    Methods

    Method Description
    error(msg, data)
    info(msg, data)
    warn(msg, data)

    Home > @acoustic-content-sdk/api > LoggerFactory

    LoggerFactory interface

    Instantiator for loggers. Clients of the SDK can use this interface to inject their custom logger implementation.

    Signature:

    export interface LoggerFactory 

    Methods

    Method Description
    create(name) Construct the logger instance. There is no need to protect against the creation of multiple loggers, the caller will make sure that loggers are singletons.

    Home > @acoustic-content-sdk/api > LoggerService

    LoggerService interface

    Service to return a logger for a given name. Calling the getter multiple times with the same name will return the same instance of the logger.

    Signature:

    export interface LoggerService 

    Properties

    Property Type Description
    get (name: string) => Logger Returns a logger for the given name$1$2 -$3

    Home > @acoustic-content-sdk/api > MultiDateElement

    MultiDateElement interface

    Date element uses a string property, the value must be an ISO 8601 date time.

    Signature:

    export interface MultiDateElement extends DateElement 

    Properties

    Property Type Description
    values string[]

    Home > @acoustic-content-sdk/api > MultiFileElement

    MultiFileElement interface

    Signature:

    export interface MultiFileElement extends FileElement 

    Properties

    Property Type Description
    values File[]

    Home > @acoustic-content-sdk/api > MultiFormattedTextElement

    MultiFormattedTextElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface MultiFormattedTextElement extends FormattedTextElement 

    Properties

    Property Type Description
    values string[]

    Home > @acoustic-content-sdk/api > MultiGroupElement

    MultiGroupElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface MultiGroupElement extends GroupElement 

    Properties

    Property Type Description
    values Group[]

    Home > @acoustic-content-sdk/api > MultiImageElement

    MultiImageElement interface

    Signature:

    export interface MultiImageElement extends ImageElement 

    Properties

    Property Type Description
    values Image[]

    Home > @acoustic-content-sdk/api > MultiLinkElement

    MultiLinkElement interface

    Link element has three text fields linkURL, linkText, and linkDescription.

    Signature:

    export interface MultiLinkElement extends LinkElement 

    Properties

    Property Type Description
    values Link[]

    Home > @acoustic-content-sdk/api > MultiNumberElement

    MultiNumberElement interface

    The Number element stores the value in the JSON as a number type.

    Signature:

    export interface MultiNumberElement extends NumberElement 

    Properties

    Property Type Description
    values number[]

    Home > @acoustic-content-sdk/api > MultiOptionSelectionElement

    MultiOptionSelectionElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface MultiOptionSelectionElement extends OptionSelectionElement 

    Properties

    Property Type Description
    values OptionSelection[]

    Home > @acoustic-content-sdk/api > MultiProductElement

    MultiProductElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface MultiProductElement extends ProductElement 

    Properties

    Property Type Description
    values string[]

    Home > @acoustic-content-sdk/api > MultiReferenceElement

    MultiReferenceElement interface

    Signature:

    export interface MultiReferenceElement extends ReferenceElement 

    Properties

    Property Type Description
    values RenderingContext[]

    Home > @acoustic-content-sdk/api > MultiTextElement

    MultiTextElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface MultiTextElement extends TextElement 

    Properties

    Property Type Description
    values string[]

    Home > @acoustic-content-sdk/api > MultiToggleElement

    MultiToggleElement interface

    Toggle just uses JSON Boolean.

    Signature:

    export interface MultiToggleElement extends ToggleElement 

    Properties

    Property Type Description
    values boolean[]

    Home > @acoustic-content-sdk/api > MultiVideoElement

    MultiVideoElement interface

    Signature:

    export interface MultiVideoElement extends VideoElement 

    Properties

    Property Type Description
    values Video[]

    Home > @acoustic-content-sdk/api > NumberElement

    NumberElement interface

    Common base class for all number elements

    Signature:

    export interface NumberElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'number'

    Home > @acoustic-content-sdk/api > OptionSelection

    OptionSelection interface

    Representation of a selection

    Signature:

    export interface OptionSelection 

    Properties

    Property Type Description
    label string
    selection string

    Home > @acoustic-content-sdk/api > OptionSelectionElement

    OptionSelectionElement interface

    Common base class for all options election elements

    Signature:

    export interface OptionSelectionElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'optionselection'

    Home > @acoustic-content-sdk/api > PageSearchResult

    PageSearchResult interface

    Signature:

    export interface PageSearchResult extends SearchResult<SitePage> 

    Properties

    Property Type Description
    document SitePage

    Home > @acoustic-content-sdk/api > ProductElement

    ProductElement interface

    Signature:

    export interface ProductElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'product'

    Home > @acoustic-content-sdk/api > Query

    Query interface

    Signature:

    export interface Query 

    Home > @acoustic-content-sdk/api > ReferenceElement

    ReferenceElement interface

    Common base class for all reference elements

    Signature:

    export interface ReferenceElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'reference'

    Home > @acoustic-content-sdk/api > RenderingContext

    RenderingContext interface

    Signature:

    export interface RenderingContext extends ContentItemWithLayout 

    Properties

    Property Type Description
    category ElementMap<CategoryElement>
    context ExtendedContext
    datetime ElementMap<Date>
    datetimes ElementMap<Date[]>
    file ElementMap<SingleFileElement>
    files ElementMap<File[]>
    formattedtext ElementMap<string>
    formattedtexts ElementMap<string[]>
    group ElementMap<any>
    groups ElementMap<any[]>
    image ElementMap<SingleImageElement>
    images ElementMap<Image[]>
    link ElementMap<SingleLinkElement>
    links ElementMap<Link[]>
    location ElementMap<LocationElement>
    markups ElementMap<string>
    number ElementMap<number>
    numbers ElementMap<number[]>
    optionselection ElementMap<OptionSelection>
    optionselections ElementMap<OptionSelection[]>
    product ElementMap<string> typings
    products ElementMap<string[]>
    reference ElementMap<RenderingContext>
    references ElementMap<RenderingContext[]>
    text ElementMap<string>
    texts ElementMap<string[]>
    toggle ElementMap<boolean>
    toggles ElementMap<boolean[]>
    video ElementMap<SingleVideoElement>
    videos ElementMap<Video[]>

    Home > @acoustic-content-sdk/api > RenderingContextGroupElement

    RenderingContextGroupElement interface

    Signature:

    export interface RenderingContextGroupElement extends DeliveryGroupElement, ElementWithMarkup 

    Home > @acoustic-content-sdk/api > RenderingContextInterceptor

    RenderingContextInterceptor interface

    Interceptor that can expose transforms for the rendering contexts.

    Signature:

    export interface RenderingContextInterceptor 

    Properties

    Property Type Description
    opRenderingContext MonoTypeOperatorFunction<RenderingContext> operator to intercept a single rendering context
    opRenderingContexts MonoTypeOperatorFunction<RenderingContext[]> operator to intercept a multiple rendering contexts

    Home > @acoustic-content-sdk/api > RenderingContextProvider

    RenderingContextProvider interface

    Signature:

    export interface RenderingContextProvider 

    Properties

    Property Type Description
    onRenderingContext Observable<RenderingContext> Retrieves the rendering context for the content item.

    Home > @acoustic-content-sdk/api > RenderingContextProviderV2

    RenderingContextProviderV2 interface

    Signature:

    export interface RenderingContextProviderV2 

    Properties

    Property Type Description
    renderingContext$ Observable<RenderingContextV2> Retrieves the rendering context for the content item.

    Home > @acoustic-content-sdk/api > RenderingContextQueryResult

    RenderingContextQueryResult interface

    Signature:

    export interface RenderingContextQueryResult 

    Properties

    Property Type Description
    numFound number
    renderingContexts RenderingContext[]

    Home > @acoustic-content-sdk/api > RenderingContextReferenceElement

    RenderingContextReferenceElement interface

    Signature:

    export interface RenderingContextReferenceElement extends DeliveryReferenceElement, ElementWithMarkup 

    Home > @acoustic-content-sdk/api > RenderingContextSearchResult

    RenderingContextSearchResult interface

    Signature:

    export interface RenderingContextSearchResult extends SearchResult<RenderingContext> 

    Properties

    Property Type Description
    document RenderingContext

    Home > @acoustic-content-sdk/api > RenderingContextV2

    RenderingContextV2 interface

    Signature:

    export interface RenderingContextV2 extends DeliveryContentItem 

    Properties

    Property Type Description
    $context ExtendedContextV2 Rendering context

    Home > @acoustic-content-sdk/api > Rendition

    Rendition interface

    Signature:

    export interface Rendition 

    Properties

    Property Type Description
    height number
    renditionId string
    source string
    transform any
    url string added by delivery
    width number

    Home > @acoustic-content-sdk/api > Resource

    Resource interface

    Signature:

    export interface Resource 

    Properties

    Property Type Description
    fileName string
    resourceId string
    resourceUri string

    Home > @acoustic-content-sdk/api > SdkActiveRouteEvent

    SdkActiveRouteEvent interface

    Signature:

    export interface SdkActiveRouteEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    page DeliveryContentItem the page
    type 'WchSdk.router.activeRoute' the event type

    Home > @acoustic-content-sdk/api > SdkErrorResponse

    SdkErrorResponse interface

    Response sent when processing a message fails

    Signature:

    export interface SdkErrorResponse extends SdkMessagePayload 

    Properties

    Property Type Description
    error any potential error

    Home > @acoustic-content-sdk/api > SdkMessageHandler

    SdkMessageHandler interface

    Signature:

    export interface SdkMessageHandler 

    Properties

    Property Type Description
    handle SdkMessageHandlerCallback

    Home > @acoustic-content-sdk/api > SdkMessagePayload

    SdkMessagePayload interface

    Base interfaces for events that can be sent to the SDK

    Signature:

    export interface SdkMessagePayload 

    Properties

    Property Type Description
    id string event identifier, identifying a potential response
    type string the event type

    Home > @acoustic-content-sdk/api > SdkModeEvent

    SdkModeEvent interface

    Signature:

    export interface SdkModeEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    mode SdkMode the mode
    type typeof SDK_MODE_EVENT_TYPE the event type

    Home > @acoustic-content-sdk/api > SdkNavigateByPathEvent

    SdkNavigateByPathEvent interface

    Signature:

    export interface SdkNavigateByPathEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    path string path to navigate to
    type 'WchSdk.router.navigateByPath' the event type

    Home > @acoustic-content-sdk/api > SdkNavigateByPathResponse

    SdkNavigateByPathResponse interface

    Response to the navigation event

    Signature:

    export interface SdkNavigateByPathResponse extends SdkMessagePayload 

    Properties

    Property Type Description
    error any potential error
    path string path navigated to
    success boolean success of the operation

    Home > @acoustic-content-sdk/api > SdkRefreshEvent

    SdkRefreshEvent interface

    Signature:

    export interface SdkRefreshEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    type 'WchSdk.refresh' the event type

    Home > @acoustic-content-sdk/api > SdkRouteEvent

    SdkRouteEvent interface

    Signature:

    export interface SdkRouteEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    page DeliveryContentItem the page
    route string the route to subscribe to
    type 'WchSdk.router.route' the event type

    Home > @acoustic-content-sdk/api > SdkSetModeEvent

    SdkSetModeEvent interface

    Signature:

    export interface SdkSetModeEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    mode SdkMode mode to set
    type 'WchSdk.setMode' the event type

    Home > @acoustic-content-sdk/api > SdkSetModeResponse

    SdkSetModeResponse interface

    Response to the set mode event

    Signature:

    export interface SdkSetModeResponse extends SdkMessagePayload 

    Properties

    Property Type Description
    error any potential error
    mode SdkMode mode set

    Home > @acoustic-content-sdk/api > SdkSubscribeActiveRouteEvent

    SdkSubscribeActiveRouteEvent interface

    Signature:

    export interface SdkSubscribeActiveRouteEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    type 'WchSdk.router.activeRoute.subscribe' the event type

    Home > @acoustic-content-sdk/api > SdkSubscribeActiveRouteEventResponse

    SdkSubscribeActiveRouteEventResponse interface

    Signature:

    export interface SdkSubscribeActiveRouteEventResponse extends SdkSubscribeEventResponse 

    Home > @acoustic-content-sdk/api > SdkSubscribeEventResponse

    SdkSubscribeEventResponse interface

    Response to a subscription

    Signature:

    export interface SdkSubscribeEventResponse extends SdkMessagePayload 

    Properties

    Property Type Description
    handle string handle, unsubscribe using this handle

    Home > @acoustic-content-sdk/api > SdkSubscribeModeEvent

    SdkSubscribeModeEvent interface

    Signature:

    export interface SdkSubscribeModeEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    type typeof SDK_SUBSCRIBE_MODE_EVENT_TYPE the event type

    Home > @acoustic-content-sdk/api > SdkSubscribeModeEventResponse

    SdkSubscribeModeEventResponse interface

    Signature:

    export interface SdkSubscribeModeEventResponse extends SdkSubscribeEventResponse 

    Home > @acoustic-content-sdk/api > SdkSubscribeRouteEvent

    SdkSubscribeRouteEvent interface

    Signature:

    export interface SdkSubscribeRouteEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    route string | string[] The desired route. If the route is a string, then it is the ESCAPED path. If it is a string array, then each array element contains the UNESCAPED path segment
    type 'WchSdk.router.route.subscribe' the event type

    Home > @acoustic-content-sdk/api > SdkSubscribeRouteEventResponse

    SdkSubscribeRouteEventResponse interface

    Signature:

    export interface SdkSubscribeRouteEventResponse extends SdkSubscribeEventResponse 

    Home > @acoustic-content-sdk/api > SdkUnsubscribeEvent

    SdkUnsubscribeEvent interface

    Signature:

    export interface SdkUnsubscribeEvent extends SdkMessagePayload 

    Properties

    Property Type Description
    handle string handle to unsubscribe on
    type 'WchSdk.unsubscribe' the event type

    Home > @acoustic-content-sdk/api > SearchResult

    SearchResult interface

    Signature:

    export interface SearchResult<T> 

    Properties

    Property Type Description
    document T

    Home > @acoustic-content-sdk/api > SearchResults

    SearchResults interface

    Signature:

    export interface SearchResults<T> 

    Properties

    Property Type Description
    documents T[]
    numFound number

    Home > @acoustic-content-sdk/api > SingleDateElement

    SingleDateElement interface

    Date element uses a string property, the value must be an ISO 8601 date time.

    Signature:

    export interface SingleDateElement extends DateElement 

    Properties

    Property Type Description
    value string

    Home > @acoustic-content-sdk/api > SingleFileElement

    SingleFileElement interface

    File element is the most basic asset reference element. It is a reference element that is used to point to an asset in content hub. Except for asset ID, all the other properties are read-only and are added from the asset at the time it is selected on a content.

    With asset references most of the properties are read-only and come from the asset. So when you set a file on file element you need to set the asset.id property. The other information is fetched automatically by the content service and stored in read-only fields.

    Signature:

    export interface SingleFileElement extends FileElement, File 

    Home > @acoustic-content-sdk/api > SingleFormattedTextElement

    SingleFormattedTextElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface SingleFormattedTextElement extends FormattedTextElement 

    Properties

    Property Type Description
    value string

    Home > @acoustic-content-sdk/api > SingleGroupElement

    SingleGroupElement interface

    The text element holds group value in a JSON string.

    Signature:

    export interface SingleGroupElement extends GroupElement 

    Properties

    Property Type Description
    value Group

    Home > @acoustic-content-sdk/api > SingleImageElement

    SingleImageElement interface

    Image is one of the more complex elements and the following section describes a normal image without an image profile configured. For information on updating and formatting the image element, go to Updating image element format.

    Note: You are always selecting a rendition of an asset and not the asset directly. As a result interactions with image elements involve setting and updating a rendition reference. Most other fields that are displayed in image element are read only!

    Signature:

    export interface SingleImageElement extends ImageElement, Image 

    Home > @acoustic-content-sdk/api > SingleLinkElement

    SingleLinkElement interface

    Link element has three text fields linkURL, linkText, and linkDescription.

    Signature:

    export interface SingleLinkElement extends LinkElement, Link 

    Home > @acoustic-content-sdk/api > SingleNumberElement

    SingleNumberElement interface

    The Number element stores the value in the JSON as a number type.

    Signature:

    export interface SingleNumberElement extends NumberElement 

    Properties

    Property Type Description
    value number

    Home > @acoustic-content-sdk/api > SingleOptionSelectionElement

    SingleOptionSelectionElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface SingleOptionSelectionElement extends OptionSelectionElement 

    Properties

    Property Type Description
    value OptionSelection

    Home > @acoustic-content-sdk/api > SingleProductElement

    SingleProductElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface SingleProductElement extends ProductElement 

    Properties

    Property Type Description
    value string

    Home > @acoustic-content-sdk/api > SingleReferenceElement

    SingleReferenceElement interface

    Signature:

    export interface SingleReferenceElement extends ReferenceElement 

    Properties

    Property Type Description
    value RenderingContext

    Home > @acoustic-content-sdk/api > SingleTextElement

    SingleTextElement interface

    The text element holds text value in a JSON string.

    Signature:

    export interface SingleTextElement extends TextElement 

    Properties

    Property Type Description
    value string

    Home > @acoustic-content-sdk/api > SingleToggleElement

    SingleToggleElement interface

    Toggle just uses JSON Boolean.

    Signature:

    export interface SingleToggleElement extends ToggleElement 

    Properties

    Property Type Description
    value boolean

    Home > @acoustic-content-sdk/api > SingleVideoElement

    SingleVideoElement interface

    Standard video element is similar to the file element. The video asset is represented in the asset section. Optionally a video asset can have a caption and a thumbnail as well, and in this case both of these point two resources in content hub. As mentioned with file, most of the properties here are inlined data from the asset/resource and is read-only. To update a video asset or its caption/thumbnail update the relevant asset/resource ID. The related information is retrieved again and added. Attempts to change the read-only fields are ignored.

    Signature:

    export interface SingleVideoElement extends VideoElement, Video 

    Home > @acoustic-content-sdk/api > Site

    Site interface

    Signature:

    export interface Site extends SiteRoot 

    Properties

    Property Type Description
    id string
    name string
    pages SiteChild[]

    Home > @acoustic-content-sdk/api > SiteChild

    SiteChild interface

    Signature:

    export interface SiteChild extends SitePage 

    Properties

    Property Type Description
    children SiteChild[]

    Home > @acoustic-content-sdk/api > SiteContext

    SiteContext interface

    Signature:

    export interface SiteContext 

    Properties

    Property Type Description
    breadcrumb SitePage[]
    children SitePage[]
    parent SitePage
    sibling SitePage[]
    site Site

    Home > @acoustic-content-sdk/api > SiteDeliveryContentItem

    SiteDeliveryContentItem interface

    Signature:

    export interface SiteDeliveryContentItem 

    Properties

    Property Type Description
    $metadata DeliveryContentMetadata Metadata record
    navigation DeliveryReferenceElement Navigation reference
    styles DeliveryReferenceElement Styles reference
    title string Title

    Home > @acoustic-content-sdk/api > SiteNavigationDeliveryContentItem

    SiteNavigationDeliveryContentItem interface

    Delivery record for the site content item

    843fb991-7413-4517-bfcb-b59fc4b1f449

    Signature:

    export interface SiteNavigationDeliveryContentItem 

    Properties

    Property Type Description
    $metadata DeliveryContentMetadata Metadata record
    defaultPage string Default page
    tree string JSON tree. The content is a serialization of SiteNavigation

    Home > @acoustic-content-sdk/api > SiteNavigationPage

    SiteNavigationPage interface

    Reference to a page in the site navigation

    Signature:

    export interface SiteNavigationPage 

    Properties

    Property Type Description
    children SiteNavigationPage[] Optionally, the navigation children of the page
    id string ID of the referenced page

    Home > @acoustic-content-sdk/api > SitePage

    SitePage interface

    Signature:

    export interface SitePage extends BaseDeliveryItem 

    Properties

    Property Type Description
    contentId string
    contentStatus string
    contentTypeId string
    decodedRoute string
    description string
    externalContext any
    hideFromNavigation boolean
    id string
    name string
    parentId string
    route string
    title string

    Home > @acoustic-content-sdk/api > SitePagesQueryResult

    SitePagesQueryResult interface

    Signature:

    export interface SitePagesQueryResult 

    Properties

    Property Type Description
    numFound number
    sitePages SitePage[]

    Home > @acoustic-content-sdk/api > SiteRoot

    SiteRoot interface

    Signature:

    export interface SiteRoot 

    Home > @acoustic-content-sdk/api > Tenant

    Tenant interface

    Signature:

    export interface Tenant 

    Properties

    Property Type Description
    _id string DEPRECATED - read-only - UUID of the domain. Use 'id' instead of _id
    capability string indicates the capabilities supported by a tenant
    corsWhitelist string[]
    defaultContentLocale string The default locale for content
    deliveryAccess DeliveryAccess
    ibmCommerce IbmCommerce
    ibmUniqueId string
    id string read-only - UUID of the domain
    isDAMEnabled boolean
    isEdgeSideEnabled boolean
    locale string The locale the UI is shown in
    locked boolean set to true if the tenant is 'locked' and should not have access to the system
    mandatoryAssetPublishApproval AssetPublishApproval
    mandatoryContentPublishApproval ContentPublishApproval
    maxAuthors number
    maxBulkUploadSize number
    maxContentItems number Max content items the tenant can have based on plan purchased
    maxDataTransfer number Max amount of data transfer the tenant has per month, based on plan purchased
    maxStorageSize number Max amount of storage the tenant has, based on plan purchased
    maxUploadSize number Max upload size - should apply to files/images/audio/video unless useSingleUploadSize is false in which case the individual max uploads apply
    maxUploadSizeFiles number Max upload size for files (if useSingleUploadSize is false)
    maxUploadSizeImage number Max upload size for images (if useSingleUploadSize is false)
    maxUploadSizeVideo number Max upload size for videos (if useSingleUploadSize is false)
    maxUserSessions number Max number of User sessions
    name string
    tier TENANT_TIER Which tier of the product the tenant has purchased, set by sbs-provisioning to one of these values; Trial, Base, Standard, Plus
    useSingleUploadSize boolean Use the maxUploadSize to cover all uploads or use the individual max upload sizes
    watsonConfidenceLevel number

    Home > @acoustic-content-sdk/api > TextElement

    TextElement interface

    Common base class for all text elements

    Signature:

    export interface TextElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'text'

    Home > @acoustic-content-sdk/api > ToggleElement

    ToggleElement interface

    Common base class for all toggle elements

    Signature:

    export interface ToggleElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'toggle'

    Home > @acoustic-content-sdk/api > TypeRef

    TypeRef interface

    Reference to a content type

    Signature:

    export interface TypeRef 

    Properties

    Property Type Description
    description string
    id string
    name string

    Home > @acoustic-content-sdk/api > UrlConfig

    UrlConfig interface

    Exposes the URL configuration to the client.

    See HubInfoConfig

    Signature:

    export interface UrlConfig extends HubInfo 

    Properties

    Property Type Description
    apiUrl URL The base URL used to access WCH APIs. The URL ends with a slash.
    baseUrl URL The base URL of the host the application is running on. This can be undefined if the application is rendered standalone as part of the universal renderer. This prefix will be preserved when generating and recognizing URLs.In many cases it is identical to the resourceUrl, but it will e.g. be different for applications that are not hosted on WCH.
    isPreviewMode boolean True if the system runs in preview mode, else false.
    resourceUrl URL The base URL used to access WCH delivery resources. The URL ends with a slash.

    Home > @acoustic-content-sdk/api > User

    User interface

    Representation of a user

    Signature:

    export interface User 

    Properties

    Property Type Description
    created string Date when this item was created
    creator string
    displayName string The name of the user that can be displayed in the UI
    externalId string The unique external identifier of the user (e.g. BlueID). Although, this field can store email addresses, other types of unique identifiers may be stored too. Do not use this field as a replacement for the user attribute email address.
    firstName string The first name of the user
    id string The unique internal identifier of the user
    lastLogin string Date when this user logged in for the last time before current session
    lastModified string Date when this item was modified for the last time
    lastModifier string
    lastName string The last name of the user
    roles string[] The roles of the user that will be used for access control (empty for the anonymous user)

    Home > @acoustic-content-sdk/api > Video

    Video interface

    Signature:

    export interface Video 

    Properties

    Property Type Description
    asset Asset
    caption Resource
    thumbnail Resource
    url string

    Home > @acoustic-content-sdk/api > VideoElement

    VideoElement interface

    Common base class for all video elements

    Signature:

    export interface VideoElement extends AbstractElement 

    Properties

    Property Type Description
    elementType 'video'

    Home > @acoustic-content-sdk/api > WchHttp

    WchHttp interface

    Signature:

    export interface WchHttp 

    Properties

    Property Type Description
    getJsonResource <T>(aUrl: string, aOptions?: HttpResourceOptions) => Observable<T> Fetches a JSON resource and keeps this live based on the given or the default options$1$2 -$3
    getTextResource (aUrl: string, aOptions?: HttpResourceOptions) => Observable<string> Fetches a string resource and keeps this live based on the given or the default options$1$2 -$3

    Home > @acoustic-content-sdk/api > WchSdk

    WchSdk interface

    Signature:

    export interface WchSdk 

    Properties

    Property Type Description
    logger LoggerService Returns a factory to access loggers
    refresh () => void Refreshes the rendering context and all JSON data that is currently displayed
    router WchSdkRouter
    search WchSdkSearch Optional search service
    version WchSdkVersion Returns version information from the SDK

    Home > @acoustic-content-sdk/api > WchSdkRouter

    WchSdkRouter interface

    Signature:

    export interface WchSdkRouter 

    Properties

    Property Type Description
    activeRenderingContext () => Observable<RenderingContext> Returns an observable that represents the active rendering context
    activeRoute () => Observable<SitePage> Returns an observable that represents the active route
    navigateByPath (aPath: string) => PromiseLike<boolean> public APIs

    Home > @acoustic-content-sdk/api > WchSdkSearch

    WchSdkSearch interface

    Signature:

    export interface WchSdkSearch 

    Properties

    Property Type Description
    getRenderingContextById (aId: string, aLevels?: number) => Observable<RenderingContext> Locates the rendering context identified by the ID$1$2 -$3 $1$2 -$3
    getRenderingContexts (aValue: QueryInput, aLevels?: number) => Observable<RenderingContextQueryResult> Locates all rendering contexts that match a particular query. It is not necessary to add the classification to the query, it will automatically only apply to content for the current site$1$2 -$3 $1$2 -$3
    getSitePages (aValue: QueryInput) => Observable<SitePagesQueryResult> Locates all pages that match a particular query. It is not necessary to add the classification to the query, it will automatically only apply to pages for the current site$1$2 -$3

    Home > @acoustic-content-sdk/api > WchSdkVersion

    WchSdkVersion interface

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

    Signature:

    export interface WchSdkVersion 

    Properties

    Property Type Description
    build Date build data of the SDK
    version {
    readonly major: string;
    readonly minor: string;
    readonly patch: string;
    }
    version number of the SDK

    Home > @acoustic-content-sdk/api > ACOUSTIC_CONFIG_API_URL

    ACOUSTIC_CONFIG_API_URL variable

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

    Signature:

    ACOUSTIC_CONFIG_API_URL = "wch-config-api-url"

    Home > @acoustic-content-sdk/api > ACOUSTIC_CONFIG_BASE_URL

    ACOUSTIC_CONFIG_BASE_URL variable

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

    Signature:

    ACOUSTIC_CONFIG_BASE_URL = "wch-config-base-url"

    Home > @acoustic-content-sdk/api > ACOUSTIC_CONFIG_RESOURCE_URL

    ACOUSTIC_CONFIG_RESOURCE_URL variable

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

    Signature:

    ACOUSTIC_CONFIG_RESOURCE_URL = "wch-config-resource-url"

    Home > @acoustic-content-sdk/api > ACOUSTIC_SDK_MODULE_NAME

    ACOUSTIC_SDK_MODULE_NAME variable

    Signature:

    ACOUSTIC_SDK_MODULE_NAME = "WchSdk"

    Home > @acoustic-content-sdk/api > CLASSIFICATION_ASSET

    CLASSIFICATION_ASSET variable

    Signature:

    CLASSIFICATION_ASSET = "asset"

    Home > @acoustic-content-sdk/api > CLASSIFICATION_CONTENT_TYPE

    CLASSIFICATION_CONTENT_TYPE variable

    Signature:

    CLASSIFICATION_CONTENT_TYPE = "content-type"

    Home > @acoustic-content-sdk/api > CLASSIFICATION_CONTENT

    CLASSIFICATION_CONTENT variable

    Signature:

    CLASSIFICATION_CONTENT = "content"

    Home > @acoustic-content-sdk/api > CLASSIFICATION_LAYOUT_MAPPING

    CLASSIFICATION_LAYOUT_MAPPING variable

    Signature:

    CLASSIFICATION_LAYOUT_MAPPING = "layout-mapping"

    Home > @acoustic-content-sdk/api > CLASSIFICATION_LAYOUT

    CLASSIFICATION_LAYOUT variable

    Signature:

    CLASSIFICATION_LAYOUT = "layout"

    Home > @acoustic-content-sdk/api > CLASSIFICATION_PAGE

    CLASSIFICATION_PAGE variable

    Signature:

    CLASSIFICATION_PAGE = "page"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_CATEGORY

    ELEMENT_TYPE_CATEGORY variable

    Signature:

    _ELEMENT_TYPE_CATEGORY = "category"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_DATE

    ELEMENT_TYPE_DATE variable

    Signature:

    _ELEMENT_TYPE_DATE = "datetime"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_FILE

    ELEMENT_TYPE_FILE variable

    Signature:

    _ELEMENT_TYPE_FILE = "file"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_FORMATTED_TEXT

    ELEMENT_TYPE_FORMATTED_TEXT variable

    Signature:

    _ELEMENT_TYPE_FORMATTED_TEXT = "formattedtext"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_GROUP

    ELEMENT_TYPE_GROUP variable

    Signature:

    _ELEMENT_TYPE_GROUP = "group"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_IMAGE

    ELEMENT_TYPE_IMAGE variable

    Signature:

    _ELEMENT_TYPE_IMAGE = "image"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_LINK

    ELEMENT_TYPE_LINK variable

    Signature:

    _ELEMENT_TYPE_LINK = "link"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_LOCATION

    ELEMENT_TYPE_LOCATION variable

    Signature:

    _ELEMENT_TYPE_LOCATION = "location"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_NUMBER

    ELEMENT_TYPE_NUMBER variable

    Signature:

    _ELEMENT_TYPE_NUMBER = "number"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_OPTION_SELECTION

    ELEMENT_TYPE_OPTION_SELECTION variable

    Signature:

    _ELEMENT_TYPE_OPTION_SELECTION = "optionselection"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_PRODUCT

    ELEMENT_TYPE_PRODUCT variable

    Signature:

    _ELEMENT_TYPE_PRODUCT = "product"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_REFERENCE

    ELEMENT_TYPE_REFERENCE variable

    Signature:

    _ELEMENT_TYPE_REFERENCE = "reference"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_TEXT

    ELEMENT_TYPE_TEXT variable

    Signature:

    _ELEMENT_TYPE_TEXT = "text"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_TOGGLE

    ELEMENT_TYPE_TOGGLE variable

    Signature:

    _ELEMENT_TYPE_TOGGLE = "toggle"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_VARIABLE

    ELEMENT_TYPE_VARIABLE variable

    Signature:

    _ELEMENT_TYPE_VARIABLE = "variabletype"

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE_VIDEO

    ELEMENT_TYPE_VIDEO variable

    Signature:

    _ELEMENT_TYPE_VIDEO = "video"

    Home > @acoustic-content-sdk/api > HEADER_BASICAUTH_TENANT_ID

    HEADER_BASICAUTH_TENANT_ID variable

    Signature:

    HEADER_BASICAUTH_TENANT_ID = "x-ibm-dx-tenant-id"

    Home > @acoustic-content-sdk/api > KEY_ACCEPT_PRIVACY_NOTICE

    KEY_ACCEPT_PRIVACY_NOTICE variable

    Signature:

    KEY_ACCEPT_PRIVACY_NOTICE = "accept-privacy-notice"

    Home > @acoustic-content-sdk/api > KEY_ACCESSOR

    KEY_ACCESSOR variable

    Signature:

    KEY_ACCESSOR = "accessor"

    Home > @acoustic-content-sdk/api > KEY_ACOUSTIC_SEED

    KEY_ACOUSTIC_SEED variable

    Signature:

    KEY_ACOUSTIC_SEED = "-wch-seed"

    Home > @acoustic-content-sdk/api > KEY_BASICAUTH_LOGIN_PASSWORD

    KEY_BASICAUTH_LOGIN_PASSWORD variable

    Signature:

    KEY_BASICAUTH_LOGIN_PASSWORD = "j_password"

    Home > @acoustic-content-sdk/api > KEY_BASICAUTH_LOGIN_USERNAME

    KEY_BASICAUTH_LOGIN_USERNAME variable

    Signature:

    KEY_BASICAUTH_LOGIN_USERNAME = "j_username"

    Home > @acoustic-content-sdk/api > KEY_CREATOR_ID

    KEY_CREATOR_ID variable

    Signature:

    KEY_CREATOR_ID = "creatorId"

    Home > @acoustic-content-sdk/api > KEY_ELEMENT_TYPE

    KEY_ELEMENT_TYPE variable

    Signature:

    KEY_ELEMENT_TYPE = "elementType"

    Home > @acoustic-content-sdk/api > KEY_ID

    KEY_ID variable

    Signature:

    KEY_ID = "id"

    Home > @acoustic-content-sdk/api > KEY_METADATA

    KEY_METADATA variable

    Signature:

    KEY_METADATA: keyof DeliveryReferenceElement

    Home > @acoustic-content-sdk/api > KEY_NAME

    KEY_NAME variable

    Signature:

    KEY_NAME = "name"

    Home > @acoustic-content-sdk/api > KEY_STATUS

    KEY_STATUS variable

    Signature:

    KEY_STATUS = "status"

    Home > @acoustic-content-sdk/api > KEY_TYPE_ID

    KEY_TYPE_ID variable

    Signature:

    KEY_TYPE_ID = "typeId"

    Home > @acoustic-content-sdk/api > KEY_TYPE_REF

    KEY_TYPE_REF variable

    Signature:

    KEY_TYPE_REF = "typeRef"

    Home > @acoustic-content-sdk/api > KEY_VALUE

    KEY_VALUE variable

    Signature:

    KEY_VALUE = "value"

    Home > @acoustic-content-sdk/api > KEY_VALUES

    KEY_VALUES variable

    Signature:

    KEY_VALUES = "values"

    Home > @acoustic-content-sdk/api > MODULE

    MODULE variable

    Module name

    Signature:

    MODULE = "@acoustic-content-sdk/api"

    Home > @acoustic-content-sdk/api > PARAM_REDIRECT_LOGIN_TARGET_TENANT

    PARAM_REDIRECT_LOGIN_TARGET_TENANT variable

    Signature:

    PARAM_REDIRECT_LOGIN_TARGET_TENANT = "targetTenant"

    Home > @acoustic-content-sdk/api > PARAM_REDIRECT_LOGIN_TARGET_URL

    PARAM_REDIRECT_LOGIN_TARGET_URL variable

    Signature:

    PARAM_REDIRECT_LOGIN_TARGET_URL = "targetUrl"

    Home > @acoustic-content-sdk/api > REGEXP_ANONYMOUS_USER_ID

    REGEXP_ANONYMOUS_USER_ID variable

    Signature:

    REGEXP_ANONYMOUS_USER_ID: RegExp

    Home > @acoustic-content-sdk/api > REL_PATH_BASICAUTH_LOGIN

    REL_PATH_BASICAUTH_LOGIN variable

    Signature:

    REL_PATH_BASICAUTH_LOGIN = "login/v1/basicauth"

    Home > @acoustic-content-sdk/api > REL_PATH_CURRENT_TENANT

    REL_PATH_CURRENT_TENANT variable

    Signature:

    REL_PATH_CURRENT_TENANT = "registry/v1/currenttenant"

    Home > @acoustic-content-sdk/api > REL_PATH_CURRENT_USER

    REL_PATH_CURRENT_USER variable

    Signature:

    REL_PATH_CURRENT_USER = "user-profile/v1/users/currentuser"

    Home > @acoustic-content-sdk/api > REL_PATH_REDIRECT_LOGIN

    REL_PATH_REDIRECT_LOGIN variable

    Signature:

    REL_PATH_REDIRECT_LOGIN = "login/v1/redirect"

    Home > @acoustic-content-sdk/api > REL_PATH_REMOVECOOKIES

    REL_PATH_REMOVECOOKIES variable

    Signature:

    REL_PATH_REMOVECOOKIES = "login/v1/removecookies"

    Home > @acoustic-content-sdk/api > REL_PATH_TYPE_BY_ID

    REL_PATH_TYPE_BY_ID variable

    Signature:

    REL_PATH_TYPE_BY_ID = "authoring/v1/types/"

    Home > @acoustic-content-sdk/api > SDK_ACTIVE_ROUTE_EVENT_TYPE

    SDK_ACTIVE_ROUTE_EVENT_TYPE variable

    Event sent to denote a modification of the active route

    Signature:

    SDK_ACTIVE_ROUTE_EVENT_TYPE = "WchSdk.router.activeRoute"

    Home > @acoustic-content-sdk/api > SDK_MODE_EVENT_TYPE

    SDK_MODE_EVENT_TYPE variable

    Event sent to denote the active mode

    Signature:

    SDK_MODE_EVENT_TYPE = "WchSdk.mode"

    Home > @acoustic-content-sdk/api > SDK_NAVIGATE_BY_PATH_EVENT_TYPE

    SDK_NAVIGATE_BY_PATH_EVENT_TYPE variable

    Event that triggers a navigation

    Signature:

    SDK_NAVIGATE_BY_PATH_EVENT_TYPE = "WchSdk.router.navigateByPath"

    Home > @acoustic-content-sdk/api > SDK_REFRESH_EVENT_TYPE

    SDK_REFRESH_EVENT_TYPE variable

    Event that triggers a refresh

    Signature:

    SDK_REFRESH_EVENT_TYPE = "WchSdk.refresh"

    Home > @acoustic-content-sdk/api > SDK_ROUTE_EVENT_TYPE

    SDK_ROUTE_EVENT_TYPE variable

    Event sent to denote a modification of the route

    Signature:

    SDK_ROUTE_EVENT_TYPE = "WchSdk.router.route"

    Home > @acoustic-content-sdk/api > SDK_SET_MODE_EVENT_TYPE

    SDK_SET_MODE_EVENT_TYPE variable

    Event that modifies the SDK mode between using public or private routes

    Signature:

    SDK_SET_MODE_EVENT_TYPE = "WchSdk.setMode"

    Home > @acoustic-content-sdk/api > SDK_SUBSCRIBE_ACTIVE_ROUTE_EVENT_TYPE

    SDK_SUBSCRIBE_ACTIVE_ROUTE_EVENT_TYPE variable

    Event that subscribes a listener for an active route

    Signature:

    SDK_SUBSCRIBE_ACTIVE_ROUTE_EVENT_TYPE = "WchSdk.router.activeRoute.subscribe"

    Home > @acoustic-content-sdk/api > SDK_SUBSCRIBE_MODE_EVENT_TYPE

    SDK_SUBSCRIBE_MODE_EVENT_TYPE variable

    Event that subscribes a listener for modes

    Signature:

    SDK_SUBSCRIBE_MODE_EVENT_TYPE = "WchSdk.mode.subscribe"

    Home > @acoustic-content-sdk/api > SDK_SUBSCRIBE_ROUTE_EVENT_TYPE

    SDK_SUBSCRIBE_ROUTE_EVENT_TYPE variable

    Event that subscribes a listener for a specific route

    Signature:

    SDK_SUBSCRIBE_ROUTE_EVENT_TYPE = "WchSdk.router.route.subscribe"

    Home > @acoustic-content-sdk/api > SDK_UNSUBSCRIBE_EVENT_TYPE

    SDK_UNSUBSCRIBE_EVENT_TYPE variable

    Event that unsubscribes a listener

    Signature:

    SDK_UNSUBSCRIBE_EVENT_TYPE = "WchSdk.unsubscribe"

    Home > @acoustic-content-sdk/api > SEARCH_FL_DOCUMENT

    SEARCH_FL_DOCUMENT variable

    Constant to get the full document from the search result

    Signature:

    SEARCH_FL_DOCUMENT = "document:[json]"

    Home > @acoustic-content-sdk/api > VALUE_ACCEPT_PRIVACY_NOTICE

    VALUE_ACCEPT_PRIVACY_NOTICE variable

    Signature:

    VALUE_ACCEPT_PRIVACY_NOTICE = "true"

    Home > @acoustic-content-sdk/api > VERSION

    VERSION variable

    Version and build number of the package

    Signature:

    VERSION: {
        version: {
            major: string;
            minor: string;
            patch: string;
            branch: string;
        };
        build: Date;
    }

    Home > @acoustic-content-sdk/api > AUTHORING_CONTENT_ITEM_KIND

    AUTHORING_CONTENT_ITEM_KIND type

    Signature:

    export declare type AUTHORING_CONTENT_ITEM_KIND = 'page' | 'landing-page' | 'catalog-page' | 'email' | 'sample';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_DATETIME_SEARCH_KEY

    AUTHORING_ELEMENT_DATETIME_SEARCH_KEY type

    Signature:

    export declare type AUTHORING_ELEMENT_DATETIME_SEARCH_KEY = 'date1' | 'date2' | 'sortableDate1' | 'sortableDate2';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_FILE_TYPE

    AUTHORING_ELEMENT_FILE_TYPE type

    Signature:

    export declare type AUTHORING_ELEMENT_FILE_TYPE = 'plain-text' | 'presentation' | 'rich-document' | 'spreadsheet' | 'pdf-document';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_IMAGE_TYPE

    AUTHORING_ELEMENT_IMAGE_TYPE type

    Signature:

    export declare type AUTHORING_ELEMENT_IMAGE_TYPE = 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_LOCATION_SEARCH_KEY

    AUTHORING_ELEMENT_LOCATION_SEARCH_KEY type

    Signature:

    export declare type AUTHORING_ELEMENT_LOCATION_SEARCH_KEY = 'location1';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_NUMBER_SEARCH_KEY

    AUTHORING_ELEMENT_NUMBER_SEARCH_KEY type

    Signature:

    export declare type AUTHORING_ELEMENT_NUMBER_SEARCH_KEY = 'number1' | 'number2' | 'sortableNumber1' | 'sortableNumber2';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_ROLE

    AUTHORING_ELEMENT_ROLE type

    Signature:

    export declare type AUTHORING_ELEMENT_ROLE = 'content' | 'configuration';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_TEXT_SEARCH_KEY

    AUTHORING_ELEMENT_TEXT_SEARCH_KEY type

    Signature:

    export declare type AUTHORING_ELEMENT_TEXT_SEARCH_KEY = 'string1' | 'string2' | 'string3' | 'string4' | 'sortableString1' | 'sortableString2' | 'sortableString3' | 'sortableString4';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY

    AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY type

    Signature:

    export declare type AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY = 'boolean1' | 'boolean2';

    Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_VIDEO_TYPE

    AUTHORING_ELEMENT_VIDEO_TYPE type

    Signature:

    export declare type AUTHORING_ELEMENT_VIDEO_TYPE = 'mp4' | 'mov';

    Home > @acoustic-content-sdk/api > AUTHORING_TYPE_KIND

    AUTHORING_TYPE_KIND type

    Possible values kind

    Signature:

    export declare type AUTHORING_TYPE_KIND = 'standalone' | 'page' | 'embedded' | 'landing-page' | 'catalog-page' | 'custom-ui' | 'email';

    Home > @acoustic-content-sdk/api > CONTENT_ITEM_KIND

    CONTENT_ITEM_KIND type

    Signature:

    export declare type CONTENT_ITEM_KIND = AUTHORING_CONTENT_ITEM_KIND;

    Home > @acoustic-content-sdk/api > DeliveryDateElement

    DeliveryDateElement type

    Signature:

    export declare type DeliveryDateElement = string;

    Home > @acoustic-content-sdk/api > DeliveryElement

    DeliveryElement type

    Signature:

    export declare type DeliveryElement = SingleDeliveryElements | MultiDeliveryElements;

    Home > @acoustic-content-sdk/api > DeliveryFileAsset

    DeliveryFileAsset type

    Signature:

    export declare type DeliveryFileAsset = DeliveryAsset;

    Home > @acoustic-content-sdk/api > DeliveryFormattedTextElement

    DeliveryFormattedTextElement type

    Signature:

    export declare type DeliveryFormattedTextElement = string;

    Home > @acoustic-content-sdk/api > DeliveryImageMode

    DeliveryImageMode type

    Signature:

    export declare type DeliveryImageMode = 'shared' | 'snapshot';

    Home > @acoustic-content-sdk/api > DeliveryImageScale

    DeliveryImageScale type

    Signature:

    export declare type DeliveryImageScale = number;

    Home > @acoustic-content-sdk/api > DeliveryLayout

    DeliveryLayout type

    Signature:

    export declare type DeliveryLayout = AuthoringLayoutItem;

    Home > @acoustic-content-sdk/api > DeliveryLayoutMapping

    DeliveryLayoutMapping type

    Signature:

    export declare type DeliveryLayoutMapping = AuthoringLayoutMapping;

    Home > @acoustic-content-sdk/api > DeliveryNumberElement

    DeliveryNumberElement type

    Signature:

    export declare type DeliveryNumberElement = number;

    Home > @acoustic-content-sdk/api > DeliveryOptionsElement

    DeliveryOptionsElement type

    Signature:

    export declare type DeliveryOptionsElement = string;

    Home > @acoustic-content-sdk/api > DeliverySelectedLayouts

    DeliverySelectedLayouts type

    Signature:

    export declare type DeliverySelectedLayouts = DeliverySelectedLayout[];

    Home > @acoustic-content-sdk/api > DeliveryTextElement

    DeliveryTextElement type

    Signature:

    export declare type DeliveryTextElement = string;

    Home > @acoustic-content-sdk/api > DeliveryToggleElement

    DeliveryToggleElement type

    Signature:

    export declare type DeliveryToggleElement = boolean;

    Home > @acoustic-content-sdk/api > DeliveryType

    DeliveryType type

    Signature:

    export declare type DeliveryType = AuthoringType;

    Home > @acoustic-content-sdk/api > ELEMENT_TYPE

    ELEMENT_TYPE type

    Signature:

    export declare type ELEMENT_TYPE = 'text' | 'number' | 'toggle' | 'formattedtext' | 'link' | 'datetime' | 'file' | 'video' | 'image' | 'reference' | 'category' | 'location' | 'optionselection' | 'group' | 'variabletype' | 'product';

    Home > @acoustic-content-sdk/api > Element

    Element type

    An element is one of the following

    Signature:

    export declare type 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;

    Home > @acoustic-content-sdk/api > GroupType

    GroupType type

    Signature:

    export declare type GroupType = ElementMap<SimpleType>;

    Home > @acoustic-content-sdk/api > HubInfoUrlProvider

    HubInfoUrlProvider type

    Signature:

    export declare type HubInfoUrlProvider = null | undefined | StaticHubInfoUrlProvider | ObservableInput<StaticHubInfoUrlProvider>;

    Home > @acoustic-content-sdk/api > Layouts

    Layouts type

    Ordering of the layouts per layout mode

    Signature:

    export declare type Layouts = Record<string, Layout>;

    Home > @acoustic-content-sdk/api > Locale

    Locale type

    Helper type to identify a locale in the interfaces

    Signature:

    export declare type Locale = string;

    Home > @acoustic-content-sdk/api > Localized

    Localized type

    Object supporting localizations

    Signature:

    export declare type Localized = LocalizedText[];

    Home > @acoustic-content-sdk/api > LocalizedContext

    LocalizedContext type

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

    Signature:

    export declare type LocalizedContext = Record<Locale, number>;

    Home > @acoustic-content-sdk/api > LocalizedText

    LocalizedText type

    Text with attached locale

    Signature:

    export declare type LocalizedText = [string, Locale];

    Home > @acoustic-content-sdk/api > MultiDeliveryElements

    MultiDeliveryElements type

    Signature:

    export declare type MultiDeliveryElements = DeliveryCategoryElement | DeliveryImageElement[] | DeliveryCategoryElement[] | DeliveryLinkElement[] | DeliveryGroupElement[] | DeliveryReferenceElement[] | DeliveryFileElement[] | DeliveryDateElement[] | DeliveryNumberElement[] | DeliveryFormattedTextElement[] | DeliveryTextElement[] | DeliveryToggleElement[] | DeliveryVideoElement[] | DeliveryOptionsElement[];

    Home > @acoustic-content-sdk/api > MultiRenderingContextElements

    MultiRenderingContextElements type

    Signature:

    export declare type MultiRenderingContextElements = Exclude<MultiDeliveryElements, DeliveryGroupElement[] | DeliveryReferenceElement[]> | RenderingContextGroupElement[] | RenderingContextReferenceElement[];

    Home > @acoustic-content-sdk/api > QueryInput

    QueryInput type

    Signature:

    export declare type QueryInput = string | string[] | null | undefined | URLSearchParams | Query;

    Home > @acoustic-content-sdk/api > QueryValue

    QueryValue type

    acceptable values for

    Signature:

    export declare type QueryValue = string | number | boolean;

    Home > @acoustic-content-sdk/api > RenderingContextElements

    RenderingContextElements type

    Signature:

    export declare type RenderingContextElements = SingleRenderingContextElements | MultiRenderingContextElements;

    Home > @acoustic-content-sdk/api > SdkMessageHandlerCallback

    SdkMessageHandlerCallback type

    Signature:

    export declare type SdkMessageHandlerCallback = (aPayload: SdkMessagePayload, aEvent: MessageEvent) => PromiseLike<SdkMessagePayload> | SdkMessagePayload | null | undefined;

    Home > @acoustic-content-sdk/api > SimpleType

    SimpleType type

    Signature:

    export declare type SimpleType = string | string[] | number | number[] | Image | Image[] | Date | Date[] | Video | Video[] | File | File[] | boolean | boolean[] | Link | Link[] | OptionSelection | OptionSelection[] | RenderingContext | RenderingContext[] | Category | Location | {
        readonly [key: string]: SimpleType;
    };

    Home > @acoustic-content-sdk/api > SingleDeliveryElements

    SingleDeliveryElements type

    Signature:

    export declare type SingleDeliveryElements = DeliveryImageElement | DeliveryLinkElement | DeliveryGroupElement | DeliveryReferenceElement | DeliveryFileElement | DeliveryDateElement | DeliveryNumberElement | DeliveryFormattedTextElement | DeliveryTextElement | DeliveryToggleElement | DeliveryVideoElement | DeliveryLocationElement | DeliveryOptionsElement;

    Home > @acoustic-content-sdk/api > SingleRenderingContextElements

    SingleRenderingContextElements type

    Signature:

    export declare type SingleRenderingContextElements = Exclude<SingleDeliveryElements, DeliveryGroupElement | DeliveryReferenceElement> | RenderingContextGroupElement | RenderingContextReferenceElement;

    Home > @acoustic-content-sdk/api > SiteNavigation

    SiteNavigation type

    The list of root pages

    Signature:

    export declare type SiteNavigation = SiteNavigationPage[];

    Home > @acoustic-content-sdk/api > StaticHubInfoUrlProvider

    StaticHubInfoUrlProvider type

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

    Signature:

    export declare type StaticHubInfoUrlProvider = null | undefined | URL | string | (() => StaticHubInfoUrlProvider);

    Home > @acoustic-content-sdk/api > AbstractElement > elementType

    AbstractElement.elementType property

    Signature:

    readonly elementType: ELEMENT_TYPE;

    Home > @acoustic-content-sdk/api > ActivePageV2 > renderingContext$

    ActivePageV2.renderingContext$ property

    Retrieves the rendering context for the content item rendered for the currently selected page.

    Signature:

    renderingContext$: Observable<RenderingContextV2>;

    Home > @acoustic-content-sdk/api > Asset > altText

    Asset.altText property

    Signature:

    readonly altText?: string;

    Home > @acoustic-content-sdk/api > Asset > fileName

    Asset.fileName property

    Signature:

    readonly fileName: string;

    Home > @acoustic-content-sdk/api > Asset > fileSize

    Asset.fileSize property

    Signature:

    readonly fileSize: number;

    Home > @acoustic-content-sdk/api > Asset > height

    Asset.height property

    Signature:

    readonly height: number;

    Home > @acoustic-content-sdk/api > Asset > id

    Asset.id property

    Signature:

    readonly id: string;

    Home > @acoustic-content-sdk/api > Asset > mediaType

    Asset.mediaType property

    Signature:

    readonly mediaType: string;

    Home > @acoustic-content-sdk/api > Asset > resourceUri

    Asset.resourceUri property

    Signature:

    readonly resourceUri: string;

    Home > @acoustic-content-sdk/api > Asset > width

    Asset.width property

    added by delivery

    Signature:

    readonly width: number;

    Home > @acoustic-content-sdk/api > AuthoringAsset > altText

    AuthoringAsset.altText property

    Signature:

    readonly altText?: string;

    Home > @acoustic-content-sdk/api > AuthoringAsset > assetType

    AuthoringAsset.assetType property

    Signature:

    readonly assetType?: string;

    Home > @acoustic-content-sdk/api > AuthoringAsset > caption

    AuthoringAsset.caption property

    Signature:

    readonly caption?: string;

    Home > @acoustic-content-sdk/api > AuthoringAsset > classification

    AuthoringAsset.classification property

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

    Signature:

    readonly classification: 'asset';

    Home > @acoustic-content-sdk/api > AuthoringAsset > digest

    AuthoringAsset.digest property

    Signature:

    readonly digest?: string;

    Home > @acoustic-content-sdk/api > AuthoringAsset > fileName

    AuthoringAsset.fileName property

    Signature:

    readonly fileName?: string;

    Home > @acoustic-content-sdk/api > AuthoringAsset > fileSize

    AuthoringAsset.fileSize property

    Signature:

    readonly fileSize?: number;

    Home > @acoustic-content-sdk/api > AuthoringAsset > isManaged

    AuthoringAsset.isManaged property

    Signature:

    readonly isManaged: boolean;

    Home > @acoustic-content-sdk/api > AuthoringAsset > mediaType

    AuthoringAsset.mediaType property

    Signature:

    readonly mediaType?: string;

    Home > @acoustic-content-sdk/api > AuthoringAsset > metadata

    AuthoringAsset.metadata property

    Signature:

    readonly metadata?: AuthoringAssetMetadata;

    Home > @acoustic-content-sdk/api > AuthoringAsset > path

    AuthoringAsset.path property

    Signature:

    readonly path: string;

    Home > @acoustic-content-sdk/api > AuthoringAsset > profileRenditions

    AuthoringAsset.profileRenditions property

    Signature:

    readonly profileRenditions?: AuthoringAssetProfileRendition[];

    Home > @acoustic-content-sdk/api > AuthoringAsset > resource

    AuthoringAsset.resource property

    Signature:

    readonly resource: string;

    Home > @acoustic-content-sdk/api > AssetPublishApproval > enabled

    AssetPublishApproval.enabled property

    True if mandatory approval is enabled

    Signature:

    enabled?: boolean;

    Home > @acoustic-content-sdk/api > AssetPublishApproval > exemptAssetTypes

    AssetPublishApproval.exemptAssetTypes property

    Signature:

    exemptAssetTypes: string[];

    Home > @acoustic-content-sdk/api > ActivePage > onRenderingContext

    ActivePage.onRenderingContext property

    Retrieves the rendering context for the content item rendered for the currently selected page.

    Signature:

    onRenderingContext: Observable<RenderingContext>;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > camera

    AuthoringAssetMetadata.camera property

    Signature:

    readonly camera?: any;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > coverage

    AuthoringAssetMetadata.coverage property

    Signature:

    readonly coverage?: any;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > creator

    AuthoringAssetMetadata.creator property

    Signature:

    readonly creator?: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > description

    AuthoringAssetMetadata.description property

    Signature:

    readonly description?: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > headline

    AuthoringAssetMetadata.headline property

    Signature:

    readonly headline?: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > heigth

    AuthoringAssetMetadata.heigth property

    Signature:

    readonly heigth?: number;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > publisher

    AuthoringAssetMetadata.publisher property

    Signature:

    readonly publisher?: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > rights

    AuthoringAssetMetadata.rights property

    Signature:

    readonly rights?: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > source

    AuthoringAssetMetadata.source property

    Signature:

    readonly source?: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > subject

    AuthoringAssetMetadata.subject property

    Signature:

    readonly subject?: string[];

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > title

    AuthoringAssetMetadata.title property

    Signature:

    readonly title?: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > width

    AuthoringAssetMetadata.width property

    Signature:

    readonly width?: number;

    Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > height

    AuthoringAssetProfileRendition.height property

    Signature:

    readonly height: number;

    Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > key

    AuthoringAssetProfileRendition.key property

    Signature:

    readonly key: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > profileId

    AuthoringAssetProfileRendition.profileId property

    Signature:

    readonly profileId: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > transform

    AuthoringAssetProfileRendition.transform property

    Signature:

    readonly transform: any;

    Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > uri

    AuthoringAssetProfileRendition.uri property

    Signature:

    readonly uri: string;

    Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > width

    AuthoringAssetProfileRendition.width property

    Signature:

    readonly width: number;

    Home > @acoustic-content-sdk/api > AuthoringCategoryElement > elementType

    AuthoringCategoryElement.elementType property

    Signature:

    elementType: 'category';

    Home > @acoustic-content-sdk/api > AuthoringCategoryElement > restrictedParents

    AuthoringCategoryElement.restrictedParents property

    Signature:

    restrictedParents?: string[];

    Home > @acoustic-content-sdk/api > AuthoringCategoryElement > searchKey

    AuthoringCategoryElement.searchKey property

    Signature:

    searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;

    Home > @acoustic-content-sdk/api > AuthoringCommerceProductCategoryElement > elementType

    AuthoringCommerceProductCategoryElement.elementType property

    Signature:

    elementType: 'productcategory';

    Home > @acoustic-content-sdk/api > AuthoringCommerceProductCategoryElement > restrictedParent

    AuthoringCommerceProductCategoryElement.restrictedParent property

    Signature:

    restrictedParent?: string;

    Home > @acoustic-content-sdk/api > AuthoringCommerceProductCategoryElement > searchKey

    AuthoringCommerceProductCategoryElement.searchKey property

    Signature:

    searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > classification

    AuthoringContentItem.classification property

    Signature:

    classification: 'content';

    Home > @acoustic-content-sdk/api > AuthoringContentItem > deliveryAccess

    AuthoringContentItem.deliveryAccess property

    Signature:

    deliveryAccess?: 'secured';

    Home > @acoustic-content-sdk/api > AuthoringContentItem > draftStatus

    AuthoringContentItem.draftStatus property

    Signature:

    draftStatus?: DraftStatus;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > elements

    AuthoringContentItem.elements property

    Signature:

    elements?: Record<string, any>;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > form

    AuthoringContentItem.form property

    Signature:

    form?: any[];

    Home > @acoustic-content-sdk/api > AuthoringContentItem > id

    AuthoringContentItem.id property

    Signature:

    id: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > keywords

    AuthoringContentItem.keywords property

    Signature:

    keywords?: string[];

    Home > @acoustic-content-sdk/api > AuthoringContentItem > kind

    AuthoringContentItem.kind property

    Signature:

    kind?: AUTHORING_CONTENT_ITEM_KIND[];

    Home > @acoustic-content-sdk/api > AuthoringContentItem > lastModified

    AuthoringContentItem.lastModified property

    Signature:

    lastModified?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > lastModifier

    AuthoringContentItem.lastModifier property

    Signature:

    lastModifier?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > lastModifierId

    AuthoringContentItem.lastModifierId property

    Signature:

    lastModifierId?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > linkedDocId

    AuthoringContentItem.linkedDocId property

    Signature:

    linkedDocId?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > links

    AuthoringContentItem.links property

    Signature:

    links?: Record<string, any>;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > locale

    AuthoringContentItem.locale property

    Signature:

    locale?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > projectId

    AuthoringContentItem.projectId property

    Signature:

    projectId?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > projects

    AuthoringContentItem.projects property

    Signature:

    projects?: string[];

    Home > @acoustic-content-sdk/api > AuthoringContentItem > publishing

    AuthoringContentItem.publishing property

    Signature:

    publishing?: Record<string, any>;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > review

    AuthoringContentItem.review property

    Signature:

    review?: Record<string, any>;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > reviewHistory

    AuthoringContentItem.reviewHistory property

    Signature:

    reviewHistory?: string[];

    Home > @acoustic-content-sdk/api > AuthoringContentItem > reviewId

    AuthoringContentItem.reviewId property

    Signature:

    reviewId?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > schema

    AuthoringContentItem.schema property

    Signature:

    schema?: Record<string, any>;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > selectedLayouts

    AuthoringContentItem.selectedLayouts property

    Signature:

    selectedLayouts?: AuthoringSelectedLayout[];

    Home > @acoustic-content-sdk/api > AuthoringContentItem > status

    AuthoringContentItem.status property

    Signature:

    status: Status;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > systemModified

    AuthoringContentItem.systemModified property

    Signature:

    systemModified?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > tags

    AuthoringContentItem.tags property

    Signature:

    tags?: string[];

    Home > @acoustic-content-sdk/api > AuthoringContentItem > thumbnail

    AuthoringContentItem.thumbnail property

    Signature:

    thumbnail?: AuthoringContentItemThumbnail;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > type

    AuthoringContentItem.type property

    Signature:

    type?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > typeId

    AuthoringContentItem.typeId property

    Signature:

    typeId: string;

    Home > @acoustic-content-sdk/api > AuthoringContentItem > valid

    AuthoringContentItem.valid property

    Signature:

    valid?: boolean;

    Home > @acoustic-content-sdk/api > AuthoringCommerceProductElement > elementType

    AuthoringCommerceProductElement.elementType property

    Signature:

    elementType: 'product';

    Home > @acoustic-content-sdk/api > AuthoringCommerceProductElement > restrictedCategories

    AuthoringCommerceProductElement.restrictedCategories property

    Signature:

    restrictedCategories?: string[];

    Home > @acoustic-content-sdk/api > AuthoringCommerceProductElement > searchKey

    AuthoringCommerceProductElement.searchKey property

    Signature:

    searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;

    Home > @acoustic-content-sdk/api > AuthoringContentItemThumbnail > id

    AuthoringContentItemThumbnail.id property

    Signature:

    id: string;

    Home > @acoustic-content-sdk/api > AuthoringDatetimeElement > elementType

    AuthoringDatetimeElement.elementType property

    Signature:

    elementType: 'datetime';

    Home > @acoustic-content-sdk/api > AuthoringDatetimeElement > fieldType

    AuthoringDatetimeElement.fieldType property

    Signature:

    fieldType?: 'date' | 'date-time';

    Home > @acoustic-content-sdk/api > AuthoringDatetimeElement > searchKey

    AuthoringDatetimeElement.searchKey property

    Signature:

    searchKey?: AUTHORING_ELEMENT_DATETIME_SEARCH_KEY;

    Home > @acoustic-content-sdk/api > AuthoringContentThumbnail > imageElement

    AuthoringContentThumbnail.imageElement property

    Signature:

    imageElement?: string;

    Home > @acoustic-content-sdk/api > AuthoringContentThumbnail > source

    AuthoringContentThumbnail.source property

    Signature:

    source: 'imageElementOrType' | 'imageElement' | 'type' | 'none';

    Home > @acoustic-content-sdk/api > AuthoringElement > allowMultipleValues

    AuthoringElement.allowMultipleValues property

    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.

    Signature:

    allowMultipleValues?: boolean;

    Home > @acoustic-content-sdk/api > AuthoringElement > elementType

    AuthoringElement.elementType property

    Specifies the type of this element.

    Signature:

    elementType: ELEMENT_TYPE | 'productcategory' | 'product';

    Home > @acoustic-content-sdk/api > AuthoringElement > fieldLabel

    AuthoringElement.fieldLabel property

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

    Signature:

    fieldLabel?: string;

    Home > @acoustic-content-sdk/api > AuthoringElement > helpText

    AuthoringElement.helpText property

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

    Signature:

    helpText?: string;

    Home > @acoustic-content-sdk/api > AuthoringElement > key

    AuthoringElement.key property

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

    Signature:

    key: string;

    Home > @acoustic-content-sdk/api > AuthoringElement > label

    AuthoringElement.label property

    The display name of the element.

    Signature:

    label: string;

    Home > @acoustic-content-sdk/api > AuthoringElement > maximumValues

    AuthoringElement.maximumValues property

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

    Signature:

    maximumValues?: number;

    Home > @acoustic-content-sdk/api > AuthoringElement > minimumValues

    AuthoringElement.minimumValues property

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

    Signature:

    minimumValues?: number;

    Home > @acoustic-content-sdk/api > AuthoringElement > placeholder

    AuthoringElement.placeholder property

    Signature:

    placeholder?: AuthoringPlaceholder;

    Home > @acoustic-content-sdk/api > AuthoringElement > required

    AuthoringElement.required property

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

    Signature:

    required?: boolean;

    Home > @acoustic-content-sdk/api > AuthoringElement > role

    AuthoringElement.role property

    Signature:

    role?: AUTHORING_ELEMENT_ROLE[];

    Home > @acoustic-content-sdk/api > AuthoringElement > uiExtensions

    AuthoringElement.uiExtensions property

    Signature:

    uiExtensions?: AuthoringUiExtensions;

    Home > @acoustic-content-sdk/api > AuthoringFileElement > acceptType

    AuthoringFileElement.acceptType property

    Signature:

    acceptType?: AUTHORING_ELEMENT_FILE_TYPE[];

    Home > @acoustic-content-sdk/api > AuthoringFileElement > elementType

    AuthoringFileElement.elementType property

    Signature:

    elementType: 'file';

    Home > @acoustic-content-sdk/api > AuthoringFileElement > searchKey

    AuthoringFileElement.searchKey property

    Signature:

    searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;

    Home > @acoustic-content-sdk/api > AuthoringFormattedTextElement > elementType

    AuthoringFormattedTextElement.elementType property

    Signature:

    elementType: 'formattedtext';

    Home > @acoustic-content-sdk/api > AuthoringFormattedTextElement > searchKey

    AuthoringFormattedTextElement.searchKey property

    Signature:

    searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;

    Home > @acoustic-content-sdk/api > AuthoringGroup > elementType

    AuthoringGroup.elementType property

    Signature:

    [KEY_ELEMENT_TYPE]: typeof ELEMENT_TYPE_GROUP;

    Home > @acoustic-content-sdk/api > AuthoringGroup > typeRef

    AuthoringGroup.typeRef property

    Signature:

    [KEY_TYPE_REF]: AuthoringReferenceValue;

    Home > @acoustic-content-sdk/api > AuthoringGroup > value

    AuthoringGroup.value property

    Signature:

    [KEY_VALUE]?: T;

    Home > @acoustic-content-sdk/api > AuthoringGroup > values

    AuthoringGroup.values property

    Signature:

    [KEY_VALUES]?: T[];

    Home > @acoustic-content-sdk/api > AuthoringGroupElement > elements

    AuthoringGroupElement.elements property

    Signature:

    elements?: any[];

    Home > @acoustic-content-sdk/api > AuthoringGroupElement > elementType

    AuthoringGroupElement.elementType property

    Signature:

    elementType: 'group';

    Home > @acoustic-content-sdk/api > AuthoringGroupElement > icon

    AuthoringGroupElement.icon property

    Signature:

    icon?: ELEMENT_TYPE;

    Home > @acoustic-content-sdk/api > AuthoringGroupElement > kind

    AuthoringGroupElement.kind property

    Signature:

    kind?: AUTHORING_TYPE_KIND[];

    Home > @acoustic-content-sdk/api > AuthoringGroupElement > typeRef

    AuthoringGroupElement.typeRef property

    Signature:

    typeRef: TypeRef;

    Home > @acoustic-content-sdk/api > AuthoringImage > elementType

    AuthoringImage.elementType property

    Signature:

    [KEY_ELEMENT_TYPE]: typeof ELEMENT_TYPE_IMAGE;

    Home > @acoustic-content-sdk/api > AuthoringImage > values

    AuthoringImage.values property

    Signature:

    [KEY_VALUES]?: Image[];

    Home > @acoustic-content-sdk/api > AuthoringLayout > classification

    AuthoringLayout.classification property

    Signature:

    classification: 'layout';

    Home > @acoustic-content-sdk/api > AuthoringLayout > id

    AuthoringLayout.id property

    Signature:

    id: string;

    Home > @acoustic-content-sdk/api > AuthoringLayout > name

    AuthoringLayout.name property

    Signature:

    name?: string;

    Home > @acoustic-content-sdk/api > AuthoringLayout > path

    AuthoringLayout.path property

    Signature:

    path?: string;

    Home > @acoustic-content-sdk/api > AuthoringImageElement > acceptType

    AuthoringImageElement.acceptType property

    Signature:

    acceptType?: AUTHORING_ELEMENT_IMAGE_TYPE[];

    Home > @acoustic-content-sdk/api > AuthoringImageElement > elementType

    AuthoringImageElement.elementType property

    Signature:

    elementType: 'image';

    Home > @acoustic-content-sdk/api > AuthoringImageElement > imageProfile

    AuthoringImageElement.imageProfile property

    Signature:

    imageProfile?: Record<string, any>;

    Home > @acoustic-content-sdk/api > AuthoringImageElement > imageProfileId

    AuthoringImageElement.imageProfileId property

    Signature:

    imageProfileId?: string;

    Home > @acoustic-content-sdk/api > AuthoringImageElement > searchKey

    AuthoringImageElement.searchKey property

    Signature:

    searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;

    Home > @acoustic-content-sdk/api > AuthoringLayoutItem > classification

    AuthoringLayoutItem.classification property

    Signature:

    classification: 'layout';

    Home > @acoustic-content-sdk/api > AuthoringLayoutItem > id

    AuthoringLayoutItem.id property

    Signature:

    id: string;

    Home > @acoustic-content-sdk/api > AuthoringLayoutItem > name

    AuthoringLayoutItem.name property

    Signature:

    name: string;

    Home > @acoustic-content-sdk/api > AuthoringLayoutItem > path

    AuthoringLayoutItem.path property

    Signature:

    path?: string;

    Home > @acoustic-content-sdk/api > AuthoringLayoutItem > prerender

    AuthoringLayoutItem.prerender property

    Signature:

    prerender?: boolean;

    Home > @acoustic-content-sdk/api > AuthoringLayoutItem > urlTemplate

    AuthoringLayoutItem.urlTemplate property

    Signature:

    urlTemplate?: string;

    Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > [_revisions](#_f13814dfc2218c56dc6fdf50f733

    Install

    npm i @acoustic-content-sdk/api

    DownloadsWeekly Downloads

    23

    Version

    9.0.10076

    License

    MIT

    Unpacked Size

    2.09 MB

    Total Files

    360

    Last publish

    Collaborators

    • marcin-pasiewicz
    • nikodem.graczewski.acoustic
    • pawel.galias-ac
    • orenaksakal
    • marcin.konopka-ac