jetstream/app.bsky.jetstream

Package-level declarations

Types

data class SubscribeAccount(val seq: Long, val did: Did, val time: Timestamp, val active: Boolean, val status: SubscribeAccountStatus? = null)

Represents a change to an account's status on a host (eg, PDS or Relay). The semantics of this event are that the status is at the host which emitted the event, not necessarily that at the currently active PDS. Eg, a Relay takedown would emit a takedown with active=false, even if the PDS is still active.

SubscribeAccountStatus

@Serializable(with = SubscribeAccountStatusSerializer::class)

sealed class SubscribeAccountStatus : AtpEnum

If active=false, this optional field indicates a reason for why the account is not active.

SubscribeAccountStatusSerializer

class SubscribeAccountStatusSerializer : KSerializer<SubscribeAccountStatus>

SubscribeCommit

@Serializable

data class SubscribeCommit(val rev: String, val operation: SubscribeCommitOperation, val collection: Nsid, val rkey: RKey, val record: JsonContent? = null, val cid: Cid? = null)

SubscribeCommitOperation

@Serializable(with = SubscribeCommitOperationSerializer::class)

sealed class SubscribeCommitOperation : AtpEnum

SubscribeCommitOperationSerializer

class SubscribeCommitOperationSerializer : KSerializer<SubscribeCommitOperation>

SubscribeEvent

@Serializable

data class SubscribeEvent(val did: Did, val time_us: Long, val kind: SubscribeEventKind, val commit: SubscribeCommit? = null, val identity: SubscribeIdentity? = null, val account: SubscribeAccount? = null)

SubscribeEventKind

@Serializable(with = SubscribeEventKindSerializer::class)

sealed class SubscribeEventKind : AtpEnum

SubscribeEventKindSerializer

class SubscribeEventKindSerializer : KSerializer<SubscribeEventKind>

SubscribeIdentity

@Serializable

data class SubscribeIdentity(val seq: Long, val did: Did, val time: Timestamp, val handle: Handle? = null)

Represents a change to an account's identity. Could be an updated handle, signing key, or pds hosting endpoint. Serves as a prod to all downstream services to refresh their identity cache.

SubscribeMessage

typealias SubscribeMessage = SubscribeEvent

SubscribeOptionsUpdate

@Serializable

data class SubscribeOptionsUpdate(val wantedCollections: List<Nsid>? = null, val wantedDids: List<Did>? = null, val maxMessageSizeBytes: Long? = 0)

Update subscription filter after connecting to the socket.

SubscribeQueryParams

@Serializable

data class SubscribeQueryParams(val wantedCollections: List<Nsid>? = null, val wantedDids: List<Did>? = null, val maxMessageSizeBytes: Long? = 0, val cursor: Long? = null, val compress: Boolean? = false, val requireHello: Boolean? = false)

SubscribeSourcedMessage

@Serializable

data class SubscribeSourcedMessage(val type: String, val payload: JsonContent)

Send messages back to Jetstream over the websocket.