Configuration

v1.9.0

Configure the SDK with the options available on your platform.

Pass these options to BugScreen.configure():

OptionDefaultDescription
apiKey: stringRequiredYour SDK API key from the BugScreen console.
screenshotDetection?: booleantrueShow the reporter when a screenshot is taken.
debug?: booleanfalseEnable SDK diagnostic logging.
captureSystemLogs?: booleanfalseAttach available current-process system logs. Does not intercept JavaScript console output. Logging
shakeDetection?: booleanfalseOpen a report on a deliberate foreground shake. iOS requires NSMotionUsageDescription. Shake to report
showFloatingButton?: booleanfalseShow an app-scoped screenshot and recording control. Floating button guide
showReportNotification?: booleanfalseShow a silent reporting notification while your app is foreground. Notification reports
requestNotificationPermission?: booleantrueRequest missing notification permission when the reporting notification is enabled. Notification reports
startScreenRecordingImmediately?: booleanfalseStart silent recent-screen recording after OS consent. Screen recording
screenRecordingOptions?: ScreenRecordingOptions30 seconds, balancedSet durationSeconds (finite integer, clamped to 5–60) and quality (low, balanced or high). Screen recording

Choose each app’s reporter wording, Type choices and Severity visibility in the Console’s Reporter tab.

Customise the reporter