Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

  • new Event(data?: any): Event

Properties

Optional _links

_links: Map<string, HalLink>

Optional brief

brief: string

Hyperlink to a document describing the requirements for the Event

Optional comment

comment: string

Textual comment to describe the event

Optional end

end: string

Date when the event should end in ISO 8601 format

Optional id

id: string

Unique id generated on creation

Optional name

name: string

Friendly name for the event

Optional start

start: string

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

archive

  • archive(): Promise<Event>

delete

  • delete(): Promise<void>

hub

  • hub(): Promise<Hub>

update

editions

editions: object

create

list

Generated using TypeDoc