Class Schedule

Implements

ServerScheduleAttributes

Index

Constructors

constructor

new Schedule(
    userClient: UserClient,
    scheduleProps: RawServerSchedule,
    parentServer: Server,
): Schedule
Parameters
- userClient: UserClient
- scheduleProps: RawServerSchedule
- parentServer: Server
Returns Schedule
- Defined in src/UserClient/Schedule.ts:32

Properties

`Readonly`created_at

created_at: Date

cron

cron: {
    day_of_month: string;
    day_of_week: string;
    hour: string;
    minute: string;
    month: string;
}

`Readonly`id

id: number

is_active

is_active: boolean

`Readonly`is_processing

is_processing: boolean

last_run_at

last_run_at: string | Date | null

name

name: string

next_run_at

next_run_at: string | Date

only_when_online

only_when_online: boolean

`Readonly`parentServer

parentServer: Server

`Readonly`relationships

relationships: { tasks: RawScheduleTaskList }

tasks

tasks: ScheduleTask[]

updated_at

updated_at: Date

Methods

createTask

createTask(task: ScheduleTaskBuilder): Promise<void>
Create a task for this schedule
Parameters
- task: ScheduleTaskBuilder
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:159

delete

delete(): Promise<void>
Delete this schedule

Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:151

execute

execute(): Promise<void>
Executes this schedule

Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:169

setActive

setActive(active: boolean): Promise<void>
Set wether the schedule is active
Parameters
- active: boolean
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:79

setDayOfMonth

setDayOfMonth(dayOfMonth: string): Promise<void>
Set the day of month of the cron schedule
Parameters
- dayOfMonth: string
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:124

setDayOfWeek

setDayOfWeek(dayOfWeek: string): Promise<void>
Set the day of week of the cron schedule
Parameters
- dayOfWeek: string
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:142

setHour

setHour(hour: string): Promise<void>
Set the hour of the cron schedule
Parameters
- hour: string
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:115

setMinute

setMinute(minute: string): Promise<void>
Set the minute of the cron schedule
Parameters
- minute: string
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:106

setMonth

setMonth(month: string): Promise<void>
Set the month of the cron schedule
Parameters
- month: string
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:133

setName

setName(name: string): Promise<void>
Set the name of the schedule
Parameters
- name: string
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:97

setOnlyWhenOnline

setOnlyWhenOnline(onlyWhenOnline: boolean): Promise<void>
Set wether the schedule should only run when the server is online
Parameters
- onlyWhenOnline: boolean
Returns Promise<void>
- Defined in src/UserClient/Schedule.ts:88