woltlab-compiler/lib/System/Tasks/CronJob.d.ts

A compiler for WoltLab-Package Archives and WoltLab-Package Components

import { Localization } from "../Globalization/Localization";
import { ICronJobOptions } from "./ICronJobOptions";
import { TimePeriod } from "./TimePeriod";
/**
 * 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 `CronJob` class.
     */
    constructor(options: ICronJobOptions);
    /**
     * Gets or sets the name of the cron-job.
     */
    Name: string;
    /**
     * Gets or sets the class-name of the cron-job.
     */
    ClassName: string;
    /**
     * Gets the description of the cron-job.
     */
    readonly Description: Localization;
    /**
     * Gets or sets a value indicating whether the cron-job can be disabled.
     */
    AllowDisable: boolean;
    /**
     * Gets or sets a value indicating whether the cron-job can be edited.
     */
    AllowEdit: boolean;
    /**
     * Gets or sets a set of options of which at least one must be enabled in order to execute the cron-job.
     */
    Options: string[];
    /**
     * Gets or sets the period to execute the cron-job.
     */
    Period: TimePeriod;
}