Event

open class Event : JsonStream.Streamable, MetadataAware, UserAware

An Event object represents a Throwable captured by Bugsnag and is available as a parameter on an OnErrorCallback, where individual properties can be mutated before an error report is sent to Bugsnag's API.

Functions

addMetadata

open fun addMetadata(@NonNull() section: String, @NonNull() value: Map<String, out Any>)

Adds a map of multiple metadata key-value pairs to the specified section.

abstract fun addMetadata(section: Null, value: Null)

open fun addMetadata(@NonNull() section: String, @NonNull() key: String, @Nullable() value: Any)

Adds the specified key and value in the specified section.

clearMetadata

open fun clearMetadata(@NonNull() section: String)

Removes all the data from the specified section.

abstract fun clearMetadata(section: Null)

open fun clearMetadata(@NonNull() section: String, @NonNull() key: String)

Removes data with the specified key from the specified section.

getApiKey

@NonNull()

open fun getApiKey(): String

The API key used for events sent to Bugsnag.

getApp

@NonNull()

open fun getApp(): AppWithState

Information set by the notifier about your app can be found in this field.

getBreadcrumbs

@NonNull()

open fun getBreadcrumbs(): List<Breadcrumb>

A list of breadcrumbs leading up to the event.

getContext

@Nullable()

open fun getContext(): String

Returns the context of the error.

getDevice

@NonNull()

open fun getDevice(): DeviceWithState

Information set by the notifier about your device can be found in this field.

getErrors

@NonNull()

open fun getErrors(): List<Error>

Information extracted from the Throwable that caused the event can be found in this field.

getGroupingHash

@Nullable()

open fun getGroupingHash(): String

Set the grouping hash of the event to override the default grouping on the dashboard.

getMetadata

@Nullable()

open fun getMetadata(@NonNull() section: String): Map<String, Any>

Returns a map of data in the specified section.

abstract fun getMetadata(section: Null): Null

@Nullable()

open fun getMetadata(@NonNull() section: String, @NonNull() key: String): Any

Returns the value of the specified key in the specified section.

getOriginalError

@Nullable()

open fun getOriginalError(): Throwable

The Throwable object that caused the event in your application.

getSeverity

@NonNull()

open fun getSeverity(): Severity

The severity of the event.

getThreads

@NonNull()

open fun getThreads(): List<Thread>

If thread state is being captured along with the event, this field will contain a list of Thread objects.

getUser

@NonNull()

open fun getUser(): User

Returns the currently set User information.

isUnhandled

open fun isUnhandled(): Boolean

Whether the event was a crash (i.e.

setApiKey

open fun setApiKey(@NonNull() apiKey: String)

The API key used for events sent to Bugsnag.

setContext

open fun setContext(@Nullable() context: String)

Sets the context of the error.

setGroupingHash

open fun setGroupingHash(@Nullable() groupingHash: String)

Set the grouping hash of the event to override the default grouping on the dashboard.

setSeverity

open fun setSeverity(@NonNull() severity: Severity)

The severity of the event.

setUnhandled

open fun setUnhandled(unhandled: Boolean)

Whether the event was a crash (i.e.

setUser

open fun setUser(@Nullable() id: String, @Nullable() email: String, @Nullable() name: String)

Sets the user associated with the event.

abstract fun setUser(id: Null, email: Null, name: Null)

toStream

open fun toStream(@NonNull() stream: JsonStream)