binnacle library

Records what happens inside an app — sessions, navigation, HTTP traffic — on the device, and hands the recording over when asked for it.

Classes

AppDto
The build a recording came from.
BatchDto
A set of recorded sessions ready to be handed over.
Binnacle
Records what happens inside an app — sessions, navigation, HTTP traffic — on the device, and hands the recording over when asked for it.
BinnacleConfig
What the host app tells the recorder about itself on startup.
DeviceDto
The device a recording came from.
ErrorCapture
A failure the host app wants on the timeline.
EventDto
One entry of a session timeline.
HttpCapture
An in-flight HTTP capture, closed by whichever outcome the request has.
HttpCaptureStart
An HTTP request as it leaves the host app.
A screen or overlay transition reported by the host app.
NoopBinnacle
A recorder that records nothing.
RecordingSummary
How much is stored, and from when to when.
SessionDto
A recorded session as it travels to the server.
SessionSummary
Enough of a stored session to list and pick one.
UserDto
Last user known on the device. Sessions carry their own attribution, so this is a hint, not the authority.

Enums

AuthKind
Which credential the host app attached to a request. The value itself is never recorded.
ErrorKind
Why an error is worth recording.
EventType
Kinds of event that can appear on a session timeline.
HttpSource
Which client stack produced an HTTP capture, so recordings coming from different clients of the same app stay distinguishable.
How a navigation event was produced.
SessionEndReason
Why a session ended. A session with no end reason is still open.
SessionStartReason
Why a session started.

Constants

authKindExtra → const String
Key an app can put in a request's extra to say which credential it attached, when the recorder cannot tell from the request alone.
batchSchemaVersion → const int
Version of the wire format. Additive changes keep it; anything that changes the shape or the meaning of a field bumps it.