Nexus & setup

import 'package:nexus_flutter/nexus.dart';

NexusCopy Anchor Link

The Nexus umbrella SDK — one entry point for every service. Initialise once at startup; then use any service, all correlated to the same journey session:

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Nexus.init(const NexusConfig(apiKey: 'nxs_...'));
  runApp(NexusScope(child: MyApp()));
}

// anywhere with a BuildContext:
context.nexus.events.track('order_placed');
context.nexus.realtime.join('orders:42');

init()Copy Anchor Link

static Future<Nexus> init(NexusConfig config)

Initialise the SDK once at startup. Re-calling disposes the previous instance and replaces it.

Parameters

Returns Future<Nexus>

instanceCopy Anchor Link

static Nexus get instance

The app-wide instance. Throws if init hasn't run.

isInitializedCopy Anchor Link

static bool get isInitialized

distinctIdCopy Anchor Link

String? get distinctId

sessionKeyCopy Anchor Link

String get sessionKey

pendingUploadsCopy Anchor Link

int get pendingUploads

Number of telemetry requests awaiting delivery (queued/offline).

configCopy Anchor Link

final NexusConfig config

sessionsCopy Anchor Link

final NexusSessions sessions

eventsCopy Anchor Link

final NexusEvents events

errorsCopy Anchor Link

final NexusErrors errors

logsCopy Anchor Link

final NexusLogs logs

flagsCopy Anchor Link

final NexusFlags flags

linksCopy Anchor Link

final NexusLinks links

realtimeCopy Anchor Link

final NexusRealtime realtime

replayCopy Anchor Link

final NexusReplay replay

surveysCopy Anchor Link

final NexusSurveys surveys

remoteConfigCopy Anchor Link

final NexusRemoteConfig remoteConfig

pushCopy Anchor Link

final NexusPush push

inAppCopy Anchor Link

final NexusInApp inApp

liveActivityCopy Anchor Link

final NexusLiveActivity liveActivity

voiceCopy Anchor Link

final NexusVoice voice

identify()Copy Anchor Link

Future<void> identify(String distinctId, {String? email, String? name, String? phone, Map<String, Object?>? traits})

Identify the current end-user (shorthand for sessions.identify).

Parameters

reset()Copy Anchor Link

Future<void> reset()

Forget the current user and start a fresh session (e.g. on logout). Also clears the persisted identity so the next launch starts anonymous.

trackScreen()Copy Anchor Link

void trackScreen(String name)

Record a screen/page change for session replay's Pages tab. Wire NexusNavigatorObserver into navigatorObservers to do this automatically.

Parameters

observeRouter()Copy Anchor Link

void observeRouter(Listenable router, String Function() currentPath)

