WireCodec class abstract final

Validates all Jackfield channel commands, results and event envelopes, v1.

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

decodeCallResult(Object? payload) → JackfieldResult<CallSnapshot>
Decodes a call command outcome, including durable action receipts.
decodeCapabilities(Object? payload) → JackfieldCapabilities
Decodes an explicit capability report, rejecting unknown feature names.
decodeDiagnostics(Object? payload) → JackfieldDiagnostics
Decodes health without accepting unrecognized fields or negative counts.
decodeEvent(Object? payload) → JackfieldEvent
Decodes one event, rejecting unknown or malformed payloads safely.
decodePushTokensResult(Object? payload) → JackfieldResult<PushTokenSnapshot>
Decodes a push-token query outcome with opaque provider token values.
decodePushTokenUpdate(Object? payload) → PushTokenUpdate
Decodes a versioned token addition, rotation or removal stream emission.
decodeVoidResult(Object? payload) → JackfieldResult<void>
Decodes a command outcome whose successful value must be null.
encodeAcknowledgements(Set<EventId> ids) → Map<String, Object?>
Encodes Flutter delivery acknowledgements without action completion.
encodeActionResult(ActionId id, ActionResult result) → Map<String, Object?>
Encodes action completion without any event acknowledgement.
encodeCallUpdate(CallUpdate update) → Map<String, Object?>
Encodes a partial update, omitting fields that should remain unchanged.
encodeConfiguration(JackfieldConfiguration config) → Map<String, Object?>
Encodes initialization, rejecting unsafe callback destinations and bounds.
encodeEndCall(CallId id, EndReason reason) → Map<String, Object?>
Encodes explicit call termination.
encodeEvent(JackfieldEvent event) → Map<String, Object?>
Encodes an event as a version 1 map suitable for JSON or a channel.
encodeIncomingCall(IncomingCall call) → Map<String, Object?>
Encodes and validates an incoming call before crossing a channel.
encodeOutgoingCall(OutgoingCall call) → Map<String, Object?>
Encodes and validates an outgoing call before crossing a channel.
encodeQuery() → Map<String, Object?>
Encodes a versioned query or stream attachment with no application data.

Constants

version → const int
The version understood by this codec.