AcraCore (acra-core 5.1.1 API)

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Inherited
public @interface AcraCore

Main ACRA configuration

Since:: 01.06.2017

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`String[]`	`additionalDropBoxTags` Custom tags to be included in DropBox event collection
`String[]`	`additionalSharedPreferences` Add here your `SharedPreferences` identifier Strings if you use others than your application's default.
`boolean`	`alsoReportToAndroidFramework` Set this to true if you prefer displaying the native force close dialog after ACRA is done.
`String`	`applicationLogFile` To use in combination with `ReportField.APPLICATION_LOG` to set the path/name of your application log file.
`Directory`	`applicationLogFileDir` To use in combination with `ReportField.APPLICATION_LOG` to set the root for the path provided in `applicationLogFile()`
`int`	`applicationLogFileLines` To use in combination with `ReportField.APPLICATION_LOG` to set the number of latest lines of your application log file to be collected.
`Class<? extends AttachmentUriProvider>`	`attachmentUriProvider` Allows `attachmentUris()` configuration at runtime instead of compile time.
`String[]`	`attachmentUris` Allows to attach files to crash reports.
`Class`	`buildConfigClass` The default value will be a BuildConfig class residing in the same package as the Application class.
`boolean`	`deleteOldUnsentReportsOnApplicationStart` This property can be used to determine whether old (out of date) reports should be sent or not.
`boolean`	`deleteUnapprovedReportsOnApplicationStart` Controls whether unapproved reports are deleted on application start or not.
`int`	`dropboxCollectionMinutes` DropBox event collection will look back this many minutes
`String[]`	`excludeMatchingSettingsKeys` Provide here regex patterns to be evaluated on each `Settings.System`, `Settings.Secure` and `Settings.Global` key to exclude KV pairs from being collected.
`String[]`	`excludeMatchingSharedPreferencesKeys` Provide here regex patterns to be evaluated on each `SharedPreferences` key to exclude KV pairs from the collected SharedPreferences.
`boolean`	`includeDropBoxSystemTags` If enabled, DropBox events collection will include system tags: system_app_anr system_app_wtf system_app_crash system_server_anr system_server_wtf system_server_crash BATTERY_DISCHARGE_INFO SYSTEM_RECOVERY_LOG SYSTEM_BOOT SYSTEM_LAST_KMSG APANIC_CONSOLE APANIC_THREADS SYSTEM_RESTART SYSTEM_TOMBSTONE data_app_strictmode
`String[]`	`logcatArguments` Arguments to be passed to the logcat command line.
`boolean`	`logcatFilterByPid` Set this to true if you want to include only logcat lines related to your Application process.
`boolean`	`logcatReadNonBlocking` Set this to true if you want to read logcat lines in a non blocking way for your thread.
`boolean`	`parallel` Allow parallel collection.
`ReportField[]`	`reportContent` Redefines the list of `ReportField`s collected and sent in your reports.
`StringFormat`	`reportFormat` Format in which the report should be sent
`Class<? extends ReportSenderFactory>[]`	`reportSenderFactoryClasses` The default `ReportSenderFactory` automatically discovers other ReportSenderFactories.
`int`	`resReportSendFailureToast` Toast shown when report sending fails
`int`	`resReportSendSuccessToast` Toast shown when a report is sent successfully
`Class<? extends RetryPolicy>`	`retryPolicyClass` Implement a custom `RetryPolicy` to decide if a failed report should be resent or not.
`boolean`	`sendReportsInDevMode` Set this to false if you want to disable sending reports in development mode.
`String`	`sharedPreferencesName` Name of the SharedPreferences that will host ACRA settings which you can make accessible to your users through a preferences screen: `ACRA.PREF_DISABLE_ACRA` or `ACRA.PREF_ENABLE_ACRA` `ACRA.PREF_ALWAYS_ACCEPT` `ACRA.PREF_ENABLE_DEVICE_ID` `ACRA.PREF_ENABLE_SYSTEM_LOGS` Default is to use the application default SharedPreferences, as retrieved with `PreferenceManager.getDefaultSharedPreferences(android.content.Context)`
`boolean`	`stopServicesOnCrash` If you have services which might crash on startup android will try to restart them indefinitely.

