Client

open class Client : MetadataAware, CallbackAware, UserAware

A Bugsnag Client instance allows you to use Bugsnag in your Android app. Typically you'd instead use the static access provided in the Bugsnag class.

Example usage: Client client = new Client(this, "your-api-key"); client.notify(new RuntimeException("something broke!"));

Constructors

Client

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

Initialize a Bugsnag client

Client

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

Initialize a Bugsnag client

Client

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

Initialize a Bugsnag client

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.

addOnBreadcrumb

abstract fun addOnBreadcrumb(onBreadcrumb: Null)

open fun addOnBreadcrumb(@NonNull() onBreadcrumb: OnBreadcrumbCallback)

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

addOnError

abstract fun addOnError(onError: Null)

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.

addOnSession

abstract fun addOnSession(onSession: Null)

open fun addOnSession(@NonNull() onSession: OnSessionCallback)

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

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.

getBreadcrumbs

@NonNull()

open fun getBreadcrumbs(): List<Breadcrumb>

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

getContext

@Nullable()

open fun getContext(): String

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

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.

getUser

@NonNull()

open fun getUser(): User

Returns the currently set User information.

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.

notify

open fun notify(@NonNull() exception: Throwable)

Notify Bugsnag of a handled exception

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

Notify Bugsnag of a handled exception

pauseSession

open fun pauseSession()

Pauses tracking of a session.

removeOnBreadcrumb

abstract fun removeOnBreadcrumb(onBreadcrumb: Null)

open fun removeOnBreadcrumb(@NonNull() onBreadcrumb: OnBreadcrumbCallback)

Removes a previously added "on breadcrumb" callback

removeOnError

abstract fun removeOnError(onError: Null)

open fun removeOnError(@NonNull() onError: OnErrorCallback)

Removes a previously added "on error" callback

removeOnSession

abstract fun removeOnSession(onSession: Null)

open fun removeOnSession(@NonNull() onSession: OnSessionCallback)

Removes a previously added "on session" callback

resumeSession

open fun resumeSession(): Boolean

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

setContext

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

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

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)

startSession

open fun startSession()

Starts tracking a new session.

Properties

lastRunInfo

@Nullable()

val lastRunInfo: LastRunInfo

Client

See also

Constructors

Functions

Properties