@acoustic-content-sdk/api
Advanced tools
Interfaces and constants to support the Acoustic sites SDK and related modules.
Interfaces and constants to support the Acoustic sites SDK and related modules.
Home > @acoustic-content-sdk/api
Interfaces and constants to support the Acoustic sites SDK and related modules.
| Enumeration | Description |
|---|---|
| CYCLE_HANDLING | Cycle handling strategy |
| DraftStatus | Possible values for draft status |
| SdkMode | |
| Status | |
| TENANT_TIER |
| 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 |
| 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. |
Home > @acoustic-content-sdk/api > CYCLE_HANDLING
Cycle handling strategy
Signature:
export declare enum CYCLE_HANDLING
| 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
Possible values for draft status
Signature:
export declare enum DraftStatus
| Member | Value | Description |
|---|---|---|
| APPROVED | "approved" | |
| IN_PROGRESS | "in-progress" | |
| IN_REVIEW | "in-review" |
Home > @acoustic-content-sdk/api > SdkMode
Signature:
export declare enum SdkMode
| Member | Value | Description |
|---|---|---|
| PROTECTED | "protected" | |
| PUBLIC | "public" |
Home > @acoustic-content-sdk/api > Status
Signature:
export declare enum Status
| Member | Value | Description |
|---|---|---|
| DRAFT | "draft" | |
| READY | "ready" | |
| RETIRED | "retired" |
Home > @acoustic-content-sdk/api > TENANT_TIER
Signature:
export declare enum TENANT_TIER
| Member | Value | Description |
|---|---|---|
| BASE | "Base" | |
| PLUS | "Plus" | |
| STANDARD | "Standard" | |
| TRIAL | "Trial" |
Home > @acoustic-content-sdk/api > createVersion
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;
| 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
Converts the version object into a version string
Signature:
export declare function createVersionString(aVersion: WchSdkVersion): string;
| Parameter | Type | Description |
|---|---|---|
| aVersion | WchSdkVersion | the version object |
Returns:
string
the version string
Home > @acoustic-content-sdk/api > AbstractElement
Signature:
export interface AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | ELEMENT_TYPE |
Home > @acoustic-content-sdk/api > ActivePage
Signature:
export interface ActivePage extends RenderingContextProvider
| 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
Signature:
export interface ActivePageV2 extends RenderingContextProviderV2
| 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
Signature:
export interface Asset
| 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
Signature:
export interface AssetPublishApproval
| Property | Type | Description |
|---|---|---|
| enabled | boolean | True if mandatory approval is enabled |
| exemptAssetTypes | string[] |
Home > @acoustic-content-sdk/api > AuthoringAsset
Signature:
export interface AuthoringAsset extends BaseAuthoringItem
| 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
Signature:
export interface AuthoringAssetMetadata
| 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
Signature:
export interface AuthoringAssetProfileRendition
| Property | Type | Description |
|---|---|---|
| height | number | |
| key | string | |
| profileId | string | |
| transform | any | |
| uri | string | |
| width | number |
Home > @acoustic-content-sdk/api > AuthoringCategoryElement
Signature:
export interface AuthoringCategoryElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'category' | |
| restrictedParents | string[] | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringCommerceProductCategoryElement
Signature:
export interface AuthoringCommerceProductCategoryElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'productcategory' | |
| restrictedParent | string | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringCommerceProductElement
Signature:
export interface AuthoringCommerceProductElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'product' | |
| restrictedCategories | string[] | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringContentItem
Signature:
export interface AuthoringContentItem extends BaseAuthoringItem
| 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
Signature:
export interface AuthoringContentItemThumbnail extends AuthoringThumbnail
| Property | Type | Description |
|---|---|---|
| id | string |
Home > @acoustic-content-sdk/api > AuthoringContentThumbnail
Signature:
export interface AuthoringContentThumbnail
| Property | Type | Description |
|---|---|---|
| imageElement | string | |
| source | 'imageElementOrType' | 'imageElement' | 'type' | 'none' |
Home > @acoustic-content-sdk/api > AuthoringDatetimeElement
Signature:
export interface AuthoringDatetimeElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'datetime' | |
| fieldType | 'date' | 'date-time' | |
| searchKey | AUTHORING_ELEMENT_DATETIME_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringElement
Signature:
export interface AuthoringElement
| 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
Signature:
export interface AuthoringFileElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| acceptType | AUTHORING_ELEMENT_FILE_TYPE[] | |
| elementType | 'file' | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringFormattedTextElement
Signature:
export interface AuthoringFormattedTextElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'formattedtext' | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringGroup
Signature:
export interface AuthoringGroup<T>
| Property | Type | Description |
|---|---|---|
| elementType | typeof ELEMENT_TYPE_GROUP | |
| typeRef | AuthoringReferenceValue | |
| value | T | |
| values | T[] |
Home > @acoustic-content-sdk/api > AuthoringGroupElement
Signature:
export interface AuthoringGroupElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elements | any[] | |
| elementType | 'group' | |
| icon | ELEMENT_TYPE | |
| kind | AUTHORING_TYPE_KIND[] | |
| typeRef | TypeRef |
Home > @acoustic-content-sdk/api > AuthoringImage
Signature:
export interface AuthoringImage
| Property | Type | Description |
|---|---|---|
| elementType | typeof ELEMENT_TYPE_IMAGE | |
| values | Image[] |
Home > @acoustic-content-sdk/api > AuthoringImageElement
Signature:
export interface AuthoringImageElement extends AuthoringElement
| 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
Signature:
export interface AuthoringLayout
| Property | Type | Description |
|---|---|---|
| classification | 'layout' | |
| id | string | |
| name | string | |
| path | string |
Home > @acoustic-content-sdk/api > AuthoringLayoutItem
Signature:
export interface AuthoringLayoutItem extends Layout
| Property | Type | Description |
|---|---|---|
| classification | 'layout' | |
| id | string | |
| name | string | |
| path | string | |
| prerender | boolean | |
| urlTemplate | string |
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping
Signature:
export interface AuthoringLayoutMapping extends BaseAuthoringItem
| 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
Signature:
export interface AuthoringLayoutMappingLayout
| Property | Type | Description |
|---|---|---|
| id | string | |
| name | string |
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingMapping
Signature:
export interface AuthoringLayoutMappingMapping
| Property | Type | Description |
|---|---|---|
| defaultLayout | AuthoringLayoutMappingLayout | |
| layoutMode | string | |
| layouts | AuthoringLayoutMappingLayout[] |
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingType
Signature:
export interface AuthoringLayoutMappingType
| Property | Type | Description |
|---|---|---|
| id | string | |
| name | string |
Home > @acoustic-content-sdk/api > AuthoringLinkElement
Signature:
export interface AuthoringLinkElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'link' | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringLocationElement
Signature:
export interface AuthoringLocationElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'location' | |
| searchKey | AUTHORING_ELEMENT_LOCATION_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringNumberElement
Signature:
export interface AuthoringNumberElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'number' | |
| fieldType | 'integer' | 'decimal' | |
| maximum | number | |
| minimum | number | |
| searchKey | AUTHORING_ELEMENT_NUMBER_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringOption
Signature:
export interface AuthoringOption
| Property | Type | Description |
|---|---|---|
| label | string | |
| selection | string |
Home > @acoustic-content-sdk/api > AuthoringOptionSelectionElement
Signature:
export interface AuthoringOptionSelectionElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'optionselection' | |
| options | AuthoringOption[] | |
| restrictedParents | string[] | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringPlaceholder
Signature:
export interface AuthoringPlaceholder
| Property | Type | Description |
|---|---|---|
| show | boolean | |
| text | string |
Home > @acoustic-content-sdk/api > AuthoringReference
Signature:
export interface AuthoringReference
| Property | Type | Description |
|---|---|---|
| elementType | typeof ELEMENT_TYPE_REFERENCE | |
| value | AuthoringReferenceValue[] | |
| values | AuthoringReferenceValue[] |
Home > @acoustic-content-sdk/api > AuthoringReferenceElement
Signature:
export interface AuthoringReferenceElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'reference' | |
| restrictTypes | TypeRef | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthoringReferenceValue
Signature:
export interface AuthoringReferenceValue
| Property | Type | Description |
|---|---|---|
| creatorId | string | |
| id | string | |
| name | string | |
| status | Status | |
| typeId | string |
Home > @acoustic-content-sdk/api > AuthoringSelectedLayout
Signature:
export interface AuthoringSelectedLayout
| Property | Type | Description |
|---|---|---|
| layout | AuthoringLayout | |
| layoutMode | string |
Home > @acoustic-content-sdk/api > AuthoringText
Signature:
export interface AuthoringText
| Property | Type | Description |
|---|---|---|
| elementType | typeof ELEMENT_TYPE_TEXT | |
| value | string | |
| values | string[] |
Home > @acoustic-content-sdk/api > AuthoringTextElement
Signature:
export interface AuthoringTextElement extends AuthoringElement
| 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
Signature:
export interface AuthoringThumbnail
| Property | Type | Description |
|---|---|---|
| id | string | |
| path | string | |
| url | string |
Home > @acoustic-content-sdk/api > AuthoringToggleElement
Signature:
export interface AuthoringToggleElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elementType | 'toggle' | |
| searchKey | AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY | |
| statement | string |
Home > @acoustic-content-sdk/api > AuthoringType
Signature:
export interface AuthoringType extends BaseAuthoringItem
| 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
Signature:
export interface AuthoringUiExtensions
| Property | Type | Description |
|---|---|---|
| element | string | |
| elementBuiltin | string | |
| elementConfig | any |
Home > @acoustic-content-sdk/api > AuthoringVariableTypeElement
Signature:
export interface AuthoringVariableTypeElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| elements | Record<string, any>[] | |
| elementType | 'variabletype' |
Home > @acoustic-content-sdk/api > AuthoringVideo
Signature:
export interface AuthoringVideo
| Property | Type | Description |
|---|---|---|
| elementType | typeof ELEMENT_TYPE_VIDEO | |
| values | Video[] |
Home > @acoustic-content-sdk/api > AuthoringVideoElement
Signature:
export interface AuthoringVideoElement extends AuthoringElement
| Property | Type | Description |
|---|---|---|
| acceptType | AUTHORING_ELEMENT_VIDEO_TYPE[] | |
| elementType | 'video' | |
| searchKey | AUTHORING_ELEMENT_TEXT_SEARCH_KEY |
Home > @acoustic-content-sdk/api > AuthStatus
Exposes the authentication status
Signature:
export interface AuthStatus
| 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
Base interface for all items
Signature:
export interface BaseAuthoringItem
| 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
Base interface for all items
Signature:
export interface BaseDeliveryItem
| 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 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
| Property | Type | Description |
|---|---|---|
| categories | string[] | |
| categoryIds | string[] | |
| categoryPaths | string[][] | extension for the local rendering context for convenience |
Home > @acoustic-content-sdk/api > 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.
Signature:
export interface CategoryElement extends AbstractElement, Category
| Property | Type | Description |
|---|---|---|
| elementType | 'category' |
Home > @acoustic-content-sdk/api > ContentItem
Representation of a generic content item.
Signature:
export interface ContentItem extends BaseDeliveryItem
| 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
Signature:
export interface ContentItemWithLayout extends ContentItem
| 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
Signature:
export interface ContentPublishApproval
| Property | Type | Description |
|---|---|---|
| enabled | boolean | True if mandatory approval is enabled |
| exemptContentTypes | string[] |
Home > @acoustic-content-sdk/api > DateElement
Common base class for all date elements
Signature:
export interface DateElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'datetime' |
Home > @acoustic-content-sdk/api > DeliveryAccess
Signature:
export interface DeliveryAccess
| Property | Type | Description |
|---|---|---|
| assets | string | |
| content | string | |
| secureAlways | boolean |
Home > @acoustic-content-sdk/api > DeliveryAsset
Signature:
export interface DeliveryAsset
| Property | Type | Description |
|---|---|---|
| fileName | string | |
| fileSize | number | |
| id | string | |
| mediaType | string | |
| resourceUri | string |
Home > @acoustic-content-sdk/api > DeliveryCategoryElement
Signature:
export interface DeliveryCategoryElement
| Property | Type | Description |
|---|---|---|
| categoryIds | string[] | |
| categoryPath | string[] |
Home > @acoustic-content-sdk/api > DeliveryContentItem
Signature:
export interface DeliveryContentItem
| Property | Type | Description |
|---|---|---|
| $metadata | DeliveryContentMetadata | Metadata record |
Home > @acoustic-content-sdk/api > DeliveryContentMetadata
Common fields in all metadata records
Signature:
export interface DeliveryContentMetadata
| 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
Signature:
export interface DeliveryFileElement
| Property | Type | Description |
|---|---|---|
| asset | DeliveryFileAsset | |
| url | string |
Home > @acoustic-content-sdk/api > DeliveryGroupElement
Signature:
export interface DeliveryGroupElement
| Property | Type | Description |
|---|---|---|
| $metadata | DeliveryGroupElementMetadata | Optional metadata |
Home > @acoustic-content-sdk/api > DeliveryGroupElementMetadata
Signature:
export interface DeliveryGroupElementMetadata
| 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
Signature:
export interface DeliveryImageAsset extends DeliveryAsset
| Property | Type | Description |
|---|---|---|
| altText | string | |
| height | number | |
| width | number |
Home > @acoustic-content-sdk/api > DeliveryImageCrop
Signature:
export interface DeliveryImageCrop
| Property | Type | Description |
|---|---|---|
| height | number | |
| width | number | |
| x | number | |
| y | number |
Home > @acoustic-content-sdk/api > DeliveryImageElement
Signature:
export interface DeliveryImageElement
| Property | Type | Description |
|---|---|---|
| asset | DeliveryImageAsset | |
| mode | DeliveryImageMode | |
| renditions | Record<string, DeliveryImageRendition> | |
| url | string |
Home > @acoustic-content-sdk/api > DeliveryImageRendition
Signature:
export interface DeliveryImageRendition
| Property | Type | Description |
|---|---|---|
| height | number | |
| source | string | |
| transform | DeliveryImageTransform | |
| url | string | |
| width | number |
Home > @acoustic-content-sdk/api > DeliveryImageTransform
Signature:
export interface DeliveryImageTransform
| Property | Type | Description |
|---|---|---|
| crop | DeliveryImageCrop | |
| scale | DeliveryImageScale |
Home > @acoustic-content-sdk/api > DeliveryLayoutRef
Signature:
export interface DeliveryLayoutRef
| Property | Type | Description |
|---|---|---|
| id | string |
Home > @acoustic-content-sdk/api > DeliveryLinkElement
Signature:
export interface DeliveryLinkElement
| Property | Type | Description |
|---|---|---|
| linkDescription | string | |
| linkText | string | |
| linkURL | string |
Home > @acoustic-content-sdk/api > DeliveryLocationElement
Signature:
export interface DeliveryLocationElement
| Property | Type | Description |
|---|---|---|
| latitude | number | |
| longitude | number |
Home > @acoustic-content-sdk/api > DeliveryReferenceElement
Signature:
export interface DeliveryReferenceElement
| Property | Type | Description |
|---|---|---|
| $metadata | DeliveryReferenceElementMetadata |
Home > @acoustic-content-sdk/api > DeliveryReferenceElementMetadata
Signature:
export interface DeliveryReferenceElementMetadata extends Partial<DeliveryContentMetadata>
| Property | Type | Description |
|---|---|---|
| id | string |
Home > @acoustic-content-sdk/api > DeliverySelectedLayout
Signature:
export interface DeliverySelectedLayout
| Property | Type | Description |
|---|---|---|
| layout | DeliveryLayoutRef |
Home > @acoustic-content-sdk/api > DeliveryThumbnail
Signature:
export interface DeliveryThumbnail
| Property | Type | Description |
|---|---|---|
| id | string | |
| url | string |
Home > @acoustic-content-sdk/api > DeliveryVideoElement
Signature:
export interface DeliveryVideoElement
Home > @acoustic-content-sdk/api > DynamicLoggerFactory
Instantiator for loggers. Clients of the SDK can use this interface to inject their custom logger implementation.
Signature:
export interface DynamicLoggerFactory
| Method | Description |
|---|---|
| get() | Returns a logger that is instantiated lazily (and potentially) multiple times. |
Home > @acoustic-content-sdk/api > ElementMap
Signature:
export interface ElementMap<T>
Home > @acoustic-content-sdk/api > ElementWithMarkup
Signature:
export interface ElementWithMarkup
| Property | Type | Description |
|---|---|---|
| $markup | string | Optionally the markup for an element |
Home > @acoustic-content-sdk/api > ErrorDetail
Signature:
export interface ErrorDetail
| Property | Type | Description |
|---|---|---|
| locale | string | |
| message | string | |
| name | string | |
| parameters | any | |
| stack | string |
Home > @acoustic-content-sdk/api > ErrorResponse
JSON structure of an error response
Signature:
export interface ErrorResponse
| Property | Type | Description |
|---|---|---|
| description | string | |
| errors | ErrorDetail[] | |
| message | string | |
| requestId | string | |
| service | string | |
| statusCode | number | |
| version | string |
Home > @acoustic-content-sdk/api > ExtendedContext
Signature:
export interface ExtendedContext extends SiteContext
| Property | Type | Description |
|---|---|---|
| hub | HubContext |
Home > @acoustic-content-sdk/api > ExtendedContextV2
Signature:
export interface ExtendedContextV2
| 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
Signature:
export interface File
| Property | Type | Description |
|---|---|---|
| asset | Asset | |
| url | string |
Home > @acoustic-content-sdk/api > FileElement
Common base class for all file elements
Signature:
export interface FileElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'file' |
Home > @acoustic-content-sdk/api > FormattedTextElement
Common base class for all text elements
Signature:
export interface FormattedTextElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'formattedtext' |
Home > @acoustic-content-sdk/api > Group
Interface that represents a grouping of elements
Signature:
export interface Group
Home > @acoustic-content-sdk/api > GroupElement
Common base class for all group elements
Signature:
export interface GroupElement extends AbstractElement
| 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
Signature:
export interface HttpResourceOptions
| 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
Signature:
export interface HubContext
| 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
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
| 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
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
| 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
Signature:
export interface IbmCommerce
| Property | Type | Description |
|---|---|---|
| apiGatewayHost | string | |
| environmentType | string | |
| liveSearchHost | string | |
| liveTransactionHost | string | |
| previewSearchHost | string | |
| previewTransactionHost | string | |
| tenantId | string |
Home > @acoustic-content-sdk/api > Image
Signature:
export interface Image
| Property | Type | Description |
|---|---|---|
| altText | string | |
| asset | Asset | |
| profiles | string[] | |
| renditions | { [key: string]: Rendition; } | |
| url | string |
Home > @acoustic-content-sdk/api > ImageElement
Common base class for all image elements
Signature:
export interface ImageElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'image' |
Home > @acoustic-content-sdk/api > Layout
Representation of a layout descriptor in the delivery artifacts
Signature:
export interface Layout
| 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
Signature:
export interface Link
| Property | Type | Description |
|---|---|---|
| linkDescription | string | |
| linkText | string | |
| linkURL | string |
Home > @acoustic-content-sdk/api > LinkElement
Common base class for all link elements
Signature:
export interface LinkElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'link' |
Home > @acoustic-content-sdk/api > Location
Signature:
export interface Location
| Property | Type | Description |
|---|---|---|
| latitude | number | |
| longitude | number |
Home > @acoustic-content-sdk/api > LocationElement
Signature:
export interface LocationElement extends AbstractElement, Location
| Property | Type | Description |
|---|---|---|
| elementType | 'location' |
Home > @acoustic-content-sdk/api > 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.
Signature:
export interface Logger
| Method | Description |
|---|---|
| error(msg, data) | |
| info(msg, data) | |
| warn(msg, data) |
Home > @acoustic-content-sdk/api > LoggerFactory
Instantiator for loggers. Clients of the SDK can use this interface to inject their custom logger implementation.
Signature:
export interface LoggerFactory
| 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
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
| Property | Type | Description |
|---|---|---|
| get | (name: string) => Logger | Returns a logger for the given name$1$2 -$3 |
Home > @acoustic-content-sdk/api > MultiDateElement
Date element uses a string property, the value must be an ISO 8601 date time.
Signature:
export interface MultiDateElement extends DateElement
| Property | Type | Description |
|---|---|---|
| values | string[] |
Home > @acoustic-content-sdk/api > MultiFileElement
Signature:
export interface MultiFileElement extends FileElement
| Property | Type | Description |
|---|---|---|
| values | File[] |
Home > @acoustic-content-sdk/api > MultiFormattedTextElement
The text element holds text value in a JSON string.
Signature:
export interface MultiFormattedTextElement extends FormattedTextElement
| Property | Type | Description |
|---|---|---|
| values | string[] |
Home > @acoustic-content-sdk/api > MultiGroupElement
The text element holds text value in a JSON string.
Signature:
export interface MultiGroupElement extends GroupElement
| Property | Type | Description |
|---|---|---|
| values | Group[] |
Home > @acoustic-content-sdk/api > MultiImageElement
Signature:
export interface MultiImageElement extends ImageElement
| Property | Type | Description |
|---|---|---|
| values | Image[] |
Home > @acoustic-content-sdk/api > MultiLinkElement
Link element has three text fields linkURL, linkText, and linkDescription.
Signature:
export interface MultiLinkElement extends LinkElement
| Property | Type | Description |
|---|---|---|
| values | Link[] |
Home > @acoustic-content-sdk/api > MultiNumberElement
The Number element stores the value in the JSON as a number type.
Signature:
export interface MultiNumberElement extends NumberElement
| Property | Type | Description |
|---|---|---|
| values | number[] |
Home > @acoustic-content-sdk/api > MultiOptionSelectionElement
The text element holds text value in a JSON string.
Signature:
export interface MultiOptionSelectionElement extends OptionSelectionElement
| Property | Type | Description |
|---|---|---|
| values | OptionSelection[] |
Home > @acoustic-content-sdk/api > MultiProductElement
The text element holds text value in a JSON string.
Signature:
export interface MultiProductElement extends ProductElement
| Property | Type | Description |
|---|---|---|
| values | string[] |
Home > @acoustic-content-sdk/api > MultiReferenceElement
Signature:
export interface MultiReferenceElement extends ReferenceElement
| Property | Type | Description |
|---|---|---|
| values | RenderingContext[] |
Home > @acoustic-content-sdk/api > MultiTextElement
The text element holds text value in a JSON string.
Signature:
export interface MultiTextElement extends TextElement
| Property | Type | Description |
|---|---|---|
| values | string[] |
Home > @acoustic-content-sdk/api > MultiToggleElement
Toggle just uses JSON Boolean.
Signature:
export interface MultiToggleElement extends ToggleElement
| Property | Type | Description |
|---|---|---|
| values | boolean[] |
Home > @acoustic-content-sdk/api > MultiVideoElement
Signature:
export interface MultiVideoElement extends VideoElement
| Property | Type | Description |
|---|---|---|
| values | Video[] |
Home > @acoustic-content-sdk/api > NumberElement
Common base class for all number elements
Signature:
export interface NumberElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'number' |
Home > @acoustic-content-sdk/api > OptionSelection
Representation of a selection
Signature:
export interface OptionSelection
| Property | Type | Description |
|---|---|---|
| label | string | |
| selection | string |
Home > @acoustic-content-sdk/api > OptionSelectionElement
Common base class for all options election elements
Signature:
export interface OptionSelectionElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'optionselection' |
Home > @acoustic-content-sdk/api > PageSearchResult
Signature:
export interface PageSearchResult extends SearchResult<SitePage>
| Property | Type | Description |
|---|---|---|
| document | SitePage |
Home > @acoustic-content-sdk/api > ProductElement
Signature:
export interface ProductElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'product' |
Home > @acoustic-content-sdk/api > Query
Signature:
export interface Query
Home > @acoustic-content-sdk/api > ReferenceElement
Common base class for all reference elements
Signature:
export interface ReferenceElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'reference' |
Home > @acoustic-content-sdk/api > RenderingContext
Signature:
export interface RenderingContext extends ContentItemWithLayout
| 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
Signature:
export interface RenderingContextGroupElement extends DeliveryGroupElement, ElementWithMarkup
Home > @acoustic-content-sdk/api > RenderingContextInterceptor
Interceptor that can expose transforms for the rendering contexts.
Signature:
export interface RenderingContextInterceptor
| 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
Signature:
export interface RenderingContextProvider
| Property | Type | Description |
|---|---|---|
| onRenderingContext | Observable<RenderingContext> | Retrieves the rendering context for the content item. |
Home > @acoustic-content-sdk/api > RenderingContextProviderV2
Signature:
export interface RenderingContextProviderV2
| Property | Type | Description |
|---|---|---|
| renderingContext$ | Observable<RenderingContextV2> | Retrieves the rendering context for the content item. |
Home > @acoustic-content-sdk/api > RenderingContextQueryResult
Signature:
export interface RenderingContextQueryResult
| Property | Type | Description |
|---|---|---|
| numFound | number | |
| renderingContexts | RenderingContext[] |
Home > @acoustic-content-sdk/api > RenderingContextReferenceElement
Signature:
export interface RenderingContextReferenceElement extends DeliveryReferenceElement, ElementWithMarkup
Home > @acoustic-content-sdk/api > RenderingContextSearchResult
Signature:
export interface RenderingContextSearchResult extends SearchResult<RenderingContext>
| Property | Type | Description |
|---|---|---|
| document | RenderingContext |
Home > @acoustic-content-sdk/api > RenderingContextV2
Signature:
export interface RenderingContextV2 extends DeliveryContentItem
| Property | Type | Description |
|---|---|---|
| $context | ExtendedContextV2 | Rendering context |
Home > @acoustic-content-sdk/api > Rendition
Signature:
export interface Rendition
| Property | Type | Description |
|---|---|---|
| height | number | |
| renditionId | string | |
| source | string | |
| transform | any | |
| url | string | added by delivery |
| width | number |
Home > @acoustic-content-sdk/api > Resource
Signature:
export interface Resource
| Property | Type | Description |
|---|---|---|
| fileName | string | |
| resourceId | string | |
| resourceUri | string |
Home > @acoustic-content-sdk/api > SdkActiveRouteEvent
Signature:
export interface SdkActiveRouteEvent extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| page | DeliveryContentItem | the page |
| type | 'WchSdk.router.activeRoute' | the event type |
Home > @acoustic-content-sdk/api > SdkErrorResponse
Response sent when processing a message fails
Signature:
export interface SdkErrorResponse extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| error | any | potential error |
Home > @acoustic-content-sdk/api > SdkMessageHandler
Signature:
export interface SdkMessageHandler
| Property | Type | Description |
|---|---|---|
| handle | SdkMessageHandlerCallback |
Home > @acoustic-content-sdk/api > SdkMessagePayload
Base interfaces for events that can be sent to the SDK
Signature:
export interface SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| id | string | event identifier, identifying a potential response |
| type | string | the event type |
Home > @acoustic-content-sdk/api > SdkModeEvent
Signature:
export interface SdkModeEvent extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| mode | SdkMode | the mode |
| type | typeof SDK_MODE_EVENT_TYPE | the event type |
Home > @acoustic-content-sdk/api > SdkNavigateByPathEvent
Signature:
export interface SdkNavigateByPathEvent extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| path | string | path to navigate to |
| type | 'WchSdk.router.navigateByPath' | the event type |
Home > @acoustic-content-sdk/api > SdkNavigateByPathResponse
Response to the navigation event
Signature:
export interface SdkNavigateByPathResponse extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| error | any | potential error |
| path | string | path navigated to |
| success | boolean | success of the operation |
Home > @acoustic-content-sdk/api > SdkRefreshEvent
Signature:
export interface SdkRefreshEvent extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| type | 'WchSdk.refresh' | the event type |
Home > @acoustic-content-sdk/api > SdkRouteEvent
Signature:
export interface SdkRouteEvent extends SdkMessagePayload
| 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
Signature:
export interface SdkSetModeEvent extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| mode | SdkMode | mode to set |
| type | 'WchSdk.setMode' | the event type |
Home > @acoustic-content-sdk/api > SdkSetModeResponse
Response to the set mode event
Signature:
export interface SdkSetModeResponse extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| error | any | potential error |
| mode | SdkMode | mode set |
Home > @acoustic-content-sdk/api > SdkSubscribeActiveRouteEvent
Signature:
export interface SdkSubscribeActiveRouteEvent extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| type | 'WchSdk.router.activeRoute.subscribe' | the event type |
Home > @acoustic-content-sdk/api > SdkSubscribeActiveRouteEventResponse
Signature:
export interface SdkSubscribeActiveRouteEventResponse extends SdkSubscribeEventResponse
Home > @acoustic-content-sdk/api > SdkSubscribeEventResponse
Response to a subscription
Signature:
export interface SdkSubscribeEventResponse extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| handle | string | handle, unsubscribe using this handle |
Home > @acoustic-content-sdk/api > SdkSubscribeModeEvent
Signature:
export interface SdkSubscribeModeEvent extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| type | typeof SDK_SUBSCRIBE_MODE_EVENT_TYPE | the event type |
Home > @acoustic-content-sdk/api > SdkSubscribeModeEventResponse
Signature:
export interface SdkSubscribeModeEventResponse extends SdkSubscribeEventResponse
Home > @acoustic-content-sdk/api > SdkSubscribeRouteEvent
Signature:
export interface SdkSubscribeRouteEvent extends SdkMessagePayload
| 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
Signature:
export interface SdkSubscribeRouteEventResponse extends SdkSubscribeEventResponse
Home > @acoustic-content-sdk/api > SdkUnsubscribeEvent
Signature:
export interface SdkUnsubscribeEvent extends SdkMessagePayload
| Property | Type | Description |
|---|---|---|
| handle | string | handle to unsubscribe on |
| type | 'WchSdk.unsubscribe' | the event type |
Home > @acoustic-content-sdk/api > SearchResult
Signature:
export interface SearchResult<T>
| Property | Type | Description |
|---|---|---|
| document | T |
Home > @acoustic-content-sdk/api > SearchResults
Signature:
export interface SearchResults<T>
| Property | Type | Description |
|---|---|---|
| documents | T[] | |
| numFound | number |
Home > @acoustic-content-sdk/api > SingleDateElement
Date element uses a string property, the value must be an ISO 8601 date time.
Signature:
export interface SingleDateElement extends DateElement
| Property | Type | Description |
|---|---|---|
| value | string |
Home > @acoustic-content-sdk/api > 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.
Signature:
export interface SingleFileElement extends FileElement, File
Home > @acoustic-content-sdk/api > SingleFormattedTextElement
The text element holds text value in a JSON string.
Signature:
export interface SingleFormattedTextElement extends FormattedTextElement
| Property | Type | Description |
|---|---|---|
| value | string |
Home > @acoustic-content-sdk/api > SingleGroupElement
The text element holds group value in a JSON string.
Signature:
export interface SingleGroupElement extends GroupElement
| Property | Type | Description |
|---|---|---|
| value | Group |
Home > @acoustic-content-sdk/api > 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!
Signature:
export interface SingleImageElement extends ImageElement, Image
Home > @acoustic-content-sdk/api > SingleLinkElement
Link element has three text fields linkURL, linkText, and linkDescription.
Signature:
export interface SingleLinkElement extends LinkElement, Link
Home > @acoustic-content-sdk/api > SingleNumberElement
The Number element stores the value in the JSON as a number type.
Signature:
export interface SingleNumberElement extends NumberElement
| Property | Type | Description |
|---|---|---|
| value | number |
Home > @acoustic-content-sdk/api > SingleOptionSelectionElement
The text element holds text value in a JSON string.
Signature:
export interface SingleOptionSelectionElement extends OptionSelectionElement
| Property | Type | Description |
|---|---|---|
| value | OptionSelection |
Home > @acoustic-content-sdk/api > SingleProductElement
The text element holds text value in a JSON string.
Signature:
export interface SingleProductElement extends ProductElement
| Property | Type | Description |
|---|---|---|
| value | string |
Home > @acoustic-content-sdk/api > SingleReferenceElement
Signature:
export interface SingleReferenceElement extends ReferenceElement
| Property | Type | Description |
|---|---|---|
| value | RenderingContext |
Home > @acoustic-content-sdk/api > SingleTextElement
The text element holds text value in a JSON string.
Signature:
export interface SingleTextElement extends TextElement
| Property | Type | Description |
|---|---|---|
| value | string |
Home > @acoustic-content-sdk/api > SingleToggleElement
Toggle just uses JSON Boolean.
Signature:
export interface SingleToggleElement extends ToggleElement
| Property | Type | Description |
|---|---|---|
| value | boolean |
Home > @acoustic-content-sdk/api > 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.
Signature:
export interface SingleVideoElement extends VideoElement, Video
Home > @acoustic-content-sdk/api > Site
Signature:
export interface Site extends SiteRoot
| Property | Type | Description |
|---|---|---|
| id | string | |
| name | string | |
| pages | SiteChild[] |
Home > @acoustic-content-sdk/api > SiteChild
Signature:
export interface SiteChild extends SitePage
| Property | Type | Description |
|---|---|---|
| children | SiteChild[] |
Home > @acoustic-content-sdk/api > SiteContext
Signature:
export interface SiteContext
| Property | Type | Description |
|---|---|---|
| breadcrumb | SitePage[] | |
| children | SitePage[] | |
| parent | SitePage | |
| sibling | SitePage[] | |
| site | Site |
Home > @acoustic-content-sdk/api > SiteDeliveryContentItem
Signature:
export interface SiteDeliveryContentItem
| Property | Type | Description |
|---|---|---|
| $metadata | DeliveryContentMetadata | Metadata record |
| navigation | DeliveryReferenceElement | Navigation reference |
| styles | DeliveryReferenceElement | Styles reference |
| title | string | Title |
Home > @acoustic-content-sdk/api > SiteNavigationDeliveryContentItem
Delivery record for the site content item
843fb991-7413-4517-bfcb-b59fc4b1f449
Signature:
export interface SiteNavigationDeliveryContentItem
| 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
Reference to a page in the site navigation
Signature:
export interface SiteNavigationPage
| 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
Signature:
export interface SitePage extends BaseDeliveryItem
| 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
Signature:
export interface SitePagesQueryResult
| Property | Type | Description |
|---|---|---|
| numFound | number | |
| sitePages | SitePage[] |
Home > @acoustic-content-sdk/api > SiteRoot
Signature:
export interface SiteRoot
Home > @acoustic-content-sdk/api > Tenant
Signature:
export interface Tenant
| 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
Common base class for all text elements
Signature:
export interface TextElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'text' |
Home > @acoustic-content-sdk/api > ToggleElement
Common base class for all toggle elements
Signature:
export interface ToggleElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'toggle' |
Home > @acoustic-content-sdk/api > TypeRef
Reference to a content type
Signature:
export interface TypeRef
| Property | Type | Description |
|---|---|---|
| description | string | |
| id | string | |
| name | string |
Home > @acoustic-content-sdk/api > UrlConfig
Exposes the URL configuration to the client.
See HubInfoConfig
Signature:
export interface UrlConfig extends HubInfo
| 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
Representation of a user
Signature:
export interface User
| 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
Signature:
export interface Video
| Property | Type | Description |
|---|---|---|
| asset | Asset | |
| caption | Resource | |
| thumbnail | Resource | |
| url | string |
Home > @acoustic-content-sdk/api > VideoElement
Common base class for all video elements
Signature:
export interface VideoElement extends AbstractElement
| Property | Type | Description |
|---|---|---|
| elementType | 'video' |
Home > @acoustic-content-sdk/api > WchHttp
Signature:
export interface WchHttp
| 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
Signature:
export interface WchSdk
| 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
Signature:
export interface WchSdkRouter
| 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
Signature:
export interface WchSdkSearch
| 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
Defines the version number and the build date of the SDK.
Signature:
export interface WchSdkVersion
| 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
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
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
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
Signature:
ACOUSTIC_SDK_MODULE_NAME = "WchSdk"
Home > @acoustic-content-sdk/api > CLASSIFICATION_ASSET
Signature:
CLASSIFICATION_ASSET = "asset"
Home > @acoustic-content-sdk/api > CLASSIFICATION_CONTENT_TYPE
Signature:
CLASSIFICATION_CONTENT_TYPE = "content-type"
Home > @acoustic-content-sdk/api > CLASSIFICATION_CONTENT
Signature:
CLASSIFICATION_CONTENT = "content"
Home > @acoustic-content-sdk/api > CLASSIFICATION_LAYOUT_MAPPING
Signature:
CLASSIFICATION_LAYOUT_MAPPING = "layout-mapping"
Home > @acoustic-content-sdk/api > CLASSIFICATION_LAYOUT
Signature:
CLASSIFICATION_LAYOUT = "layout"
Home > @acoustic-content-sdk/api > CLASSIFICATION_PAGE
Signature:
CLASSIFICATION_PAGE = "page"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_CATEGORY
Signature:
_ELEMENT_TYPE_CATEGORY = "category"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_DATE
Signature:
_ELEMENT_TYPE_DATE = "datetime"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_FILE
Signature:
_ELEMENT_TYPE_FILE = "file"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_FORMATTED_TEXT
Signature:
_ELEMENT_TYPE_FORMATTED_TEXT = "formattedtext"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_GROUP
Signature:
_ELEMENT_TYPE_GROUP = "group"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_IMAGE
Signature:
_ELEMENT_TYPE_IMAGE = "image"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_LINK
Signature:
_ELEMENT_TYPE_LINK = "link"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_LOCATION
Signature:
_ELEMENT_TYPE_LOCATION = "location"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_NUMBER
Signature:
_ELEMENT_TYPE_NUMBER = "number"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_OPTION_SELECTION
Signature:
_ELEMENT_TYPE_OPTION_SELECTION = "optionselection"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_PRODUCT
Signature:
_ELEMENT_TYPE_PRODUCT = "product"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_REFERENCE
Signature:
_ELEMENT_TYPE_REFERENCE = "reference"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_TEXT
Signature:
_ELEMENT_TYPE_TEXT = "text"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_TOGGLE
Signature:
_ELEMENT_TYPE_TOGGLE = "toggle"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_VARIABLE
Signature:
_ELEMENT_TYPE_VARIABLE = "variabletype"
Home > @acoustic-content-sdk/api > ELEMENT_TYPE_VIDEO
Signature:
_ELEMENT_TYPE_VIDEO = "video"
Home > @acoustic-content-sdk/api > HEADER_BASICAUTH_TENANT_ID
Signature:
HEADER_BASICAUTH_TENANT_ID = "x-ibm-dx-tenant-id"
Home > @acoustic-content-sdk/api > KEY_ACCEPT_PRIVACY_NOTICE
Signature:
KEY_ACCEPT_PRIVACY_NOTICE = "accept-privacy-notice"
Home > @acoustic-content-sdk/api > KEY_ACCESSOR
Signature:
KEY_ACCESSOR = "accessor"
Home > @acoustic-content-sdk/api > KEY_ACOUSTIC_SEED
Signature:
KEY_ACOUSTIC_SEED = "-wch-seed"
Home > @acoustic-content-sdk/api > KEY_BASICAUTH_LOGIN_PASSWORD
Signature:
KEY_BASICAUTH_LOGIN_PASSWORD = "j_password"
Home > @acoustic-content-sdk/api > KEY_BASICAUTH_LOGIN_USERNAME
Signature:
KEY_BASICAUTH_LOGIN_USERNAME = "j_username"
Home > @acoustic-content-sdk/api > KEY_CREATOR_ID
Signature:
KEY_CREATOR_ID = "creatorId"
Home > @acoustic-content-sdk/api > KEY_ELEMENT_TYPE
Signature:
KEY_ELEMENT_TYPE = "elementType"
Home > @acoustic-content-sdk/api > KEY_ID
Signature:
KEY_ID = "id"
Home > @acoustic-content-sdk/api > KEY_METADATA
Signature:
KEY_METADATA: keyof DeliveryReferenceElement
Home > @acoustic-content-sdk/api > KEY_NAME
Signature:
KEY_NAME = "name"
Home > @acoustic-content-sdk/api > KEY_STATUS
Signature:
KEY_STATUS = "status"
Home > @acoustic-content-sdk/api > KEY_TYPE_ID
Signature:
KEY_TYPE_ID = "typeId"
Home > @acoustic-content-sdk/api > KEY_TYPE_REF
Signature:
KEY_TYPE_REF = "typeRef"
Home > @acoustic-content-sdk/api > KEY_VALUE
Signature:
KEY_VALUE = "value"
Home > @acoustic-content-sdk/api > KEY_VALUES
Signature:
KEY_VALUES = "values"
Home > @acoustic-content-sdk/api > MODULE
Module name
Signature:
MODULE = "@acoustic-content-sdk/api"
Home > @acoustic-content-sdk/api > PARAM_REDIRECT_LOGIN_TARGET_TENANT
Signature:
PARAM_REDIRECT_LOGIN_TARGET_TENANT = "targetTenant"
Home > @acoustic-content-sdk/api > PARAM_REDIRECT_LOGIN_TARGET_URL
Signature:
PARAM_REDIRECT_LOGIN_TARGET_URL = "targetUrl"
Home > @acoustic-content-sdk/api > REGEXP_ANONYMOUS_USER_ID
Signature:
REGEXP_ANONYMOUS_USER_ID: RegExp
Home > @acoustic-content-sdk/api > REL_PATH_BASICAUTH_LOGIN
Signature:
REL_PATH_BASICAUTH_LOGIN = "login/v1/basicauth"
Home > @acoustic-content-sdk/api > REL_PATH_CURRENT_TENANT
Signature:
REL_PATH_CURRENT_TENANT = "registry/v1/currenttenant"
Home > @acoustic-content-sdk/api > REL_PATH_CURRENT_USER
Signature:
REL_PATH_CURRENT_USER = "user-profile/v1/users/currentuser"
Home > @acoustic-content-sdk/api > REL_PATH_REDIRECT_LOGIN
Signature:
REL_PATH_REDIRECT_LOGIN = "login/v1/redirect"
Home > @acoustic-content-sdk/api > REL_PATH_REMOVECOOKIES
Signature:
REL_PATH_REMOVECOOKIES = "login/v1/removecookies"
Home > @acoustic-content-sdk/api > REL_PATH_TYPE_BY_ID
Signature:
REL_PATH_TYPE_BY_ID = "authoring/v1/types/"
Home > @acoustic-content-sdk/api > SDK_ACTIVE_ROUTE_EVENT_TYPE
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
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
Event that triggers a navigation
Signature:
SDK_NAVIGATE_BY_PATH_EVENT_TYPE = "WchSdk.router.navigateByPath"
Home > @acoustic-content-sdk/api > SDK_REFRESH_EVENT_TYPE
Event that triggers a refresh
Signature:
SDK_REFRESH_EVENT_TYPE = "WchSdk.refresh"
Home > @acoustic-content-sdk/api > SDK_ROUTE_EVENT_TYPE
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
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
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
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
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
Event that unsubscribes a listener
Signature:
SDK_UNSUBSCRIBE_EVENT_TYPE = "WchSdk.unsubscribe"
Home > @acoustic-content-sdk/api > SEARCH_FL_DOCUMENT
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
Signature:
VALUE_ACCEPT_PRIVACY_NOTICE = "true"
Home > @acoustic-content-sdk/api > VERSION
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
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
Signature:
export declare type AUTHORING_ELEMENT_DATETIME_SEARCH_KEY = 'date1' | 'date2' | 'sortableDate1' | 'sortableDate2';
Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_FILE_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
Signature:
export declare type AUTHORING_ELEMENT_IMAGE_TYPE = 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg';
Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_LOCATION_SEARCH_KEY
Signature:
export declare type AUTHORING_ELEMENT_LOCATION_SEARCH_KEY = 'location1';
Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_NUMBER_SEARCH_KEY
Signature:
export declare type AUTHORING_ELEMENT_NUMBER_SEARCH_KEY = 'number1' | 'number2' | 'sortableNumber1' | 'sortableNumber2';
Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_ROLE
Signature:
export declare type AUTHORING_ELEMENT_ROLE = 'content' | 'configuration';
Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_TEXT_SEARCH_KEY
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
Signature:
export declare type AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY = 'boolean1' | 'boolean2';
Home > @acoustic-content-sdk/api > AUTHORING_ELEMENT_VIDEO_TYPE
Signature:
export declare type AUTHORING_ELEMENT_VIDEO_TYPE = 'mp4' | 'mov';
Home > @acoustic-content-sdk/api > AUTHORING_TYPE_KIND
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
Signature:
export declare type CONTENT_ITEM_KIND = AUTHORING_CONTENT_ITEM_KIND;
Home > @acoustic-content-sdk/api > DeliveryDateElement
Signature:
export declare type DeliveryDateElement = string;
Home > @acoustic-content-sdk/api > DeliveryElement
Signature:
export declare type DeliveryElement = SingleDeliveryElements | MultiDeliveryElements;
Home > @acoustic-content-sdk/api > DeliveryFileAsset
Signature:
export declare type DeliveryFileAsset = DeliveryAsset;
Home > @acoustic-content-sdk/api > DeliveryFormattedTextElement
Signature:
export declare type DeliveryFormattedTextElement = string;
Home > @acoustic-content-sdk/api > DeliveryImageMode
Signature:
export declare type DeliveryImageMode = 'shared' | 'snapshot';
Home > @acoustic-content-sdk/api > DeliveryImageScale
Signature:
export declare type DeliveryImageScale = number;
Home > @acoustic-content-sdk/api > DeliveryLayout
Signature:
export declare type DeliveryLayout = AuthoringLayoutItem;
Home > @acoustic-content-sdk/api > DeliveryLayoutMapping
Signature:
export declare type DeliveryLayoutMapping = AuthoringLayoutMapping;
Home > @acoustic-content-sdk/api > DeliveryNumberElement
Signature:
export declare type DeliveryNumberElement = number;
Home > @acoustic-content-sdk/api > DeliveryOptionsElement
Signature:
export declare type DeliveryOptionsElement = string;
Home > @acoustic-content-sdk/api > DeliverySelectedLayouts
Signature:
export declare type DeliverySelectedLayouts = DeliverySelectedLayout[];
Home > @acoustic-content-sdk/api > DeliveryTextElement
Signature:
export declare type DeliveryTextElement = string;
Home > @acoustic-content-sdk/api > DeliveryToggleElement
Signature:
export declare type DeliveryToggleElement = boolean;
Home > @acoustic-content-sdk/api > DeliveryType
Signature:
export declare type DeliveryType = AuthoringType;
Home > @acoustic-content-sdk/api > ELEMENT_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
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
Signature:
export declare type GroupType = ElementMap<SimpleType>;
Home > @acoustic-content-sdk/api > HubInfoUrlProvider
Signature:
export declare type HubInfoUrlProvider = null | undefined | StaticHubInfoUrlProvider | ObservableInput<StaticHubInfoUrlProvider>;
Home > @acoustic-content-sdk/api > Layouts
Ordering of the layouts per layout mode
Signature:
export declare type Layouts = Record<string, Layout>;
Home > @acoustic-content-sdk/api > Locale
Helper type to identify a locale in the interfaces
Signature:
export declare type Locale = string;
Home > @acoustic-content-sdk/api > Localized
Object supporting localizations
Signature:
export declare type Localized = LocalizedText[];
Home > @acoustic-content-sdk/api > LocalizedContext
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
Text with attached locale
Signature:
export declare type LocalizedText = [string, Locale];
Home > @acoustic-content-sdk/api > MultiDeliveryElements
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
Signature:
export declare type MultiRenderingContextElements = Exclude<MultiDeliveryElements, DeliveryGroupElement[] | DeliveryReferenceElement[]> | RenderingContextGroupElement[] | RenderingContextReferenceElement[];
Home > @acoustic-content-sdk/api > QueryInput
Signature:
export declare type QueryInput = string | string[] | null | undefined | URLSearchParams | Query;
Home > @acoustic-content-sdk/api > QueryValue
acceptable values for
Signature:
export declare type QueryValue = string | number | boolean;
Home > @acoustic-content-sdk/api > RenderingContextElements
Signature:
export declare type RenderingContextElements = SingleRenderingContextElements | MultiRenderingContextElements;
Home > @acoustic-content-sdk/api > SdkMessageHandlerCallback
Signature:
export declare type SdkMessageHandlerCallback = (aPayload: SdkMessagePayload, aEvent: MessageEvent) => PromiseLike<SdkMessagePayload> | SdkMessagePayload | null | undefined;
Home > @acoustic-content-sdk/api > SimpleType
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
Signature:
export declare type SingleDeliveryElements = DeliveryImageElement | DeliveryLinkElement | DeliveryGroupElement | DeliveryReferenceElement | DeliveryFileElement | DeliveryDateElement | DeliveryNumberElement | DeliveryFormattedTextElement | DeliveryTextElement | DeliveryToggleElement | DeliveryVideoElement | DeliveryLocationElement | DeliveryOptionsElement;
Home > @acoustic-content-sdk/api > SingleRenderingContextElements
Signature:
export declare type SingleRenderingContextElements = Exclude<SingleDeliveryElements, DeliveryGroupElement | DeliveryReferenceElement> | RenderingContextGroupElement | RenderingContextReferenceElement;
Home > @acoustic-content-sdk/api > SiteNavigation
The list of root pages
Signature:
export declare type SiteNavigation = SiteNavigationPage[];
Home > @acoustic-content-sdk/api > StaticHubInfoUrlProvider
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
Signature:
readonly elementType: ELEMENT_TYPE;
Home > @acoustic-content-sdk/api > ActivePage > onRenderingContext
Retrieves the rendering context for the content item rendered for the currently selected page.
Signature:
onRenderingContext: Observable<RenderingContext>;
Home > @acoustic-content-sdk/api > ActivePageV2 > renderingContext$
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
Signature:
readonly altText?: string;
Home > @acoustic-content-sdk/api > Asset > fileName
Signature:
readonly fileName: string;
Home > @acoustic-content-sdk/api > Asset > fileSize
Signature:
readonly fileSize: number;
Home > @acoustic-content-sdk/api > Asset > height
Signature:
readonly height: number;
Home > @acoustic-content-sdk/api > Asset > id
Signature:
readonly id: string;
Home > @acoustic-content-sdk/api > Asset > mediaType
Signature:
readonly mediaType: string;
Home > @acoustic-content-sdk/api > Asset > resourceUri
Signature:
readonly resourceUri: string;
Home > @acoustic-content-sdk/api > Asset > width
added by delivery
Signature:
readonly width: number;
Home > @acoustic-content-sdk/api > AssetPublishApproval > enabled
True if mandatory approval is enabled
Signature:
enabled?: boolean;
Home > @acoustic-content-sdk/api > AssetPublishApproval > exemptAssetTypes
Signature:
exemptAssetTypes: string[];
Home > @acoustic-content-sdk/api > AuthoringAsset > altText
Signature:
readonly altText?: string;
Home > @acoustic-content-sdk/api > AuthoringAsset > assetType
Signature:
readonly assetType?: string;
Home > @acoustic-content-sdk/api > AuthoringAsset > caption
Signature:
readonly caption?: string;
Home > @acoustic-content-sdk/api > AuthoringAsset > classification
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
Signature:
readonly digest?: string;
Home > @acoustic-content-sdk/api > AuthoringAsset > fileName
Signature:
readonly fileName?: string;
Home > @acoustic-content-sdk/api > AuthoringAsset > fileSize
Signature:
readonly fileSize?: number;
Home > @acoustic-content-sdk/api > AuthoringAsset > isManaged
Signature:
readonly isManaged: boolean;
Home > @acoustic-content-sdk/api > AuthoringAsset > mediaType
Signature:
readonly mediaType?: string;
Home > @acoustic-content-sdk/api > AuthoringAsset > metadata
Signature:
readonly metadata?: AuthoringAssetMetadata;
Home > @acoustic-content-sdk/api > AuthoringAsset > path
Signature:
readonly path: string;
Home > @acoustic-content-sdk/api > AuthoringAsset > profileRenditions
Signature:
readonly profileRenditions?: AuthoringAssetProfileRendition[];
Home > @acoustic-content-sdk/api > AuthoringAsset > resource
Signature:
readonly resource: string;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > camera
Signature:
readonly camera?: any;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > coverage
Signature:
readonly coverage?: any;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > creator
Signature:
readonly creator?: string;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > description
Signature:
readonly description?: string;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > headline
Signature:
readonly headline?: string;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > heigth
Signature:
readonly heigth?: number;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > publisher
Signature:
readonly publisher?: string;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > rights
Signature:
readonly rights?: string;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > source
Signature:
readonly source?: string;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > subject
Signature:
readonly subject?: string[];
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > title
Signature:
readonly title?: string;
Home > @acoustic-content-sdk/api > AuthoringAssetMetadata > width
Signature:
readonly width?: number;
Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > height
Signature:
readonly height: number;
Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > key
Signature:
readonly key: string;
Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > profileId
Signature:
readonly profileId: string;
Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > transform
Signature:
readonly transform: any;
Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > uri
Signature:
readonly uri: string;
Home > @acoustic-content-sdk/api > AuthoringAssetProfileRendition > width
Signature:
readonly width: number;
Home > @acoustic-content-sdk/api > AuthoringCommerceProductCategoryElement > elementType
Signature:
elementType: 'productcategory';
Home > @acoustic-content-sdk/api > AuthoringCommerceProductCategoryElement > restrictedParent
Signature:
restrictedParent?: string;
Home > @acoustic-content-sdk/api > AuthoringCommerceProductCategoryElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringCommerceProductElement > elementType
Signature:
elementType: 'product';
Home > @acoustic-content-sdk/api > AuthoringCommerceProductElement > restrictedCategories
Signature:
restrictedCategories?: string[];
Home > @acoustic-content-sdk/api > AuthoringCommerceProductElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringCategoryElement > elementType
Signature:
elementType: 'category';
Home > @acoustic-content-sdk/api > AuthoringCategoryElement > restrictedParents
Signature:
restrictedParents?: string[];
Home > @acoustic-content-sdk/api > AuthoringCategoryElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringContentItem > classification
Signature:
classification: 'content';
Home > @acoustic-content-sdk/api > AuthoringContentItem > deliveryAccess
Signature:
deliveryAccess?: 'secured';
Home > @acoustic-content-sdk/api > AuthoringContentItem > draftStatus
Signature:
draftStatus?: DraftStatus;
Home > @acoustic-content-sdk/api > AuthoringContentItem > elements
Signature:
elements?: Record<string, any>;
Home > @acoustic-content-sdk/api > AuthoringContentItem > form
Signature:
form?: any[];
Home > @acoustic-content-sdk/api > AuthoringContentItem > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > keywords
Signature:
keywords?: string[];
Home > @acoustic-content-sdk/api > AuthoringContentItem > kind
Signature:
kind?: AUTHORING_CONTENT_ITEM_KIND[];
Home > @acoustic-content-sdk/api > AuthoringContentItem > lastModified
Signature:
lastModified?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > lastModifier
Signature:
lastModifier?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > lastModifierId
Signature:
lastModifierId?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > linkedDocId
Signature:
linkedDocId?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > links
Signature:
links?: Record<string, any>;
Home > @acoustic-content-sdk/api > AuthoringContentItem > locale
Signature:
locale?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > projectId
Signature:
projectId?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > projects
Signature:
projects?: string[];
Home > @acoustic-content-sdk/api > AuthoringContentItem > publishing
Signature:
publishing?: Record<string, any>;
Home > @acoustic-content-sdk/api > AuthoringContentItem > review
Signature:
review?: Record<string, any>;
Home > @acoustic-content-sdk/api > AuthoringContentItem > reviewHistory
Signature:
reviewHistory?: string[];
Home > @acoustic-content-sdk/api > AuthoringContentItem > reviewId
Signature:
reviewId?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > schema
Signature:
schema?: Record<string, any>;
Home > @acoustic-content-sdk/api > AuthoringContentItem > selectedLayouts
Signature:
selectedLayouts?: AuthoringSelectedLayout[];
Home > @acoustic-content-sdk/api > AuthoringContentItem > status
Signature:
status: Status;
Home > @acoustic-content-sdk/api > AuthoringContentItem > systemModified
Signature:
systemModified?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > tags
Signature:
tags?: string[];
Home > @acoustic-content-sdk/api > AuthoringContentItem > thumbnail
Signature:
thumbnail?: AuthoringContentItemThumbnail;
Home > @acoustic-content-sdk/api > AuthoringContentItem > type
Signature:
type?: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > typeId
Signature:
typeId: string;
Home > @acoustic-content-sdk/api > AuthoringContentItem > valid
Signature:
valid?: boolean;
Home > @acoustic-content-sdk/api > AuthoringContentItemThumbnail > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > AuthoringContentThumbnail > imageElement
Signature:
imageElement?: string;
Home > @acoustic-content-sdk/api > AuthoringContentThumbnail > source
Signature:
source: 'imageElementOrType' | 'imageElement' | 'type' | 'none';
Home > @acoustic-content-sdk/api > AuthoringDatetimeElement > elementType
Signature:
elementType: 'datetime';
Home > @acoustic-content-sdk/api > AuthoringDatetimeElement > fieldType
Signature:
fieldType?: 'date' | 'date-time';
Home > @acoustic-content-sdk/api > AuthoringDatetimeElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_DATETIME_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringElement > allowMultipleValues
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
Specifies the type of this element.
Signature:
elementType: ELEMENT_TYPE | 'productcategory' | 'product';
Home > @acoustic-content-sdk/api > AuthoringElement > fieldLabel
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
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
The element identifer. Within content items, elements are referred to by key only.
Signature:
key: string;
Home > @acoustic-content-sdk/api > AuthoringElement > label
The display name of the element.
Signature:
label: string;
Home > @acoustic-content-sdk/api > AuthoringElement > maximumValues
When allowMulitpleValues is true, indicates the maximum number of values are that allowed.
Signature:
maximumValues?: number;
Home > @acoustic-content-sdk/api > AuthoringElement > minimumValues
When allowMulitpleValues is true, indicates the minimum number of values are that required.
Signature:
minimumValues?: number;
Home > @acoustic-content-sdk/api > AuthoringElement > placeholder
Signature:
placeholder?: AuthoringPlaceholder;
Home > @acoustic-content-sdk/api > AuthoringElement > required
Indicates whether content items must specify a value for this element.
Signature:
required?: boolean;
Home > @acoustic-content-sdk/api > AuthoringElement > role
Signature:
role?: AUTHORING_ELEMENT_ROLE[];
Home > @acoustic-content-sdk/api > AuthoringElement > uiExtensions
Signature:
uiExtensions?: AuthoringUiExtensions;
Home > @acoustic-content-sdk/api > AuthoringFileElement > acceptType
Signature:
acceptType?: AUTHORING_ELEMENT_FILE_TYPE[];
Home > @acoustic-content-sdk/api > AuthoringFileElement > elementType
Signature:
elementType: 'file';
Home > @acoustic-content-sdk/api > AuthoringFileElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringFormattedTextElement > elementType
Signature:
elementType: 'formattedtext';
Home > @acoustic-content-sdk/api > AuthoringFormattedTextElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringGroupElement > elements
Signature:
elements?: any[];
Home > @acoustic-content-sdk/api > AuthoringGroupElement > elementType
Signature:
elementType: 'group';
Home > @acoustic-content-sdk/api > AuthoringGroupElement > icon
Signature:
icon?: ELEMENT_TYPE;
Home > @acoustic-content-sdk/api > AuthoringGroupElement > kind
Signature:
kind?: AUTHORING_TYPE_KIND[];
Home > @acoustic-content-sdk/api > AuthoringGroupElement > typeRef
Signature:
typeRef: TypeRef;
Home > @acoustic-content-sdk/api > AuthoringGroup > elementType
Signature:
[KEY_ELEMENT_TYPE]: typeof ELEMENT_TYPE_GROUP;
Home > @acoustic-content-sdk/api > AuthoringGroup > typeRef
Signature:
[KEY_TYPE_REF]: AuthoringReferenceValue;
Home > @acoustic-content-sdk/api > AuthoringGroup > value
Signature:
[KEY_VALUE]?: T;
Home > @acoustic-content-sdk/api > AuthoringGroup > values
Signature:
[KEY_VALUES]?: T[];
Home > @acoustic-content-sdk/api > AuthoringImage > elementType
Signature:
[KEY_ELEMENT_TYPE]: typeof ELEMENT_TYPE_IMAGE;
Home > @acoustic-content-sdk/api > AuthoringImage > values
Signature:
[KEY_VALUES]?: Image[];
Home > @acoustic-content-sdk/api > AuthoringImageElement > acceptType
Signature:
acceptType?: AUTHORING_ELEMENT_IMAGE_TYPE[];
Home > @acoustic-content-sdk/api > AuthoringImageElement > elementType
Signature:
elementType: 'image';
Home > @acoustic-content-sdk/api > AuthoringImageElement > imageProfile
Signature:
imageProfile?: Record<string, any>;
Home > @acoustic-content-sdk/api > AuthoringImageElement > imageProfileId
Signature:
imageProfileId?: string;
Home > @acoustic-content-sdk/api > AuthoringImageElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringLayout > classification
Signature:
classification: 'layout';
Home > @acoustic-content-sdk/api > AuthoringLayout > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > AuthoringLayout > name
Signature:
name?: string;
Home > @acoustic-content-sdk/api > AuthoringLayout > path
Signature:
path?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutItem > classification
Signature:
classification: 'layout';
Home > @acoustic-content-sdk/api > AuthoringLayoutItem > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutItem > name
Signature:
name: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutItem > path
Signature:
path?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutItem > prerender
Signature:
prerender?: boolean;
Home > @acoustic-content-sdk/api > AuthoringLayoutItem > urlTemplate
Signature:
urlTemplate?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > _revisions
Signature:
_revisions?: Record<string, string>;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > classification
Signature:
classification: 'layout-mapping';
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > created
Signature:
created?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > creatorId
Signature:
creatorId?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > id
Signature:
id?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > lastModified
Signature:
lastModified?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > lastModifierId
Signature:
lastModifierId?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > mappings
Signature:
mappings: AuthoringLayoutMappingMapping[];
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > name
Signature:
name: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > path
Signature:
path?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > rev
Signature:
rev?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > tags
Signature:
tags?: string[];
Home > @acoustic-content-sdk/api > AuthoringLayoutMapping > type
Signature:
type: AuthoringLayoutMappingType;
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingLayout > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingLayout > name
Signature:
name?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingMapping > defaultLayout
Signature:
defaultLayout: AuthoringLayoutMappingLayout;
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingMapping > layoutMode
Signature:
layoutMode?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingMapping > layouts
Signature:
layouts: AuthoringLayoutMappingLayout[];
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingType > id
Signature:
id?: string;
Home > @acoustic-content-sdk/api > AuthoringLayoutMappingType > name
Signature:
name?: string;
Home > @acoustic-content-sdk/api > AuthoringLinkElement > elementType
Signature:
elementType: 'link';
Home > @acoustic-content-sdk/api > AuthoringLinkElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringLocationElement > elementType
Signature:
elementType: 'location';
Home > @acoustic-content-sdk/api > AuthoringLocationElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_LOCATION_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringNumberElement > elementType
Signature:
elementType: 'number';
Home > @acoustic-content-sdk/api > AuthoringNumberElement > fieldType
Signature:
fieldType?: 'integer' | 'decimal';
Home > @acoustic-content-sdk/api > AuthoringNumberElement > maximum
Signature:
maximum?: number;
Home > @acoustic-content-sdk/api > AuthoringNumberElement > minimum
Signature:
minimum?: number;
Home > @acoustic-content-sdk/api > AuthoringNumberElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_NUMBER_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringOption > label
Signature:
label: string;
Home > @acoustic-content-sdk/api > AuthoringOption > selection
Signature:
selection: string;
Home > @acoustic-content-sdk/api > AuthoringOptionSelectionElement > elementType
Signature:
elementType: 'optionselection';
Home > @acoustic-content-sdk/api > AuthoringOptionSelectionElement > options
Signature:
options?: AuthoringOption[];
Home > @acoustic-content-sdk/api > AuthoringOptionSelectionElement > restrictedParents
Signature:
restrictedParents?: string[];
Home > @acoustic-content-sdk/api > AuthoringOptionSelectionElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringPlaceholder > show
Signature:
show?: boolean;
Home > @acoustic-content-sdk/api > AuthoringPlaceholder > text
Signature:
text?: string;
Home > @acoustic-content-sdk/api > AuthoringReference > elementType
Signature:
[KEY_ELEMENT_TYPE]: typeof ELEMENT_TYPE_REFERENCE;
Home > @acoustic-content-sdk/api > AuthoringReference > value
Signature:
[KEY_VALUE]?: AuthoringReferenceValue[];
Home > @acoustic-content-sdk/api > AuthoringReference > values
Signature:
[KEY_VALUES]?: AuthoringReferenceValue[];
Home > @acoustic-content-sdk/api > AuthoringReferenceElement > elementType
Signature:
elementType: 'reference';
Home > @acoustic-content-sdk/api > AuthoringReferenceElement > restrictTypes
Signature:
restrictTypes?: TypeRef;
Home > @acoustic-content-sdk/api > AuthoringReferenceElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringReferenceValue > creatorId
Signature:
[KEY_CREATOR_ID]?: string;
Home > @acoustic-content-sdk/api > AuthoringReferenceValue > id
Signature:
[KEY_ID]: string;
Home > @acoustic-content-sdk/api > AuthoringReferenceValue > name
Signature:
[KEY_NAME]?: string;
Home > @acoustic-content-sdk/api > AuthoringReferenceValue > status
Signature:
[KEY_STATUS]?: Status;
Home > @acoustic-content-sdk/api > AuthoringReferenceValue > typeId
Signature:
[KEY_TYPE_ID]?: string;
Home > @acoustic-content-sdk/api > AuthoringText > elementType
Signature:
[KEY_ELEMENT_TYPE]: typeof ELEMENT_TYPE_TEXT;
Home > @acoustic-content-sdk/api > AuthoringText > value
Signature:
[KEY_VALUE]?: string;
Home > @acoustic-content-sdk/api > AuthoringText > values
Signature:
[KEY_VALUES]?: string[];
Home > @acoustic-content-sdk/api > AuthoringTextElement > displayHeight
Signature:
displayHeight?: number;
Home > @acoustic-content-sdk/api > AuthoringTextElement > displayType
Signature:
displayType?: 'singleLine' | 'multiLine';
Home > @acoustic-content-sdk/api > AuthoringTextElement > displayWidth
Signature:
displayWidth?: number;
Home > @acoustic-content-sdk/api > AuthoringTextElement > elementType
Signature:
elementType: 'text';
Home > @acoustic-content-sdk/api > AuthoringTextElement > maxLength
Signature:
maxLength?: number;
Home > @acoustic-content-sdk/api > AuthoringTextElement > minLength
Signature:
minLength?: number;
Home > @acoustic-content-sdk/api > AuthoringTextElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringThumbnail > id
Signature:
id?: string;
Home > @acoustic-content-sdk/api > AuthoringThumbnail > path
Signature:
path?: string;
Home > @acoustic-content-sdk/api > AuthoringThumbnail > url
Signature:
url?: string;
Home > @acoustic-content-sdk/api > AuthoringSelectedLayout > layout
Signature:
layout: AuthoringLayout;
Home > @acoustic-content-sdk/api > AuthoringSelectedLayout > layoutMode
Signature:
layoutMode?: string;
Home > @acoustic-content-sdk/api > AuthoringToggleElement > elementType
Signature:
elementType: 'toggle';
Home > @acoustic-content-sdk/api > AuthoringToggleElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TOGGLE_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthoringToggleElement > statement
Signature:
statement?: string;
Home > @acoustic-content-sdk/api > AuthoringType > _revisions
Unknown semantic
Signature:
_revisions?: Record<string, any>;
Home > @acoustic-content-sdk/api > AuthoringType > categories
Signature:
categories?: string[];
Home > @acoustic-content-sdk/api > AuthoringType > categoryIds
Signature:
categoryIds?: string[];
Home > @acoustic-content-sdk/api > AuthoringType > classification
Fixed classification
Signature:
classification: 'content-type';
Home > @acoustic-content-sdk/api > AuthoringType > contentThumbnail
Optional content thumbnail for the type
Signature:
contentThumbnail?: AuthoringContentThumbnail;
Home > @acoustic-content-sdk/api > AuthoringType > elements
Elements on the type, strange that this is an array and not a map
Signature:
elements: AuthoringElement[];
Home > @acoustic-content-sdk/api > AuthoringType > icon
Optional icon to be used for the type
Signature:
icon?: ELEMENT_TYPE;
Home > @acoustic-content-sdk/api > AuthoringType > kind
Lisz of possible kinds for the authoring type
Signature:
kind?: AUTHORING_TYPE_KIND[];
Home > @acoustic-content-sdk/api > AuthoringType > linkedDocId
Signature:
linkedDocId?: string;
Home > @acoustic-content-sdk/api > AuthoringType > status
Signature:
status: Status;
Home > @acoustic-content-sdk/api > AuthoringType > tags
Signature:
tags?: string[];
Home > @acoustic-content-sdk/api > AuthoringType > thumbnail
Optional thumbnail for the type
Signature:
thumbnail?: AuthoringThumbnail;
Home > @acoustic-content-sdk/api > AuthoringType > uiExtensions
Signature:
uiExtensions?: AuthoringUiExtensions;
Home > @acoustic-content-sdk/api > AuthoringUiExtensions > element
Signature:
element?: string;
Home > @acoustic-content-sdk/api > AuthoringUiExtensions > elementBuiltin
Signature:
elementBuiltin?: string;
Home > @acoustic-content-sdk/api > AuthoringUiExtensions > elementConfig
Signature:
elementConfig: any;
Home > @acoustic-content-sdk/api > AuthoringVariableTypeElement > elements
Signature:
elements: Record<string, any>[];
Home > @acoustic-content-sdk/api > AuthoringVariableTypeElement > elementType
Signature:
elementType: 'variabletype';
Home > @acoustic-content-sdk/api > AuthoringVideo > elementType
Signature:
[KEY_ELEMENT_TYPE]: typeof ELEMENT_TYPE_VIDEO;
Home > @acoustic-content-sdk/api > AuthoringVideo > values
Signature:
[KEY_VALUES]?: Video[];
Home > @acoustic-content-sdk/api > AuthoringVideoElement > acceptType
Signature:
acceptType?: AUTHORING_ELEMENT_VIDEO_TYPE[];
Home > @acoustic-content-sdk/api > AuthoringVideoElement > elementType
Signature:
elementType: 'video';
Home > @acoustic-content-sdk/api > AuthoringVideoElement > searchKey
Signature:
searchKey?: AUTHORING_ELEMENT_TEXT_SEARCH_KEY;
Home > @acoustic-content-sdk/api > AuthStatus > authenticated$
Exposes the flag that tells if the system is authenticated. This is e.g. used to decide to use the delivery or mydelivery routes.
Signature:
authenticated$: Observable<boolean>;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > classification
The classification defines the document type. For content items, all documents are classified as "content".
Signature:
classification?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > created
The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
Signature:
created?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > creatorId
Signature:
creatorId?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > description
The description of the item.
Signature:
readonly description?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > id
The ID of the content item.
Signature:
readonly id?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > lastModified
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.
Signature:
lastModified?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > lastModifierId
name of user for now, this property may change once user management is defined (read only).
Signature:
lastModifierId?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > linkedDocId
Optionally the ID of the ready item
Signature:
readonly linkedDocId?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > name
The name of the content item.
Signature:
readonly name: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > path
Signature:
path?: string;
Home > @acoustic-content-sdk/api > BaseAuthoringItem > rev
The current revision of the document.
Signature:
rev?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > classification
The classification defines the document type. For content items, all documents are classified as "content".
Signature:
classification?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > created
The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
Signature:
created?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > creatorId
Signature:
creatorId?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > description
The description of the item.
Signature:
description?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > id
The ID of the content item.
Signature:
id?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > lastModified
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.
Signature:
lastModified?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > lastModifierId
name of user for now, this property may change once user management is defined (read only).
Signature:
lastModifierId?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > name
The name of the content item.
Signature:
name?: string;
Home > @acoustic-content-sdk/api > BaseDeliveryItem > rev
The current revision of the document.
Signature:
rev?: string;
Home > @acoustic-content-sdk/api > Category > categories
Signature:
readonly categories?: string[];
Home > @acoustic-content-sdk/api > Category > categoryIds
Signature:
readonly categoryIds?: string[];
Home > @acoustic-content-sdk/api > Category > categoryPaths
extension for the local rendering context for convenience
Signature:
readonly categoryPaths?: string[][];
Home > @acoustic-content-sdk/api > CategoryElement > elementType
Signature:
readonly elementType: 'category';
Home > @acoustic-content-sdk/api > ContentItem > draftId
TBD
Signature:
draftId?: string;
Home > @acoustic-content-sdk/api > ContentItem > draftStatus
TBD
Signature:
draftStatus?: DraftStatus;
Home > @acoustic-content-sdk/api > ContentItem > elements
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.
Signature:
elements: {
[key: string]: any;
};
Home > @acoustic-content-sdk/api > ContentItem > kind
Kind of a content item
Signature:
kind: CONTENT_ITEM_KIND[];
Home > @acoustic-content-sdk/api > ContentItem > locale
locale of the document (e.g "en", or "de").
Signature:
locale?: string;
Home > @acoustic-content-sdk/api > ContentItem > projectId
The project ID
Signature:
projectId?: string;
Home > @acoustic-content-sdk/api > ContentItem > tags
The tags describing the content item.
Signature:
tags?: Array<string>;
Home > @acoustic-content-sdk/api > ContentItem > type
this is the link to the content type document this content is based on.
Signature:
type?: string;
Home > @acoustic-content-sdk/api > ContentItem > typeId
The ID of the content type this item belongs to.
Signature:
typeId?: string;
Home > @acoustic-content-sdk/api > ContentItemWithLayout > id
The ID of the content item.
Signature:
readonly id: string;
Home > @acoustic-content-sdk/api > ContentItemWithLayout > layouts
The layouts for the content item, ordered by mode. The 'default' mode always exists and denotes the default layout.
Signature:
readonly layouts: Layouts;
Home > @acoustic-content-sdk/api > ContentItemWithLayout > selectedLayouts
Optionally the explicitly assigned layouts
Signature:
readonly selectedLayouts?: AuthoringSelectedLayout[];
Home > @acoustic-content-sdk/api > DateElement > elementType
Signature:
readonly elementType: 'datetime';
Home > @acoustic-content-sdk/api > DeliveryAsset > fileName
Signature:
fileName: string;
Home > @acoustic-content-sdk/api > DeliveryAsset > fileSize
Signature:
fileSize: number;
Home > @acoustic-content-sdk/api > DeliveryAsset > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > DeliveryAsset > mediaType
Signature:
mediaType: string;
Home > @acoustic-content-sdk/api > DeliveryAsset > resourceUri
Signature:
resourceUri: string;
Home > @acoustic-content-sdk/api > DeliveryAccess > assets
Signature:
assets?: string;
Home > @acoustic-content-sdk/api > DeliveryAccess > content
Signature:
content?: string;
Home > @acoustic-content-sdk/api > DeliveryAccess > secureAlways
Signature:
secureAlways?: boolean;
Home > @acoustic-content-sdk/api > DeliveryCategoryElement > categoryIds
Signature:
categoryIds: string[];
Home > @acoustic-content-sdk/api > DeliveryCategoryElement > categoryPath
Signature:
categoryPath: string[];
Home > @acoustic-content-sdk/api > ContentPublishApproval > enabled
True if mandatory approval is enabled
Signature:
enabled?: boolean;
Home > @acoustic-content-sdk/api > ContentPublishApproval > exemptContentTypes
Signature:
exemptContentTypes: string[];
Home > @acoustic-content-sdk/api > DeliveryContentItem > $metadata
Metadata record
Signature:
$metadata: DeliveryContentMetadata;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > accessor
Accessor that references the main element relative to the root of the authoring data structure
Signature:
accessor: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > classification
Signature:
classification: 'content';
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > created
Signature:
created: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > creatorId
Signature:
creatorId: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > description
Signature:
description?: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > draftId
Signature:
draftId?: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > id
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'.
Signature:
id: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > keywords
Signature:
keywords?: string[];
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > kind
Signature:
kind?: string[];
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > lastModified
Signature:
lastModified: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > lastModifierId
Signature:
lastModifierId: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > locale
Signature:
locale: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > name
Signature:
name: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > protectedUrl
Signature:
protectedUrl: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > rev
Signature:
rev: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > selectedLayouts
Signature:
selectedLayouts?: DeliverySelectedLayouts;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > systemModified
Signature:
systemModified: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > tags
Signature:
tags?: string[];
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > thumbnail
Signature:
thumbnail?: DeliveryThumbnail;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > type
Signature:
type?: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > typeId
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.
Signature:
typeId: string;
Home > @acoustic-content-sdk/api > DeliveryContentMetadata > url
Signature:
url?: string;
Home > @acoustic-content-sdk/api > DeliveryFileElement > asset
Signature:
asset: DeliveryFileAsset;
Home > @acoustic-content-sdk/api > DeliveryFileElement > url
Signature:
url: string;
Home > @acoustic-content-sdk/api > DeliveryGroupElement > $metadata
Optional metadata
Signature:
$metadata?: DeliveryGroupElementMetadata;
Home > @acoustic-content-sdk/api > DeliveryGroupElementMetadata > accessor
Accessor that references the group element relative to the root of the authoring data structure
Signature:
accessor: string;
Home > @acoustic-content-sdk/api > DeliveryGroupElementMetadata > selectedLayouts
Optionally the selected layouts for the group element
Signature:
selectedLayouts?: DeliverySelectedLayouts;
Home > @acoustic-content-sdk/api > DeliveryImageAsset > altText
Signature:
altText: string;
Home > @acoustic-content-sdk/api > DeliveryImageAsset > height
Signature:
height: number;
Home > @acoustic-content-sdk/api > DeliveryImageAsset > width
Signature:
width: number;
Home > @acoustic-content-sdk/api > DeliveryImageCrop > height
Signature:
height: number;
Home > @acoustic-content-sdk/api > DeliveryImageCrop > width
Signature:
width: number;
Home > @acoustic-content-sdk/api > DeliveryImageCrop > x
Signature:
x: number;
Home > @acoustic-content-sdk/api > DeliveryImageCrop > y
Signature:
y: number;
Home > @acoustic-content-sdk/api > DeliveryImageElement > asset
Signature:
asset: DeliveryImageAsset;
Home > @acoustic-content-sdk/api > DeliveryImageElement > mode
Signature:
mode?: DeliveryImageMode;
Home > @acoustic-content-sdk/api > DeliveryImageElement > renditions
Signature:
renditions: Record<string, DeliveryImageRendition>;
Home > @acoustic-content-sdk/api > DeliveryImageElement > url
Signature:
url: string;
Home > @acoustic-content-sdk/api > DeliveryImageRendition > height
Signature:
height: number;
Home > @acoustic-content-sdk/api > DeliveryImageRendition > source
Signature:
source: string;
Home > @acoustic-content-sdk/api > DeliveryImageRendition > transform
Signature:
transform?: DeliveryImageTransform;
Home > @acoustic-content-sdk/api > DeliveryImageRendition > url
Signature:
url: string;
Home > @acoustic-content-sdk/api > DeliveryImageRendition > width
Signature:
width: number;
Home > @acoustic-content-sdk/api > DeliveryImageTransform > crop
Signature:
crop?: DeliveryImageCrop;
Home > @acoustic-content-sdk/api > DeliveryImageTransform > scale
Signature:
scale?: DeliveryImageScale;
Home > @acoustic-content-sdk/api > DeliveryLayoutRef > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > DeliveryLinkElement > linkDescription
Signature:
linkDescription?: string;
Home > @acoustic-content-sdk/api > DeliveryLinkElement > linkText
Signature:
linkText: string;
Home > @acoustic-content-sdk/api > DeliveryLinkElement > linkURL
Signature:
linkURL: string;
Home > @acoustic-content-sdk/api > DeliveryLocationElement > latitude
Signature:
latitude: number;
Home > @acoustic-content-sdk/api > DeliveryLocationElement > longitude
Signature:
longitude: number;
Home > @acoustic-content-sdk/api > DeliveryReferenceElementMetadata > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > DeliveryReferenceElement > $metadata
Signature:
$metadata: DeliveryReferenceElementMetadata;
Home > @acoustic-content-sdk/api > DeliverySelectedLayout > layout
Signature:
layout: DeliveryLayoutRef;
Home > @acoustic-content-sdk/api > DeliveryThumbnail > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > DeliveryThumbnail > url
Signature:
url: string;
Home > @acoustic-content-sdk/api > DynamicLoggerFactory > get
Returns a logger that is instantiated lazily (and potentially) multiple times.
Signature:
get(): Observable<LoggerFactory>;
Returns:
Observable<LoggerFactory>
observable of the logger factory
Home > @acoustic-content-sdk/api > ElementWithMarkup > $markup
Optionally the markup for an element
Signature:
$markup?: string;
Home > @acoustic-content-sdk/api > ErrorDetail > locale
Signature:
locale: string;
Home > @acoustic-content-sdk/api > ErrorDetail > message
Signature:
message: string;
Home > @acoustic-content-sdk/api > ErrorDetail > name
Signature:
name: string;
Home > @acoustic-content-sdk/api > ErrorDetail > parameters
Signature:
parameters: any;
Home > @acoustic-content-sdk/api > ErrorDetail > stack
Signature:
stack?: string;
Home > @acoustic-content-sdk/api > ErrorResponse > description
Signature:
description: string;
Home > @acoustic-content-sdk/api > ErrorResponse > errors
Signature:
errors: ErrorDetail[];
Home > @acoustic-content-sdk/api > ErrorResponse > message
Signature:
message: string;
Home > @acoustic-content-sdk/api > ErrorResponse > requestId
Signature:
requestId: string;
Home > @acoustic-content-sdk/api > ErrorResponse > service
Signature:
service: string;
Home > @acoustic-content-sdk/api > ErrorResponse > statusCode
Signature:
statusCode: number;
Home > @acoustic-content-sdk/api > ErrorResponse > version
Signature:
version: string;
Home > @acoustic-content-sdk/api > ExtendedContext > hub
Signature:
readonly hub?: HubContext;
Home > @acoustic-content-sdk/api > ExtendedContextV2 > editMode
Information about edit mode
Signature:
editMode?: boolean;
Home > @acoustic-content-sdk/api > ExtendedContextV2 > hub
Information about URLs that can be used to access the REST APIs
Signature:
hub?: HubContext;
Home > @acoustic-content-sdk/api > File > asset
Signature:
readonly asset?: Asset;
Home > @acoustic-content-sdk/api > File > url
Signature:
readonly url?: string;
Home > @acoustic-content-sdk/api > FileElement > elementType
Signature:
readonly elementType: 'file';
Home > @acoustic-content-sdk/api > FormattedTextElement > elementType
Signature:
readonly elementType: 'formattedtext';
Home > @acoustic-content-sdk/api > HttpResourceOptions > pollTime
Signature:
readonly pollTime?: number;
Home > @acoustic-content-sdk/api > HttpResourceOptions > pollTimeVariation
Signature:
readonly pollTimeVariation?: number;
Home > @acoustic-content-sdk/api > HttpResourceOptions > retries
Signature:
readonly retries?: number;
Home > @acoustic-content-sdk/api > HttpResourceOptions > useApi
Optionally use REST to load resources, default is true
Signature:
readonly useApi?: boolean;
Home > @acoustic-content-sdk/api > HttpResourceOptions > useBootstrap
Optionally enable pre-loading from bootstrap, default is true
Signature:
readonly useBootstrap?: boolean;
Home > @acoustic-content-sdk/api > HttpResourceOptions > useJsonP
Configure if we should use XHR or JSONp
Signature:
readonly useJsonP?: boolean;
Home > @acoustic-content-sdk/api > HttpResourceOptions > useLocalStorage
Optionally enable pre-loading from local storage, default is true
Signature:
readonly useLocalStorage?: boolean;
Home > @acoustic-content-sdk/api > HttpResourceOptions > usePolling
Configure if we should use polling at all, default is true
Signature:
readonly usePolling?: boolean;
Home > @acoustic-content-sdk/api > HttpResourceOptions > useStaticResources
Optionally enable use of static resources, default is true
Signature:
readonly useStaticResources?: boolean;
Home > @acoustic-content-sdk/api > GroupElement > elementType
Signature:
readonly elementType: 'group';
Home > @acoustic-content-sdk/api > GroupElement > layouts
The layouts for the content item, ordered by mode. The 'default' mode always exists and denotes the default layout.
Signature:
readonly layouts?: Layouts;
Home > @acoustic-content-sdk/api > GroupElement > selectedLayouts
Optionally the explicitly assigned layouts
Signature:
readonly selectedLayouts?: AuthoringSelectedLayout[];
Home > @acoustic-content-sdk/api > GroupElement > typeRef
Reference to the actual type
Signature:
readonly typeRef: TypeRef;
Home > @acoustic-content-sdk/api > HubContext > apiUrl
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
Signature:
readonly apiUrl: URL;
Home > @acoustic-content-sdk/api > HubContext > isPreviewMode
Flag that indicates if the system is in preview mode.
Signature:
readonly isPreviewMode?: boolean;
Home > @acoustic-content-sdk/api > HubContext > resourceUrl
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
Signature:
readonly resourceUrl: URL;
Home > @acoustic-content-sdk/api > HubInfo > apiUrl
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
Signature:
readonly apiUrl: URL | string;
Home > @acoustic-content-sdk/api > HubInfo > resourceUrl
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
Signature:
readonly resourceUrl: URL | string;
Home > @acoustic-content-sdk/api > IbmCommerce > apiGatewayHost
Signature:
apiGatewayHost?: string;
Home > @acoustic-content-sdk/api > IbmCommerce > environmentType
Signature:
environmentType?: string;
Home > @acoustic-content-sdk/api > IbmCommerce > liveSearchHost
Signature:
liveSearchHost?: string;
Home > @acoustic-content-sdk/api > IbmCommerce > liveTransactionHost
Signature:
liveTransactionHost?: string;
Home > @acoustic-content-sdk/api > IbmCommerce > previewSearchHost
Signature:
previewSearchHost?: string;
Home > @acoustic-content-sdk/api > IbmCommerce > previewTransactionHost
Signature:
previewTransactionHost?: string;
Home > @acoustic-content-sdk/api > IbmCommerce > tenantId
Signature:
tenantId?: string;
Home > @acoustic-content-sdk/api > HubInfoConfig > apiUrl
URL to access the API layer
Naming of this field according to the field in the rendering context
Signature:
readonly apiUrl?: HubInfoUrlProvider;
'https://my.digitalexperience.ibm.com/api/345563cf-a83c-40e5-a065-1d6ff36b05c1'
'https://my.digitalexperience.ibm.com/api/345563cf-a83c-40e5-a065-1d6ff36b05c1/dxsites/mysite'
Home > @acoustic-content-sdk/api > HubInfoConfig > baseUrl
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.
Signature:
readonly baseUrl?: HubInfoUrlProvider;
'https://my.digitalexperience.ibm.com/345563cf-a83c-40e5-a065-1d6ff36b05c1'
'https://my.digitalexperience.ibm.com/345563cf-a83c-40e5-a065-1d6ff36b05c1/dxsites/mysite'
'https://my.external.example.com/'
Home > @acoustic-content-sdk/api > HubInfoConfig > cycleHandlingStrategy
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
Signature:
readonly cycleHandlingStrategy?: CYCLE_HANDLING | string;
Home > @acoustic-content-sdk/api > HubInfoConfig > fetchLevels
Number of levels to fetch per request to the rendering context. If missing all levels will be fetched.
Signature:
readonly fetchLevels?: number;
Home > @acoustic-content-sdk/api > HubInfoConfig > httpOptions
Optionally specify how the SDK makes outbound requests
Signature:
readonly httpOptions?: HttpResourceOptions;
Home > @acoustic-content-sdk/api > HubInfoConfig > httpPreviewOptions
Optionally specify how the SDK makes outbound requests for the preview case
Signature:
readonly httpPreviewOptions?: HttpResourceOptions;
Home > @acoustic-content-sdk/api > HubInfoConfig > resourceUrl
URL to access the delivery
Naming of this field according to the field in the rendering context
Signature:
readonly resourceUrl?: HubInfoUrlProvider;
'https://my.digitalexperience.ibm.com/345563cf-a83c-40e5-a065-1d6ff36b05c1'
'https://my.digitalexperience.ibm.com/345563cf-a83c-40e5-a065-1d6ff36b05c1/dxsites/mysite'
Home > @acoustic-content-sdk/api > Image > altText
Signature:
readonly altText?: string;
Home > @acoustic-content-sdk/api > Image > asset
Signature:
readonly asset?: Asset;
Home > @acoustic-content-sdk/api > Image > profiles
Signature:
readonly profiles?: string[];
Home > @acoustic-content-sdk/api > Image > renditions
Signature:
readonly renditions?: {
[key: string]: Rendition;
};
Home > @acoustic-content-sdk/api > Image > url
Signature:
readonly url?: string;
Home > @acoustic-content-sdk/api > ImageElement > elementType
Signature:
readonly elementType: 'image';
Home > @acoustic-content-sdk/api > Layout > id
ID of the layout
Signature:
id: string;
Home > @acoustic-content-sdk/api > Layout > name
Name of the layout
Signature:
name: string;
Home > @acoustic-content-sdk/api > Layout > tags
Optional list of tags
Signature:
tags?: string[];
Home > @acoustic-content-sdk/api > Layout > template
The template description, will be a selector for angular and a filename for handlebars
Signature:
template: string;
Home > @acoustic-content-sdk/api > Layout > templateType
The template type, either 'handlebars' or 'angular'
Signature:
templateType: string;
Home > @acoustic-content-sdk/api > Link > linkDescription
Signature:
readonly linkDescription?: string;
Home > @acoustic-content-sdk/api > Link > linkText
Signature:
readonly linkText?: string;
Home > @acoustic-content-sdk/api > Link > linkURL
Signature:
readonly linkURL?: string;
Home > @acoustic-content-sdk/api > LinkElement > elementType
Signature:
readonly elementType: 'link';
Home > @acoustic-content-sdk/api > Location > latitude
Signature:
readonly latitude?: number;
Home > @acoustic-content-sdk/api > Location > longitude
Signature:
readonly longitude?: number;
Home > @acoustic-content-sdk/api > LocationElement > elementType
Signature:
readonly elementType: 'location';
Home > @acoustic-content-sdk/api > Logger > error
Signature:
error(msg: string, ...data: any[]): void;
| Parameter | Type | Description |
|---|---|---|
| msg | string | |
| data | any[] |
Returns:
void
Home > @acoustic-content-sdk/api > Logger > info
Signature:
info(msg: string, ...data: any[]): void;
| Parameter | Type | Description |
|---|---|---|
| msg | string | |
| data | any[] |
Returns:
void
Home > @acoustic-content-sdk/api > Logger > warn
Signature:
warn(msg: string, ...data: any[]): void;
| Parameter | Type | Description |
|---|---|---|
| msg | string | |
| data | any[] |
Returns:
void
Home > @acoustic-content-sdk/api > LoggerFactory > create
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.
Signature:
create(name: string): Logger;
| Parameter | Type | Description |
|---|---|---|
| name | string | name of the logger |
Returns:
Logger
the new logger instance
Home > @acoustic-content-sdk/api > LoggerService > get
Returns a logger for the given name
$1$2 -$3
Signature:
readonly get: (name: string) => Logger;
Home > @acoustic-content-sdk/api > MultiDateElement > values
Signature:
readonly values: string[];
Home > @acoustic-content-sdk/api > MultiFileElement > values
Signature:
readonly values: File[];
Home > @acoustic-content-sdk/api > MultiFormattedTextElement > values
Signature:
readonly values: string[];
Home > @acoustic-content-sdk/api > MultiGroupElement > values
Signature:
readonly values: Group[];
Home > @acoustic-content-sdk/api > MultiImageElement > values
Signature:
readonly values: Image[];
Home > @acoustic-content-sdk/api > MultiLinkElement > values
Signature:
readonly values: Link[];
Home > @acoustic-content-sdk/api > MultiNumberElement > values
Signature:
readonly values: number[];
Home > @acoustic-content-sdk/api > MultiOptionSelectionElement > values
Signature:
readonly values: OptionSelection[];
Home > @acoustic-content-sdk/api > MultiProductElement > values
Signature:
readonly values: string[];
Home > @acoustic-content-sdk/api > MultiReferenceElement > values
Signature:
readonly values: RenderingContext[];
Home > @acoustic-content-sdk/api > MultiTextElement > values
Signature:
readonly values: string[];
Home > @acoustic-content-sdk/api > MultiToggleElement > values
Signature:
readonly values: boolean[];
Home > @acoustic-content-sdk/api > MultiVideoElement > values
Signature:
readonly values: Video[];
Home > @acoustic-content-sdk/api > NumberElement > elementType
Signature:
readonly elementType: 'number';
Home > @acoustic-content-sdk/api > OptionSelection > label
Signature:
readonly label?: string;
Home > @acoustic-content-sdk/api > OptionSelection > selection
Signature:
readonly selection: string;
Home > @acoustic-content-sdk/api > PageSearchResult > document
Signature:
document: SitePage;
Home > @acoustic-content-sdk/api > OptionSelectionElement > elementType
Signature:
readonly elementType: 'optionselection';
Home > @acoustic-content-sdk/api > ProductElement > elementType
Signature:
readonly elementType: 'product';
Home > @acoustic-content-sdk/api > ReferenceElement > elementType
Signature:
readonly elementType: 'reference';
Home > @acoustic-content-sdk/api > RenderingContext > category
Signature:
readonly category?: ElementMap<CategoryElement>;
Home > @acoustic-content-sdk/api > RenderingContext > context
Signature:
readonly context: ExtendedContext;
Home > @acoustic-content-sdk/api > RenderingContext > datetime
Signature:
readonly datetime?: ElementMap<Date>;
Home > @acoustic-content-sdk/api > RenderingContext > datetimes
Signature:
readonly datetimes?: ElementMap<Date[]>;
Home > @acoustic-content-sdk/api > RenderingContext > file
Signature:
readonly file?: ElementMap<SingleFileElement>;
Home > @acoustic-content-sdk/api > RenderingContext > files
Signature:
readonly files?: ElementMap<File[]>;
Home > @acoustic-content-sdk/api > RenderingContext > formattedtext
Signature:
readonly formattedtext?: ElementMap<string>;
Home > @acoustic-content-sdk/api > RenderingContext > formattedtexts
Signature:
readonly formattedtexts?: ElementMap<string[]>;
Home > @acoustic-content-sdk/api > RenderingContext > group
Signature:
readonly group?: ElementMap<any>;
Home > @acoustic-content-sdk/api > RenderingContext > groups
Signature:
readonly groups?: ElementMap<any[]>;
Home > @acoustic-content-sdk/api > RenderingContext > image
Signature:
readonly image?: ElementMap<SingleImageElement>;
Home > @acoustic-content-sdk/api > RenderingContext > images
Signature:
readonly images?: ElementMap<Image[]>;
Home > @acoustic-content-sdk/api > RenderingContext > link
Signature:
readonly link?: ElementMap<SingleLinkElement>;
Home > @acoustic-content-sdk/api > RenderingContext > links
Signature:
readonly links?: ElementMap<Link[]>;
Home > @acoustic-content-sdk/api > RenderingContext > location
Signature:
readonly location?: ElementMap<LocationElement>;
Home > @acoustic-content-sdk/api > RenderingContext > markups
Signature:
readonly markups: ElementMap<string>;
Home > @acoustic-content-sdk/api > RenderingContext > number
Signature:
readonly number?: ElementMap<number>;
Home > @acoustic-content-sdk/api > RenderingContext > numbers
Signature:
readonly numbers?: ElementMap<number[]>;
Home > @acoustic-content-sdk/api > RenderingContext > optionselection
Signature:
readonly optionselection?: ElementMap<OptionSelection>;
Home > @acoustic-content-sdk/api > RenderingContext > optionselections
Signature:
readonly optionselections?: ElementMap<OptionSelection[]>;
Home > @acoustic-content-sdk/api > RenderingContext > product
typings
Signature:
readonly product?: ElementMap<string>;
Home > @acoustic-content-sdk/api > RenderingContext > products
Signature:
readonly products?: ElementMap<string[]>;
Home > @acoustic-content-sdk/api > RenderingContext > reference
Signature:
readonly reference?: ElementMap<RenderingContext>;
Home > @acoustic-content-sdk/api > RenderingContext > references
Signature:
readonly references?: ElementMap<RenderingContext[]>;
Home > @acoustic-content-sdk/api > RenderingContext > text
Signature:
readonly text?: ElementMap<string>;
Home > @acoustic-content-sdk/api > RenderingContext > texts
Signature:
readonly texts?: ElementMap<string[]>;
Home > @acoustic-content-sdk/api > RenderingContext > toggle
Signature:
readonly toggle?: ElementMap<boolean>;
Home > @acoustic-content-sdk/api > RenderingContext > toggles
Signature:
readonly toggles?: ElementMap<boolean[]>;
Home > @acoustic-content-sdk/api > RenderingContext > video
Signature:
readonly video?: ElementMap<SingleVideoElement>;
Home > @acoustic-content-sdk/api > RenderingContext > videos
Signature:
readonly videos?: ElementMap<Video[]>;
Home > @acoustic-content-sdk/api > RenderingContextInterceptor > opRenderingContext
operator to intercept a single rendering context
Signature:
opRenderingContext?: MonoTypeOperatorFunction<RenderingContext>;
Home > @acoustic-content-sdk/api > RenderingContextInterceptor > opRenderingContexts
operator to intercept a multiple rendering contexts
Signature:
opRenderingContexts?: MonoTypeOperatorFunction<RenderingContext[]>;
Home > @acoustic-content-sdk/api > RenderingContextProviderV2 > renderingContext$
Retrieves the rendering context for the content item.
Signature:
renderingContext$: Observable<RenderingContextV2>;
Home > @acoustic-content-sdk/api > RenderingContextProvider > onRenderingContext
Retrieves the rendering context for the content item.
Signature:
onRenderingContext: Observable<RenderingContext>;
Home > @acoustic-content-sdk/api > RenderingContextSearchResult > document
Signature:
document: RenderingContext;
Home > @acoustic-content-sdk/api > RenderingContextQueryResult > numFound
Signature:
numFound: number;
Home > @acoustic-content-sdk/api > RenderingContextQueryResult > renderingContexts
Signature:
renderingContexts: RenderingContext[];
Home > @acoustic-content-sdk/api > Resource > fileName
Signature:
readonly fileName: string;
Home > @acoustic-content-sdk/api > Resource > resourceId
Signature:
readonly resourceId: string;
Home > @acoustic-content-sdk/api > Resource > resourceUri
Signature:
readonly resourceUri: string;
Home > @acoustic-content-sdk/api > RenderingContextV2 > $context
Rendering context
Signature:
$context: ExtendedContextV2;
Home > @acoustic-content-sdk/api > Rendition > height
Signature:
readonly height: number;
Home > @acoustic-content-sdk/api > Rendition > renditionId
Signature:
readonly renditionId: string;
Home > @acoustic-content-sdk/api > Rendition > source
Signature:
readonly source: string;
Home > @acoustic-content-sdk/api > Rendition > transform
Signature:
readonly transform?: any;
Home > @acoustic-content-sdk/api > Rendition > url
added by delivery
Signature:
readonly url: string;
Home > @acoustic-content-sdk/api > Rendition > width
Signature:
readonly width: number;
Home > @acoustic-content-sdk/api > SdkActiveRouteEvent > page
the page
Signature:
page: DeliveryContentItem;
Home > @acoustic-content-sdk/api > SdkActiveRouteEvent > type
the event type
Signature:
type: 'WchSdk.router.activeRoute';
Home > @acoustic-content-sdk/api > SdkErrorResponse > error
potential error
Signature:
error: any;
Home > @acoustic-content-sdk/api > SdkMessageHandler > handle
Signature:
handle: SdkMessageHandlerCallback;
Home > @acoustic-content-sdk/api > SdkMessagePayload > id
event identifier, identifying a potential response
Signature:
id: string;
Home > @acoustic-content-sdk/api > SdkMessagePayload > type
the event type
Signature:
type: string;
Home > @acoustic-content-sdk/api > SdkModeEvent > mode
the mode
Signature:
mode: SdkMode;
Home > @acoustic-content-sdk/api > SdkModeEvent > type
the event type
Signature:
type: typeof SDK_MODE_EVENT_TYPE;
Home > @acoustic-content-sdk/api > SdkNavigateByPathEvent > path
path to navigate to
Signature:
path: string;
Home > @acoustic-content-sdk/api > SdkNavigateByPathEvent > type
the event type
Signature:
type: 'WchSdk.router.navigateByPath';
Home > @acoustic-content-sdk/api > SdkNavigateByPathResponse > error
potential error
Signature:
error?: any;
Home > @acoustic-content-sdk/api > SdkNavigateByPathResponse > path
path navigated to
Signature:
path: string;
Home > @acoustic-content-sdk/api > SdkNavigateByPathResponse > success
success of the operation
Signature:
success: boolean;
Home > @acoustic-content-sdk/api > SdkRefreshEvent > type
the event type
Signature:
type: 'WchSdk.refresh';
Home > @acoustic-content-sdk/api > SdkSetModeEvent > mode
mode to set
Signature:
mode: SdkMode;
Home > @acoustic-content-sdk/api > SdkSetModeEvent > type
the event type
Signature:
type: 'WchSdk.setMode';
Home > @acoustic-content-sdk/api > SdkRouteEvent > page
the page
Signature:
page: DeliveryContentItem;
Home > @acoustic-content-sdk/api > SdkRouteEvent > route
the route to subscribe to
Signature:
route: string;
Home > @acoustic-content-sdk/api > SdkRouteEvent > type
the event type
Signature:
type: 'WchSdk.router.route';
Home > @acoustic-content-sdk/api > SdkSetModeResponse > error
potential error
Signature:
error?: any;
Home > @acoustic-content-sdk/api > SdkSetModeResponse > mode
mode set
Signature:
mode: SdkMode;
Home > @acoustic-content-sdk/api > SdkSubscribeActiveRouteEvent > type
the event type
Signature:
type: 'WchSdk.router.activeRoute.subscribe';
Home > @acoustic-content-sdk/api > SdkSubscribeEventResponse > handle
handle, unsubscribe using this handle
Signature:
handle: string;
Home > @acoustic-content-sdk/api > SdkSubscribeModeEvent > type
the event type
Signature:
type: typeof SDK_SUBSCRIBE_MODE_EVENT_TYPE;
Home > @acoustic-content-sdk/api > SdkSubscribeRouteEvent > route
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
Signature:
route: string | string[];
Home > @acoustic-content-sdk/api > SdkSubscribeRouteEvent > type
the event type
Signature:
type: 'WchSdk.router.route.subscribe';
Home > @acoustic-content-sdk/api > SdkUnsubscribeEvent > handle
handle to unsubscribe on
Signature:
handle: string;
Home > @acoustic-content-sdk/api > SdkUnsubscribeEvent > type
the event type
Signature:
type: 'WchSdk.unsubscribe';
Home > @acoustic-content-sdk/api > SearchResults > documents
Signature:
documents?: T[];
Home > @acoustic-content-sdk/api > SearchResults > numFound
Signature:
numFound: number;
Home > @acoustic-content-sdk/api > SingleDateElement > value
Signature:
readonly value: string;
Home > @acoustic-content-sdk/api > SearchResult > document
Signature:
document: T;
Home > @acoustic-content-sdk/api > SingleFormattedTextElement > value
Signature:
readonly value: string;
Home > @acoustic-content-sdk/api > SingleGroupElement > value
Signature:
readonly value: Group;
Home > @acoustic-content-sdk/api > SingleNumberElement > value
Signature:
readonly value: number;
Home > @acoustic-content-sdk/api > SingleProductElement > value
Signature:
readonly value: string;
Home > @acoustic-content-sdk/api > SingleOptionSelectionElement > value
Signature:
readonly value: OptionSelection;
Home > @acoustic-content-sdk/api > SingleTextElement > value
Signature:
readonly value: string;
Home > @acoustic-content-sdk/api > SingleReferenceElement > value
Signature:
readonly value: RenderingContext;
Home > @acoustic-content-sdk/api > SingleToggleElement > value
Signature:
readonly value: boolean;
Home > @acoustic-content-sdk/api > SiteChild > children
Signature:
children: SiteChild[];
Home > @acoustic-content-sdk/api > Site > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > Site > name
Signature:
name?: string;
Home > @acoustic-content-sdk/api > Site > pages
Signature:
pages: SiteChild[];
Home > @acoustic-content-sdk/api > SiteDeliveryContentItem > $metadata
Metadata record
Signature:
$metadata: DeliveryContentMetadata;
Home > @acoustic-content-sdk/api > SiteDeliveryContentItem > navigation
Navigation reference
Signature:
navigation: DeliveryReferenceElement;
Home > @acoustic-content-sdk/api > SiteDeliveryContentItem > styles
Styles reference
Signature:
styles?: DeliveryReferenceElement;
Home > @acoustic-content-sdk/api > SiteDeliveryContentItem > title
Title
Signature:
title?: string;
Home > @acoustic-content-sdk/api > SiteContext > breadcrumb
Signature:
breadcrumb: SitePage[];
Home > @acoustic-content-sdk/api > SiteContext > children
Signature:
children: SitePage[];
Home > @acoustic-content-sdk/api > SiteContext > parent
Signature:
parent?: SitePage;
Home > @acoustic-content-sdk/api > SiteContext > sibling
Signature:
sibling: SitePage[];
Home > @acoustic-content-sdk/api > SiteContext > site
Signature:
site: Site;
Home > @acoustic-content-sdk/api > SiteNavigationDeliveryContentItem > $metadata
Metadata record
Signature:
$metadata: DeliveryContentMetadata;
Home > @acoustic-content-sdk/api > SiteNavigationDeliveryContentItem > defaultPage
Default page
Signature:
defaultPage?: string;
Home > @acoustic-content-sdk/api > SiteNavigationDeliveryContentItem > tree
JSON tree. The content is a serialization of SiteNavigation
Signature:
tree: string;
Home > @acoustic-content-sdk/api > SiteNavigationPage > children
Optionally, the navigation children of the page
Signature:
children?: SiteNavigationPage[];
Home > @acoustic-content-sdk/api > SiteNavigationPage > id
ID of the referenced page
Signature:
id: string;
Home > @acoustic-content-sdk/api > SitePagesQueryResult > numFound
Signature:
numFound: number;
Home > @acoustic-content-sdk/api > SitePagesQueryResult > sitePages
Signature:
sitePages: SitePage[];
Home > @acoustic-content-sdk/api > SitePage > contentId
Signature:
contentId: string;
Home > @acoustic-content-sdk/api > SitePage > contentStatus
Signature:
contentStatus: string;
Home > @acoustic-content-sdk/api > SitePage > contentTypeId
Signature:
contentTypeId: string;
Home > @acoustic-content-sdk/api > SitePage > decodedRoute
Signature:
decodedRoute: string;
Home > @acoustic-content-sdk/api > SitePage > description
Signature:
description?: string;
Home > @acoustic-content-sdk/api > SitePage > externalContext
Signature:
externalContext?: any;
Home > @acoustic-content-sdk/api > SitePage > hideFromNavigation
Signature:
hideFromNavigation: boolean;
Home > @acoustic-content-sdk/api > SitePage > id
Signature:
id: string;
Home > @acoustic-content-sdk/api > SitePage > name
Signature:
name: string;
Home > @acoustic-content-sdk/api > SitePage > parentId
Signature:
parentId?: string;
Home > @acoustic-content-sdk/api > SitePage > route
Signature:
route: string;
Home > @acoustic-content-sdk/api > SitePage > title
Signature:
title?: string;
Home > @acoustic-content-sdk/api > Tenant > _id
DEPRECATED - read-only - UUID of the domain. Use 'id' instead of _id
Signature:
_id: string;
Home > @acoustic-content-sdk/api > Tenant > capability
indicates the capabilities supported by a tenant
Signature:
capability?: string;
Home > @acoustic-content-sdk/api > Tenant > corsWhitelist
Signature:
corsWhitelist?: string[];
Home > @acoustic-content-sdk/api > Tenant > defaultContentLocale
The default locale for content
Signature:
defaultContentLocale?: string;
Home > @acoustic-content-sdk/api > Tenant > deliveryAccess
Signature:
deliveryAccess?: DeliveryAccess;
Home > @acoustic-content-sdk/api > Tenant > ibmCommerce
Signature:
ibmCommerce?: IbmCommerce;
Home > @acoustic-content-sdk/api > Tenant > ibmUniqueId
Signature:
ibmUniqueId?: string;
Home > @acoustic-content-sdk/api > Tenant > id
read-only - UUID of the domain
Signature:
id?: string;
Home > @acoustic-content-sdk/api > Tenant > isDAMEnabled
Signature:
isDAMEnabled?: boolean;
Home > @acoustic-content-sdk/api > Tenant > isEdgeSideEnabled
Signature:
isEdgeSideEnabled?: boolean;
Home > @acoustic-content-sdk/api > Tenant > locale
The locale the UI is shown in
Signature:
locale?: string;
Home > @acoustic-content-sdk/api > Tenant > locked
set to true if the tenant is 'locked' and should not have access to the system
Signature:
locked?: boolean;
Home > @acoustic-content-sdk/api > Tenant > mandatoryAssetPublishApproval
Signature:
mandatoryAssetPublishApproval?: AssetPublishApproval;
Home > @acoustic-content-sdk/api > Tenant > mandatoryContentPublishApproval
Signature:
mandatoryContentPublishApproval?: ContentPublishApproval;
Home > @acoustic-content-sdk/api > Tenant > maxAuthors
Signature:
maxAuthors?: number;
Home > @acoustic-content-sdk/api > Tenant > maxBulkUploadSize
Signature:
maxBulkUploadSize?: number;
Home > @acoustic-content-sdk/api > Tenant > maxContentItems
Max content items the tenant can have based on plan purchased
Signature:
maxContentItems?: number;
Home > @acoustic-content-sdk/api > Tenant > maxDataTransfer
Max amount of data transfer the tenant has per month, based on plan purchased
Signature:
maxDataTransfer?: number;
Home > @acoustic-content-sdk/api > Tenant > maxStorageSize
Max amount of storage the tenant has, based on plan purchased
Signature:
maxStorageSize?: number;
Home > @acoustic-content-sdk/api > Tenant > maxUploadSize
Max upload size - should apply to files/images/audio/video unless useSingleUploadSize is false in which case the individual max uploads apply
Signature:
maxUploadSize?: number;
Home > @acoustic-content-sdk/api > Tenant > maxUploadSizeFiles
Max upload size for files (if useSingleUploadSize is false)
Signature:
maxUploadSizeFiles?: number;
Home > @acoustic-content-sdk/api > Tenant > maxUploadSizeImage
Max upload size for images (if useSingleUploadSize is false)
Signature:
maxUploadSizeImage?: number;
Home > @acoustic-content-sdk/api > Tenant > maxUploadSizeVideo
Max upload size for videos (if useSingleUploadSize is false)
Signature:
maxUploadSizeVideo?: number;
Home > @acoustic-content-sdk/api > Tenant > maxUserSessions
Max number of User sessions
Signature:
maxUserSessions?: number;
Home > @acoustic-content-sdk/api > Tenant > name
Signature:
name?: string;
Home > @acoustic-content-sdk/api > Tenant > tier
Which tier of the product the tenant has purchased, set by sbs-provisioning to one of these values; Trial, Base, Standard, Plus
Signature:
tier?: TENANT_TIER;
Home > @acoustic-content-sdk/api > Tenant > useSingleUploadSize
Use the maxUploadSize to cover all uploads or use the individual max upload sizes
Signature:
useSingleUploadSize?: boolean;
Home > @acoustic-content-sdk/api > Tenant > watsonConfidenceLevel
Signature:
watsonConfidenceLevel?: number;
Home > @acoustic-content-sdk/api > ToggleElement > elementType
Signature:
readonly elementType: 'toggle';
Home > @acoustic-content-sdk/api > TextElement > elementType
Signature:
readonly elementType: 'text';
Home > @acoustic-content-sdk/api > TypeRef > description
Signature:
readonly description?: string;
Home > @acoustic-content-sdk/api > TypeRef > id
Signature:
readonly id: string;
Home > @acoustic-content-sdk/api > TypeRef > name
Signature:
readonly name?: string;
Home > @acoustic-content-sdk/api > UrlConfig > apiUrl
The base URL used to access WCH APIs. The URL ends with a slash.
Signature:
readonly apiUrl: URL;
Home > @acoustic-content-sdk/api > UrlConfig > baseUrl
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.
Signature:
readonly baseUrl?: URL;
Home > @acoustic-content-sdk/api > UrlConfig > isPreviewMode
True if the system runs in preview mode, else false.
Signature:
readonly isPreviewMode: boolean;
Home > @acoustic-content-sdk/api > UrlConfig > resourceUrl
The base URL used to access WCH delivery resources. The URL ends with a slash.
Signature:
readonly resourceUrl: URL;
Home > @acoustic-content-sdk/api > User > created
Date when this item was created
Signature:
created?: string;
Home > @acoustic-content-sdk/api > User > creator
Signature:
creator?: string;
Home > @acoustic-content-sdk/api > User > displayName
The name of the user that can be displayed in the UI
Signature:
displayName?: string;
Home > @acoustic-content-sdk/api > User > externalId
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.
Signature:
externalId: string;
Home > @acoustic-content-sdk/api > User > firstName
The first name of the user
Signature:
firstName?: string;
Home > @acoustic-content-sdk/api > User > id
The unique internal identifier of the user
Signature:
id: string;
Home > @acoustic-content-sdk/api > User > lastLogin
Date when this user logged in for the last time before current session
Signature:
lastLogin?: string;
Home > @acoustic-content-sdk/api > User > lastModified
Date when this item was modified for the last time
Signature:
lastModified?: string;
Home > @acoustic-content-sdk/api > User > lastModifier
Signature:
lastModifier?: string;
Home > @acoustic-content-sdk/api > User > lastName
The last name of the user
Signature:
lastName?: string;
Home > @acoustic-content-sdk/api > User > roles
The roles of the user that will be used for access control (empty for the anonymous user)
Signature:
roles: string[];
Home > @acoustic-content-sdk/api > VideoElement > elementType
Signature:
readonly elementType: 'video';
Home > @acoustic-content-sdk/api > Video > asset
Signature:
readonly asset?: Asset;
Home > @acoustic-content-sdk/api > Video > caption
Signature:
readonly caption?: Resource;
Home > @acoustic-content-sdk/api > Video > thumbnail
Signature:
readonly thumbnail?: Resource;
Home > @acoustic-content-sdk/api > Video > url
Signature:
readonly url?: string;
Home > @acoustic-content-sdk/api > WchHttp > getJsonResource
Fetches a JSON resource and keeps this live based on the given or the default options
$1$2 -$3
Signature:
getJsonResource: <T>(aUrl: string, aOptions?: HttpResourceOptions) => Observable<T>;
Home > @acoustic-content-sdk/api > WchHttp > getTextResource
Fetches a string resource and keeps this live based on the given or the default options
$1$2 -$3
Signature:
getTextResource: (aUrl: string, aOptions?: HttpResourceOptions) => Observable<string>;
Home > @acoustic-content-sdk/api > WchSdk > logger
Returns a factory to access loggers
Signature:
readonly logger?: LoggerService;
Home > @acoustic-content-sdk/api > WchSdk > refresh
Refreshes the rendering context and all JSON data that is currently displayed
Signature:
refresh: () => void;
Home > @acoustic-content-sdk/api > WchSdk > router
Signature:
readonly router: WchSdkRouter;
Home > @acoustic-content-sdk/api > WchSdk > search
Optional search service
Signature:
readonly search?: WchSdkSearch;
Home > @acoustic-content-sdk/api > WchSdk > version
Returns version information from the SDK
Signature:
readonly version: WchSdkVersion;
Home > @acoustic-content-sdk/api > WchSdkRouter > activeRenderingContext
Returns an observable that represents the active rendering context
Signature:
activeRenderingContext: () => Observable<RenderingContext>;
Home > @acoustic-content-sdk/api > WchSdkRouter > activeRoute
Returns an observable that represents the active route
Signature:
activeRoute: () => Observable<SitePage>;
Home > @acoustic-content-sdk/api > WchSdkRouter > navigateByPath
public APIs
Signature:
navigateByPath: (aPath: string) => PromiseLike<boolean>;
Home > @acoustic-content-sdk/api > WchSdkSearch > getRenderingContextById
Locates the rendering context identified by the ID
$1$2 -$3 $1$2 -$3
Signature:
getRenderingContextById: (aId: string, aLevels?: number) => Observable<RenderingContext>;
Home > @acoustic-content-sdk/api > WchSdkSearch > getRenderingContexts
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
Signature:
getRenderingContexts: (aValue: QueryInput, aLevels?: number) => Observable<RenderingContextQueryResult>;
Home > @acoustic-content-sdk/api > WchSdkSearch > getSitePages
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
Signature:
getSitePages: (aValue: QueryInput) => Observable<SitePagesQueryResult>;
Home > @acoustic-content-sdk/api > WchSdkVersion > build
build data of the SDK
Signature:
readonly build: Date;
Home > @acoustic-content-sdk/api > WchSdkVersion > version
version number of the SDK
Signature:
readonly version: {
readonly major: string;
readonly minor: string;
readonly patch: string;
};
FAQs
Interfaces and constants to support the Acoustic sites SDK and related modules.
The npm package @acoustic-content-sdk/api receives a total of 35 weekly downloads. As such, @acoustic-content-sdk/api popularity was classified as not popular.
We found that @acoustic-content-sdk/api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.