FailureReason enum

Why an interview could not complete, carried by InterviewFailed and FetchFailed.

The same shared set backs both Fireside.present and Fireside.fetchInterviewStatuses — there is no per-method reason. The host-facing failure surface is deliberately lean: a value is public only when the host has a distinct, correct action to take and it is not a failure Fireside owns end-to-end and should prevent. Richer internal codes ride telemetry and never reach the host.

Inheritance
Available extensions

Values

networkIssue → const FailureReason

A reachability problem — Fireside throttled the call, or the participant's connection or Fireside was unreachable, timed out, or 5xx after the retry budget (including a handshake that couldn't complete). Retryable — re-invoke present / fetch to retry.

integrationError → const FailureReason

The integration is wrong — credentials that don't validate (bad/unregistered apiKey or unbound bundle id), or a host misuse (called before identify, an invalid studyId, called before init). Terminal — retrying unchanged won't help; the fix is in the host's code/config. The exact cause is named in a debug-visible log, never a distinct host-facing arm. Emitted by both present and fetch.

unexpected → const FailureReason

A terminal error the host does not need to distinguish. The rich internal code rides telemetry; the host shows a generic try-again. The forward-compat sink for the open failure-reason set.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
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

Constants

values → const List<FailureReason>
A constant List of the values in this enum, in order of their declaration.