Skip to main content

com.atproto.label.defs

#label

Metadata tag on an atproto resource (eg, repo or record).

PropertyTypeKnown ValuesRequiredDescription
verinteger-The AT Protocol version of the label object.
srcstring (did)-DID of the actor who created this label.
uristring (uri)-AT URI of the record, repository (account), or other resource that this label applies to.
cidstring (cid)-Optionally, CID specifying the specific version of 'uri' resource this label applies to.
valstring-The short string name of the value or type of this label.
negboolean-If true, this is a negation label, overwriting a previous label.
ctsstring (datetime)-Timestamp when this label was created.
expstring (datetime)-Timestamp at which this label expires (no longer applies).
sigbytes-Signature of dag-cbor encoded label.

#selfLabels

Metadata tags on an atproto record, published by the author within the record.

PropertyTypeKnown ValuesRequiredDescription
valuesarray of #selfLabel--

#selfLabel

Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.

PropertyTypeKnown ValuesRequiredDescription
valstring-The short string name of the value or type of this label.

#labelValueDefinition

Declares a label value and its expected interpretations and behaviors.

PropertyTypeKnown ValuesRequiredDescription
identifierstring-The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).
severitystringinform
alert
none
How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.
blursstringcontent
media
none
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.
defaultSettingstringignore
warn
hide
The default setting for this label.
adultOnlyboolean-Does the user need to have adult content enabled in order to configure this label?
localesarray of #labelValueDefinitionStrings--

#labelValueDefinitionStrings

Strings which describe the label in the UI, localized into a specific language.

PropertyTypeKnown ValuesRequiredDescription
langstring (language)-The code of the language these strings are written in.
namestring-A short human-readable name for the label.
descriptionstring-A longer description of what the label means and why it might be applied.

#labelValue

PropertyTypeKnown ValuesRequiredDescription
labelValuestring!hide
!no-promote
!warn
!no-unauthenticated
dmca-violation
doxxing
porn
sexual
nudity
nsfl
gore
-