Configuration (bugsnag-android API)

java.lang.Object
- com.bugsnag.android.Configuration

```
public class Configuration
extends java.lang.Object
```
User-specified configuration storage object, contains information specified at the client level, api-key and endpoint configuration.

Constructor Summary

Constructors
Constructor and Description

Configuration(java.lang.String apiKey)
Construct a new Bugsnag configuration object

Constructors
Constructor and Description
`Configuration(java.lang.String apiKey)` Construct a new Bugsnag configuration object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`beforeNotify(BeforeNotify beforeNotify)` Adds a new before notify task
`java.lang.String`	`getApiKey()` Gets the API key to send reports to
`java.lang.String`	`getAppVersion()` Gets the application version sent to Bugsnag.
`protected java.util.Collection<BeforeNotify>`	`getBeforeNotifyTasks()` Gets any before notify tasks to run
`java.lang.String`	`getBuildUUID()` Get the buildUUID.
`java.lang.String`	`getContext()` Gets the context to be sent to Bugsnag.
`boolean`	`getEnableExceptionHandler()` Get whether or not Bugsnag should automatically handle uncaught exceptions
`java.lang.String`	`getEndpoint()` Get the endpoint to send data
`java.lang.String[]`	`getFilters()` Get which keys should be filtered when sending metaData to Bugsnag
`java.lang.String[]`	`getIgnoreClasses()` Get which exception classes should be ignored (not sent) by Bugsnag.
`protected MetaData`	`getMetaData()`
`java.lang.String[]`	`getNotifyReleaseStages()` Get for which releaseStages errors should be sent to Bugsnag.
`boolean`	`getPersistUserBetweenSessions()` Get whether or not Bugsnag should persist user information between application settings
`java.lang.String[]`	`getProjectPackages()` Get which packages should be considered part of your application.
`java.lang.String`	`getReleaseStage()` Get the current "release stage" of your application.
`boolean`	`getSendThreads()` Get whether to send thread-state with report.
`protected boolean`	`inProject(java.lang.String className)` Checks if the given class name should be marked as in the project or not
`void`	`setAppVersion(java.lang.String appVersion)` Set the application version sent to Bugsnag.
`void`	`setBuildUUID(java.lang.String buildUUID)` Set the buildUUID to your own value.
`void`	`setContext(java.lang.String context)` Set the context sent to Bugsnag.
`void`	`setEnableExceptionHandler(boolean enableExceptionHandler)` Set whether or not Bugsnag should automatically handle uncaught exceptions
`void`	`setEndpoint(java.lang.String endpoint)` Set the endpoint to send data to.
`void`	`setFilters(java.lang.String[] filters)` Set which keys should be filtered when sending metaData to Bugsnag.
`void`	`setIgnoreClasses(java.lang.String[] ignoreClasses)` Set which exception classes should be ignored (not sent) by Bugsnag.
`protected void`	`setMetaData(MetaData metaData)` Sets any meta data associated with the error
`void`	`setNotifyReleaseStages(java.lang.String[] notifyReleaseStages)` Set for which releaseStages errors should be sent to Bugsnag.
`void`	`setPersistUserBetweenSessions(boolean persistUserBetweenSessions)` Set whether or not Bugsnag should persist user information between application settings if set then any user information set will be re-used until
`void`	`setProjectPackages(java.lang.String[] projectPackages)` Set which packages should be considered part of your application.
`void`	`setReleaseStage(java.lang.String releaseStage)` Set the current "release stage" of your application.
`void`	`setSendThreads(boolean sendThreads)` Set whether to send thread-state with report.
`protected boolean`	`shouldIgnoreClass(java.lang.String className)` Checks if the given exception class should be ignored or not
`protected boolean`	`shouldNotifyForReleaseStage(java.lang.String releaseStage)` Checks if the given release stage should be notified or not

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Configuration
```
public Configuration(java.lang.String apiKey)
```
    Construct a new Bugsnag configuration object
    
    Parameters:
    
    apiKey - The API key to send reports to
- Method Detail
  - getApiKey
```
public java.lang.String getApiKey()
```
    Gets the API key to send reports to
    
    Returns:
    
    API key
  - getAppVersion
