dc-management-sdk-js
    Preparing search index...

    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 (View Summary)

    Index

    Constructors

    constructor

    Properties

    _links? comment? createdBy? createdDate? createdFrom? id? related type?

    Methods

    performActionWithoutResourceResponse toJson toJSON

    Constructors

    Properties

    Optional_links

    _links?: Map<string, HalLink>
    comment?: string

    Textual comment description of the Snapshot

    createdBy?: string

    Id of the user responsible for originally creating the Snapshot

    createdDate?: string

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

    createdFrom?: SnapshotCreator

    Resource type the snapshot was created from

    id?: string

    Unique id generated on creation

    related: {
        hub: () => Promise<Hub>;
        snapshotContentItem: (id: string) => Promise<ContentItem>;
    } = ...

    Resources and actions related to a Snapshot

    Type declaration

    • hub: () => Promise<Hub>

      Retrieves the Hub this snapshot is stored in

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

      Retrieves the specific version of a content item referenced by the Snapshot

    type?: SnapshotType

    Snapshot type

    Methods

    • POST to an action endpoint with no resource response returned.

      Parameters

      • name: string
      • params: any
      • data: any
      • method: POST | PUT | PATCH = HttpMethod.POST

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods