frontface_chat
library
Classes
CallAvailability
Whether to show the Call button.
CallConnected
An agent answered. agentName arrives a moment after the answer, when the agent's audio joins:
this state is emitted again with the name.
CallConnecting
Joining the audio (a second or two after tapping Call, or while rejoining).
CallContinuedElsewhere
The same customer joined this call from another device or session, which took the audio over.
The call itself goes on there; this session stops.
CallDeviceStore
Where the package keeps this phone's registration for calls from support between launches. The
value includes a secret: keep it in secure storage (Keychain / Keystore), for example with
flutter_secure_storage. The background push handler must be able to read it too.
CallEnded
The call is over. result is the server's record (outcome, duration, agent); its outcome is
CallOutcome.unknown only if the server could not be reached to ask.
CallEndedPush
The call stopped ringing elsewhere (cancelled, answered on another phone): dismiss the call screen.
Android only; an iPhone learns it from IncomingCall.stoppedRinging .
CallPush
A push FrontFace sent this phone for a call from support. Read one with parseCallPush .
CallReconnecting
The network dropped for a moment; the package is getting the audio back. Keep the call screen.
CallResult
The server's view of a call (GET …/calls/{callId} and POST …/end).
CallRinging
Waiting for an agent. queuePosition 1 = next in line (null when unknown).
CallsErrorCode
The error codes the call endpoints return, plus network for "no response".
CallSession
One call, from tapping Call to the end. Read state and listen to changes to drive the call
screen.
CallState
What the call screen shows. A CallSession moves through these in order; CallEnded and
CallContinuedElsewhere are final.
FrontFaceAttachmentCard
Renders a location / media / document attachment card inside a chat bubble.
FrontFaceAttachmentPayload
UI helper for local provisional bubbles / legacy text parse.
FrontFaceAttachmentsConfig
Optional chat attachments (location, images, voice notes).
FrontFaceAttachmentSheet
Bottom sheet listing enabled attachment actions.
FrontFaceCalls
Entry point: check whether the customer can call, start a call, and take calls from support.
FrontFaceCallScreen
Full-screen call UI driven by CallSession.state / CallSession.changes .
FrontFaceChannelButton
FrontFaceChannelButtons
FrontFaceChat
Entry point for opening FrontFace chat in your Flutter app.
FrontFaceChatConfig
Credentials and settings for your FrontFace project.
FrontFaceChatMessage
FrontFaceChatProvider
FrontFaceChatScreen
Full-screen native FrontFace chat UI.
FrontFaceChatStrings
Localizable UI strings for the chat package.
FrontFaceChatTheme
Visual styling for the chat UI. Override any field to match your app.
FrontFaceCsatPrompt
FrontFaceEmbedConfig
FrontFaceEmbedNotice
FrontFaceHandoffAvailability
FrontFaceIdentifyResult
FrontFaceImageViewer
Full-screen image preview with pinch / double-tap zoom.
FrontFaceLeadForm
FrontFaceLocationData
Location payload for POST /api/chat/message (location field).
FrontFaceLocationPickerScreen
Full-screen map picker with place search. Returns a location payload or null.
FrontFaceMediaUploadReservation
Response from POST /api/media/uploads.
FrontFaceMessageBubble
FrontFaceMessageMetadata
FrontFaceMessagePart
Non-text part from GET …/messages/public (MessagePart in openapi).
FrontFaceOfflineForm
FrontFacePendingAttachment
Local file waiting to be uploaded to FrontFace storage.
FrontFaceRealtimeConfig
Supabase Realtime settings from bootstrap GET /api/embed/config/{projectId}.
FrontFaceTicketAction
FrontFaceTicketCard
FrontFaceTypingIndicator
IncomingCall
A call from support ringing on this phone: answer it, decline it, and learn when it stops ringing.
IncomingCallPush
Support is calling: ring (show the system call screen) right away.
StoredDevice
What the package stores: the credential, and what it was registered with (to skip registering again
when nothing changed).
