Customize Report Fields

Control which attachments users can add to a bug report from your KMP app, set a disclaimer, toggle view hierarchy, and enable auto screen recording.

You can control which attachment types are available, set a disclaimer, and (on iOS) set a minimum character count for comments.

Attachment types

Enable or disable screenshot, extra screenshot, gallery image, and screen recording:

Kotlin

BugReportingKmp.setEnabledAttachmentTypes(
    screenshot = true,
    extraScreenshot = true,
    galleryImage = true,
    screenRecording = true
)

Auto screen recording

You can enable automatic screen recording and (on iOS) set the maximum duration:

Kotlin

BugReportingKmp.setAutoScreenRecordingEnabled(true)
// iOS only
BugReportingKmp.setAutoScreenRecordingDurationIOS(seconds = 30)

View hierarchy

Include or exclude view hierarchy capture in reports:

Kotlin

BugReportingKmp.setViewHierarchyEnabled(true)

Disclaimer text

Show a disclaimer before the user sends a report:

Kotlin

BugReportingKmp.setDisclaimerText("By submitting you agree to our privacy policy.")

Comment minimum character count (iOS)

On iOS you can require a minimum number of characters in the comment field:

Kotlin

BugReportingKmp.setCommentMinimumCharacterCount(limit = 10, reportTypes = listOf(ReportType.Bug))
// null reportTypes = applies to all report types
BugReportingKmp.setCommentMinimumCharacterCount(limit = 5, reportTypes = null)

This is a no-op on Android.

User consent

Add a consent step to the bug reporting flow (e.g. for privacy or terms). You can make it mandatory and optionally apply an action when selected:

Kotlin

BugReportingKmp.addUserConsent(
    key = "privacy_consent",
    description = "I agree to share my data for support purposes.",
    mandatory = true,
    checked = false,
    action = UserConsentActionType.DropLogs  // optional: e.g. drop logs when accepted
)

UserConsentActionType can be: DropAutoCapturedMedia, DropLogs, NoChat.

Invocation options

Set default invocation options (e.g. require comment, hide thank-you dialog, email field behavior):

Kotlin

BugReportingKmp.setInvocationOptions(listOf(
    InvocationOptions.CommentFieldRequired,
    InvocationOptions.EmailFieldOptional
))