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

    Class Event

    Class representing the Event resource. An Event represents a major date in the calendar, such as Christmas or Black Friday. An Event may span multiple days and start and end at any given UTC time.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _links? brief? comment? end? id? name? related start?

    Methods

    performActionWithoutResourceResponse toJson toJSON

    Constructors

    Properties

    Optional_links

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

    Hyperlink to a document describing the requirements for the Event

    comment?: string

    Textual comment to describe the event

    end?: string

    Date when the event should end in ISO 8601 format

    id?: string

    Unique id generated on creation

    name?: string

    Friendly name for the event

    related: {
        archive: () => Promise<Event>;
        delete: () => Promise<void>;
        editions: {
            create: (resource: Edition) => Promise<Edition>;
            list: (options?: Pageable & Sortable) => Promise<Page<Edition>>;
        };
        hub: () => Promise<Hub>;
        update: (mutation: Event) => Promise<Event>;
    } = ...

    Resources and actions related to an Event

    Type declaration

    • archive: () => Promise<Event>

      Archive Event

    • delete: () => Promise<void>

      Delete Event

    • editions: {
          create: (resource: Edition) => Promise<Edition>;
          list: (options?: Pageable & Sortable) => Promise<Page<Edition>>;
      }
    • hub: () => Promise<Hub>

      Retrieves the Hub this event is stored in

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

      Updates this Event with the changes in the mutation parameter.

    start?: string

    Date when the event 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