ScheduleJS
Options
All
  • Public
  • Public/Protected
  • All
Menu

A specialized calendar activity used to represent weekend days (e.g. Saturday, Sunday).

since

1.0

Type parameters

  • T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new WeekendCalendarActivity(name: string, startTime: number, endTime: number, day: DayOfWeek): WeekendCalendarActivity

  • Constructs a new weekend calendar activity with the given name, start time, and end time.

    since

    1.0

    Parameters

    • name: string

      the name of the activity

    • startTime: number

      the start time of the activity

    • endTime: number

      the end time of the activity

    • day: DayOfWeek

      the day of week that this activity is representing

    Returns WeekendCalendarActivity

Properties

Static DEFAULT_DURATION

DEFAULT_DURATION: number = TimeUtil.ofDays(5)

Methods

getDayOfWeek

  • getDayOfWeek(): DayOfWeek

  • Returns the week day that this activity is representing, e.g. DayOfWeek.SUNDAY.

    since

    1.0

    Returns DayOfWeek

    the day of week represented by this activity

getEndTime

  • getEndTime(): number

getId

  • getId(): string

  • The unique id of the activity.

    since

    1.0

    Returns string

    the unique activity ID

getName

  • getName(): string

  • The name of the activity, for example "Flight 3441".

    since

    1.0

    Returns string

    the name of the activity

getStartTime

  • getStartTime(): number

getUserObject

  • getUserObject(): T

  • Returns the user object associated to the activity.

    since

    1.0

    Returns T

    the user object associated to the activity

setUserObject

  • setUserObject(obj: T): void

  • Set the user object associated to the activity.

    since

    1.0

    Parameters

    • obj: T

      the user object to associate to the activity

    Returns void

toString

  • toString(): string

  • Returns string