sdk/com.bugscreen.sdk/BugScreenSDK

BugScreenSDK

object BugScreenSDK

Main SDK class for BugScreen

Initialize in your Application class:

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        BugScreenSDK.start(
            BugScreenConfig.Builder(this)
                .apiKey("fb_your_api_key")
                .enableScreenshotDetection(true)
                .enableLogging(BuildConfig.DEBUG)
                .build()
        )
    }
}

Properties

val isInitialized: Boolean

Check if SDK is initialized

Functions

getRequiredPermission

fun getRequiredPermission(): String?

Get the permission string required for screenshot detection on this device.

hasScreenshotPermission

fun hasScreenshotPermission(context: Context): Boolean

Check if the app has the required permission for screenshot detection.

fun log(level: LogLevel, message: String)

Log a message that will be included in bug reports. Logs are stored in memory (max 1MB) and sent with bug report submissions.

openBugReportScreen

fun openBugReportScreen(context: Context, screenshotUri: String? = null)

Open the bug report screen

requestScreenshotPermission

fun requestScreenshotPermission(activity: Activity, callback: (granted: Boolean) -> Unit)

Request the screenshot detection permission from the user.

shouldRequestPermission

fun shouldRequestPermission(context: Context): Boolean

Check if the app should request screenshot detection permission from the user.

Shutdown the SDK and release resources

fun start(config: BugScreenConfig)

Start the SDK with the given configuration