componentSetting (switch)

Parent: componentSetting

Applies whentype = switch

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
typeenumYesdata type=string; lov=STATIC
Valid values: item region dynamicAction genAITool process authenticationScheme authorizationScheme restDataSource
nameenumYesdata type=string; lov=PLUGINS
Valid values: switch

Property Groups:

  • settings
  • subscription
settings
PropertyTypeRequiredDefault ValueDetails
onValuestringNoYdata type=string; maxLen=255
onLabelstringNodata type=string; maxLen=4000
offValuestringYesNdata type=string; maxLen=255
offLabelstringNodata type=string; maxLen=4000
displayStyleenumYesswitchdata type=string; maxLen=4000; lov=STATIC
Valid values: switch selectList pillButton
settings {
  onValue: value
  onLabel: value
  offValue: value
  offLabel: value
  displayStyle: switch
}
subscription
PropertyTypeRequiredDefault ValueDetails
masterenumNodata type=reference; lov=COMPONENT; references=app
Valid values: @/8842.242/ @/8842.242/UTDEV18800 @/8842.261/ @/8842.261/UT261 @/8842.262/ @/8842.262/UT262 @/8842.9999/ @/8842.9999/DATA-REPORTER-THEME
subscription {
  master: "@/8842.242/"
}

APEXlang Example

componentSetting sample (
    type: item
    name: switch
    settings {
        onValue: value
        onLabel: value
        offValue: value
        offLabel: value
        displayStyle: switch
    }
    subscription {
        master: "@/8842.242/"
    }
)