- Element Detail
  - sharedPreferencesName
```
@NonNull
public abstract String sharedPreferencesName
```
    Name of the SharedPreferences that will host ACRA settings which you can make accessible to your users through a preferences screen:
    Default is to use the application default SharedPreferences, as retrieved with PreferenceManager.getDefaultSharedPreferences(android.content.Context)
    Returns:
    
    SharedPreferences name.
    
    Default:
    
    ""
- - includeDropBoxSystemTags
```
public abstract boolean includeDropBoxSystemTags
```
    If enabled, DropBox events collection will include system tags:
    - system_app_anr
    - system_app_wtf
    - system_app_crash
    - system_server_anr
    - system_server_wtf
    - system_server_crash
    - BATTERY_DISCHARGE_INFO
    - SYSTEM_RECOVERY_LOG
    - SYSTEM_BOOT
    - SYSTEM_LAST_KMSG
    - APANIC_CONSOLE
    - APANIC_THREADS
    - SYSTEM_RESTART
    - SYSTEM_TOMBSTONE
    - data_app_strictmode
    Returns:
    
    if system tags are to be included as part of DropBox events.
    
    Default:
    
    false
- - additionalDropBoxTags
```
@NonNull
public abstract String[] additionalDropBoxTags
```
    Custom tags to be included in DropBox event collection
    
    Returns:
    
    tags that you want to be fetched when collecting DropBox events.
    
    Default:
    
    {}
- - dropboxCollectionMinutes
```
public abstract int dropboxCollectionMinutes
```
    DropBox event collection will look back this many minutes
    
    Returns:
    
    Number of minutes to look back.
    
    Default:
    
    5
- - logcatArguments
```
@NonNull
public abstract String[] logcatArguments
```
    Arguments to be passed to the logcat command line. Default is { "-t", "100", "-v", "time" } for:
```
logcat -t 100 -v time
```
    Do not include -b arguments for buffer selection, include ReportField.EVENTSLOG and ReportField.RADIOLOG in reportContent() to activate alternative logcat buffers reporting. They will use the same other arguments as those provided here.
    
    See Listing of logcat Command Options.
    Returns:
    
    arguments to supply if retrieving the log as part of the report.
    
    Default:
    
    {"-t", "100", "-v", "time"}
- - reportContent
```
@NonNull
public abstract ReportField[] reportContent
```
    Redefines the list of ReportFields collected and sent in your reports.
    
    You can also use this property to modify fields order in your reports.
    
    The default list is ACRAConstants.DEFAULT_REPORT_FIELDS
    
    Returns:
    
    fields to be included in the report.
    
    Default:
    
    {}
- - deleteUnapprovedReportsOnApplicationStart
```
public abstract boolean deleteUnapprovedReportsOnApplicationStart
```
    Controls whether unapproved reports are deleted on application start or not.
    Silent and Toast reports are automatically approved. Dialog and Notification reports require explicit approval by the user before they are sent.
    
    On application restart the user is prompted with approval for one unsent report. So you generally don't want to accumulate unapproved reports, otherwise you will prompt them multiple times.
    
    If this is set to true then all unapproved reports bar one will be deleted on application start. The last report is always retained because that is the report that probably just happened.
    
    Returns:
    
    if ACRA should delete unapproved reports on application start.
    
    Default:
    
    true
- - deleteOldUnsentReportsOnApplicationStart
```
public abstract boolean deleteOldUnsentReportsOnApplicationStart
```
    This property can be used to determine whether old (out of date) reports should be sent or not.
    
    Returns:
    
    if ACRA should delete any unsent reports on startup if the application has been updated since the last time the application was started.
    
    Default:
    
    true
