DigiaInstance class

Internal singleton that backs the public Digia static facade.

This is an implementation detail of the SDK. App developers never see or reference this class — all calls flow through Digia.

Implemented types
Mixed-in types

Properties

allCampaigns → List<CampaignModel>
All campaigns currently cached in the store. Exposed for host/dev tooling (e.g. the medihub "campaign lab" screen) to enumerate fetched campaigns.
no setter
anchorRegistry → AnchorRegistry
no setter
captureBubbleHiddenNotifier → ValueNotifier<bool>
final
captureFlashNotifier → ValueNotifier<int>
final
captureMediaNotifier → ValueNotifier<bool>
final
captureModeNotifier → ValueNotifier<bool>
Capture controls are debug-only and independent from Sync.
final
captureStructureNotifier → ValueNotifier<bool>
final
captureTextNotifier → ValueNotifier<bool>
final
controller → DigiaOverlayController
Controller for inline campaigns, notifies when they change. Exposed so DigiaHost can subscribe at mount time.
no setter
currentScreen → String?
no setter
events → EngageEventEmitter
Experience-event emitter used by render surfaces (DigiaSlot, DigiaHost, nudge widgets) to route lifecycle events to CEP and/or Digia.
no setter
floaterStoryOrchestrator → FloaterStoryOrchestrator
no setter
guideManager → GuideShowcaseManager
no setter
guideOrchestrator → GuideOrchestrator
no setter
hashCode → int
The hash code for this object.
no setterinherited
no setter
pipOrchestrator → PipOrchestrator
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdkState → SDKState
no setter
successfulCapturePagesNotifier → ValueNotifier<List<String>>
final
surveyOrchestrator → SurveyOrchestrator
no setter
themeMode → DigiaThemeMode
no setter

Methods

