jackfield library
Typed application API for system calls, durable events and diagnostics.
Applications import this library. Adapter authors use
jackfield_platform_interface.dart for the wire codec and registration.
Classes
- ActionResult
- The outcome of an application-owned action, such as connecting media.
- AnswerRequested
- The system user requested an answer that the application must complete.
- CallActionReceipt
- The known outcome of one application-owned action.
- CallbackAuth
- Credentials used exclusively by the autonomous HTTPS callback transport.
- CallbackConfiguration
- Optional autonomous HTTPS delivery, independent of Flutter event delivery.
- CallEnded
- The call has reached its ended state.
- Caller
- Caller information suitable for a system call presentation.
- CallSnapshot
- The current local view of one call.
- CallUpdate
- A partial update to the system presentation of a call.
- DeliverySucceeded
- A 2xx response completed HTTP delivery.
- DoNotRetry
- A permanent response or expired event must not be retried.
- IncomingCall
- A request to present an incoming call.
- Jackfield
- Application API for system call presentation and durable event delivery.
- JackfieldCapabilities
- Reports the features and presentation mechanism available on a platform.
- JackfieldConfiguration
- Configuration applied when initializing an adapter.
- JackfieldDiagnostics
- A read-only snapshot of adapter health, excluding credentials and tokens.
- JackfieldError
- An expected, typed Jackfield error.
- JackfieldEvent
- A durable event associated with one call.
-
JackfieldFailure<
T> - An operation that returned an expected error.
-
JackfieldResult<
T> - A typed operation outcome.
-
JackfieldSuccess<
T> - An operation that completed successfully.
- OutgoingCall
- A request to start an outgoing call.
- PauseForAuthentication
- A credential failure suspends HTTP delivery until credentials rotate.
- PushToken
- A push token and its provider-assigned value.
- PushTokenSnapshot
- The currently known push tokens.
- PushTokenUpdate
- A change in a platform push token.
- RetryDecision
- The transport-independent outcome of one callback attempt.
- RetryLater
- A transient failure may be retried after delay.
- RetryPolicy
- Classifies HTTPS outcomes without networking or platform scheduling.
Enums
- CallMedia
- The media requested for a call; Jackfield does not transport it.
- CallState
- The local state of a call.
- EndReason
- Why a call ended.
- JackfieldErrorCode
- Stable categories for expected Jackfield failures.
- JackfieldFeature
- A call feature that a platform adapter may support.
- JackfieldMechanism
- The mechanism used to present calls on a platform.
- JackfieldPermissionState
- The adapter's last observed state of a system permission.
Extension Types
Exceptions / Errors
- JackfieldProtocolException
- A malformed or unsupported platform wire payload.
- JackfieldTransportException
- A sanitized channel failure for APIs that cannot return a result wrapper.