ErrorReporterService

interface ErrorReporterService

The ErrorReporterService collects useful data such as device name, OS and application version, logs, screenshots, video recordings, etc., and allows the user to send error reports containing that collected data to the development team.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
interface ErrorReportSentListener

A listener, whose callback is invoked when an error report has been successfully sent.

Properties

Link copied to clipboard
abstract val canReportErrors: Boolean

When canReportErrors is true, error reporting is ready. An error report can be created and sent using createReport and sendReport.

Link copied to clipboard
abstract val isEnabled: Boolean

Indicates whether error reporting and data collection is possible. See also setEnabled.

Link copied to clipboard
abstract val reportState: ErrorReportState

State of the error report.

Functions

Link copied to clipboard
abstract suspend fun cancelAudioRecording()

Cancels audio recording.

Link copied to clipboard
abstract suspend fun cancelReport()

Cancels a report that was created using createReport.

Link copied to clipboard
abstract suspend fun createReport()

Creates an error report. The report can contain information about the device, the current session, and other useful things such as a screenshot or a video. The service must be isEnabled and canReportErrors in order to sent reports.

Link copied to clipboard
abstract suspend fun saveAudioRecording()

Saves the audio recording, to be attached to error report.

Link copied to clipboard
abstract suspend fun sendReport()

Sends a report that was created using createReport.

Link copied to clipboard
abstract suspend fun setEnabled(enabled: Boolean)

Enables or disables error reporting and data collection. Data can only be collected when the service is enabled.

Link copied to clipboard
abstract suspend fun startAudioRecording(): Boolean

Starts an audio recording, to be attached to error report.