If your app's codebase contains different entry-points/processes, but reports to a single Bugsnag project, you might want to add information denoting the type of process the error came from.

getAppVersion

@Nullable()

open fun getAppVersion(): String

Set the application version sent to Bugsnag.

getAutoDetectErrors

open fun getAutoDetectErrors(): Boolean

If you want to disable automatic detection of all errors, you can set this property to false.

getAutoTrackSessions

open fun getAutoTrackSessions(): Boolean

Sets whether or not Bugsnag should automatically capture and report User sessions whenever the app enters the foreground.

getContext

@Nullable()

open fun getContext(): String

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

getDelivery

@NonNull()

open fun getDelivery(): Delivery

The Delivery implementation used to make network calls to the Bugsnag Error Reporting and Sessions API.

getDiscardClasses

@NonNull()

open fun getDiscardClasses(): Set<String>

Allows you to specify the fully-qualified name of error classes that will be discarded before being sent to Bugsnag if they are detected.

getEnabledBreadcrumbTypes

@Nullable()

open fun getEnabledBreadcrumbTypes(): Set<BreadcrumbType>

By default we will automatically add breadcrumbs for common application events such as activity lifecycle events and system intents.

getEnabledErrorTypes

@NonNull()

open fun getEnabledErrorTypes(): ErrorTypes

Bugsnag will automatically detect different types of error in your application.

getEnabledReleaseStages

@Nullable()

open fun getEnabledReleaseStages(): Set<String>

By default, Bugsnag will be notified of events that happen in any releaseStage.

getEndpoints

@NonNull()

open fun getEndpoints(): EndpointConfiguration

Set the endpoints to send data to.

getLaunchCrashThresholdMs

@Deprecated()

open fun getLaunchCrashThresholdMs(): Long

Deprecated.

getLaunchDurationMillis

open fun getLaunchDurationMillis(): Long

Sets the threshold in milliseconds for an uncaught error to be considered as a crash on launch.

getLogger

@Nullable()

open fun getLogger(): Logger

By default, the notifier's log messages will be logged using android.util.Log with a "Bugsnag" tag unless the releaseStage is "production".

getMaxBreadcrumbs

open fun getMaxBreadcrumbs(): Int

Sets the maximum number of breadcrumbs which will be stored.

getMaxPersistedEvents

open fun getMaxPersistedEvents(): Int

Sets the maximum number of persisted events which will be stored.

getMaxPersistedSessions

open fun getMaxPersistedSessions(): Int

Sets the maximum number of persisted sessions which will be stored.

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.

getPersistenceDirectory

@Nullable()

open fun getPersistenceDirectory(): File

Sets the directory where event and session JSON payloads should be persisted if a network request is not successful.

getPersistUser

open fun getPersistUser(): Boolean

Set whether or not Bugsnag should persist user information between application sessions.

getProjectPackages

@NonNull()

open fun getProjectPackages(): Set<String>

Sets which package names Bugsnag should consider as a part of the running application.

getRedactedKeys

@NonNull()

open fun getRedactedKeys(): Set<String>

Sets which values should be removed from any Metadata objects before sending them to Bugsnag.

getReleaseStage

@Nullable()

open fun getReleaseStage(): String

If you would like to distinguish between errors that happen in different stages of the application release process (development, production, etc) you can set the releaseStage that is reported to Bugsnag.

getSendLaunchCrashesSynchronously

open fun getSendLaunchCrashesSynchronously(): Boolean

Sets whether or not Bugsnag should send crashes synchronously that occurred during the application's launch period.

getSendThreads

@NonNull()

open fun getSendThreads(): ThreadSendPolicy

Controls whether we should capture and serialize the state of all threads at the time of an error.

getUser

@NonNull()

open fun getUser(): User

Returns the currently set User information.

getVersionCode

@Nullable()

open fun getVersionCode(): Integer

We'll automatically pull your versionCode from the versionCode field in your AndroidManifest.xml file.

load

@NonNull()

open fun load(@NonNull() context: Context): Configuration

Loads a Configuration object from values supplied as meta-data elements in your AndroidManifest.

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

setApiKey

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

Changes the API key used for events sent to Bugsnag.

