Configuration
v1.9.0Configure the SDK with the options available on your platform.
Pass these options to BugScreen.configure():
| Option | Default | Description |
|---|---|---|
| apiKey: string | Required | Your SDK API key from the BugScreen console. |
| screenshotDetection?: boolean | true | Show the reporter when a screenshot is taken. |
| debug?: boolean | false | Enable SDK diagnostic logging. |
| captureSystemLogs?: boolean | false | Attach available current-process system logs. Does not intercept JavaScript console output. Logging |
| shakeDetection?: boolean | false | Open a report on a deliberate foreground shake. iOS requires NSMotionUsageDescription. Shake to report |
| showFloatingButton?: boolean | false | Show an app-scoped screenshot and recording control. Floating button guide |
| showReportNotification?: boolean | false | Show a silent reporting notification while your app is foreground. Notification reports |
| requestNotificationPermission?: boolean | true | Request missing notification permission when the reporting notification is enabled. Notification reports |
| startScreenRecordingImmediately?: boolean | false | Start silent recent-screen recording after OS consent. Screen recording |
| screenRecordingOptions?: ScreenRecordingOptions | 30 seconds, balanced | Set 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.