Skip to main content

AppSettingFieldView

One field of an installed app's settings form, as the app's manifest declares it.

type AppSettingFieldView {
  helpText: String
  key: String!
  label: String!
  placeholder: String
  required: Boolean!
  secret: Boolean!
  type: String!
}

Fields​

AppSettingFieldView.helpText ● String scalar​

Help shown under the field.

AppSettingFieldView.key ● String! non-null scalar​

The setting's key.

AppSettingFieldView.label ● String! non-null scalar​

The label shown on the form.

AppSettingFieldView.placeholder ● String scalar​

Placeholder text.

AppSettingFieldView.required ● Boolean! non-null scalar​

True when the form needs a value before it saves.

AppSettingFieldView.secret ● Boolean! non-null scalar​

True when the value is a secret: it is encrypted, and only a masked hint is ever shown.

AppSettingFieldView.type ● String! non-null scalar​

text, number, boolean or url.

Member Of​

AppSettingsFormView object