Skip to main content

Interface: LabelValueDefinition

Defined in: web/lib/api/generated/types/com/atproto/label/defs.ts:84

Declares a label value and its expected interpretations and behaviors.

Properties​

$type?​

optional $type: "com.atproto.label.defs#labelValueDefinition"

Defined in: web/lib/api/generated/types/com/atproto/label/defs.ts:85


adultOnly?​

optional adultOnly: boolean

Defined in: web/lib/api/generated/types/com/atproto/label/defs.ts:95

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


blurs​

blurs: string & object | "none" | "media" | "content"

Defined in: web/lib/api/generated/types/com/atproto/label/defs.ts:91

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​

defaultSetting: "warn" | string & object | "hide" | "ignore"

Defined in: web/lib/api/generated/types/com/atproto/label/defs.ts:93

The default setting for this label.


identifier​

identifier: string

Defined in: web/lib/api/generated/types/com/atproto/label/defs.ts:87

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


locales​

locales: LabelValueDefinitionStrings[]

Defined in: web/lib/api/generated/types/com/atproto/label/defs.ts:96


severity​

severity: string & object | "none" | "alert" | "inform"

Defined in: web/lib/api/generated/types/com/atproto/label/defs.ts:89

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