Enum CollabEvent 

pub enum CollabEvent {
    LocalFileClipboardResult {
        request_id: u64,
        result: Result<Reply, String>,
    },
    CommittedDocument {
        route: RouteSpec,
        read: CommittedDocument,
    },
    Context {
        collaborators: Vec<Collaborator>,
        permissions: Vec<String>,
    },
    HistoryAgents {
        cluster_id: String,
        agents: Vec<RosterAgent>,
    },
    FollowChanged {
        peer_id: Option<String>,
    },
    DocumentSnapshotRequested {
        route: RouteSpec,
    },
    Handoff {
        request: HandoffRequest,
    },
    RemoteCursorMoved {
        user_id: String,
        x: f32,
        y: f32,
    },
    RemotePresenceUpdate {
        user_id: String,
        key: PresenceKey,
        payload: PresencePayload,
    },
    ActionArrived {
        type_id: String,
        payload: Vec<u8>,
        from_user_id: String,
    },
    ChannelAccess {
        route: RouteSpec,
        state: ChannelAccessState,
    },
    Document {
        envelope: Box<SignedOp>,
        from_user_id: String,
        decrypted_payload: Option<Vec<u8>>,
    },
    ScrollbackBatch {
        artifact: ArtifactId,
        ops: Vec<Box<SignedOp>>,
        decrypted_payloads: Vec<Option<Vec<u8>>>,
        oldest_seq: Option<u64>,
        exhausted: bool,
    },
    Invocation {
        id: u64,
        invocation: InvocationId,
        resource: String,
        action: String,
        argument: Option<String>,
        actor: String,
        context: Option<Box<ActionContext>>,
    },
    InvocationCancellation {
        id: u64,
    },
    RemoteAction {
        message: RemoteActionMessage,
    },
    ActionCatalogue {
        surfaces: Vec<BrokerActionSurface>,
    },
    ActionDirectoryPage {
        request_id: u64,
        result: Result<ActionDirectoryPage, String>,
    },
    PublishedActionResolution {
        request_id: u64,
        result: Result<ActionDirectoryResolution, String>,
    },
    ManagedInvocationObservation {
        result: ManagedAttemptResult,
    },
    PublishedInvocationResult {
        request_id: u64,
        result: Result<(u64, InvocationUpdate), String>,
    },
    InstalledApplicationLaunchResult {
        request_id: u64,
        result: Result<(u64, InvocationUpdate), String>,
    },
    TaskRun(TaskRunEnvelope),
    TaskActionInvocationResult {
        request_id: u64,
        result: Result<(u64, InvocationUpdate), String>,
    },
    TaskRunCancellation {
        request_id: u64,
        result: Result<bool, String>,
    },
    TaskRunControl {
        request_id: u64,
        control: TaskRunControl,
    },
    TaskRunReportResult {
        request_id: u64,
        result: Result<(), String>,
    },
    WorkspaceControl {
        session_id: u64,
        event: WorkspaceControlEvent,
    },
    NativeMediaCommandResult {
        request_id: u64,
        result: Result<Snapshot, String>,
    },
    RecordContent {
        route: RouteSpec,
        hash: String,
        bytes: Vec<u8>,
    },
    RealtimeCommandResult {
        request_id: u64,
        result: Result<RealtimeReply, String>,
    },
    NearbyTransferCommandResult {
        request_id: u64,
        result: Result<NearbyTransferReply, String>,
    },
    Realtime(RealtimeEvent),
}

Variants

LocalFileClipboardResult

Fields

request_id: u64

result: Result<Reply, String>

CommittedDocument

Original committed history from this SDK channel, applied by its document owner.

Fields

route: RouteSpec

read: CommittedDocument

Context

Fields

collaborators: Vec<Collaborator>

permissions: Vec<String>

HistoryAgents

The delegated agents on cluster_id’s roster whose person’s root signed the delegation for exactly that device, as the session verified them: who the app’s history names for changes their own device keys signed. Session-local and presentation only.

Fields

cluster_id: String

agents: Vec<RosterAgent>

FollowChanged

Session chrome asked this app to bind its viewport/view mode to a participant, or release that binding. This is local session control: it is never published to collaboration peers.

Fields

peer_id: Option<String>

DocumentSnapshotRequested

The broker selected this connection as the sole snapshot responder for a late joiner on the same document route.

Fields

route: RouteSpec

Handoff

The shell asked this instance for a step of moving its window to another workspace. Session-local control; never from a peer.

Fields

request: HandoffRequest

RemoteCursorMoved

Fields

user_id: String

x: f32

y: f32

RemotePresenceUpdate

Fields

user_id: String

key: PresenceKey

payload: PresencePayload

ActionArrived

A typed action another app in this room published, delivered to every connection. A receiver decodes it via its own ActionRegistry; an action for a different app decodes to nothing, making room-wide fan-out safe.

