broken-site-api/com.duckduckgo.brokensite.api/BrokenSitePrompt

BrokenSitePrompt

interface BrokenSitePrompt

The Broken Site Prompt interface defines methods for detecting repeated user-initiated refreshes and determining when and how often to show a prompt to report site breakage.

Functions

Link copied to clipboard
abstract suspend fun ctaShown()

Called when the Call-to-Action (CTA), the broken site prompt, is shown.

Link copied to clipboard
abstract fun getUserRefreshPatterns(): Set<RefreshPattern>

Retrieves the set of user refresh patterns.

Link copied to clipboard
abstract suspend fun isFeatureEnabled(): Boolean

Checks if the broken site prompt feature is enabled.

Link copied to clipboard
abstract fun pageRefreshed(url: Uri)

Records a page refresh for the given URL.

Link copied to clipboard
abstract suspend fun shouldShowBrokenSitePrompt(url: String, refreshPatterns: Set<RefreshPattern>): Boolean

Determines whether the broken site prompt should be shown for the given URL and detected refresh patterns.

Link copied to clipboard
abstract suspend fun userAcceptedPrompt()

Called when the user accepts the broken site prompt.

Link copied to clipboard
abstract suspend fun userDismissedPrompt()

Called when the user dismisses the broken site prompt.