org.acra

Class ACRA

java.lang.Object

org.acra.ACRA

public final class ACRA
extends Object

Use this class to initialize the crash reporting feature using init(Application) as soon as possible in your Application subclass Application.onCreate() method. Configuration items must have been set by using AcraCore above the declaration of your Application subclass.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEV_LOGGING
static ACRALog	log
static String	LOG_TAG
static String	PREF_ALWAYS_ACCEPT The key of the SharedPreference allowing the user to automatically accept sending reports.
static String	PREF_DISABLE_ACRA The key of the application default SharedPreference where you can put a 'true' Boolean value to disable ACRA.
static String	PREF_ENABLE_ACRA Alternatively, you can use this key if you prefer your users to have the checkbox ticked to enable crash reports.
static String	PREF_ENABLE_DEVICE_ID The key of the SharedPreference allowing the user to disable sending his device id.
static String	PREF_ENABLE_SYSTEM_LOGS The key of the SharedPreference allowing the user to disable sending content of logcat/dropbox.
static String	PREF_LAST_VERSION_NR The version number of the application the last time ACRA was started.
static String	PREF_USER_EMAIL_ADDRESS The key of the SharedPreference allowing the user to always include his email address.

Method Summary

Modifier and Type	Method and Description
static ErrorReporter	getErrorReporter()
static void	init(Application app) Initialize ACRA for a given Application.
static void	init(Application app, CoreConfiguration config) Initialize ACRA for a given Application.
static void	init(Application app, CoreConfiguration config, boolean checkReportsOnApplicationStart) Initialize ACRA for a given Application.
static void	init(Application app, CoreConfigurationBuilder builder) Initialize ACRA for a given Application.
static void	init(Application app, CoreConfigurationBuilder builder, boolean checkReportsOnApplicationStart) Initialize ACRA for a given Application.
static boolean	isACRASenderServiceProcess()
static boolean	isInitialised()
static void	setLog(ACRALog log)

Methods inherited from class java.lang.Object

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

Field Detail

DEV_LOGGING

public static boolean DEV_LOGGING

LOG_TAG

public static final String LOG_TAG

log

@NonNull
public static ACRALog log

PREF_DISABLE_ACRA

public static final String PREF_DISABLE_ACRA

The key of the application default SharedPreference where you can put a 'true' Boolean value to disable ACRA.

See Also:

Constant Field Values

PREF_ENABLE_ACRA

public static final String PREF_ENABLE_ACRA

Alternatively, you can use this key if you prefer your users to have the checkbox ticked to enable crash reports. If both acra.disable and acra.enable are set, the value of acra.disable takes over the other.

See Also:

Constant Field Values

PREF_ENABLE_SYSTEM_LOGS

public static final String PREF_ENABLE_SYSTEM_LOGS

The key of the SharedPreference allowing the user to disable sending content of logcat/dropbox. System logs collection is also dependent of the READ_LOGS permission.

See Also:

Constant Field Values

PREF_ENABLE_DEVICE_ID

public static final String PREF_ENABLE_DEVICE_ID

The key of the SharedPreference allowing the user to disable sending his device id. Device ID collection is also dependent of the READ_PHONE_STATE permission.

See Also:

Constant Field Values

PREF_USER_EMAIL_ADDRESS

public static final String PREF_USER_EMAIL_ADDRESS

The key of the SharedPreference allowing the user to always include his email address.

See Also:

Constant Field Values

PREF_ALWAYS_ACCEPT

public static final String PREF_ALWAYS_ACCEPT

The key of the SharedPreference allowing the user to automatically accept sending reports.

See Also:

Constant Field Values

PREF_LAST_VERSION_NR

public static final String PREF_LAST_VERSION_NR

The version number of the application the last time ACRA was started. This is used to determine whether unsent reports should be discarded because they are old and out of date.

See Also:

Constant Field Values

Method Detail

init

public static void init(@NonNull
                        Application app)

Initialize ACRA for a given Application.

The call to this method should be placed as soon as possible in the ContextWrapper.attachBaseContext(Context) method.

Uses the configuration as configured with the @ReportCrashes annotation. Sends any unsent reports.

Parameters:

app - Your Application class.

Throws:

IllegalStateException - if it is called more than once.

init

public static void init(@NonNull
                        Application app,
                        @NonNull
                        CoreConfigurationBuilder builder)

Initialize ACRA for a given Application.

The call to this method should be placed as soon as possible in the ContextWrapper.attachBaseContext(Context) method.

Uses the configuration as configured with the @ReportCrashes annotation. Sends any unsent reports.

Parameters:

app - Your Application class.

builder - ConfigurationBuilder to manually set up ACRA configuration.

init

public static void init(@NonNull
                        Application app,
                        @NonNull
                        CoreConfigurationBuilder builder,
                        boolean checkReportsOnApplicationStart)

Initialize ACRA for a given Application.

The call to this method should be placed as soon as possible in the ContextWrapper.attachBaseContext(Context) method.

Parameters:

app - Your Application class.

builder - ConfigurationBuilder to manually set up ACRA configuration.

checkReportsOnApplicationStart - Whether to invoke ErrorReporter.checkReportsOnApplicationStart().

init

public static void init(@NonNull
                        Application app,
                        @NonNull
                        CoreConfiguration config)

Initialize ACRA for a given Application.

The call to this method should be placed as soon as possible in the ContextWrapper.attachBaseContext(Context) method.

Sends any unsent reports.

Parameters:

app - Your Application class.

config - CoreConfiguration to manually set up ACRA configuration.

Throws:

IllegalStateException - if it is called more than once.

init

public static void init(@NonNull
                        Application app,
                        @NonNull
                        CoreConfiguration config,
                        boolean checkReportsOnApplicationStart)

Initialize ACRA for a given Application. The call to this method should be placed as soon as possible in the ContextWrapper.attachBaseContext(Context) method.

Parameters:

app - Your Application class.

config - CoreConfiguration to manually set up ACRA configuration.

checkReportsOnApplicationStart - Whether to invoke ErrorReporter.checkReportsOnApplicationStart().

Throws:

IllegalStateException - if it is called more than once.

isInitialised

public static boolean isInitialised()

Returns:

true is ACRA has been initialised.

isACRASenderServiceProcess

public static boolean isACRASenderServiceProcess()

Returns:

true if the current process is the process running the SenderService. NB this assumes that your SenderService is configured to used the default ':acra' process.

getErrorReporter

@NonNull
public static ErrorReporter getErrorReporter()

Returns:

the current instance of ErrorReporter.

Throws:

IllegalStateException - if init(android.app.Application) has not yet been called.

setLog

public static void setLog(@NonNull
                          ACRALog log)