BugReporterConfig class

Everything the reporter needs: identity, backend, look, and optional hooks.

Annotations

Constructors

BugReporterConfig({required String appName, String? appVersion, String? apiUrl, Map<String, String>? headers, BugReporterRepository? repository, Map<String, Object?>? deviceInfo, Map<String, Object?>? packageInfo, DiagnosticsCollector? collectDiagnostics, ContextCollector? collectContext, ReportPriority? defaultPriority, BugReporterTheme theme = BugReporterTheme.indigo, String backendName = 'ClickUp', ScreenshotOptions screenshot = const ScreenshotOptions(), ReportQueueStorage? storage, String label = 'Report a bug', bool showButton = true, ShakeOptions? shake})
const

Properties

apiUrl → String?
Default HTTP backend: reports are POSTed here when repository is null.
final
appName → String
Application name (required), e.g. 'CheckRidePro'.
final
appVersion → String?
Application version, shown in the captured context.
final
backendName → String
Name shown in the form footer ("Filing to …") and success card.
final
collectContext → ContextCollector?
Called when the form opens to append extra context rows (network type, build channel, feature flags, user tier…). May be async.
final
collectDiagnostics → DiagnosticsCollector?
Called fresh on every submit, so diagnostics reflect the moment of report.
final
defaultPriority → ReportPriority?
Fallback priority when the chosen severity maps to nothing.
final
deviceInfo → Map<String, Object?>?
Static device info merged into every report (e.g. from device_info_plus).
final
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, String>?
Extra headers for the default HTTP backend (e.g. Authorization).
final
label → String
Accessibility label / tooltip for the floating button.
final
packageInfo → Map<String, Object?>?
Static app/package info merged into every report (e.g. package_info_plus).
final
repository → BugReporterRepository?
Backend implementation. When set, used instead of apiUrl.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenshot → ScreenshotOptions
Screenshot size guard.
final
shake → ShakeOptions?
Shake-to-report. Null (the default) means off.
final
showButton → bool
Whether to show the floating button.
final
storage → ReportQueueStorage?
Backing store for the offline retry queue. When null, failed submits surface an error instead of being retried later.
final
theme → BugReporterTheme
UI tokens. Use a preset or preset.copyWith(...).
final

Methods

copyWith({String? appName, String? appVersion, String? apiUrl, Map<String, String>? headers, BugReporterRepository? repository, Map<String, Object?>? deviceInfo, Map<String, Object?>? packageInfo, DiagnosticsCollector? collectDiagnostics, ContextCollector? collectContext, ReportPriority? defaultPriority, BugReporterTheme? theme, String? backendName, ScreenshotOptions? screenshot, ReportQueueStorage? storage, String? label, bool? showButton, ShakeOptions? shake}) → BugReporterConfig
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