Interface OptionBase

Defines a single extension option.

interface OptionBase {
    description?: LocalizableString;
    identifier: string;
    label?: LocalizableString;
    type: OptionType;
}

Hierarchy (view full)

Properties

description? identifier label? type

Properties

Optional Readonly description

description?: LocalizableString

An optional longer explanantion of this option, to be shown in the UI.

Readonly identifier

identifier: string

An identifying string for this option.

Optional Readonly label

label?: LocalizableString

A short label for this option.

Readonly type

type: OptionType

The kind of option, one of:

  • string: a text box for free text entry,
  • boolean: a check box,
  • multiple: multiple-choice drop-down with predefined options,
  • secret: concealed text entry field (persisted in user's keychain),
  • password: concealed text entry field (not persisted, only passed to auth function),
  • heading: adds a heading in the user interface, but does not actually define an option

Settings

Member Visibility

Theme

On This Page

descriptionidentifierlabeltype