@manuth/woltlab-compiler/lib/Tasks/CronJob.d.ts

A compiler for generating WoltLab-Package `.tar` Archives and other WoltLab-Package Components

import { Localization } from "../Globalization/Localization.js";
import { ICronJobOptions } from "./ICronJobOptions.js";
import { TimePeriod } from "./TimePeriod.js";
/**
 * Represents a cron-job.
 */
export declare class CronJob {
    /**
     * The name of the cron-job.
     */
    private name;
    /**
     * The class-name of the cron-job.
     */
    private className;
    /**
     * The description of the cron-job.
     */
    private description;
    /**
     * A value indicating whether the cron-job can be disabled.
     */
    private allowDisable;
    /**
     * A value indicating whether the cron-job can be edited.
     */
    private allowEdit;
    /**
     * A set of options of which at least one must be enabled in order to execute the cron-job.
     */
    private options;
    /**
     * The period to execute the cron-job.
     */
    private period;
    /**
     * Initializes a new instance of the {@link CronJob `CronJob`} class.
     *
     * @param options
     * The options of the cron-job.
     */
    constructor(options: ICronJobOptions);
    /**
     * Gets or sets the name of the cron-job.
     */
    get Name(): string;
    /**
     * @inheritdoc
     */
    set Name(value: string);
    /**
     * Gets or sets the class-name of the cron-job.
     */
    get ClassName(): string;
    /**
     * @inheritdoc
     */
    set ClassName(value: string);
    /**
     * Gets the description of the cron-job.
     */
    get Description(): Localization;
    /**
     * Gets or sets a value indicating whether the cron-job can be disabled.
     */
    get AllowDisable(): boolean;
    /**
     * @inheritdoc
     */
    set AllowDisable(value: boolean);
    /**
     * Gets or sets a value indicating whether the cron-job can be edited.
     */
    get AllowEdit(): boolean;
    /**
     * @inheritdoc
     */
    set AllowEdit(value: boolean);
    /**
     * Gets or sets a set of options of which at least one must be enabled in order to execute the cron-job.
     */
    get Options(): string[];
    /**
     * @inheritdoc
     */
    set Options(value: string[]);
    /**
     * Gets or sets the period to execute the cron-job.
     */
    get Period(): TimePeriod;
    /**
     * @inheritdoc
     */
    set Period(value: TimePeriod);
}