FakeChataptorClient class

Domain-level fake for ChataptorClient.

Designed for merchants writing widget tests of their host app — never exposes transport, HTTP, or serialization concerns. For low-level protocol-layer tests of the SDK itself, reach for FakeChatTransport instead.

The fake does not implement every ChataptorClient member — it covers the surface exercised by the drop-in widgets and by typical merchant host-app tests (connect / disconnect / sendMessage / clearSession / identify, plus the corresponding streams). Additional members are added as the real counterparts ship.

Implemented types

• ChataptorClient

Constructors

FakeChataptorClient({ConnectionState initialConnectionState = const Disconnected(DisconnectReason.userRequested), AgentInfo? initialAgent})

Creates a FakeChataptorClient in initialConnectionState (defaults to Disconnected(userRequested)), optionally with an initialAgent.

Properties

config → ChataptorConfig

The active configuration. Most fields are immutable for the lifetime of the client, but ChataptorConfig.customer may be swapped at runtime via identify; reading config always returns the current value.

no setter, inherited

connectionState → Stream<ConnectionState>

Stream of connection state updates.

no setter, override

currentConnectionState → ConnectionState?

Synchronous read of the current connection state.

no setter, override

currentMessages → List<Message>

Snapshot of all messages received in this session, sorted oldest-first.

no setter, override

currentOnlineAgents → List<AgentInfo>

Snapshot of agents currently reported as online for this site, in arrival order. The list is capped on the wire and typically holds at most a handful of entries.

no setter, inherited

currentSiteConfig → SiteConfig?

Last SiteConfig received from the backend on site:X channel join.

no setter, inherited

debugAgent → AgentInfo?

Exposed for internal testing only.

no setter, inherited

debugStorage → ChataptorStorage

Exposed for internal testing only.

no setter, inherited

errors → Stream<ChataptorError>

Stream of non-fatal errors emitted by the client.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

inject ↔ FakeChataptorClientInject

Scripted-event injection API.

late, final

messages → Stream<Message>

Stream of incoming messages (agent → customer) and locally sent messages (customer → agent) — the Flutter layer uses this to drive the message list.

no setter, override

onlineAgentsStream → Stream<List<AgentInfo>>

Stream of online-agent snapshots. Emits a fresh list each time the backend pushes agent:available or agents:offline. Replays the current snapshot to new listeners.

no setter, inherited

recorded → FakeChataptorClientRecorded

Observable record of calls.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

siteConfigStream → Stream<SiteConfig>

Stream of SiteConfig updates. Emits once per successful site:X join. Replays the current value to new listeners.

no setter, inherited

Methods

clearSession() → Future<void>

Clears the local session: deletes the stored guest ID and disconnects if currently connected. The next connect call will create a new anonymous identity and open a fresh conversation on the backend.

override

connect() → Future<void>

Opens the WebSocket, joins the site channel, creates a conversation, and joins the conversation channel. Connected is emitted only after the full handshake completes. Idempotent.

override

disconnect() → Future<void>

Closes the WebSocket. Idempotent.

override

dispose() → Future<void>

Releases every resource. After dispose the client is unusable.

override

identify(CustomerIdentity newIdentity) → Future<void>

Migrates the current session to a new CustomerIdentity.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

override

sendMessage(String text, {Map<String, dynamic>? metadata}) → Future<SendResult>

Sends a text text. Runs the beforeSend interceptor if set, then pushes the payload over the transport. Returns a SendResult reflecting the outcome.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited