prompts-coordinator-api/com.duckduckgo.promptscoordinator.api/ModalEvaluator

ModalEvaluator

Interface for modal evaluators that can be coordinated by the ModalEvaluatorCoordinator. Each evaluator should implement this interface and contribute itself via @ContributesMultibinding.

Types

EvaluationResult

sealed class EvaluationResult

Result of modal evaluation

Properties

evaluatorId

abstract val evaluatorId: String

Unique identifier for this evaluator, used for tracking completion timestamps.

priority

abstract val priority: Int

Priority determines evaluation order. Lower numbers are evaluated first. Priority 1 = highest priority (evaluated first) Priority 2+ = lower priorities (evaluated in ascending order)

trigger

open val trigger: ModalTrigger

Which lifecycle event causes the coordinator to evaluate this modal. Evaluators tied to the New Tab Page should override with ModalTrigger.NTP_RENDER.

Functions

evaluate

abstract suspend fun evaluate(): ModalEvaluator.EvaluationResult

Evaluates whether this modal should be shown. Called by coordinator only if not blocked by 24-hour window (cooldown period).