Add the in-app feedback SDK to your app

1. Before your begin, make sure that Apptics is integrated into your project by following the Integration Guide.
   
2. Declaring in-app feedback dependency using Apptics BoM.

1. If you do not use Apptics BoM you can directly declare the in-app feedback dependency with its version.

Note: It is recommend to use Apptics BoM to avoid unnecessary compatibility issues.

1. Initialize in-app feedback SDK in application onCreate() method.

Feedback notification to users

1. Success - `Feedback sent successfully` is shown in the notification drawer if the feedback was sent without any issues.
   
2. Failure - 'Feedback sending failed' and `Retry` button is displayed in the notification drawer. If the user performs the swipe gesture and cancels the failure notification (ideal android behaviour), sending feedback will not be retried.
   
3. A default feedback icon option is provided. Unless you change it, the default option will be used.

Shake for feedback

1. Use the below method to turn off shake for feedback.

1. Use the below method to turn on shake for feedback.

1. Use the below method to know the current state of shake for feedback.

1. Use the below callback to show your custom prompt on detecting shake.

Present feedback screen

Present report bug screen

1. An app user can share the feedback/report a bug with their email id or can share it anonymously. If the user opts to share the feedback/report a bug anonymously then an alert is displayed on the screen. The alert will inform the user that if the feedback/report a bug is shared anonymously, app developers will not be able to contact them with solutions to the raised issues.
2. You need to disable showing the alert on choosing anonymous explicitly. By default, it is enabled.
3. The feedback screen/report a bug screen can be used both in portrait and landscape mode.
   
4. Set the below method to true to enable an alert message when a user is in anonymous mode. If you set it to false user won't be notified with the anonymous alert message.

Disable anonymous feedback reports

1. Use the below method to hide the anonymous option in the feedback screen. This will force the user to use the id while sharing the feedback.

Headless feedback

1. This is a fire-and-forget method to send feedback. It uses WorkManager to sync the feedback with the Apptics server. This method has an inbuilt retry mechanism.
2. This works in tandem with the user consent preference set in the app at the time of calling this method.
3. A user can attach up to five images while sharing the feedback. The images can be attached only from the app's cache directory.

Note: If WorkManager is disabled, the above method will fail and the feedback won't be sent.

1. AppticsFeedback.sendFeedback(
       type = AppticsFeedback.Type.FEEDBACK,
       feedbackMessage = "Feedback Message",
       includeDiagnostics = true,
       includeLogs = true
   )

sendFeedbackInstantlyWithoutRetries :

1. This method will return the feedback status. It should be called from the workerThread.

Note: This method will fail if it is called via the UI Thread and the app will crash.

1. This works in tandem with the user consent preference set in the app at the time of calling this method.
2. A user can attach up to five images while sharing the feedback. The images can be attached only from the app's cache directory.

Note: if forceToAnonymous is set as true, the feedback will be shared anonymously and will override the user consent preference of the app.

1. val feedbackStatus = AppticsFeedback.sendFeedbackInstantlyWithoutRetries(
       type = AppticsFeedback.Type.FEEDBACK,
       feedbackMessage = "Feedback Message",
       includeDiagnostics = true,
       includeLogs = true,
       forceToAnonymous = false
   )

Logs

1. Use the below method to write a log.

1. Use the below method to attach a log file.

Note: If both addLogFile and writeLogs are set by the developer, priority is given to the addlog file. Only one logfile is allowed per feedback and it cannot exceed 1MB in size.

1. A diagnostic info file is a set of key-value pairs, where each pair can be grouped under the given heading. To add diagnostic info, follow the below.

1. AppticsLogs.addDiagnosticsInfo("HEADING", "key", "value")

Convenience APIs

1. To perform this activity, override the following callback.