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

    Class Edition

    Class representing the Edition resource. An Edition is the main way of scheduling content to be published on a specific date. It holds the association between slots and content items. Once all slots are valid and there are no conflicts, it is ready to be scheduled.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _links? activeEndDate? comment? createdBy? createdDate? end? event? eventId? id? lastModifiedBy? lastModifiedDate? name? publishingJobId? publishingStatus? publishManifestId? related start?

    Methods

    performActionWithoutResourceResponse toJson toJSON

    Constructors

    Properties

    Optional_links

    _links?: Map<string, HalLink>
    activeEndDate?: boolean

    Boolean flag indicating if the content should become invalid after the end date. This does not cause the content to become unpublished but instead acts as a flag for your application to decide if the content should be displayed after the end date.

    comment?: string

    Textual comment to describe the edition

    createdBy?: string

    Id of the user responsible for originally creating the edition

    createdDate?: string

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

    end?: string

    Date when the edition should end in ISO 8601 format

    event?: ProjectedEvent

    Projected event

    eventId?: string

    Id of the event the edition is associated with.

    id?: string

    Unique id generated on creation

    lastModifiedBy?: string

    Id of the user responsible for the last update to the edition

    lastModifiedDate?: string

    Timestamp representing when the edition was last updated in ISO 8601 format

    name?: string

    Friendly name for the edition

    publishingJobId?: string

    Id of the job responsible for publishing the content in this edition. This will be undefined if the edition is in a state where a publish is yet to occur.

    publishingStatus?: PublishingStatus

    Current publishing status of the edition

    publishManifestId?: string

    Id of the publish manifest generated when the edition was scheduled. This will be undefined if the edition is in a state where a schedule is yet to occur.

    related: {
        archive: () => Promise<Edition>;
        delete: () => Promise<void>;
        event: () => Promise<Event>;
        schedule: (
            ignoreWarnings?: boolean,
            lastModifiedDate?: string,
        ) => Promise<void>;
        slots: {
            create: (slots: EditionSlotRequest[]) => Promise<Page<EditionSlot>>;
            list: (options?: Pageable & Sortable) => Promise<Page<EditionSlot>>;
        };
        unschedule: () => Promise<void>;
        update: (mutation: Edition) => Promise<Edition>;
    } = ...

    Resources and actions related to an Edition

    Type declaration

    • archive: () => Promise<Edition>

      Archive Edition

    • delete: () => Promise<void>

      Delete Edition

    • event: () => Promise<Event>

      Retrieves the Event associated with this Edition

    • schedule: (ignoreWarnings?: boolean, lastModifiedDate?: string) => Promise<void>

      Schedule Edition

    • slots: {
          create: (slots: EditionSlotRequest[]) => Promise<Page<EditionSlot>>;
          list: (options?: Pageable & Sortable) => Promise<Page<EditionSlot>>;
      }
    • unschedule: () => Promise<void>

      Unschedule Edition

    • update: (mutation: Edition) => Promise<Edition>

      Updates this Edition with the changes in the mutation parameter.

    start?: string

    Date when the edition should begin in ISO 8601 format

    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