acra/org.acra.config/CoreConfiguration

CoreConfiguration

class CoreConfiguration(val sharedPreferencesName: String? = null, val includeDropBoxSystemTags: Boolean = false, val additionalDropBoxTags: List<String> = emptyList(), val dropboxCollectionMinutes: Int = 5, val logcatArguments: List<String> = listOf("-t", ACRAConstants.DEFAULT_LOG_LINES.toString(), "-v", "time"), val reportContent: List<ReportField> = ACRAConstants.DEFAULT_REPORT_FIELDS.toList(), val deleteUnapprovedReportsOnApplicationStart: Boolean = true, val alsoReportToAndroidFramework: Boolean = false, val additionalSharedPreferences: List<String> = emptyList(), val logcatFilterByPid: Boolean = true, val logcatReadNonBlocking: Boolean = false, val sendReportsInDevMode: Boolean = true, val excludeMatchingSharedPreferencesKeys: List<String> = emptyList(), val excludeMatchingSettingsKeys: List<String> = emptyList(), val buildConfigClass: Class<*>? = null, val applicationLogFile: String? = null, val applicationLogFileLines: Int = ACRAConstants.DEFAULT_LOG_LINES, val applicationLogFileDir: Directory = Directory.FILES_LEGACY, val retryPolicyClass: Class<out RetryPolicy> = DefaultRetryPolicy::class.java, val stopServicesOnCrash: Boolean = false, val attachmentUris: List<String> = emptyList(), val attachmentUriProvider: Class<out AttachmentUriProvider> = DefaultAttachmentProvider::class.java, val reportSendSuccessToast: String? = null, val reportSendFailureToast: String? = null, val reportFormat: StringFormat = StringFormat.JSON, val parallel: Boolean = true, val pluginLoader: PluginLoader = ServicePluginLoader(), val pluginConfigurations: List<Configuration> = emptyList()) : Serializable, Configuration

Constructors

CoreConfiguration

constructor(sharedPreferencesName: String? = null, includeDropBoxSystemTags: Boolean = false, additionalDropBoxTags: List<String> = emptyList(), dropboxCollectionMinutes: Int = 5, logcatArguments: List<String> = listOf("-t", ACRAConstants.DEFAULT_LOG_LINES.toString(), "-v", "time"), reportContent: List<ReportField> = ACRAConstants.DEFAULT_REPORT_FIELDS.toList(), deleteUnapprovedReportsOnApplicationStart: Boolean = true, alsoReportToAndroidFramework: Boolean = false, additionalSharedPreferences: List<String> = emptyList(), logcatFilterByPid: Boolean = true, logcatReadNonBlocking: Boolean = false, sendReportsInDevMode: Boolean = true, excludeMatchingSharedPreferencesKeys: List<String> = emptyList(), excludeMatchingSettingsKeys: List<String> = emptyList(), buildConfigClass: Class<*>? = null, applicationLogFile: String? = null, applicationLogFileLines: Int = ACRAConstants.DEFAULT_LOG_LINES, applicationLogFileDir: Directory = Directory.FILES_LEGACY, retryPolicyClass: Class<out RetryPolicy> = DefaultRetryPolicy::class.java, stopServicesOnCrash: Boolean = false, attachmentUris: List<String> = emptyList(), attachmentUriProvider: Class<out AttachmentUriProvider> = DefaultAttachmentProvider::class.java, reportSendSuccessToast: String? = null, reportSendFailureToast: String? = null, reportFormat: StringFormat = StringFormat.JSON, parallel: Boolean = true, pluginLoader: PluginLoader = ServicePluginLoader(), pluginConfigurations: List<Configuration> = emptyList())

Properties

additionalDropBoxTags

val additionalDropBoxTags: List<String>

Custom tags to be included in DropBox event collection

additionalSharedPreferences

val additionalSharedPreferences: List<String>

Add here your android.content.SharedPreferences identifier Strings if you use others than your application's default. They will be added to the ReportField.SHARED_PREFERENCES field.

alsoReportToAndroidFramework

val alsoReportToAndroidFramework: Boolean = false

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.

applicationLogFile

val applicationLogFile: String? = null

To use in combination with ReportField.APPLICATION_LOG to set the path/name of your application log file.

applicationLogFileDir

val applicationLogFileDir: Directory

To use in combination with ReportField.APPLICATION_LOG to set the root for the path provided in applicationLogFile

applicationLogFileLines

val applicationLogFileLines: Int

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.

attachmentUriProvider

val attachmentUriProvider: Class<out AttachmentUriProvider>

Allows attachmentUris configuration at runtime instead of compile time.

attachmentUris

val attachmentUris: List<String>

Allows to attach files to crash reports.

buildConfigClass

val buildConfigClass: Class<*>? = null

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.

deleteUnapprovedReportsOnApplicationStart

val deleteUnapprovedReportsOnApplicationStart: Boolean = true

Controls whether unapproved reports are deleted on application start or not.

dropboxCollectionMinutes

val dropboxCollectionMinutes: Int = 5

DropBox event collection will look back this many minutes

excludeMatchingSettingsKeys

val excludeMatchingSettingsKeys: List<String>

Provide here regex patterns to be evaluated on each [android.provider.Settings.System}, android.provider.Settings.Secure and android.provider.Settings.Global key to exclude KV pairs from being collected. This allows you to exclude sensitive data from being collected.

excludeMatchingSharedPreferencesKeys

val excludeMatchingSharedPreferencesKeys: List<String>

Provide here regex patterns to be evaluated on each android.content.SharedPreferences key to exclude KV pairs from the collected SharedPreferences. This allows you to exclude sensitive user data like passwords from being collected.

includeDropBoxSystemTags

val includeDropBoxSystemTags: Boolean = false

If enabled, DropBox events collection will include system tags:

logcatArguments

val logcatArguments: List<String>

Arguments to be passed to the logcat command line.

logcatFilterByPid

val logcatFilterByPid: Boolean = true

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)

logcatReadNonBlocking

val logcatReadNonBlocking: Boolean = false

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.

parallel

val parallel: Boolean = true

Allow parallel collection. Increases performance but might pollute e.g. logcat output

pluginConfigurations

val pluginConfigurations: List<Configuration>

Plugin configurations

pluginLoader

val pluginLoader: PluginLoader

Allows custom plugin loading