DeclarativeSettingsTypes
in package
Declarative settings types supported in the IDeclarativeSettingsForm forms
Tags
Table of Contents
Constants
- CHECKBOX = 'checkbox'
- NcCheckboxRadioSwitch type checkbox
- EMAIL = 'email'
- NcInputField type email
- MULTI_CHECKBOX = 'multi-checkbox'
- Multiple NcCheckboxRadioSwitch type checkbox representing a one config value (saved as JSON object)
- MULTI_SELECT = 'multi-select'
- Multiple NcSelect representing a one config value (saved as JSON array)
- NUMBER = 'number'
- NcInputField type number
- PASSWORD = 'password'
- NcInputField type password
- RADIO = 'radio'
- NcCheckboxRadioSwitch type radio
- SECTION_TYPE_ADMIN = 'admin'
- IDeclarativeSettingsForm section_type which is determines where the form is displayed
- SECTION_TYPE_PERSONAL = 'personal'
- IDeclarativeSettingsForm section_type which is determines where the form is displayed
- SELECT = 'select'
- NcSelect
- STORAGE_TYPE_EXTERNAL = 'external'
- IDeclarativeSettingsForm storage_type which is determines where and how the config value is stored
- STORAGE_TYPE_INTERNAL = 'internal'
- IDeclarativeSettingsForm storage_type which is determines where and how the config value is stored
- TEL = 'tel'
- NcInputField type tel
- TEXT = 'text'
- NcInputField type text
- URL = 'url'
- NcInputField type url
Constants
CHECKBOX
NcCheckboxRadioSwitch type checkbox
public
mixed
CHECKBOX
= 'checkbox'
Tags
NcInputField type email
public
mixed
EMAIL
= 'email'
Tags
MULTI_CHECKBOX
Multiple NcCheckboxRadioSwitch type checkbox representing a one config value (saved as JSON object)
public
mixed
MULTI_CHECKBOX
= 'multi-checkbox'
Tags
MULTI_SELECT
Multiple NcSelect representing a one config value (saved as JSON array)
public
mixed
MULTI_SELECT
= 'multi-select'
Tags
NUMBER
NcInputField type number
public
mixed
NUMBER
= 'number'
Tags
PASSWORD
NcInputField type password
public
mixed
PASSWORD
= 'password'
Tags
RADIO
NcCheckboxRadioSwitch type radio
public
mixed
RADIO
= 'radio'
Tags
SECTION_TYPE_ADMIN
IDeclarativeSettingsForm section_type which is determines where the form is displayed
public
mixed
SECTION_TYPE_ADMIN
= 'admin'
Tags
SECTION_TYPE_PERSONAL
IDeclarativeSettingsForm section_type which is determines where the form is displayed
public
mixed
SECTION_TYPE_PERSONAL
= 'personal'
Tags
SELECT
NcSelect
public
mixed
SELECT
= 'select'
Tags
STORAGE_TYPE_EXTERNAL
IDeclarativeSettingsForm storage_type which is determines where and how the config value is stored
public
mixed
STORAGE_TYPE_EXTERNAL
= 'external'
For external storage_type the app needs to either implement event listeners for \OCP\Settings\SetDeclarativeSettingsValueEvent
and \OCP\Settings\GetDeclarativeSettingsValueEvent or the IDeclarativeSettingsForm also needs to implement
IDeclarativeSettingsFormWithHandlers for storing and retrieving the config value.
Tags
STORAGE_TYPE_INTERNAL
IDeclarativeSettingsForm storage_type which is determines where and how the config value is stored
public
mixed
STORAGE_TYPE_INTERNAL
= 'internal'
For internal storage_type the config value is stored in default appconfig and preferences tables.
Tags
TEL
NcInputField type tel
public
mixed
TEL
= 'tel'
Tags
TEXT
NcInputField type text
public
mixed
TEXT
= 'text'
Tags
URL
NcInputField type url
public
mixed
URL
= 'url'