from_user_id is who sent the frame, not necessarily who the action says authored it.

Fields

type_id: String

payload: Vec<u8>

from_user_id: String

ChannelAccess

What this endpoint can do with one route’s end-to-end encrypted content changed: it was admitted, is waiting for access (a new device before its welcome arrives), was removed, or cannot join. While a route is not open the SDK holds edits and incoming ciphertext on the device instead of dropping them; apps show the state.

Fields

route: RouteSpec

state: ChannelAccessState

Document

A validated signed document envelope from another peer. For cleartext routes the mutation kind is inside the outer signed payload. For an MLS route, envelope.payload remains the original signed ciphertext and decrypted_payload holds endpoint-only plaintext after the inner MLS authentication succeeds. A mutation too large for one frame arrives as several signed segments; the SDK delivers it once, after every segment arrived and the reassembled bytes matched their signed digest, with envelope set to the final segment.

Fields

envelope: Box<SignedOp>

from_user_id: String

decrypted_payload: Option<Vec<u8>>

Endpoint-verified typed mutation bytes when they differ from envelope.payload: MLS plaintext, or a mutation reassembled from segments. None for single-frame cleartext envelopes (read directly from envelope.payload) and for broker events, which never possess MLS keys.

ScrollbackBatch

Response to a CollabRequest::FetchScrollback: a page of previously-validated ops plus exhausted.

Targeted send — unlike every other event here, the broker writes this only to the connection that issued the matching request.

Fields

artifact: ArtifactId

Echoes FetchScrollback::artifact so multiple in-flight fetches route to the right history view.

ops: Vec<Box<SignedOp>>

Ascending seq order. Empty when the broker has no matching range (typically evicted by compaction).

decrypted_payloads: Vec<Option<Vec<u8>>>

Endpoint-decrypted payload parallel to ops. Brokers leave this empty because they have no MLS keys; SDK endpoints populate one slot per op and drop undecryptable encrypted entries.

oldest_seq: Option<u64>

Oldest seq the host returned, before the endpoint dropped ops it could not use yet (an incomplete segment), so paging resumes below it rather than re-fetching or stopping early.

exhausted: bool

Invocation

One capability-checked invocation addressed to this application connection by the session action broker.

Fields

id: u64

invocation: InvocationId

resource: String

action: String

argument: Option<String>

actor: String

context: Option<Box<ActionContext>>

Broker-owned task/session provenance. The concrete application resource and action remain authoritative; this only supplies the surrounding purpose and work-group for durable history.

InvocationCancellation

The invocation owner requested cooperative cancellation. Delivered at most once; the app-side job decides the next safe stopping boundary.

Fields

id: u64

RemoteAction

The session’s answer to a CollabRequest::RemoteAction.

Fields

message: RemoteActionMessage

ActionCatalogue

Fields

surfaces: Vec<BrokerActionSurface>

ActionDirectoryPage

Fields

request_id: u64

result: Result<ActionDirectoryPage, String>

PublishedActionResolution

Fields

request_id: u64

result: Result<ActionDirectoryResolution, String>

ManagedInvocationObservation

Original attempt custody remains with this result through final clone destruction. Only the sender’s physical barrier can acknowledge it.

Fields

result: ManagedAttemptResult

PublishedInvocationResult

Fields

request_id: u64

result: Result<(u64, InvocationUpdate), String>

InstalledApplicationLaunchResult

Fields

request_id: u64

result: Result<(u64, InvocationUpdate), String>

TaskRun(TaskRunEnvelope)

A run addressed to this admitted agent. The envelope is broker-minted and contains a lease, not a caller-selected authority token.

TaskActionInvocationResult

Fields

request_id: u64

result: Result<(u64, InvocationUpdate), String>

TaskRunCancellation

Fields

request_id: u64

result: Result<bool, String>

TaskRunControl

Fields

request_id: u64

control: TaskRunControl

TaskRunReportResult

Fields

request_id: u64

result: Result<(), String>

WorkspaceControl

Fields

session_id: u64

event: WorkspaceControlEvent

NativeMediaCommandResult

Fields

request_id: u64

result: Result<Snapshot, String>

RecordContent

Content the record on route references arrived: an answer to CollabRequest::WantContent, or content another app on the record offered. The bytes are verified against hash before use.

Fields

route: RouteSpec

hash: String

bytes: Vec<u8>

RealtimeCommandResult

Fields

request_id: u64

result: Result<RealtimeReply, String>

NearbyTransferCommandResult

Fields

request_id: u64

result: Result<NearbyTransferReply, String>

Realtime(RealtimeEvent)

Implementations

impl CollabEvent

pub fn document_mutation( &self, ) -> Option<Result<DocumentMutation, DocumentMutationError>>

Decode the typed payload of a validated document event. Returns None for presence, context, action, and scrollback events.

Trait Implementations

impl Clone for CollabEvent

fn clone(&self) -> CollabEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CollabEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.