setAppType

open fun setAppType(@Nullable() appType: String)

If your app's codebase contains different entry-points/processes, but reports to a single Bugsnag project, you might want to add information denoting the type of process the error came from.

setAppVersion

open fun setAppVersion(@Nullable() appVersion: String)

Set the application version sent to Bugsnag.

setAutoDetectErrors

open fun setAutoDetectErrors(autoDetectErrors: Boolean)

If you want to disable automatic detection of all errors, you can set this property to false.

setAutoTrackSessions

open fun setAutoTrackSessions(autoTrackSessions: Boolean)

Sets whether or not Bugsnag should automatically capture and report User sessions whenever the app enters the foreground.

setContext

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

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

setDelivery

open fun setDelivery(@NonNull() delivery: Delivery)

The Delivery implementation used to make network calls to the Bugsnag Error Reporting and Sessions API.

setDiscardClasses

open fun setDiscardClasses(@NonNull() discardClasses: Set<String>)

Allows you to specify the fully-qualified name of error classes that will be discarded before being sent to Bugsnag if they are detected.

setEnabledBreadcrumbTypes

open fun setEnabledBreadcrumbTypes(@Nullable() enabledBreadcrumbTypes: Set<BreadcrumbType>)

By default we will automatically add breadcrumbs for common application events such as activity lifecycle events and system intents.

setEnabledErrorTypes

open fun setEnabledErrorTypes(@NonNull() enabledErrorTypes: ErrorTypes)

Bugsnag will automatically detect different types of error in your application.

setEnabledReleaseStages

open fun setEnabledReleaseStages(@Nullable() enabledReleaseStages: Set<String>)

By default, Bugsnag will be notified of events that happen in any releaseStage.

setEndpoints

open fun setEndpoints(@NonNull() endpoints: EndpointConfiguration)

Set the endpoints to send data to.

setLaunchCrashThresholdMs

@Deprecated()

open fun setLaunchCrashThresholdMs(launchCrashThresholdMs: Long)

Deprecated.

setLaunchDurationMillis

open fun setLaunchDurationMillis(launchDurationMillis: Long)

Sets the threshold in milliseconds for an uncaught error to be considered as a crash on launch.

setLogger

open fun setLogger(@Nullable() logger: Logger)

By default, the notifier's log messages will be logged using android.util.Log with a "Bugsnag" tag unless the releaseStage is "production".

setMaxBreadcrumbs

open fun setMaxBreadcrumbs(maxBreadcrumbs: Int)

Sets the maximum number of breadcrumbs which will be stored.

setMaxPersistedEvents

open fun setMaxPersistedEvents(maxPersistedEvents: Int)

Sets the maximum number of persisted events which will be stored.

setMaxPersistedSessions

open fun setMaxPersistedSessions(maxPersistedSessions: Int)

Sets the maximum number of persisted sessions which will be stored.

setPersistenceDirectory

open fun setPersistenceDirectory(@Nullable() directory: File)

Sets the directory where event and session JSON payloads should be persisted if a network request is not successful.

setPersistUser

open fun setPersistUser(persistUser: Boolean)

Set whether or not Bugsnag should persist user information between application sessions.

setProjectPackages

open fun setProjectPackages(@NonNull() projectPackages: Set<String>)

Sets which package names Bugsnag should consider as a part of the running application.

setRedactedKeys

open fun setRedactedKeys(@NonNull() redactedKeys: Set<String>)

Sets which values should be removed from any Metadata objects before sending them to Bugsnag.

setReleaseStage

open fun setReleaseStage(@Nullable() releaseStage: String)

setSendLaunchCrashesSynchronously

open fun setSendLaunchCrashesSynchronously(sendLaunchCrashesSynchronously: Boolean)

Sets whether or not Bugsnag should send crashes synchronously that occurred during the application's launch period.

setSendThreads

open fun setSendThreads(@NonNull() sendThreads: ThreadSendPolicy)

Controls whether we should capture and serialize the state of all threads at the time of an error.

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)

setVersionCode

open fun setVersionCode(@Nullable() versionCode: Integer)

We'll automatically pull your versionCode from the versionCode field in your AndroidManifest.xml file.