Track navigation from a Listenable router (e.g. GoRouter's routerDelegate) — catches shell/nested routes a root observer misses. See NexusReplay.observeRouter.

Parameters

flush()Copy Anchor Link

Future<void> flush()

Flush all buffered telemetry into the outbox and try to deliver it now (call before the app is backgrounded/killed).

dispose()Copy Anchor Link

void dispose()

Tear down the instance (timers, socket, http).

NexusDeepLinkHandlerCopy Anchor Link

typedef NexusDeepLinkHandler = FutureOr<bool> Function(NexusDeepLink link)

Decide what to do with a Nexus deep link. Return true when the app handled the navigation itself; false lets the SDK route to NexusDeepLink.path.

NexusConfigCopy Anchor Link

Configuration for Nexus.init.

NexusConfigCopy Anchor Link

const NexusConfig({required this.apiKey, this.baseUrl = 'https://services.inverge.net', this.realtimeUrl, this.autoTrackSessions = true, this.autoCaptureErrors = true, this.autoConnectRealtime = false, this.manageRealtimeWithLifecycle = true, this.flushOnBackground = true, this.flushInterval = const Duration(seconds: 10), this.maxBatch = 50, this.logging = false, this.logLevel, this.onLog, this.replayEnabled = false, this.replayInterval = const Duration(milliseconds: 1000), this.replayPixelRatio = 1.0, this.replayMaskTextFields = true, this.replayCaptureConsole = true, this.replayCaptureNetwork = true, this.surveysEnabled = false, this.surveyAutoShow = true, this.inAppEnabled = false, this.inAppAutoShow = true, this.autoShowOverlay = true, this.liveActivityEnabled = false, this.voiceEnabled = false, this.remoteConfigEnabled = false, this.remoteConfigRealtime = false, this.remoteConfigDefaults = const {}, this.pushEnabled = false, this.pushAutoRequestPermission = true, this.pushWebVapidKey, this.pushForegroundDisplay = true, this.pushAndroidChannelId = 'nexus_default', this.pushAndroidChannelName = 'Notifications', this.linksEnabled = true, this.linkDomains = const [], this.autoRouteDeepLinks = true, this.onDeepLink, this.appVersion, this.defaultProperties = const {}})

Parameters

resolvedLogLevelCopy Anchor Link

NexusLogLevel get resolvedLogLevel

Effective log level: explicit logLevel, else debug when logging is on, else warn.

httpBaseCopy Anchor Link

String get httpBase

socketBaseCopy Anchor Link

String get socketBase

apiKeyCopy Anchor Link

final String apiKey

Tenant API key (nxs_...). Sent as x-api-key on HTTP and in the socket handshake auth.

baseUrlCopy Anchor Link

final String baseUrl

Control-plane / data-plane origin. Partner endpoints live under /partner.

realtimeUrlCopy Anchor Link

final String? realtimeUrl

Realtime (Socket.IO) origin. Defaults to baseUrl when null.

autoTrackSessionsCopy Anchor Link

final bool autoTrackSessions

Start (and keep alive) a journey session automatically. Default true.

autoCaptureErrorsCopy Anchor Link

final bool autoCaptureErrors

Install a Flutter error handler that reports uncaught errors. Default true.

autoConnectRealtimeCopy Anchor Link

final bool autoConnectRealtime

Open the realtime (Socket.IO) connection automatically at startup, right after the session is established — so the user is live without a manual nexus.realtime.connect(). Rooms are still joined via nexus.realtime.join(...). Default false (realtime connection-minutes are billed — opt in). Works with manageRealtimeWithLifecycle.

manageRealtimeWithLifecycleCopy Anchor Link

final bool manageRealtimeWithLifecycle

Gracefully disconnect realtime when the app is backgrounded and reconnect (rejoining rooms) on foreground. This makes billed connection-minutes accurate — the app isn't charged while suspended. Default true.

flushOnBackgroundCopy Anchor Link

final bool flushOnBackground

Flush queued telemetry when the app is backgrounded (so nothing is lost if the OS kills the app). Default true.

flushIntervalCopy Anchor Link

final Duration flushInterval

How often batched telemetry (events/logs) is flushed. Default 10s.

maxBatchCopy Anchor Link

final int maxBatch

Max items per batch flush. Default 50.

loggingCopy Anchor Link

final bool logging

Shorthand for verbose logging: true maps to NexusLogLevel.debug. Prefer logLevel for finer control. Default false.

logLevelCopy Anchor Link

final NexusLogLevel? logLevel

Diagnostic log verbosity. When null, falls back to logging (debug if on) and otherwise NexusLogLevel.warn — so failed requests and dropped telemetry are always visible, while the happy path stays quiet.

onLogCopy Anchor Link

final NexusLogSink? onLog

Optional sink to receive every log record (in addition to debugPrint), e.g. to forward SDK diagnostics into your own logging.

replayEnabledCopy Anchor Link

final bool replayEnabled

Record session replay: periodic screenshots of the app + pointer events, shipped as rrweb frames. Requires wrapping the app in NexusScope. Wrap sensitive widgets in NexusMask to redact them. Default false (billed / privacy-sensitive — opt in explicitly).

replayIntervalCopy Anchor Link

final Duration replayInterval

How often a replay frame is captured. Lower = smoother but more data/CPU. Default 1s. Identical consecutive frames are dropped automatically.

replayPixelRatioCopy Anchor Link

final double replayPixelRatio

Capture resolution as a multiple of logical pixels. 1.0 ≈ device-independent resolution (small, fast); raise toward MediaQuery.devicePixelRatio for crisper frames, lower (e.g. 0.75) to shrink payloads. Default 1.0.

replayMaskTextFieldsCopy Anchor Link

final bool replayMaskTextFields

Automatically redact every text input (anything backed by EditableText — TextField, TextFormField, CupertinoTextField, SelectableText) from replay frames, so typed content (passwords, PII) is never captured. On by default; use NexusMask for finer control. Set false to opt out.

replayCaptureConsoleCopy Anchor Link

final bool replayCaptureConsole

Tee the app's debugPrint output into the replay stream so it shows in the player's Console tab (mirrors rrweb's console plugin). SDK-internal [Nexus] lines are skipped. On by default; set false to opt out.

replayCaptureNetworkCopy Anchor Link

final bool replayCaptureNetwork

Automatically capture HTTP requests for the player's Network tab via HttpOverrides — covers both Dio and package:http (any dart:io client) with no wiring. Requests to the Nexus API are excluded. On by default (no effect on web — use a Dio interceptor there). Set false to opt out (e.g. if the app installs its own HttpOverrides).

surveysEnabledCopy Anchor Link

final bool surveysEnabled

Fetch eligible in-product surveys at startup (and on foreground). Requires NexusSurveyOverlay in your MaterialApp.builder to display them. Default false (billed per response — opt in).

surveyAutoShowCopy Anchor Link

final bool surveyAutoShow

Automatically show eligible popover/banner surveys (and event-triggered ones on events.track). Set false to present surveys manually via nexus.surveys.show(...). Default true.

inAppEnabledCopy Anchor Link

final bool inAppEnabled

Fetch in-app messages at startup (and on foreground) and show them via the NexusInAppOverlay. Default false — opt in.

inAppAutoShowCopy Anchor Link

final bool inAppAutoShow

Automatically show a triggered in-app message (session start / event). Set false to present manually via nexus.inApp.show(...). Default true.

autoShowOverlayCopy Anchor Link

final bool autoShowOverlay

Auto-mount the survey + in-app overlays without touching MaterialApp.builder (the SDK inserts them into the app's root overlay). Default true. Set false to mount NexusSurveyOverlay / NexusInAppOverlay yourself.

liveActivityEnabledCopy Anchor Link

final bool liveActivityEnabled

Enable Live Activities: iOS receives ActivityKit push updates (Lock Screen / Dynamic Island); Android renders a live ongoing notification from the server's data message. Drive them from the dashboard/API or via nexus.liveActivity. Default false.

voiceEnabledCopy Anchor Link

final bool voiceEnabled

Enable Nexus Voice (CPaaS calling). Exposes nexus.voice — place/answer calls, in-call controls, DTMF, quality. Register a media engine (WebRTC) and optionally CallKit to actually carry audio / show the native call UI. Default false.

pushEnabledCopy Anchor Link

final bool pushEnabled

Fetch Remote Config at startup (and on foreground). Read values via nexus.remoteConfig.getString(...) etc. Default false (billed per fetch — opt in). Set in-app fallbacks with remoteConfigDefaults. Turn-key push notifications. When true, the SDK requests permission, obtains the device's FCM token, registers it with Nexus, re-registers on refresh, and reports notification opens — all automatically. You only need the platform Firebase config (google-services.json / GoogleService-Info.plist). Default false.

pushAutoRequestPermissionCopy Anchor Link

final bool pushAutoRequestPermission

Ask the OS for notification permission when push is enabled. Default true; set false to request it yourself at a better moment (then the token is registered on the next launch, or call nexus.push.start()).

pushWebVapidKeyCopy Anchor Link

final String? pushWebVapidKey

Web only — the VAPID public key for FCM web push. Required to obtain a web token; ignored on iOS/Android.

pushForegroundDisplayCopy Anchor Link

final bool pushForegroundDisplay

Display notifications while the app is in the foreground. FCM does not draw a notification when the app is open — on Android nothing shows unless the app renders it, and on iOS the banner is suppressed by default. With this true (default) the SDK shows it for you: a native banner on iOS and a local notification on Android, tap-attributed like a background open. Set false if you handle FirebaseMessaging.onMessage yourself.

pushAndroidChannelIdCopy Anchor Link

final String pushAndroidChannelId

Android channel id used for foreground notifications the SDK displays. Match your server-side android.notification.channel_id to keep foreground and background notifications on one channel. Default nexus_default.

pushAndroidChannelNameCopy Anchor Link

final String pushAndroidChannelName

Human-readable name for pushAndroidChannelId, shown in Android system settings. Default Notifications.

linksEnabledCopy Anchor Link

final bool linksEnabled

Nexus Links, automatically: report the install on first launch (with the Google Play install referrer on Android, for an exact match), report every app open that came from a Nexus link, and route the user to the link's deep-link value. No code needed. Default true.

linkDomainsCopy Anchor Link

final List<String> linkDomains

Extra hosts that serve your Nexus short links (a branded domain). The baseUrl host is always included.

autoRouteDeepLinksCopy Anchor Link

final bool autoRouteDeepLinks

Navigate to a link's deep-link value when the app's router could not have seen it itself: after an install (deferred deep link) and when the app was opened by the short link directly (App Links / Universal Links). The SDK delivers it as a platform deep link, so go_router, auto_route or a plain Navigator route it exactly like one. Default true.

onDeepLinkCopy Anchor Link

final NexusDeepLinkHandler? onDeepLink

Called for every Nexus deep link before the SDK routes it — return true to take over (e.g. hold it until after login; see NexusLinks.consumePending).

remoteConfigEnabledCopy Anchor Link

final bool remoteConfigEnabled

remoteConfigRealtimeCopy Anchor Link

final bool remoteConfigRealtime

Subscribe to realtime Remote Config updates: when a new template is published, the app re-fetches automatically (Firebase Realtime RC). Needs a realtime connection (see autoConnectRealtime). Default false.

remoteConfigDefaultsCopy Anchor Link

final Map<String, Object?> remoteConfigDefaults

In-app default Remote Config values, used until/unless the server provides a value for a key. Mirrors Firebase setDefaults.

appVersionCopy Anchor Link

final String? appVersion

App version reported with telemetry (e.g. from package_info). Optional.

defaultPropertiesCopy Anchor Link

final Map<String, Object?> defaultProperties

Properties merged into every event's/person's context.

NexusLogLevelCopy Anchor Link

enum NexusLogLevel

Verbosity of the SDK's diagnostic logging.

Higher levels include everything below them. The default is warn — silent in the happy path, but surfacing dropped telemetry / failed requests so problems (like a rejected session) never fail silently. Set NexusConfig(logLevel: NexusLogLevel.debug) (or logging: true) to trace every request while integrating.

NexusLogSinkCopy Anchor Link

typedef NexusLogSink = void Function(NexusLogLevel level, String message, [Object? error, StackTrace? stackTrace])

A custom log sink — receive every record the SDK emits (e.g. to forward it into your own logging, or into Nexus Logs). Set via NexusConfig.onLog.

NexusLogCopy Anchor Link

Central, leveled logger for the SDK. Configured once from NexusConfig at Nexus.init; every component logs through the static methods so output is consistent ([Nexus] HH:mm:ss.SSS LEVEL message) and centrally gated.

Uses debugPrint (rate-limited, not stripped in profile builds) rather than print, and additionally fans out to an optional NexusLogSink.

configure()Copy Anchor Link

static void configure({NexusLogLevel? level, NexusLogSink? sink})

Apply configuration from NexusConfig. Called at the start of init.

Parameters

error()Copy Anchor Link

static void error(String message, [Object? error, StackTrace? stackTrace])

Parameters

warn()Copy Anchor Link

static void warn(String message)

Parameters

info()Copy Anchor Link

static void info(String message)

Parameters

debug()Copy Anchor Link

static void debug(String message)

Parameters

mask()Copy Anchor Link

static String mask(String secret)

Mask a secret for logs: keep a readable prefix + last 4 chars.

Parameters

Returns String

levelCopy Anchor Link

static NexusLogLevel level

Active level. Below this, calls are cheap no-ops.

sinkCopy Anchor Link

static NexusLogSink? sink

Optional extra sink (in addition to debugPrint).

NexusScopeCopy Anchor Link

class NexusScope extends StatelessWidget

Makes the initialised Nexus available through the widget tree, and — when session replay is enabled — installs the RepaintBoundary + pointer listener the recorder captures from. Optional for access (context.nexus falls back to the global Nexus.instance), but required for replay.

runApp(NexusScope(child: MyApp()));

NexusScopeCopy Anchor Link

const NexusScope({super.key, this.nexus, required this.child})

Parameters

of()Copy Anchor Link

static Nexus of(BuildContext context)

Parameters

Returns Nexus

nexusCopy Anchor Link

final Nexus? nexus

Override instance (e.g. in tests). Defaults to Nexus.instance.

childCopy Anchor Link

final Widget child

NexusBuildContextCopy Anchor Link

extension NexusBuildContext on BuildContext

context.nexus — access the SDK from any widget.

nexusCopy Anchor Link

Nexus get nexus

The app-wide Nexus instance. Use it as context.nexus.realtime, context.nexus.events, context.nexus.errors, …

NexusPlatformCopy Anchor Link

abstract class NexusPlatform extends PlatformInterface

The native surface of the SDK: device/app context and (native-backed) session replay capture. Platform implementations (Kotlin/Swift/web) provide these; the pure-Dart services (events, errors, logs, realtime, …) work without native code.

NexusPlatformCopy Anchor Link

NexusPlatform()

instanceCopy Anchor Link

static NexusPlatform get instance

getPlatformVersion()Copy Anchor Link

Future<String?> getPlatformVersion()

Returns Future<String?>

deviceInfo()Copy Anchor Link

Future<Map<String, Object?>> deviceInfo()

Device + OS + app context (osType, osVersion, deviceModel, appVersion, …).

Returns Future<Map<String, Object?>>

startReplay()Copy Anchor Link

Future<void> startReplay(String recordingId)

Begin native session-replay capture for recordingId. No-op where the native SDK isn't present (web/desktop today).

Parameters

stopReplay()Copy Anchor Link

Future<void> stopReplay()

Stop native session-replay capture.

onReplayBatch()Copy Anchor Link

void onReplayBatch(void Function(String recordingId, List<Object?> events) sink)

Register a sink for batches of replay events pushed up from native.

Parameters

configureCrashReporting()Copy Anchor Link

Future<void> configureCrashReporting(bool enabled)

Install (or remove) the native uncaught-exception / signal handlers that persist crashes for forwarding on the next launch. No-op where unsupported.

Parameters

takePendingCrashes()Copy Anchor Link

Future<List<Map<String, Object?>>> takePendingCrashes()

Return and clear native crashes persisted since the last launch. Each map: { type, message, stack (frames or string), platform, timestamp }.

Returns Future<List<Map<String, Object?>>>

showNotification()Copy Anchor Link

Future<bool> showNotification({required int id, String? title, String? body, required String channelId, required String channelName, String? payload, String? largeIcon, String? bigPicture, String? smallIcon, String? visibility, String? accentColor, List<Map<String, String?>>? buttons})

Post a notification from native code (used to render foreground pushes on Android, since FCM does not draw one while the app is open). Returns true if it was shown. No-op / false where unsupported. payload is stashed on the tap intent and delivered back via onNotificationTap.

Parameters

Returns Future<bool>

onNotificationTap()Copy Anchor Link

void onNotificationTap(void Function(Map<String, dynamic> data) sink)

Register a sink for taps on notifications posted via showNotification. Receives the decoded payload map so the caller can attribute the open.

Parameters

linksTakePending()Copy Anchor Link

Future<List<String>> linksTakePending()

Deep links (Nexus links). Native code sees every URL that opens the app before Flutter does; it queues them until Dart asks, so a cold-start link is never lost to the engine starting first. Returns the queued URLs and switches native to live delivery via onLinkOpened.

Returns Future<List<String>>

onLinkOpened()Copy Anchor Link

void onLinkOpened(void Function(String url) sink)

Register a sink for links opened while the app is running.

Parameters

linksConfigure()Copy Anchor Link

Future<void> linksConfigure(List<String> hosts)

Tell native which hosts serve Nexus short links, so it can consume them (keep them away from the app's router) on the NEXT cold start too.

Parameters

installReferrer()Copy Anchor Link

Future<String?> installReferrer()

Android only: the Google Play install referrer (e.g. link_click_id=…), or null where unavailable (iOS, sideloaded, not yet installed via Play).

Returns Future<String?>

showLiveActivity()Copy Anchor Link

Future<bool> showLiveActivity({required int id, required String channelId, required String channelName, String? title, String? body, String? subText, int? progress, bool indeterminate = false, bool ongoing = true, String? payload})

Post or update an Android live ongoing notification (the Android equivalent of an iOS Live Activity). Uses a promoted Live Update (ProgressStyle) on Android 16+, a normal ongoing notification with a progress bar otherwise. Returns true if shown.

Parameters

Returns Future<bool>

endLiveActivity()Copy Anchor Link

Future<void> endLiveActivity(int id)

Remove an Android live ongoing notification (end of a live activity).

Parameters

showLiveActivityTemplate()Copy Anchor Link

Future<bool> showLiveActivityTemplate({required int id, required Map<String, dynamic> payload})

Render a Nexus Live Activity template on Android: a promoted Live Update (ProgressStyle — segments/points/tracker icon, status chip, ETA countdown) on Android 16+, an ongoing notification with a progress bar otherwise. payload is { event, activityId, template, data }. Returns true if shown.

Parameters

Returns Future<bool>

liveActivityCacheImages()Copy Anchor Link

Future<void> liveActivityCacheImages(List<String> urls)

iOS: download template images into the App Group so the widget can show them.

Parameters

liveActivityStart()Copy Anchor Link

Future<void> liveActivityStart({required String activityId, required String activityType, required Map<String, dynamic> contentState, Map<String, dynamic>? attributes, Map<String, dynamic>? template})

Start an iOS Live Activity (ActivityKit) with the turn-key default attributes. The native side registers its update token via onLiveActivityToken.

Parameters

liveActivityUpdate()Copy Anchor Link

Future<void> liveActivityUpdate({required String activityId, required Map<String, dynamic> contentState})

Update a running iOS Live Activity's content state.

Parameters

liveActivityEnd()Copy Anchor Link

Future<void> liveActivityEnd({required String activityId, Map<String, dynamic>? finalContentState})

End a running iOS Live Activity.

Parameters

liveActivityObservePushToStart()Copy Anchor Link

Future<void> liveActivityObservePushToStart(String activityType)

Start observing ActivityKit: push-to-start tokens (iOS 17.2+), push-started activities' update tokens, and diagnostics — all via onLiveActivityToken.

Parameters

onLiveActivityToken()Copy Anchor Link

void onLiveActivityToken(void Function(Map<String, dynamic> info) sink)

Register a sink for ActivityKit tokens. info carries { kind: 'pushToStart'|'update', activityType?, activityId?, token } or a diagnostic { kind: 'status', event, … }.

Parameters

voiceRegisterAccount()Copy Anchor Link

Future<void> voiceRegisterAccount()

Register the self-managed phone account so the OS routes our calls through the native call UI. Call once at startup. No-op where unsupported.

voiceReportIncoming()Copy Anchor Link

Future<void> voiceReportIncoming({required String callId, required String from, String? displayName, String? avatarUrl, bool hasVideo = false})

Ask the OS to ring callId in the SYSTEM call UI (over the lock screen). The call is answered NATIVELY — the app is never forced open.

Parameters

voiceEndCall()Copy Anchor Link

Future<void> voiceEndCall(String callId)

End a native call (local hangup / remote-left) so the system UI clears.

Parameters

voiceMissedCall()Copy Anchor Link

Future<void> voiceMissedCall({required String callId, required String from, String? displayName, String? avatarUrl})

The caller cancelled before we answered — clear the ring and leave a "Missed call" notification, like a native phone call.

Parameters

onNativeCallEvent()Copy Anchor Link

void onNativeCallEvent(void Function(String action, String callId) sink)

Register a sink for native call actions the user took in the SYSTEM UI. action is answer | reject | disconnect; callId identifies the call.

Parameters

voiceReportOutgoing()Copy Anchor Link

Future<void> voiceReportOutgoing({required String callId, required String to, String? displayName})

Start a native OUTGOING call entry. iOS only in practice: under CallKit the audio session is activated only for a call the OS knows about, so an unreported outbound call has no audio. Android deliberately skips this (a self-managed outgoing Connection can auto-end and tear down a live call).

Parameters

voiceReportConnected()Copy Anchor Link

Future<void> voiceReportConnected(String callId)

Tell the OS the call connected (starts its timer / active-call UI).

Parameters

voiceVoipToken()Copy Anchor Link

Future<String?> voiceVoipToken()

The device's APNs VoIP (PushKit) token, registered with the Voice control plane so a killed app can be rung. Null off iOS / before the token arrives.

Returns Future<String?>

onNativeCallControl()Copy Anchor Link

void onNativeCallControl(void Function(String action, String callId, Object? value) sink)

Register a sink for in-call controls the user drove from the SYSTEM call UI (mute / hold / DTMF keypad). action is mute | hold | dtmf; value is the bool or digit string. iOS/CallKit only — Android's self-managed UI has no system in-call controls.

Parameters

onNativeCallAudioSession()Copy Anchor Link

void onNativeCallAudioSession(void Function(bool active) sink)

Register a sink for the external call system's audio-session window (iOS CallKit didActivate/didDeactivate). The media engine may only run its audio engine while this is true.

Parameters

onNativeVoicePush()Copy Anchor Link

void onNativeVoicePush(void Function(Map<String, dynamic> data) sink)

Register a sink for incoming-call payloads delivered natively (iOS APNs VoIP/PushKit). On Android the equivalent arrives as an FCM data message handled in Dart, so this never fires there.

Parameters

onNativeVoipToken()Copy Anchor Link

void onNativeVoipToken(void Function(String token) sink)

Register a sink for APNs VoIP token updates (iOS PushKit).

Parameters

appIsForeground()Copy Anchor Link

Future<bool> appIsForeground()

Whether the app is in the foreground. Answered authoritatively on iOS (UIApplication.applicationState), where a VoIP push can launch the app in the BACKGROUND and no permission dialog can be presented. Defaults to true where unimplemented, preserving the caller's normal behaviour.

Returns Future<bool>

micPermissionStatus()Copy Anchor Link

Future<String?> micPermissionStatus()

The OS microphone authorization: granted | denied | restricted | undetermined. Null where unimplemented (callers then fall back to permission_handler). iOS only — and necessary there because permission_handler cannot distinguish "never asked" from "refused".

Returns Future<String?>

micRequestPermission()Copy Anchor Link

Future<bool?> micRequestPermission()

Ask the OS for the microphone and return whether it was granted, using the platform's own API rather than a permission package. Null where unimplemented, so callers fall back to permission_handler. iOS only.

Returns Future<bool?>

instanceCopy Anchor Link

static set instance(NexusPlatform instance)

Parameters