ozone/com.atproto.label

Package-level declarations

Types

@Serializable(with = BlursSerializer::class)

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.

BlursSerializer

class BlursSerializer : KSerializer<Blurs>

DefaultSetting

@Serializable(with = DefaultSettingSerializer::class)

sealed class DefaultSetting : AtpEnum

The default setting for this label.

DefaultSettingSerializer

class DefaultSettingSerializer : KSerializer<DefaultSetting>

Label

@Serializable

data class Label(val ver: Long? = null, val src: Did, val uri: Uri, val cid: Cid? = null, val val: String, val neg: Boolean? = null, val cts: Timestamp, val exp: Timestamp? = null, val sig: ByteArray? = null)

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

LabelValue

@Serializable(with = LabelValueSerializer::class)

sealed class LabelValue : AtpEnum

LabelValueDefinition

@Serializable

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.

LabelValueDefinitionStrings

@Serializable

data class LabelValueDefinitionStrings(val lang: Language, val name: String, val description: String)

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

LabelValueSerializer

class LabelValueSerializer : KSerializer<LabelValue>

QueryLabelsQueryParams

@Serializable

data class QueryLabelsQueryParams(val uriPatterns: List<String>, val sources: List<Did> = emptyList(), val limit: Long? = 50, val cursor: String? = null)

QueryLabelsResponse

@Serializable

data class QueryLabelsResponse(val cursor: String? = null, val labels: List<Label>)

SelfLabel

@Serializable

data class SelfLabel(val val: String)

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

SelfLabels

@Serializable

data class SelfLabels(val values: List<SelfLabel>)

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

Severity

@Serializable(with = SeveritySerializer::class)

sealed class Severity : AtpEnum

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

SeveritySerializer

class SeveritySerializer : KSerializer<Severity>

SubscribeLabelsInfo

@Serializable

data class SubscribeLabelsInfo(val name: SubscribeLabelsName, val message: String? = null)

SubscribeLabelsLabels

@Serializable

data class SubscribeLabelsLabels(val seq: Long, val labels: List<Label>)

SubscribeLabelsMessage

typealias SubscribeLabelsMessage = SubscribeLabelsMessageUnion

SubscribeLabelsMessageUnion

@Serializable