com.atproto.label.defs

class atproto_client.models.com.atproto.label.defs.Label

Bases: ModelBase

Definition model for com.atproto.label.defs. Metadata tag on an atproto resource (eg, repo or record).

field cid: str | None = None

Optionally, CID specifying the specific version of ‘uri’ resource this label applies to.

field cts: str [Required]

Timestamp when this label was created.

field exp: str | None = None

Timestamp at which this label expires (no longer applies).

field neg: bool | None = None

If true, this is a negation label, overwriting a previous label.

field py_type: Literal['com.atproto.label.defs#label'] = 'com.atproto.label.defs#label'

field sig: str | bytes | None = None

Signature of dag-cbor encoded label.

field src: str [Required]

DID of the actor who created this label.

field uri: str [Required]

AT URI of the record, repository (account), or other resource that this label applies to.

field val: str [Required]

The short string name of the value or type of this label.

Constraints:

• max_length = 128

field ver: int | None = None

The AT Protocol version of the label object.

atproto_client.models.com.atproto.label.defs.LabelValue

Label value

alias of Union[Literal[‘!hide’], Literal[‘!no-promote’], Literal[‘!warn’], Literal[‘!no-unauthenticated’], Literal[‘dmca-violation’], Literal[‘doxxing’], Literal[‘porn’], Literal[‘sexual’], Literal[‘nudity’], Literal[‘nsfl’], Literal[‘gore’]]

class atproto_client.models.com.atproto.label.defs.LabelValueDefinition

Bases: ModelBase

Definition model for com.atproto.label.defs. Declares a label value and its expected interpertations and behaviors.

field adult_only: bool | None = None

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

field blurs: str [Required]

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.

field default_setting: str | None = None

The default setting for this label.

field identifier: str [Required]

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

Constraints:

• max_length = 100

field locales: List[models.ComAtprotoLabelDefs.LabelValueDefinitionStrings] [Required]

Locales.

field py_type: Literal['com.atproto.label.defs#labelValueDefinition'] = 'com.atproto.label.defs#labelValueDefinition'

field severity: str [Required]

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

class atproto_client.models.com.atproto.label.defs.LabelValueDefinitionStrings

Bases: ModelBase

Definition model for com.atproto.label.defs. Strings which describe the label in the UI, localized into a specific language.

field description: str [Required]

A longer description of what the label means and why it might be applied.

Constraints:

• max_length = 100000

field lang: str [Required]

The code of the language these strings are written in.

field name: str [Required]

A short human-readable name for the label.

Constraints:

• max_length = 640

field py_type: Literal['com.atproto.label.defs#labelValueDefinitionStrings'] = 'com.atproto.label.defs#labelValueDefinitionStrings'

class atproto_client.models.com.atproto.label.defs.SelfLabel

Bases: ModelBase

Definition model for com.atproto.label.defs. Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.

field py_type: Literal['com.atproto.label.defs#selfLabel'] = 'com.atproto.label.defs#selfLabel'

field val: str [Required]

The short string name of the value or type of this label.

Constraints:

• max_length = 128

class atproto_client.models.com.atproto.label.defs.SelfLabels

Bases: ModelBase

Definition model for com.atproto.label.defs. Metadata tags on an atproto record, published by the author within the record.

field py_type: Literal['com.atproto.label.defs#selfLabels'] = 'com.atproto.label.defs#selfLabels'

field values: List[models.ComAtprotoLabelDefs.SelfLabel] [Required]

Values.

Constraints:

• max_length = 10