- - alsoReportToAndroidFramework
```
public abstract boolean alsoReportToAndroidFramework
```
    Set this to true if you prefer displaying the native force close dialog after ACRA is done. Recommended: Keep this set to false if using interactions with user input.
    
    Returns:
    
    if the native force close dialog should be displayed.
    
    Default:
    
    false
- - additionalSharedPreferences
```
@NonNull
public abstract String[] additionalSharedPreferences
```
    Add here your SharedPreferences identifier Strings if you use others than your application's default. They will be added to the ReportField.SHARED_PREFERENCES field.
    
    Returns:
    
    names of additional preferences.
    
    Default:
    
    {}
- - logcatFilterByPid
```
public abstract boolean logcatFilterByPid
```
    Set this to true if you want to include only logcat lines related to your Application process. Note that this is always done by android starting with API 16 (Jellybean)
    
    Returns:
    
    true if you want to filter logcat with your process id.
    
    Default:
    
    true
- - logcatReadNonBlocking
```
public abstract boolean logcatReadNonBlocking
```
    Set this to true if you want to read logcat lines in a non blocking way for your thread. It has a default timeout of 3 seconds.
    
    Returns:
    
    if reading of logcat lines should not block the current thread.
    
    Default:
    
    false
- - sendReportsInDevMode
```
public abstract boolean sendReportsInDevMode
```
    Set this to false if you want to disable sending reports in development mode. Only signed application packages will send reports.
    
    Returns:
    
    if reports should only be sent from signed packages.
    
    Default:
    
    true
- - excludeMatchingSharedPreferencesKeys
```
@NonNull
public abstract String[] excludeMatchingSharedPreferencesKeys
```
    Provide here regex patterns to be evaluated on each SharedPreferences key to exclude KV pairs from the collected SharedPreferences. This allows you to exclude sensitive user data like passwords from being collected.
    
    Returns:
    
    regex patterns, every matching key is not collected.
    
    Default:
    
    {}
- - excludeMatchingSettingsKeys
```
@NonNull
public abstract String[] excludeMatchingSettingsKeys
```
    Provide here regex patterns to be evaluated on each Settings.System, Settings.Secure and Settings.Global key to exclude KV pairs from being collected. This allows you to exclude sensitive data from being collected.
    
    Returns:
    
    regex patterns, every matching key is not collected.
    
    Default:
    
    {}
- - buildConfigClass
```
@NonNull
public abstract Class buildConfigClass
```
    The default value will be a BuildConfig class residing in the same package as the Application class. You only have to set this option if your BuildConfig class is obfuscated.
    
    Returns:
    
    BuildConfig class from which to read any BuildConfig attributes.
    
    Default:
    
    java.lang.Object.class
- - reportSenderFactoryClasses
```
@NonNull
public abstract Class<? extends ReportSenderFactory>[] reportSenderFactoryClasses
```
    The default ReportSenderFactory automatically discovers other ReportSenderFactories.
    
    Returns:
    
    ReportSenderFactorys with which to construct the ReportSenders that will send the crash reports.
    
    Default:
    
    org.acra.sender.DefaultReportSenderFactory.class
- - applicationLogFile
```
@NonNull
public abstract String applicationLogFile
```
    To use in combination with ReportField.APPLICATION_LOG to set the path/name of your application log file.
    
    Returns:
    
    path/name of your application log file.
    
    Default:
    
    ""
- - applicationLogFileLines
```
public abstract int applicationLogFileLines
```
    To use in combination with ReportField.APPLICATION_LOG to set the number of latest lines of your application log file to be collected. Default value is 100.
    
    Returns:
    
    number of lines to collect.
    
    Default:
    
    100
- - applicationLogFileDir
```
@NonNull
public abstract Directory applicationLogFileDir
```
    To use in combination with ReportField.APPLICATION_LOG to set the root for the path provided in applicationLogFile()
    
    Returns:
    
    the directory of the application log file
    
    Default:
    
    org.acra.file.Directory.FILES_LEGACY
