Deep links

import 'package:nexus_flutter/nexus.dart';

NexusDeepLinkSourceCopy Anchor Link

enum NexusDeepLinkSource

Where a NexusDeepLink came from.

NexusDeepLinkCopy Anchor Link

A Nexus link that brought the user into the app, as the server resolved it.

NexusDeepLinkCopy Anchor Link

const NexusDeepLink({required this.source, this.uri, this.path, this.params = const {}, this.slug, this.campaign, this.mediaSource, this.channel, this.clickId, this.matchType})

Parameters

isDeferredCopy Anchor Link

bool get isDeferred

sourceCopy Anchor Link

final NexusDeepLinkSource source

uriCopy Anchor Link

final Uri? uri

The URL that opened the app. Null for a deferred match after an install.

pathCopy Anchor Link

final String? path

Where to take the user: the link's deep-link value (console), else the path of the URL that opened the app.

paramsCopy Anchor Link

final Map<String, dynamic> params

The link's deep-link parameters (console → link → deep-link params).

slugCopy Anchor Link

final String? slug

campaignCopy Anchor Link

final String? campaign

mediaSourceCopy Anchor Link

final String? mediaSource

channelCopy Anchor Link

final String? channel

clickIdCopy Anchor Link

final String? clickId

matchTypeCopy Anchor Link

final String? matchType

deterministic, probabilistic or organic.

NexusLinksCopy Anchor Link

Deep linking & attribution (OneLink-style), automatic with linksEnabled:

• Install — reported once per install on first launch, matched to the link click exactly via the Google Play install referrer on Android, or by the opening link itself, else by the server's fingerprint window.
• Open — every launch or resume from a Nexus link is reported, matched exactly by its click-id.
• Routing — when the app's router could not have seen the link (deferred deep link after install; app opened by the short link itself via App Links / Universal Links), the SDK routes to the link's deep-link value by delivering it as a platform deep link — any Router or Navigator handles it.

Uninstalls are measured server-side (silent push probes); nothing runs here.

onLinkCopy Anchor Link

Stream<NexusDeepLink> get onLink

Every Nexus deep link as it is resolved (install or open).

consumePending()Copy Anchor Link

NexusDeepLink? consumePending()

The last deep link the SDK did NOT route itself (routing off, or the onDeepLink handler took over), cleared on read — e.g. route it from your home screen once the user has logged in.

Returns NexusDeepLink?

start()Copy Anchor Link

Future<void> start()

Wire automatic install/open reporting. Called by Nexus.init when linksEnabled; idempotent.

attribute()Copy Anchor Link

Future<Map<String, dynamic>?> attribute({String type = 'install', String? clickId, String? slug, String? name, String? platform, Map<String, Object?>? properties})

Report a conversion. Pass clickId (from the link) for deterministic attribution, or slug when the app was opened by the short link itself; otherwise the server matches by fingerprint. Returns the matched link's deep-link data (or null if unattributed).

Parameters

Returns Future<Map<String, dynamic>?>

handleDeepLink()Copy Anchor Link

Future<Map<String, dynamic>?> handleDeepLink(Uri uri, {String type = 'open'})

Convenience: parse a deep-link uri for link_click_id and attribute an open, returning the deep-link data. Not needed with linksEnabled, which reports opens automatically.

Parameters

Returns Future<Map<String, dynamic>?>

dispose()Copy Anchor Link

void dispose()