Raygun class
The official Raygun provider for Flutter. This is the main class that provides functionality for sending exceptions to the Raygun service.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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
Static Properties
- onBeforeSend ↔ OnBeforeSendCallback?
-
Allows accessing or mutating the candidate error payload immediately
before it is sent, or cancelling the send outright.
getter/setter pair
Static Methods
-
clearBreadcrumbs(
) → Future< void> - Clears breadcrumbs
-
init(
{required String apiKey, String? version}) → Future< void> -
Initalizes the Raygun client with your Raygun API
apiKey. -
recordBreadcrumb(
String message) → Future< void> - Sends a breadcrumb to Raygun as String
-
recordBreadcrumbObject(
RaygunBreadcrumbMessage raygunBreadcrumbMessage) → Future< void> - Sends a breadcrumb to Raygun as RaygunBreadcrumbMessage
-
sendCustom(
{required String className, required String reason, List< String> ? tags, Map<String, dynamic> ? customData, StackTrace? stackTrace}) → Future<void> - Sends a custom error message to Raygun.
-
sendException(
{required Object error, List< String> ? tags, Map<String, dynamic> ? customData, StackTrace? stackTrace}) → Future<void> -
Sends an exception to Raygun.
Convenience method that wraps sendCustom.
The class name and the message are obtained from the
errorobject. -
setCustomCrashReportingEndpoint(
String? url) → Future< void> - Allows the user to set a custom endpoint for Crash Reporting
-
setCustomData(
Map< String, dynamic> ? customData) → Future<void> - Sets a key-value Map which, like the tags, will be sent along with every exception. This will be merged with any other custom data passed in sendException and sendCustom.
-
setTags(
List< String> ? tags) → Future<void> - Sets a List of tags which will be sent along with every exception. This will be merged with any other tags passed in sendException and sendCustom.
-
setUser(
RaygunUserInfo? raygunUserInfo) → Future< void> - Sets the current user of your application.
-
setUserId(
String? userId) → Future< void> - Sets the current user of your application.
-
setVersion(
String? version) → Future< void> - Manually stores the version of your application to be transmitted with each message, for version filtering. This is normally read from your pubspec.yaml or passed in on init(); this is only provided as a convenience.