keyName
keyName: (ConfigItemAnnotation) -> stringThe store's key.
| Method | Returns | Description |
|---|---|---|
keyName() | string | The store's key. |
name() | string | The settings page's label. |
description() | string | The settings page's tooltip, which its filter also searches. |
section() | string | The keyName of the ConfigSection it sits in; empty for none. |
secret() | boolean | Whether only the plugin that declares it reads it; a text item also shows as a password field. |
hidden() | boolean | Whether it is left off the settings page; it is stored and read like any other item. |
warning() | string | What the settings page asks the user to confirm before it changes the value; empty for nothing. |
| Method | Returns | Description |
|---|---|---|
ConfigItemDescriptor.getItem | ConfigItemAnnotation | The fields ConfigItem{...} declared, as methods. |
keyNamekeyName: (ConfigItemAnnotation) -> stringThe store's key.
namename: (ConfigItemAnnotation) -> stringThe settings page's label.
descriptiondescription: (ConfigItemAnnotation) -> stringThe settings page's tooltip, which its filter also searches.
sectionsection: (ConfigItemAnnotation) -> stringThe keyName of the ConfigSection it sits in; empty for none.
secretsecret: (ConfigItemAnnotation) -> booleanWhether only the plugin that declares it reads it; a text item also shows as a password field.
warningwarning: (ConfigItemAnnotation) -> stringWhat the settings page asks the user to confirm before it changes the value; empty for nothing.