pterodactyl.ts
    Preparing search index...

    Class Schedule

    Implements

    • ServerScheduleAttributes
    Index

    Constructors

    Properties

    created_at: Date
    cron: {
        day_of_month: string;
        day_of_week: string;
        hour: string;
        minute: string;
        month: string;
    }
    id: number
    is_active: boolean
    is_processing: boolean
    last_run_at: string | Date | null
    name: string
    next_run_at: string | Date
    only_when_online: boolean
    parentServer: Server
    relationships: { tasks: RawScheduleTaskList }
    tasks: ScheduleTask[]
    updated_at: Date

    Methods

    • Set wether the schedule is active

      Parameters

      • active: boolean

      Returns Promise<void>

    • Set the day of month of the cron schedule

      Parameters

      • dayOfMonth: string

      Returns Promise<void>

    • Set the day of week of the cron schedule

      Parameters

      • dayOfWeek: string

      Returns Promise<void>

    • Set the hour of the cron schedule

      Parameters

      • hour: string

      Returns Promise<void>

    • Set the minute of the cron schedule

      Parameters

      • minute: string

      Returns Promise<void>

    • Set the month of the cron schedule

      Parameters

      • month: string

      Returns Promise<void>

    • Set the name of the schedule

      Parameters

      • name: string

      Returns Promise<void>

    • Set wether the schedule should only run when the server is online

      Parameters

      • onlyWhenOnline: boolean

      Returns Promise<void>