```
public java.lang.String getAppVersion()
```
    Gets the application version sent to Bugsnag.
    
    Returns:
    
    App Version
  - setAppVersion
```
public void setAppVersion(java.lang.String appVersion)
```
    Set the application version sent to Bugsnag. By default we'll pull this from your AndroidManifest.xml
    
    Parameters:
    
    appVersion - the app version to send
  - getContext
```
public java.lang.String getContext()
```
    Gets the context to be sent to Bugsnag.
    
    Returns:
    
    Context
  - setContext
```
public void setContext(java.lang.String context)
```
    Set the context sent to Bugsnag. By default we'll attempt to detect the name of the top-most activity at the time of a report, and use this as the context, but sometime this is not possible.
    
    Parameters:
    
    context - set what was happening at the time of a crash
  - getEndpoint
```
public java.lang.String getEndpoint()
```
    Get the endpoint to send data
    
    Returns:
    
    Endpoint
  - setEndpoint
```
public void setEndpoint(java.lang.String endpoint)
```
    Set the endpoint to send data to. By default we'll send reports to the standard https://notify.bugsnag.com endpoint, but you can override this if you are using Bugsnag Enterprise to point to your own Bugsnag endpoint.
    
    Parameters:
    
    endpoint - the custom endpoint to send report to
  - getBuildUUID
```
public java.lang.String getBuildUUID()
```
    Get the buildUUID.
    
    Returns:
    
    build UUID
  - setBuildUUID
```
public void setBuildUUID(java.lang.String buildUUID)
```
    Set the buildUUID to your own value. This is used to identify proguard mapping files in the case that you publish multiple different apps with the same appId and versionCode. The default value is read from the com.bugsnag.android.BUILD_UUID meta-data field in your app manifest.
    
    Parameters:
    
    buildUUID - the buildUUID.
  - getFilters
```
public java.lang.String[] getFilters()
```
    Get which keys should be filtered when sending metaData to Bugsnag
    
    Returns:
    
    Filters
  - setFilters
```
public void setFilters(java.lang.String[] filters)
```
    Set which keys should be filtered when sending metaData to Bugsnag. Use this when you want to ensure sensitive information, such as passwords or credit card information is stripped from metaData you send to Bugsnag. Any keys in metaData which contain these strings will be marked as [FILTERED] when send to Bugsnag.
    For example:
    client.setFilters("password", "credit_card");
    
    Parameters:
    
    filters - a list of keys to filter from metaData
  - getIgnoreClasses
```
public java.lang.String[] getIgnoreClasses()
```
    Get which exception classes should be ignored (not sent) by Bugsnag.
    
    Returns:
    
    Ignore classes
  - setIgnoreClasses
```
public void setIgnoreClasses(java.lang.String[] ignoreClasses)
```
    Set which exception classes should be ignored (not sent) by Bugsnag.
    For example:
    client.setIgnoreClasses("java.lang.RuntimeException");
    
    Parameters:
    
    ignoreClasses - a list of exception classes to ignore
  - getNotifyReleaseStages
```
public java.lang.String[] getNotifyReleaseStages()
```
    Get for which releaseStages errors should be sent to Bugsnag.
    
    Returns:
    
    Notify release stages
  - setNotifyReleaseStages
```
public void setNotifyReleaseStages(java.lang.String[] notifyReleaseStages)
```
    Set for which releaseStages errors should be sent to Bugsnag. Use this to stop errors from development builds being sent.
    For example:
    client.setNotifyReleaseStages("production");
    
    Parameters:
    
    notifyReleaseStages - a list of releaseStages to notify for
    
    See Also:
    
    setReleaseStage(java.lang.String)
  - getProjectPackages
```
public java.lang.String[] getProjectPackages()
```
    Get which packages should be considered part of your application.
    
    Returns:
    
    packages
  - setProjectPackages
```
public void setProjectPackages(java.lang.String[] projectPackages)
```
    Set which packages should be considered part of your application. Bugsnag uses this to help with error grouping, and stacktrace display.
    For example:
    client.setProjectPackages("com.example.myapp");
    By default, we'll mark the current package name as part of you app.
    
    Parameters:
    
    projectPackages - a list of package names
  - getReleaseStage