- - retryPolicyClass
```
@NonNull
public abstract Class<? extends RetryPolicy> retryPolicyClass
```
    Implement a custom RetryPolicy to decide if a failed report should be resent or not.
    
    Returns:
    
    a class that decides if a report should be resent (usually if one or more senders failed).
    
    Since:
    
    4.9.1
    
    Default:
    
    org.acra.config.DefaultRetryPolicy.class
- - stopServicesOnCrash
```
public abstract boolean stopServicesOnCrash
```
    If you have services which might crash on startup android will try to restart them indefinitely. Set this to true to prevent that.
    
    Returns:
    
    if all services running in a process should be stopped before it is killed.
    
    Since:
    
    4.9.2
    
    Default:
    
    false
- - attachmentUris
```
@NonNull
public abstract String[] attachmentUris
```
    Allows to attach files to crash reports.
    ACRA contains a file provider under the following Uri: content://[applicationId].acra/[Directory]/[Path] where [applicationId] is your application package name, [Directory] is one of the enum constants in Directory in lower case and [Path] is the relative path to the file in that directory e.g. content://org.acra.test.acra/files/thisIsATest.txt
    Side effects:
    - POST mode: requests will be sent with content-type multipart/mixed
    - PUT mode: There will be additional requests with the attachments. Naming scheme: [report-id]-[filename]
    - EMAIL mode: Some email clients do not support attachments, so some email may lack these attachments. Note that attachments might be readable to email clients when they are sent.
    Returns:
    
    uris to be attached to crash reports.
    
    Since:
    
    4.9.3
    
    Default:
    
    {}
- - attachmentUriProvider
```
@NonNull
public abstract Class<? extends AttachmentUriProvider> attachmentUriProvider
```
    Allows attachmentUris() configuration at runtime instead of compile time.
    
    Returns:
    
    a class that decides which uris should be attached to reports
    
    Since:
    
    4.9.3
    
    Default:
    
    org.acra.attachment.DefaultAttachmentProvider.class
- - resReportSendSuccessToast
```
@StringRes
public abstract int resReportSendSuccessToast
```
    Toast shown when a report is sent successfully
    
    Returns:
    
    Resource id for the Toast text triggered when a report was sent successfully.
    
    Since:
    
    5.0.0
    
    Default:
    
    0
- - resReportSendFailureToast
```
@StringRes
public abstract int resReportSendFailureToast
```
    Toast shown when report sending fails
    
    Returns:
    
    Resource id for the Toast text triggered when no report was sent successfully.
    
    Since:
    
    5.0.0
    
    Default:
    
    0
- - reportFormat
```
@NonNull
public abstract StringFormat reportFormat
```
    Format in which the report should be sent
    
    Returns:
    
    report format
    
    Since:
    
    5.0.0
    
    Default:
    
    org.acra.data.StringFormat.JSON
- - parallel
```
public abstract boolean parallel
```
    Allow parallel collection. Increases performance but might pollute e.g. logcat output
    
    Returns:
    
    if parallel collection should be active
    
    Since:
    
    5.0.1
    
    Default:
    
    true

Annotation Type AcraCore

Optional Element Summary

Element Detail

sharedPreferencesName

includeDropBoxSystemTags

additionalDropBoxTags

dropboxCollectionMinutes

logcatArguments

reportContent

deleteUnapprovedReportsOnApplicationStart

deleteOldUnsentReportsOnApplicationStart

alsoReportToAndroidFramework

additionalSharedPreferences

logcatFilterByPid

logcatReadNonBlocking

sendReportsInDevMode

excludeMatchingSharedPreferencesKeys

excludeMatchingSettingsKeys

buildConfigClass

reportSenderFactoryClasses

applicationLogFile

applicationLogFileLines

applicationLogFileDir

retryPolicyClass

stopServicesOnCrash

attachmentUris

attachmentUriProvider

resReportSendSuccessToast

resReportSendFailureToast

reportFormat

parallel