CoreConfiguration

class CoreConfiguration(sharedPreferencesName: String?, includeDropBoxSystemTags: Boolean, additionalDropBoxTags: List<String>, dropboxCollectionMinutes: Int, logcatArguments: List<String>, reportContent: List<ReportField>, deleteUnapprovedReportsOnApplicationStart: Boolean, alsoReportToAndroidFramework: Boolean, additionalSharedPreferences: List<String>, logcatFilterByPid: Boolean, logcatReadNonBlocking: Boolean, sendReportsInDevMode: Boolean, excludeMatchingSharedPreferencesKeys: List<String>, excludeMatchingSettingsKeys: List<String>, buildConfigClass: Class<*>?, applicationLogFile: String, applicationLogFileLines: Int, applicationLogFileDir: Directory, retryPolicyClass: Class<out RetryPolicy>, stopServicesOnCrash: Boolean, attachmentUris: List<String>, attachmentUriProvider: Class<out AttachmentUriProvider>, reportSendSuccessToast: String?, reportSendFailureToast: String?, reportFormat: StringFormat, parallel: Boolean, pluginLoader: PluginLoader, pluginConfigurations: List<Configuration>) : Serializable, Configuration

Functions

enabled
Link copied to clipboard
open override fun enabled(): Boolean

Properties

additionalDropBoxTags
Link copied to clipboard
val additionalDropBoxTags: List<String>
Custom tags to be included in DropBox event collection
additionalSharedPreferences
Link copied to clipboard
val additionalSharedPreferences: List<String>
Add here your android.content.SharedPreferences identifier Strings if you use others than your application's default.
alsoReportToAndroidFramework
Link copied to clipboard
val alsoReportToAndroidFramework: Boolean = false
Set this to true if you prefer displaying the native force close dialog after ACRA is done.
applicationLogFile
Link copied to clipboard
val applicationLogFile: String
To use in combination with ReportField.APPLICATION_LOG to set the path/name of your application log file.
applicationLogFileDir
Link copied to clipboard
val applicationLogFileDir: Directory
To use in combination with ReportField.APPLICATION_LOG to set the root for the path provided in applicationLogFile
applicationLogFileLines
Link copied to clipboard
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.
attachmentUriProvider
Link copied to clipboard
val attachmentUriProvider: Class<out AttachmentUriProvider>
Allows attachmentUris configuration at runtime instead of compile time.
attachmentUris
Link copied to clipboard
val attachmentUris: List<String>
Allows to attach files to crash reports.
buildConfigClass
Link copied to clipboard
val buildConfigClass: Class<*>? = null
The default value will be a BuildConfig class residing in the same package as the Application class.
val deleteUnapprovedReportsOnApplicationStart: Boolean = true
Controls whether unapproved reports are deleted on application start or not.
dropboxCollectionMinutes
Link copied to clipboard
val dropboxCollectionMinutes: Int = 5
DropBox event collection will look back this many minutes
excludeMatchingSettingsKeys
Link copied to clipboard
val excludeMatchingSettingsKeys: List<String>
Provide here regex patterns to be evaluated on each [android.provider.Settings.
excludeMatchingSharedPreferencesKeys
Link copied to clipboard
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.
includeDropBoxSystemTags
Link copied to clipboard
val includeDropBoxSystemTags: Boolean = false
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

logcatArguments
Link copied to clipboard
val logcatArguments: List<String>
Arguments to be passed to the logcat command line.
logcatFilterByPid
Link copied to clipboard
val logcatFilterByPid: Boolean = true
Set this to true if you want to include only logcat lines related to your Application process.
logcatReadNonBlocking
Link copied to clipboard
val logcatReadNonBlocking: Boolean = false
Set this to true if you want to read logcat lines in a non blocking way for your thread.
parallel
Link copied to clipboard
val parallel: Boolean = true
Allow parallel collection.
pluginConfigurations
Link copied to clipboard
val pluginConfigurations: List<Configuration>
Plugin configurations
pluginLoader
Link copied to clipboard
val pluginLoader: PluginLoader
Allows custom plugin loading
reportContent
Link copied to clipboard
val reportContent: List<ReportField>
Redefines the list of ReportFields collected and sent in your reports.
reportFormat
Link copied to clipboard
val reportFormat: StringFormat
Format in which the report should be sent
reportSendFailureToast
Link copied to clipboard
val reportSendFailureToast: String? = null
Toast shown when report sending fails
reportSendSuccessToast
Link copied to clipboard
val reportSendSuccessToast: String? = null
Toast shown when a report is sent successfully
retryPolicyClass
Link copied to clipboard
val retryPolicyClass: Class<out RetryPolicy>
Implement a custom RetryPolicy to decide if a failed report should be resent or not.
sendReportsInDevMode
Link copied to clipboard
val sendReportsInDevMode: Boolean = true
Set this to false if you want to disable sending reports in development mode.
sharedPreferencesName
Link copied to clipboard
val sharedPreferencesName: String? = null
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 android.preference.PreferenceManager.getDefaultSharedPreferences
stopServicesOnCrash
Link copied to clipboard
val stopServicesOnCrash: Boolean = false
If you have services which might crash on startup android will try to restart them indefinitely.

Extensions

findPluginConfiguration
Link copied to clipboard
inline fun <T : Configuration> CoreConfiguration.findPluginConfiguration(): T?
fun <T : Configuration> CoreConfiguration.findPluginConfiguration(c: Class<T>): T?
getPluginConfiguration
Link copied to clipboard
inline fun <T : Configuration> CoreConfiguration.getPluginConfiguration(): T
Allows easy access to Plugin configurations from the main configuration
fun <T : Configuration> CoreConfiguration.getPluginConfiguration(c: Class<T>): T