Frame models

class atproto_jetstream.models.ErrorFrame(error: str, message: str | None = None)

Bases: object

Jetstream error frame.

error: str

Code of the error.

message: str | None = None

Description of the error.

atproto_jetstream.models.Frame

Base frame.

alias of Union[MessageFrame, ErrorFrame]

class atproto_jetstream.models.MessageFrame(payload: dict)

Bases: object

Jetstream message frame.

payload: dict

Payload.

property type: str | None

Fully qualified type of the payload.

Type:

str

atproto_jetstream.models.SubscribeEventsMessage

Subscribe Events Message

alias of Union[Commit, Identity, Account, Sync, Info]

atproto_jetstream.models.parse_frame(data: str | bytes) → MessageFrame | ErrorFrame

Decode a frame of the xrpc.v1.json subprotocol.

Parameters:

data – Raw websocket frame.

Returns:

atproto.jetstream_models.MessageFrame or atproto.jetstream_models.ErrorFrame

Raises:

atproto.exceptions.JetstreamDecodingError – Invalid data frame.

atproto_jetstream.models.parse_subscribe_events_message(message: MessageFrame) → Commit | Identity | Account | Sync | Info

Parse Jetstream message to the corresponding model.

Parameters:

message – Message frame.

Returns:

Corresponding message model.

Return type:

SubscribeEventsMessage

Raises:

atproto.exceptions.JetstreamDecodingError – Unknown message type.