History

proton-ci 6880bb0eb7 i18n: Upgrade translations from crowdin (`9115a3a2`).		2024-04-30 10:13:51 +00:00
..
dagger	feat(report): Added attach log file functionality	2024-04-05 13:41:47 +00:00
data	feat(report): Added attach log file functionality	2024-04-05 13:41:47 +00:00
domain	feat(report): Added attach log file functionality	2024-04-05 13:41:47 +00:00
presentation	i18n: Upgrade translations from crowdin (`9115a3a2`).	2024-04-30 10:13:51 +00:00
test	feat(report): Added attach log file functionality	2024-04-05 13:41:47 +00:00
README.md	report-presentation: update resource prefix to `core_report`; fix links in report/README.md	2021-12-22 11:06:57 +01:00
build.gradle.kts	chore!: Upgraded AGP to 8.0.2 (+Java 17).	2023-07-04 16:22:38 +02:00

README.md

Report

The report module allows a user to send bug reports.

Once a report is written, and user submits it, it is enqueued into a WorkManager. The report is sent whenever an Internet connection is available. By default, once a report is enqueued, from the user perspective it is considered as sent, and the Bug Report activity will be finished.

Quickstart

Add me.proton.core:report-presentation module.
If you use Hilt, add me.proton.core:report-dagger module.
Optionally, add BugReportActivity to your AndroidManifest.xml file, replacing _ProtonApp_ with Calendar, Drive, Mail or Vpn (by default it uses ProtonTheme):

<activity
    android:name="me.proton.core.report.presentation.ui.BugReportActivity"
    android:theme="@style/ProtonTheme._ProtonApp_"
    tools:replace="android:theme" />

Make sure WorkManager is configured:
- add WorkManager as your dependency
- configure WorkManager to be available in Hilt (i.e. your Application should implement androidx.work.Configuration.Provider)
- provide a WorkManager instance from your dagger module
Whenever you want to display a Bug Report screen, use ReportOrchestrator.
Refer to ReportsViewModel from CoreExample app for sample usage.