Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Snapshot

Class representing the Snapshot resource. A Snapshot is an immutable representation of a content item with all of its descendants (including their versions) at a given point in time.

Hierarchy

Index

Constructors

constructor

Properties

Optional _links

_links: Map<string, HalLink>

Optional comment

comment: string

Textual comment description of the Snapshot

Optional createdBy

createdBy: string

Id of the user responsible for originally creating the Snapshot

Optional createdDate

createdDate: string

Timestamp representing when the Snapshot was originally created in ISO 8601 format

Optional createdFrom

createdFrom: SnapshotCreator

Resource type the snapshot was created from

Optional id

id: string

Unique id generated on creation

Optional type

Snapshot type

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 Snapshot

hub

  • hub(): Promise<Hub>

snapshotContentItem

  • snapshotContentItem(id: string): Promise<ContentItem>

Generated using TypeDoc