ConfigItemAnnotation

Methods
7
Fields
None

Methods

MethodReturnsDescription
keyName()stringThe store's key.
name()stringThe settings page's label.
description()stringThe settings page's tooltip, which its filter also searches.
section()stringThe keyName of the ConfigSection it sits in; empty for none.
secret()booleanWhether only the plugin that declares it reads it; a text item also shows as a password field.
hidden()booleanWhether it is left off the settings page; it is stored and read like any other item.
warning()stringWhat the settings page asks the user to confirm before it changes the value; empty for nothing.

Returned by

MethodReturnsDescription
ConfigItemDescriptor.getItemConfigItemAnnotationThe fields ConfigItem{...} declared, as methods.

Method details

secret

secret: (ConfigItemAnnotation) -> boolean

Whether only the plugin that declares it reads it; a text item also shows as a password field.

hidden

hidden: (ConfigItemAnnotation) -> boolean

Whether it is left off the settings page; it is stored and read like any other item.

warning

warning: (ConfigItemAnnotation) -> string

What the settings page asks the user to confirm before it changes the value; empty for nothing.