bugsnag-android-core/com.bugsnag.android/Bugsnag

Bugsnag

Static access to a Bugsnag Client, the easiest way to use Bugsnag in your Android app. For example:

Bugsnag.start(this, "your-api-key"); Bugsnag.notify(new RuntimeException("something broke!"));

See also

Properties

open val client: Client

Functions

open fun addFeatureFlag(@NonNull name: String)

Add a single feature flag with no variant.

open fun addFeatureFlag(@NonNull name: String, @Nullable variant: String)

Add a single feature flag with an optional variant.

addFeatureFlags

open fun addFeatureFlags(@NonNull featureFlags: Iterable<FeatureFlag>)

Add a collection of feature flags.

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.

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

Adds the specified key and value in the specified section.

addOnBreadcrumb

open fun addOnBreadcrumb(@NonNull onBreadcrumb: OnBreadcrumbCallback)

Add an "on breadcrumb" callback, to execute code before every breadcrumb captured by Bugsnag.

open fun addOnError(@NonNull onError: OnErrorCallback)

Add a "on error" callback, to execute code at the point where an error report is captured in Bugsnag.

open fun addOnSession(@NonNull onSession: OnSessionCallback)

Add an "on session" callback, to execute code before every session captured by Bugsnag.

clearFeatureFlag

open fun clearFeatureFlag(@NonNull name: String)

Remove a single feature flag regardless of its current status.

clearFeatureFlags

open fun clearFeatureFlags()

Clear all of the feature flags.

open fun clearMetadata(@NonNull section: String)

Removes all the data from the specified section.

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

Removes data with the specified key from the specified section.

open fun getBreadcrumbs(): List<Breadcrumb>

Returns the current buffer of breadcrumbs that will be sent with captured events.

open fun getContext(): String

Bugsnag uses the concept of "contexts" to help display and group your errors.

open fun getLastRunInfo(): LastRunInfo

Retrieves information about the last launch of the application, if it has been run before.

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

Returns a map of data in the specified section.

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

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

open fun getUser(): User

Returns the currently set User information.

open fun isStarted(): Boolean

Returns true if one of the start methods have been has been called and so Bugsnag is initialized; false if start has not been called and the other methods will throw IllegalStateException.

leaveBreadcrumb

open fun leaveBreadcrumb(@NonNull message: String)

Leave a "breadcrumb" log message, representing an action that occurred in your app, to aid with debugging.

open fun leaveBreadcrumb(@NonNull message: String, @NonNull metadata: Map<String, Any>, @NonNull type: BreadcrumbType)

Leave a "breadcrumb" log message representing an action or event which occurred in your app, to aid with debugging

markLaunchCompleted

open fun markLaunchCompleted()

Informs Bugsnag that the application has finished launching.

open fun notify(@NonNull exception: Throwable)

open fun notify(@NonNull exception: Throwable, @Nullable onError: OnErrorCallback)

Notify Bugsnag of a handled exception

open fun pauseSession()

Pauses tracking of a session.

removeOnBreadcrumb

open fun removeOnBreadcrumb(@NonNull onBreadcrumb: OnBreadcrumbCallback)

Removes a previously added "on breadcrumb" callback

open fun removeOnError(@NonNull onError: OnErrorCallback)

Removes a previously added "on error" callback

removeOnSession

open fun removeOnSession(@NonNull onSession: OnSessionCallback)

Removes a previously added "on session" callback

open fun resumeSession(): Boolean

Resumes a session which has previously been paused, or starts a new session if none exists.

open fun setContext(@Nullable context: String)

Bugsnag uses the concept of "contexts" to help display and group your errors.

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

Sets the user associated with the event.

open fun start(@NonNull androidContext: Context): Client

open fun start(@NonNull androidContext: Context, @NonNull config: Configuration): Client

open fun start(@NonNull androidContext: Context, @NonNull apiKey: String): Client

Initialize the static Bugsnag client

open fun startSession()

Starts tracking a new session.