com.bugsnag.android

Class Error

java.lang.Object

com.bugsnag.android.Error

All Implemented Interfaces:

JsonStream.Streamable

public class Error
extends java.lang.Object
implements JsonStream.Streamable

Information and associated diagnostics relating to a handled or unhandled Exception.

This object is made available in BeforeNotify callbacks, so you can inspect and modify it before it is delivered to Bugsnag.

See Also:

BeforeNotify

Method Summary

Modifier and Type	Method and Description
void	addToTab(java.lang.String tabName, java.lang.String key, java.lang.Object value) Add additional diagnostic information to send with this Error.
void	clearTab(java.lang.String tabName) Remove a tab of app-wide diagnostic information from this Error
java.lang.String	getContext() Get the context associated with this Error.
java.lang.Throwable	getException() The exception which triggered this Error report.
java.lang.String	getExceptionMessage() Get the message from the exception contained in this Error report.
java.lang.String	getExceptionName() Get the class name from the exception contained in this Error report.
MetaData	getMetaData() Get any additional diagnostic MetaData currently attached to this Error.
Severity	getSeverity() Get the Severity of this Error.
com.bugsnag.android.User	getUser()
void	setContext(java.lang.String context) Override the context sent to Bugsnag with this Error.
void	setGroupingHash(java.lang.String groupingHash) Set a custom grouping hash to use when grouping this Error on the Bugsnag dashboard.
void	setMetaData(MetaData metaData) Set additional diagnostic MetaData to send with this Error.
void	setSeverity(Severity severity) Set the Severity of this Error.
void	setUser(java.lang.String id, java.lang.String email, java.lang.String name) Set user information associated with this Error
void	setUserEmail(java.lang.String email) Set user email address associated with this Error
void	setUserId(java.lang.String id) Set user id associated with this Error
void	setUserName(java.lang.String name) Set user name associated with this Error
void	toStream(JsonStream writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

toStream

public void toStream(JsonStream writer)
              throws java.io.IOException

Specified by:

toStream in interface JsonStream.Streamable

Throws:

java.io.IOException

setContext

public void setContext(java.lang.String context)

Override the context sent to Bugsnag with this Error. By default we'll attempt to detect the name of the top-most Activity when this error occurred, and use this as the context, but sometimes this is not possible.

Parameters:

context - what was happening at the time of a crash

getContext

public java.lang.String getContext()

Get the context associated with this Error.

setGroupingHash

public void setGroupingHash(java.lang.String groupingHash)

Set a custom grouping hash to use when grouping this Error on the Bugsnag dashboard. By default, we use a combination of error class and top-most stacktrace line to calculate this, and we do not recommend you override this.

Parameters:

groupingHash - a string to use when grouping errors

setSeverity

public void setSeverity(Severity severity)

Set the Severity of this Error. By default, unhandled exceptions will be Severity.ERROR and handled exceptions sent with bugsnag.notify will be Severity.WARNING.

Parameters:

severity - the severity of this error

See Also:

Severity

getSeverity

public Severity getSeverity()

Get the Severity of this Error.

See Also:

Severity

setUser

public void setUser(java.lang.String id,
                    java.lang.String email,
                    java.lang.String name)

Set user information associated with this Error

Parameters:

id - the id of the user

email - the email address of the user

name - the name of the user

getUser

public com.bugsnag.android.User getUser()

Returns:

user information associated with this Error

setUserId

public void setUserId(java.lang.String id)

Set user id associated with this Error

Parameters:

id - the id of the user

setUserEmail

public void setUserEmail(java.lang.String email)

Set user email address associated with this Error

Parameters:

email - the email address of the user

setUserName

public void setUserName(java.lang.String name)

Set user name associated with this Error

Parameters:

name - the name of the user

addToTab

public void addToTab(java.lang.String tabName,
                     java.lang.String key,
                     java.lang.Object value)

Add additional diagnostic information to send with this Error. Diagnostic information is collected in "tabs" on your dashboard. For example: error.addToTab("account", "name", "Acme Co."); error.addToTab("account", "payingCustomer", true);

Parameters:

tabName - the dashboard tab to add diagnostic data to

key - the name of the diagnostic information

value - the contents of the diagnostic information

clearTab

public void clearTab(java.lang.String tabName)

Remove a tab of app-wide diagnostic information from this Error

Parameters:

tabName - the dashboard tab to remove diagnostic data from

getMetaData

public MetaData getMetaData()

Get any additional diagnostic MetaData currently attached to this Error. This will contain any MetaData set by setMetaData or addToTab.

See Also:

setMetaData(com.bugsnag.android.MetaData), addToTab(java.lang.String, java.lang.String, java.lang.Object)

setMetaData

public void setMetaData(MetaData metaData)

Set additional diagnostic MetaData to send with this Error. This will be merged with any global MetaData you set on the Client. Note: This will overwrite any MetaData you provided using Bugsnag.notify, so it is recommended to use addToTab instead.

Parameters:

metaData - additional diagnostic data to send with this Error

See Also:

addToTab(java.lang.String, java.lang.String, java.lang.Object), getMetaData()

getExceptionName

public java.lang.String getExceptionName()

Get the class name from the exception contained in this Error report.

getExceptionMessage

public java.lang.String getExceptionMessage()

Get the message from the exception contained in this Error report.

getException

public java.lang.Throwable getException()

The exception which triggered this Error report.