```
public java.lang.String getReleaseStage()
```
    Get the current "release stage" of your application.
    
    Returns:
    
    release stage
  - setReleaseStage
```
public void setReleaseStage(java.lang.String releaseStage)
```
    Set the current "release stage" of your application. By default, we'll set this to "development" for debug builds and "production" for non-debug builds.
    
    Parameters:
    
    releaseStage - the release stage of the app
    
    See Also:
    
    setNotifyReleaseStages(java.lang.String[])
  - getSendThreads
```
public boolean getSendThreads()
```
    Get whether to send thread-state with report.
    
    Returns:
    
    send threads
  - setSendThreads
```
public void setSendThreads(boolean sendThreads)
```
    Set whether to send thread-state with report. By default, this will be true.
    
    Parameters:
    
    sendThreads - should we send thread-state with report?
  - getEnableExceptionHandler
```
public boolean getEnableExceptionHandler()
```
    Get whether or not Bugsnag should automatically handle uncaught exceptions
    
    Returns:
    
    should Bugsnag automatically handle uncaught exceptions
  - setEnableExceptionHandler
```
public void setEnableExceptionHandler(boolean enableExceptionHandler)
```
    Set whether or not Bugsnag should automatically handle uncaught exceptions
    
    Parameters:
    
    enableExceptionHandler - should Bugsnag automatically handle uncaught exceptions
  - getMetaData
```
protected MetaData getMetaData()
```
  - setMetaData
```
protected void setMetaData(MetaData metaData)
```
    Sets any meta data associated with the error
    
    Parameters:
    
    metaData - meta data
  - getBeforeNotifyTasks
```
protected java.util.Collection<BeforeNotify> getBeforeNotifyTasks()
```
    Gets any before notify tasks to run
    
    Returns:
    
    the before notify tasks
  - getPersistUserBetweenSessions
```
public boolean getPersistUserBetweenSessions()
```
    Get whether or not Bugsnag should persist user information between application settings
    
    Returns:
    
    whether or not Bugsnag should persist user information
  - setPersistUserBetweenSessions
```
public void setPersistUserBetweenSessions(boolean persistUserBetweenSessions)
```
    Set whether or not Bugsnag should persist user information between application settings if set then any user information set will be re-used until
    
    Parameters:
    
    persistUserBetweenSessions - whether or not Bugsnag should persist user information
    
    See Also:
    
    is called
  - shouldNotifyForReleaseStage
```
protected boolean shouldNotifyForReleaseStage(java.lang.String releaseStage)
```
    Checks if the given release stage should be notified or not
    
    Parameters:
    
    releaseStage - the release stage to check
    
    Returns:
    
    true if the release state should be notified else false
  - shouldIgnoreClass
```
protected boolean shouldIgnoreClass(java.lang.String className)
```
    Checks if the given exception class should be ignored or not
    
    Parameters:
    
    className - the exception class to check
    
    Returns:
    
    true if the exception class should be ignored else false
  - beforeNotify
```
protected void beforeNotify(BeforeNotify beforeNotify)
```
    Adds a new before notify task
    
    Parameters:
    
    beforeNotify - the new before notify task
  - inProject
```
protected boolean inProject(java.lang.String className)
```
    Checks if the given class name should be marked as in the project or not
    
    Parameters:
    
    className - the class to check
    
    Returns:
    
    true if the class should be considered in the project else false

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Method Detail

getApiKey

getAppVersion

setAppVersion

getContext

setContext

getEndpoint

setEndpoint

getBuildUUID

setBuildUUID

getFilters

setFilters

getIgnoreClasses

setIgnoreClasses

getNotifyReleaseStages

setNotifyReleaseStages

getProjectPackages

setProjectPackages

getReleaseStage

setReleaseStage

getSendThreads

setSendThreads

getEnableExceptionHandler

setEnableExceptionHandler

getMetaData

setMetaData

getBeforeNotifyTasks

getPersistUserBetweenSessions

setPersistUserBetweenSessions

shouldNotifyForReleaseStage

shouldIgnoreClass

beforeNotify

inProject