Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContentItem

Class representing the Content Item resource. Content Items are instances of content created from a content type.

Hierarchy

Index

Constructors

constructor

Properties

Optional _links

_links: Map<string, HalLink>

assignedDate

assignedDate: string

Timestamp representing when the assignees list was last updated in ISO 8601 format

assignees

assignees: string[]

List of user Id' who are assigned to the content item

body

body: any

Content item JSON body. The body must include the content type URL to indicate which content type this item will be created against, e.g.

{
 "_meta": {
   "schema": "https://raw.githubusercontent.com/amplience/dc-content-types/master/text-block.json"
 }
}

The body will be validated against the content type and will reject if there are any validation errors.

contentRepositoryId

contentRepositoryId: string

Content repository id

createdBy

createdBy: string

Id of the user responsible for originally creating the content item

createdDate

createdDate: string

Timestamp representing when the content item was originally created in ISO 8601 format

deliveryId

deliveryId: string

Unique id used by client applications to request the content from the delivery API

folderId

folderId: string

Id of the folder where this content item is placed. This will be undefined if the item is in the repository root.

Optional hierarchy

hierarchy: HierarchyMeta

Defined if content item is a member of a hierarchy

id

id: string

Unique id generated on creation

label

label: string

Friendly label for the content item

lastModifiedBy

lastModifiedBy: string

Id of the user responsible for the last update to the content item

lastModifiedDate

lastModifiedDate: string

Timestamp representing when the content item was last updated in ISO 8601 format

Optional locale

locale: string

Locale

status

status: Status

Lifecycle status of the content item

version

version: number

Version number of the content item returned. By default this is the latest version but content items accessed via a snapshot will return the version found in the snapshot.

Optional workflow

Assigned workflow state

Methods

Protected performActionWithoutResourceResponse

  • performActionWithoutResourceResponse(name: string, params: any, data: any, method?: POST | PATCH | PUT): Promise<void>

toJSON

  • toJSON(): any

toJson

  • toJson(): any

Object literals

Readonly related

related: object

Resources and actions related to a Content Item

archive

assignWorkflowState

contentItemVersion

  • contentItemVersion(version: number): Promise<ContentItem>

contentRepository

localizations

localize

  • localize(localesList: string[]): Promise<any>

setLocale

  • setLocale(localeDefinition: string): Promise<ContentItem>

unarchive

unassignWorkflowState

update

  • Updates this Content Item with the changes in the mutation parameter. You must provide the current version number in the mutation to avoid overwriting other user's changes.

    Parameters

    Returns Promise<ContentItem>

Generated using TypeDoc