Nextcloud PHP API (master)

DeclarativeSettingsTypes
in package

FinalYes

Declarative settings types supported in the IDeclarativeSettingsForm forms

Tags
since
29.0.0

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

MULTI_CHECKBOX

Multiple NcCheckboxRadioSwitch type checkbox representing a one config value (saved as JSON object)

public mixed MULTI_CHECKBOX = 'multi-checkbox'
Tags
since
29.0.0

MULTI_SELECT

Multiple NcSelect representing a one config value (saved as JSON array)

public mixed MULTI_SELECT = 'multi-select'
Tags
since
29.0.0

SECTION_TYPE_ADMIN

IDeclarativeSettingsForm section_type which is determines where the form is displayed

public mixed SECTION_TYPE_ADMIN = 'admin'
Tags
since
29.0.0

SECTION_TYPE_PERSONAL

IDeclarativeSettingsForm section_type which is determines where the form is displayed

public mixed SECTION_TYPE_PERSONAL = 'personal'
Tags
since
29.0.0

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 implementing \OCP\Settings\SetDeclarativeSettingsValueEvent and \OCP\Settings\GetDeclarativeSettingsValueEvent events is responsible for storing and retrieving the config value.

Tags
since
29.0.0

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. For external storage_type the app implementing \OCP\Settings\SetDeclarativeSettingsValueEvent and \OCP\Settings\GetDeclarativeSettingsValueEvent events is responsible for storing and retrieving the config value.

Tags
since
29.0.0

        
On this page

Search results