Catcher2Options class

Constructors

Catcher2Options(ReportMode reportMode, List<ReportHandler> handlers, {int handlerTimeout = 5000, Map<String, dynamic> customParameters = const <String, dynamic>{}, List<LocalizationOptions> localizationOptions = const [], Map<String, ReportMode> explicitExceptionReportModesMap = const {}, Map<String, ReportHandler> explicitExceptionHandlersMap = const {}, bool handleSilentError = true, String screenshotsPath = '', List<String> excludedParameters = const [], bool filterFunction(Report report)?, int reportOccurrenceTimeout = 3000, void onFlutterError(FlutterErrorDetails details)?, void onPlatformError(Object error, StackTrace stack)?, Catcher2Logger? logger})
Builds catcher 2 options instance
Catcher2Options.getDefaultDebugOptions()
Builds default catcher 2 options debug instance
Catcher2Options.getDefaultProfileOptions()
Builds default catcher 2 options profile instance
Catcher2Options.getDefaultReleaseOptions()
Builds default catcher 2 options release instance

Properties

customParameters Map<String, dynamic>
Custom parameters which will be used in report handler
final
excludedParameters List<String>
Parameters which will be excluded from report
final
explicitExceptionHandlersMap Map<String, ReportHandler>
Explicit report handler map which will be used to trigger specific report report handler for specific error
final
explicitExceptionReportModesMap Map<String, ReportMode>
Explicit report modes map which will be used to trigger specific report mode for specific error
final
filterFunction → (bool Function(Report report)?)
Function which is used to filter reports. If filterFunction is empty then all reports will be passed to handlers. To mark given Report as valid, filterFunction should return true, otherwise return false.
final
handlers List<ReportHandler>
Handlers that should be used
final
handlerTimeout int
Timeout for handlers which uses long-running action. In milliseconds.
final
handleSilentError bool
Should catcher 2 handle silent errors
final
hashCode int
The hash code for this object.
no setterinherited
localizationOptions List<LocalizationOptions>
Localization options (translations)
final
logger Catcher2Logger?
Logger instance.
final
onFlutterError → (void Function(FlutterErrorDetails details)?)
Function which should additionally be called when an error is caught using the FlutterError.onError mechanism. Useful if other packages also need to override this behaviour (such as integration tests).
final
onPlatformError → (void Function(Object error, StackTrace stack)?)
Function which should additionally be called when an error is caught using the PlatformDispatcher.instance.onError mechanism. Useful if other packages also need to override this behaviour.
final
reportMode ReportMode
Report mode that should be called if new report appears
final
reportOccurrenceTimeout int
Timeout for reports to prevent handling duplicates of same error. In milliseconds.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
screenshotsPath String
Path which will be used to save temp. screenshots. If not set, Catcher 2 will use temp directory.
final

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