acra/org.acra.config

Package-level declarations

Types

ACRAConfigurationException

class ACRAConfigurationException : Exception

A simple Exception used when required configuration items are missing.

ClassValidator

object ClassValidator

Configuration

interface Configuration : Serializable

A configuration object

ConfigurationBuilder

interface ConfigurationBuilder

A Configuration builder

ConfigurationBuilderFactory

interface ConfigurationBuilderFactory : Plugin

A factory for configuration builders

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

CoreConfigurationBuilder

class CoreConfigurationBuilder

DefaultRetryPolicy

class DefaultRetryPolicy : RetryPolicy

Default RetryPolicy. Only resend if all senders failed.

DialogConfiguration

class DialogConfiguration(val enabled: Boolean = true, val reportDialogClass: Class<out Activity> = CrashReportDialog::class.java, val positiveButtonText: String? = null, val negativeButtonText: String? = null, val commentPrompt: String? = null, val emailPrompt: String? = null, @DrawableRes val resIcon: Int? = android.R.drawable.ic_dialog_alert, val text: String? = null, val title: String? = null, @StyleRes val resTheme: Int? = null) : Configuration

CrashReportDialog configuration

DialogConfigurationBuilder

class DialogConfigurationBuilder

HttpSenderConfiguration

class HttpSenderConfiguration(val enabled: Boolean = true, val uri: String, val basicAuthLogin: String? = null, val basicAuthPassword: String? = null, val httpMethod: HttpSender.Method = HttpSender.Method.POST, val connectionTimeout: Int = 5000, val socketTimeout: Int = 20000, val dropReportsOnTimeout: Boolean = false, val keyStoreFactoryClass: Class<out KeyStoreFactory> = NoKeyStoreFactory::class.java, val certificatePath: String? = null, @RawRes val resCertificate: Int? = null, val certificateType: String = "X.509", val compress: Boolean = false, val chunked: Boolean = false, val tlsProtocols: List<TLS> = listOf(TLS.V1_3, TLS.V1_2, TLS.V1_1, TLS.V1), val httpHeaders: Map<String, String> = emptyMap()) : Configuration

Http sender configuration

HttpSenderConfigurationBuilder

class HttpSenderConfigurationBuilder

LimiterConfiguration

class LimiterConfiguration(val enabled: Boolean = true, val periodUnit: TimeUnit = TimeUnit.DAYS, val period: Long = 7, val overallLimit: Int = 25, val stacktraceLimit: Int = 3, val exceptionClassLimit: Int = 10, val failedReportLimit: Int = 5, val ignoredCrashToast: String? = null, val deleteReportsOnAppUpdate: Boolean = true, val resetLimitsOnAppUpdate: Boolean = true) : Configuration

Limiter configuration

LimiterConfigurationBuilder

class LimiterConfigurationBuilder

LimiterData

class LimiterData

LimitingReportAdministrator

@AutoService(value = [ReportingAdministrator::class])

class LimitingReportAdministrator : HasConfigPlugin, ReportingAdministrator

MailSenderConfiguration

class MailSenderConfiguration(val enabled: Boolean = true, val mailTo: String, val reportAsFile: Boolean = true, val reportFileName: String = EmailIntentSender.DEFAULT_REPORT_FILENAME, val subject: String? = null, val body: String? = null) : Configuration

MailSenderConfigurationBuilder

class MailSenderConfigurationBuilder

NotificationConfiguration

class NotificationConfiguration(val enabled: Boolean = true, @DrawableRes val resIcon: Int = android.R.drawable.stat_sys_warning, val title: String, val text: String, val tickerText: String? = null, val sendButtonText: String? = null, @DrawableRes val resSendButtonIcon: Int = android.R.drawable.ic_menu_send, val discardButtonText: String? = null, @DrawableRes val resDiscardButtonIcon: Int = android.R.drawable.ic_menu_delete, val channelName: String, val channelDescription: String? = null, val channelImportance: Int = 4, val sendWithCommentButtonText: String? = null, @DrawableRes val resSendWithCommentButtonIcon: Int = android.R.drawable.ic_menu_send, val commentPrompt: String? = null, val sendOnClick: Boolean = false, @ColorInt val color: Int? = null) : Configuration

NotificationConfigurationBuilder

class NotificationConfigurationBuilder

ReportingAdministrator

interface ReportingAdministrator : Plugin

Controls if reports are sent

RetryPolicy

interface RetryPolicy

A policy which determines if a report should be resent.

SchedulerConfiguration

class SchedulerConfiguration(val enabled: Boolean = true, val requiresNetworkType: Int = JobInfo.NETWORK_TYPE_NONE, val requiresCharging: Boolean = false, val requiresDeviceIdle: Boolean = false, val requiresBatteryNotLow: Boolean = false, val restartAfterCrash: Boolean = false) : Configuration

SchedulerConfigurationBuilder

class SchedulerConfigurationBuilder

ToastConfiguration

class ToastConfiguration(val enabled: Boolean = true, val text: String, @IntRange(from = 0, to = 1) val length: Int = Toast.LENGTH_LONG) : Configuration

ToastConfigurationBuilder

class ToastConfigurationBuilder

Functions

coreConfiguration

fun coreConfiguration(initializer: CoreConfigurationBuilder.() -> Unit): <Error class: unknown class>

dialog

fun CoreConfigurationBuilder.dialog(initializer: <Error class: unknown class>.() -> Unit)

dialogConfiguration

fun dialogConfiguration(initializer: DialogConfigurationBuilder.() -> Unit): <Error class: unknown class>

findPluginConfiguration

inline fun <T : Configuration> CoreConfiguration.findPluginConfiguration(): T?

fun <T : Configuration> CoreConfiguration.findPluginConfiguration(c: Class<T>): T?

getPluginConfiguration

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

httpSender

fun CoreConfigurationBuilder.httpSender(initializer: <Error class: unknown class>.() -> Unit)

httpSenderConfiguration

fun httpSenderConfiguration(initializer: HttpSenderConfigurationBuilder.() -> Unit): <Error class: unknown class>

limiter

fun CoreConfigurationBuilder.limiter(initializer: <Error class: unknown class>.() -> Unit)

limiterConfiguration

fun limiterConfiguration(initializer: LimiterConfigurationBuilder.() -> Unit): <Error class: unknown class>

mailSender

fun CoreConfigurationBuilder.mailSender(initializer: <Error class: unknown class>.() -> Unit)

mailSenderConfiguration

fun mailSenderConfiguration(initializer: MailSenderConfigurationBuilder.() -> Unit): <Error class: unknown class>

notification

fun CoreConfigurationBuilder.notification(initializer: <Error class: unknown class>.() -> Unit)

notificationConfiguration

fun notificationConfiguration(initializer: NotificationConfigurationBuilder.() -> Unit): <Error class: unknown class>

scheduler

fun CoreConfigurationBuilder.scheduler(initializer: <Error class: unknown class>.() -> Unit)

schedulerConfiguration

fun schedulerConfiguration(initializer: SchedulerConfigurationBuilder.() -> Unit): <Error class: unknown class>

toast

fun CoreConfigurationBuilder.toast(initializer: <Error class: unknown class>.() -> Unit)

toastConfiguration

fun toastConfiguration(initializer: ToastConfigurationBuilder.() -> Unit): <Error class: unknown class>