attachNavigator(NavigatorState navigator) → void
campaignForPayload(CEPTriggerPayload payload) → CampaignModel?
Looks up the campaign for payload (live test entry if present, else the real cache). Used by inline surfaces to attach campaign context.
captureCurrentPage(TextDirection textDirection) → Future<String>
clearAllInlineContent() → void
Clears all inline content (carousels/stories) across every placement.
clearInlineContent(List<String> placementKeys) → void
Clears inline content (carousels/stories) for each key in placementKeys. Once loaded, inline content is retained indefinitely — hosts should call this on logout so a stale user's content doesn't linger across the account switch. No-op if placementKeys is empty.
clearUserId() → Future<void>
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void
Called when the system puts the app in the background or returns the app to the foreground.
override
didChangeLocales(List<Locale>? locales) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
inherited
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated.
inherited
didChangePlatformBrightness() → void
Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes.
inherited
didChangeViewFocus(ViewFocusEvent event) → void
Called whenever the PlatformDispatcher receives a notification that the focus state on a view has changed.
inherited
didHaveMemoryPressure() → void
Called when the system is running low on memory.
inherited
didPopRoute() → Future<bool>
Called when the system tells the app to pop the current route, such as after a system back button press or back gesture.
inherited
didPushRoute(String route) → Future<bool>
Called when the host tells the application to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>
Called when a request is received from the system to exit the application.
inherited
dwellElapsedMs(String cepCampaignId) → int?
Milliseconds since cepCampaignId's surface was marked visible, for callers that must stamp time_to_action_ms at the moment of the tap rather than when they get around to reporting it.
floaterStoryActionScope(BuildContext context) → EngageActionScope
Action bindings for content inside a story floater.
flushAnalytics() → Future<void>
getAnonymousId() → String
getInlineCampaign(String placementKey) → CEPTriggerPayload?
Gets the active inline campaign for a given placement key, if any.
handleCancelBackGesture() → void
Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void
Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleLiveTestCampaign(LiveTestInvocation invocation) → void
Handles one campaign_test SSE event: ACKs received, then routes the inline campaign through the same _routeStoredCampaign path an organic CEP trigger uses.
handleStartBackGesture(PredictiveBackEvent backEvent) → bool
Called at the start of a predictive back gesture.
inherited
handleStatusBarTap() → void
Called when the user taps the status bar on iOS, to scroll a scroll view to the top.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
initialize(DigiaConfig config) → Future<void>
markNudgeDismissed(CEPTriggerPayload payload) → void
Fired when the nudge is dismissed — by the user or programmatically.
markSurveyCompleted(Map<String, dynamic> response, [Map<String, SurveyAnswer> answers = const {}]) → void
Reports completion and clears the active survey.
markSurveyDismissed({int? abandonedAtItem, int? answeredCount}) → void
Clears the active survey after the user closes the result page. Fired when the user closes the survey without completing it. abandonedAtItem is the 1-based question they were on; answeredCount is how many they had answered.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onCampaignInvalidated(String campaignId) → void
Called when a previously delivered campaign is no longer valid. Digia dismisses the active nudge or inline payload with matching id.
override
onCampaignTriggered(CEPTriggerPayload payload) → bool
Called when the CEP has evaluated a campaign and it is ready to render. Digia routes the payload to nudge or inline surfaces based on campaignKey.
override
onHostMounted() → void
Called by DigiaHost when it mounts into the widget tree.
onHostUnmounted() → void
Called by DigiaHost when it is removed from the widget tree.
openDebugSettingsFromOverlay() → Future<void>
Pushes the debug settings screen from DigiaRecordingBadge, which lives above the app's own Navigator (inside DigiaHost's Stack, same as _presentNudge) — so it can't resolve Navigator.of(context) from its own BuildContext and must go through _navigator directly instead of the BuildContext-based Digia.openDebugSettings.
pipActionScope(BuildContext context) → EngageActionScope
Action bindings for buttons inside the expanded PiP content.
pushDebugSettingsRoute(NavigatorState navigator) → Future<void>
Pushes the debug settings screen, at most one at a time.
recordAnchorSeen(String anchorKey) → void
Called by DigiaAnchor the first time an anchor key mounts. Recorded against the currently-set screen name (see setCurrentScreen) — anchors require one server-side, so this is skipped if no screen is set yet.
recordSlotSeen(String placementKey) → void
Called by DigiaSlot the first time a placement key mounts.
register(DigiaCEPPlugin plugin) → void
reportAnchorlessGuideFailure(int guideToken, LiveTestFailureCode code, String message) → void
reportBannerClicked(CEPTriggerPayload payload, {String? actionType, String? actionUrl}) → void
reportCarouselStepClicked(CEPTriggerPayload payload, {required int itemIndex, String? actionType, String? actionUrl}) → void
A carousel item (or its CTA) was tapped. The first item tap also counts as an experience-level engagement click (once, deduped).
reportCarouselStepViewed(CEPTriggerPayload payload, {required int itemIndex, required int itemTotal, required bool auto}) → void
A carousel item scrolled into view. auto = autoplay advance vs manual swipe. itemIndex is 1-based.
reportFloaterStoryClicked({required String elementId, required String actionType, required String ctaRole, String? ctaLabel, String? actionUrl}) → void
SDK chrome taps on the window itself — opening the story, and the ×.
reportFloaterStoryStepClicked(CEPTriggerPayload payload, {required String ctaLabel, required String actionType, required String ctaRole, String? actionUrl, int? timeToActionMs}) → void
An authored CTA on the window or inside a story — the real conversion.
reportInlineCanvasClicked(CEPTriggerPayload payload, {String? elementId, String? ctaLabel, String? actionType, String? ctaRole}) → void
An element on an inline canvas was tapped.
reportInlineCanvasDismissed(CEPTriggerPayload payload) → void
The author's Hide action removed an inline canvas from its slot.
reportInlineCanvasPrimaryClicked(CEPTriggerPayload payload, {String? elementId}) → void
reportInlineTimerClicked(CEPTriggerPayload payload, ResolvedInlineTimerConfig config, InlineTimerState renderedState, Duration remaining, {required bool isPrimary, String? elementId, String? label, String? actionType, String? actionUrl}) → void
reportInlineTimerDismissed(CEPTriggerPayload payload, ResolvedInlineTimerConfig config, InlineTimerState renderedState) → void
reportInlineTimerRendered(CEPTriggerPayload payload, ResolvedInlineTimerConfig config, InlineTimerState state, Duration remaining) → void
reportNudgeClicked(CEPTriggerPayload payload, {String? elementId, String? ctaLabel, String? actionType, String? ctaRole}) → void
reportNudgeImpression(CEPTriggerPayload payload, NudgeConfig config) → void
Fired once when the nudge first becomes visible (its impression).
reportPipClicked({required String elementId, required String actionType, required PipState state, required String ctaRole}) → void
SDK chrome taps on the PiP itself — expand, collapse, close, mute, play.
reportPipStepClicked(CEPTriggerPayload payload, {required String ctaLabel, required String actionType, required String ctaRole, String? actionUrl, int? timeToActionMs}) → void
An authored CTA inside the expanded content — the PiP's real conversion.
reportSlotFirstRender(CEPTriggerPayload payload) → void
Fired when an inline slot first paints. Records the deduped Digia impression as a CarouselViewed or StoriesViewed depending on the campaign type. Mirrors Android's reportSlotFirstRender.
reportStoryCompleted(CEPTriggerPayload payload, {required int itemTotal, int? timeToCompleteMs}) → void
Last story frame viewed. itemTotal = frames viewed; timeToCompleteMs from open.
reportStoryOpened(CEPTriggerPayload payload, {required int itemIndex}) → void
A story was opened (ring/thumbnail tapped) — drives Digia's open rate. itemIndex is the 1-based item opened.
reportStoryStepClicked(CEPTriggerPayload payload, {required int itemIndex, String? ctaLabel, String? actionType, String? actionUrl}) → void
A CTA inside a story frame was tapped.
reportStoryStepDismissed(CEPTriggerPayload payload, {required int itemIndex}) → void
Story closed before the last frame. itemIndex is the 1-based frame on close.
reportStoryStepViewed(CEPTriggerPayload payload, {required int itemIndex, required int itemTotal}) → void
A story frame became visible. itemIndex is 1-based; itemTotal = frames in this story.
reportSurveyAnswered(String stepId, Map<String, dynamic> answer) → void
Fired after a question (any block other than welcome) is answered. stepId identifies the node. First-party Digia analytics only.
reportSurveyCompleted(Map<String, dynamic> response, [Map<String, SurveyAnswer> answers = const {}]) → void
Fired once when the survey finishes (idempotent per showing). Beyond the Completed analytics event, answers (when supplied) are POSTed to the backend's recordSubmission endpoint via SubmissionReporter.
reportSurveyQuestionSkipped(String nodeId, int itemIndex) → void
Fired when the user advances past an unanswered, optional question. First-party Digia analytics only.
reportSurveyQuestionViewed(String nodeId, int itemIndex) → void
Fired when a (non-content) question becomes visible. itemIndex is the 1-based respondent traversal depth. Stamps the view time for time_to_answer_ms. First-party Digia analytics only.
reportSurveyStartClicked() → void
reportSurveyStarted() → void
Fired once when the survey first becomes visible (its impression).
reportWelcomeCtaClicked() → void
Fired for the survey's single Clicked engagement signal — on the welcome screen's start CTA, or on the first question's CTA when the welcome screen is hidden. Only a physical welcome Start also emits the coarse CEP click.
resolveActiveCampaign() → CampaignModel?
Resolves the CampaignModel for the active payload so DigiaHost can switch on its config type and present the correct experience. Returns null (and auto-dismisses) when no matching campaign is found.
setCaptureModeEnabled(bool enabled) → Future<void>
setCaptureProfile({bool? includeText, bool? includeImagesAndMedia, bool? includeOtherStructuralNodes}) → Future<void>
setCurrentScreen(String name) → void
Sets the current screen. This is the single source of truth for screen scoping — a PiP belongs to the screen named here when it opened, and ends when this reports a different one. That is the expected end of most PiP impressions, not an error path.
setCustomKVHandler(FutureOr<void> handler(Map<String, String> payload)?) → void
setDeepLinkHandler(FutureOr<void> handler(String deepLink)?) → void
setOpenURLHandler(FutureOr<void> handler(String deepLink)?) → void
setThemeMode(DigiaThemeMode themeMode) → void
Selects the theme used when Campaign Canvas colors are rendered.
setUserId(String userId) → Future<void>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

instance → DigiaInstance
Internal accessor used only by Digia and DigiaHost.
no setter