Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Schedule

Index

Constructors

Properties

active: boolean

Whether the schedule is active.

client: PteroClient
createdAt: Date

The date the schedule was created.

cron: Cron

The schedule cronjob data.

id: number

The ID of the schedule.

lastRunAt: undefined | Date

The date the schedule last ran.

name: string

The name of the schedule.

nextRunAt: Date

The date the scheduls is supposed to run next.

onlyWhenOnline: boolean

Whether the schedule should only run when the server is online.

processing: boolean

Whether the schedule is currently being processed.

serverId: string
tasks: Dict<number, ScheduleTask>

A dict of tasks that will be executed when the schedule is running.

updatedAt: undefined | Date

The date the schedule was last updated.

Methods

  • _patch(data: any): void
  • deleteTask(id: number): Promise<void>
  • execute(): Promise<void>
  • toJSON(): object
  • Converts the schedule into a JSON object, relative to the API response object.

    Returns object

    The JSON object.

  • toString(): string

Generated using TypeDoc