LabelValueDefinition

data class LabelValueDefinition(val identifier: String, val severity: Severity, val blurs: Blurs, val defaultSetting: DefaultSetting? = DefaultSetting.Warn, val adultOnly: Boolean? = null, val locales: List<LabelValueDefinitionStrings>)

Declares a label value and its expected interpretations and behaviors.

Parameters

identifier

The value of the label being defined. Must only include lowercase ascii and the '-' character (a-z-+).

severity

How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.

blurs

What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.

defaultSetting

The default setting for this label.

adultOnly

Does the user need to have adult content enabled in order to configure this label?

Constructors

Link copied to clipboard
constructor(identifier: String, severity: Severity, blurs: Blurs, defaultSetting: DefaultSetting? = DefaultSetting.Warn, adultOnly: Boolean? = null, locales: List<LabelValueDefinitionStrings>)

Properties

Link copied to clipboard
val adultOnly: Boolean? = null

Does the user need to have adult content enabled in order to configure this label?

Link copied to clipboard

What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.

Link copied to clipboard

The default setting for this label.

Link copied to clipboard

The value of the label being defined. Must only include lowercase ascii and the '-' character (a-z-+).

Link copied to clipboard
Link copied to clipboard

How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.