woltlab-compiler/lib/System/Events/IListenerOptions.d.ts

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

import { ListenerEnvironment } from "./ListenerEnvironment";
/**
 * Provides options for the `Listener` class.
 */
export interface IListenerOptions {
    /**
     * The name of the listener.
     */
    Name: string;
    /**
     * The environment to install the listener to.
     */
    Environment?: ListenerEnvironment;
    /**
     * The name of the event to listen to.
     */
    EventName: string;
    /**
     * A number indicating the execution order of the event-listener.
     */
    ExecutionOrder?: number;
    /**
     * The permissions of which the active user must have at least one in order to execute the listener.
     */
    Permissions?: string[];
    /**
     * The options of which at least one must be enabled in order to execute the listener.
     */
    Options?: string[];
}