Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Properties

Optional _links

_links: Map<string, HalLink>

Optional activeEndDate

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.

Optional comment

comment: string

Textual comment to describe the edition

Optional createdBy

createdBy: string

Id of the user responsible for originally creating the edition

Optional createdDate

createdDate: string

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

Optional end

end: string

Date when the edition should end in ISO 8601 format

Optional event

event: ProjectedEvent

Projected event

Optional eventId

eventId: string

Id of the event the edition is associated with.

Optional id

id: string

Unique id generated on creation

Optional lastModifiedBy

lastModifiedBy: string

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

Optional lastModifiedDate

lastModifiedDate: string

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

Optional name

name: string

Friendly name for the edition

Optional publishManifestId

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.

Optional publishingJobId

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.

Optional publishingStatus

publishingStatus: PublishingStatus

Current publishing status of the edition

Optional start

start: string

Date when the edition should begin in ISO 8601 format

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 an Edition

archive

delete

  • delete(): Promise<void>

event

  • event(): Promise<Event>

schedule

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

  • Schedule Edition

    Parameters

    • Default value ignoreWarnings: boolean = false
    • Default value lastModifiedDate: string = new Date().toISOString()

    Returns Promise<void>

unschedule

  • unschedule(): Promise<void>

update

slots

slots: object

create

list

Generated using TypeDoc