duckchat-api/com.duckduckgo.duckchat.api/DuckChat

DuckChat

interface DuckChat

DuckChat interface provides a set of methods for interacting and controlling DuckChat.

Functions

Link copied to clipboard
abstract fun getDuckChatUrl(query: String, autoPrompt: Boolean, sidebar: Boolean = false): String

Returns the Duck Chat URL to be used

Link copied to clipboard
abstract fun isChatSuggestionsFeatureAvailable(): Boolean

Returns whether the chat suggestions feature is available (feature flag is enabled). Does not consider user preference — use for visibility checks.

Link copied to clipboard
abstract fun isDuckChatUrl(uri: Uri): Boolean

Determines whether a given Uri is a DuckChat URL. There are two Duck Chat URLs Legacy: https://duckduckgo.com/?q=DuckDuckGo+AI+Chat&ia=chat&duckai=5 After Migration: https://duck.ai/chat?q=DuckDuckGo+AI+Chat&duckai=5&atb=v520-1ru&ko=-1&t=ddg_android&migration=native-import https://app.asana.com/1/137249556945/task/1210497696306780

Link copied to clipboard
abstract fun isEnabled(): Boolean

Checks whether DuckChat is enabled based on remote config flag and user preference. Uses a cached value - does not perform disk I/O.

Link copied to clipboard
abstract suspend fun isStandaloneMigrationCompleted(): Boolean
abstract fun observeAutomaticContextAttachmentUserSettingEnabled(): Flow<Boolean>

Observes the value for the automatic context attachment for Contextual Mode

Link copied to clipboard
abstract fun observeChatSuggestionsUserSettingEnabled(): Flow<Boolean>

Observes whether the user has enabled chat suggestions.

abstract fun observeCosmeticInputScreenUserSettingEnabled(): Flow<Boolean?>

Observes the cosmetic value for the input screen user setting. Returns null if the cosmetic value has not been set before.

Link copied to clipboard
abstract fun observeInputScreenUserSettingEnabled(): Flow<Boolean>

Observes whether Duck.ai input screen with a mode switch is enabled or disabled.

abstract fun observeNativeInputFieldUserSettingEnabled(): Flow<Boolean>

Observes whether the native input field user setting is enabled.

Link copied to clipboard
abstract fun openDuckChat()

Opens the DuckChat WebView with optional pre-filled String query.

Link copied to clipboard
abstract fun openDuckChatWithAutoPrompt(query: String)

Auto-prompts the DuckChat WebView with the provided String query.

Link copied to clipboard
abstract fun openDuckChatWithPrefill(query: String)

Opens Duck Chat with a prefilled String query.

Link copied to clipboard
abstract suspend fun setChatSuggestionsUserSetting(enabled: Boolean)

Set user preference for whether chat suggestions are shown in the input screen.

Link copied to clipboard
abstract suspend fun setCosmeticInputScreenUserSetting(enabled: Boolean)

Cosmetically sets the input screen user setting.

Link copied to clipboard
abstract suspend fun setInputScreenUserSetting(enabled: Boolean)

Set user setting to determine whether dedicated Duck.ai input screen with a mode switch should be used.

Link copied to clipboard
abstract fun showNewAddressBarOptionChoiceScreen(context: Context, isDarkThemeEnabled: Boolean)

Displays the new address bar option choice screen.

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

Returns true if Duck Chat was ever opened before.