Class ContentClient

Creates a Delivery API Client instance. You must provide a configuration object with the required details for the particular service you wish to fetch content from.

This function will help construct requests for fetching multiple Content Items or Slots by delivery key or ID. Wraps /content/fetch endpoint. Additional documentation

This function will help construct requests for filtering Content Items or Slots

This function will help construct requests for filtering Content Items or Slots

equivalent to:

 client.filterBy('/_meta/schema', contentTypeUri)
Copy

This function will help construct requests for filtering Content Items or Slots

equivalent to:

 client.filterBy('/_meta/hierarchy/parentId', id)
Copy

This function will help construct requests for filtering Content Items or Slots

This function will load a hierarchy and return the root item with any children attached, it will also fetch the root item if needed.

This function will load a hierarchy and return the root item with any children attached, it will also fetch the root item if needed.

This function will load a hierarchy and return the root item with any children attached, it will also fetch the root item if needed.

This function will load a Content Item or Slot by id and return a Promise of the result. If the content is not found the promise will reject with an error. If the content is found the promise will resolve with a parsed version of the content with all dependencies.

The content body will match the format defined by your content type, however keep in mind that if you have evolved your content type some published content may still be in the older format.

Some pre-processing is applied to the content body to make it easier to work with:

• Linked content items are joined together into the root content item to create a single JSON document.
• Media references (images and videos) are replaced with wrapper objects [[Image]] and [[Video]] which provide helper functions.
• Content created using V1 of the CMS will be upgraded to the V2 format.

You can convert the content back to plain JSON by calling the toJSON() function on the returned ContentItem.

This function will load a Content Item or Slot by key and return a Promise of the result. If the content is not found the promise will reject with an error. If the content is found the promise will resolve with a parsed version of the content with all dependencies.

A delivery key can be a simple string or a path such as "home-page/feature-banner". This makes it simpler to write your integration code and allows users more control over where items of content are delivered. You can add a delivery key to a slot in the Dynamic Content app or to a content item or slot using the Dynamic Content Management API. Note that a delivery key may not start or end with "/" and must be between 1 and 150 characters. Delivery keys can contain the following alphanumeric characters: a to z, A to Z and 0 to 9. You can also include "-" and "_" and "/" as long as it is not included at the start or end of the key.

The content body will match the format defined by your content type.

Some pre-processing is applied to the content body to make it easier to work with:

• Linked content items are joined together into the root content item to create a single JSON document.
• Media references (images and videos) are replaced with wrapper objects [[Image]] and [[Video]] which provide helper functions.
• Content created using V1 of the CMS will be upgraded to the V2 format.

You can convert the content back to plain JSON by calling the toJSON() function on the returned ContentItem.

This function will help construct requests for fetching multiple Content Items or Slots by delivery key and/or id and is equivalent to:

 client.fetchContentItems({
   parameters: {
     depth: 'all',
     format: 'inlined'
   },
   requests: [
     { id: '6cd4de36-591b-4ca2-874b-1dec7b681d7e' },
     { key: 'blog/article-1' },
   ],
 });
Copy

These functions will help construct requests for fetching multiple Content Items or Slots by delivery ID and is equivalent to:

 client.fetchContentItems({
   parameters: {
     depth: 'all',
     format: 'inlined'
   },
   requests: [
     { id: '6cd4de36-591b-4ca2-874b-1dec7b681d7e' },
     { id: 'c6d9e038-591b-4ca2-874b-da354f5d6e61' },
   ],
 });
Copy

This function will help construct requests for fetching multiple Content Items or Slots by delivery key and is equivalent to:

 client.fetchContentItems({
   parameters: {
     depth: 'all',
     format: 'inlined'
   },
   requests: [
     { key: 'blog/article-1' },
     { key: 'blog/article-2' },
   ],
 });
Copy

This function will help construct requests for filtering Content Items or Slots

equivalent to:

 client.lookUpBy(key, value)
Copy

This function will help construct requests for filtering Content Items or Slots

equivalent to:

 client.lookUpBy('HIERARCHY_PARENT_META_DELIVERY_KEY', deliveryKey)
Copy

Converts a Content Item or Slot into a custom format (e.g. HTML / XML) by applying a template server side.