Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Event

An event entry.

Hierarchy

Index

Properties

Optional description

description: string

A description for that event.

Optional if

if: string | string[]

One or more (JavaScript) conditions that check if that item is available or not.

Optional isFor

isFor: string | string[]

A list of one or more (host)names that item is (visible) for.

name

name: string

The name of the event.

Optional once

once: boolean

Execute once or not.

Optional options

options: any

Options / data for the execution.

Optional platforms

platforms: string | string[]

One or more platform the item is for.

script

script: string

The path to the script.

Optional sortOrder

sortOrder: number | Object

The sort order.

Optional state

state: any

The initial value for the state.

Generated using TypeDoc