org.acra

Interface ErrorReporter

All Known Implementing Classes:

ErrorReporterImpl

public interface ErrorReporter

This interface contains methods used to interact with ACRA after it has been initialized

Since:

29.12.2017

Method Summary

Modifier and Type	Method and Description
void	clearCustomData() Removes all key/value pairs from your reports custom data field.
String	getCustomData(String key) Gets the current value for a key in your reports custom data field.
SenderScheduler	getReportScheduler() Access point to manual report scheduling
void	handleException(Throwable e) Send a normal report for the given exception.
void	handleException(Throwable e, boolean endApplication) Send a normal report for the given exception
void	handleSilentException(Throwable e) Send a silent report for the given exception
String	putCustomData(String key, String value) Use this method to provide the ErrorReporter with data of your running application.
String	removeCustomData(String key) Removes a key/value pair from your reports custom data field.
void	setEnabled(boolean enabled) Enable or disable this ErrorReporter.

Method Detail

putCustomData

String putCustomData(@NonNull
                     String key,
                     String value)

Use this method to provide the ErrorReporter with data of your running application. You should call this at several key places in your code the same way as you would output important debug data in a log file. Only the latest value is kept for each key (no history of the values is sent in the report).

Parameters:

key - A key for your custom data.

value - The value associated to your key.

Returns:

The previous value for this key if there was one, or null.

See Also:

removeCustomData(String), getCustomData(String)

removeCustomData

String removeCustomData(@NonNull
                        String key)

Removes a key/value pair from your reports custom data field.

Parameters:

key - The key of the data to be removed.

Returns:

The value for this key before removal.

See Also:

putCustomData(String, String), getCustomData(String)

clearCustomData

void clearCustomData()

Removes all key/value pairs from your reports custom data field.

getCustomData

String getCustomData(@NonNull
                     String key)

Gets the current value for a key in your reports custom data field.

Parameters:

key - The key of the data to be retrieved.

Returns:

The value for this key.

See Also:

putCustomData(String, String), removeCustomData(String)

handleSilentException

void handleSilentException(@Nullable
                           Throwable e)

Send a silent report for the given exception

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").

setEnabled

void setEnabled(boolean enabled)

Enable or disable this ErrorReporter. By default it is enabled.

Parameters:

enabled - Whether this ErrorReporter should capture Exceptions and forward them as crash reports.

handleException

void handleException(@Nullable
                     Throwable e,
                     boolean endApplication)

Send a normal report for the given exception

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").

endApplication - if you want the application to be ended after sending the report.

handleException

void handleException(@Nullable
                     Throwable e)

Send a normal report for the given exception.

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").

getReportScheduler

SenderScheduler getReportScheduler()

Access point to manual report scheduling

Returns:

current SenderScheduler