Live Activities

LiveActivitiesResourceCopy Anchor Link

class Inverge.Nexus.Resources.LiveActivitiesResource

Live Activities — a live, updating view of something in progress.

Templated (recommended): design the activity once in the Nexus console; the mobile SDKs render it on iOS and Android in each device's language, and the server sends only data — Template, StartTemplateAsync, UpdateDataAsync, EndWithDataAsync.

iOS renders these on the Lock Screen and in the Dynamic Island; Android as an ongoing live notification. The server-side shape is always the same: start when the order or ride or match begins, update as it changes, end when it is done. iOS additionally needs the APNs key configured in the console — Live Activities cannot go through FCM — and a Widget Extension in the app.

Activity()Copy Anchor Link

LiveActivityBuilder Activity(string activityTypeOrId, string? activityId = null)

Starts a fluent activity. Pass the type and id to start one; pass just the id to update or end an existing one.

Parameters

Returns LiveActivityBuilder

EndAsync()Copy Anchor Link

Task<LiveActivityResult> EndAsync(string activityId, object? contentState = null, DateTimeOffset? dismissalDate = null, CancellationToken cancellationToken = default)

Ends the activity, with an optional final state and dismissal time.

Parameters

Returns Task<LiveActivityResult>

EndWithDataAsync()Copy Anchor Link

Task<LiveActivityResult> EndWithDataAsync(string activityId, object? data = null, DateTimeOffset? dismissalDate = null, CancellationToken cancellationToken = default)

Ends a templated activity with its final data shown before dismissal — e.g. new { step = "completed" } or new { state = "canceled" }.

Parameters

Returns Task<LiveActivityResult>

RegisterActivityAsync()Copy Anchor Link

Task<NexusAck> RegisterActivityAsync(string activityId, string activityType, string platform = "ios", string? updateToken = null, object? contentState = null, NexusTelemetryContext? context = null, CancellationToken cancellationToken = default)

Registers a running activity instance's update token.

Parameters

Returns Task<NexusAck>

RegisterPushToStartTokenAsync()Copy Anchor Link

Task<NexusAck> RegisterPushToStartTokenAsync(string activityType, string token, NexusTelemetryContext? context = null, CancellationToken cancellationToken = default)

Registers an iOS push-to-start token. Normally the device SDK's job.

Parameters

Returns Task<NexusAck>

StartAsync()Copy Anchor Link

Task<LiveActivityResult> StartAsync(string activityType, string activityId, object? contentState = null, IEnumerable<string>? distinctIds = null, object? attributes = null, DateTimeOffset? staleDate = null, int? priority = null, CancellationToken cancellationToken = default)

Starts an activity.

Parameters

Returns Task<LiveActivityResult>

StartTemplateAsync()Copy Anchor Link

Task<LiveActivityResult> StartTemplateAsync(object template, string activityId, object? data = null, IEnumerable<string>? distinctIds = null, string? lang = null, string? alertTitle = null, string? alertBody = null, object? attributes = null, DateTimeOffset? staleDate = null, int? priority = null, CancellationToken cancellationToken = default)

Starts a templated activity.

Parameters

Returns Task<LiveActivityResult>

Template()Copy Anchor Link

LiveActivityBuilder Template(object template, string activityId)

Starts a fluent templated activity. template is a template key from the Nexus console (e.g. "order_tracking") or an inline design object.

Parameters

Returns LiveActivityBuilder

TrackEventAsync()Copy Anchor Link

Task<NexusAck> TrackEventAsync(string activityId, string type, string? platform = null, CancellationToken cancellationToken = default)

Reports a delivery receipt, click or failure, for analytics.

Parameters

Returns Task<NexusAck>

UpdateAsync()Copy Anchor Link

Task<LiveActivityResult> UpdateAsync(string activityId, object? contentState = null, DateTimeOffset? staleDate = null, int? priority = null, CancellationToken cancellationToken = default)

Pushes a new content state to every device showing the activity.

Parameters

Returns Task<LiveActivityResult>

UpdateDataAsync()Copy Anchor Link

Task<LiveActivityResult> UpdateDataAsync(string activityId, object data, DateTimeOffset? staleDate = null, int? priority = null, CancellationToken cancellationToken = default)

Updates a templated activity with partial data — only what changed. The server merges it into the activity's current data; a null inside clears a field.

Parameters

Returns Task<LiveActivityResult>

LiveActivityBuilderCopy Anchor Link

class Inverge.Nexus.Builders.LiveActivityBuilder

Composes a Live Activity's data (or content state) and audience, then starts, updates or ends it.

Template-only setters (Step, EtaAt, Value, Canceled, …) send template data, which the server merges on update. On their own, Progress and the texts keep sending a plain contentState for your own widget.

Alert()Copy Anchor Link

LiveActivityBuilder Alert(string title, string? body = null)

The iOS alert shown with the start. Start only.

Parameters

Returns LiveActivityBuilder

Attributes()Copy Anchor Link

LiveActivityBuilder Attributes(object attributes)

Sets fixed attributes, read once when the activity starts.

On iOS these are ActivityKit's static attributes: they cannot be changed by a later update, so anything that will change belongs in the content state.

Parameters

Returns LiveActivityBuilder

Body()Copy Anchor Link

LiveActivityBuilder Body(string value)

Sets the activity's body text.

Parameters

Returns LiveActivityBuilder

Canceled()Copy Anchor Link

LiveActivityBuilder Canceled()

Shows the canceled state.

Returns LiveActivityBuilder

Data()Copy Anchor Link

LiveActivityBuilder Data(object data)

Merges raw template data (step, state, progress, etaAt, values).

Parameters

Returns LiveActivityBuilder

DismissAt()Copy Anchor Link

LiveActivityBuilder DismissAt(DateTimeOffset when)

When iOS should remove the ended activity. End only.

Parameters

Returns LiveActivityBuilder

Done()Copy Anchor Link

LiveActivityBuilder Done()

Shows the finished state.

Returns LiveActivityBuilder

EndAsync()Copy Anchor Link

Task<LiveActivityResult> EndAsync(CancellationToken cancellationToken = default)

Ends the activity, with an optional final state.

Parameters

Returns Task<LiveActivityResult>

Eta()Copy Anchor Link

LiveActivityBuilder Eta(string text)

A fixed ETA text instead of a countdown, e.g. "8 min".

Parameters

Returns LiveActivityBuilder

EtaAt()Copy Anchor Link

LiveActivityBuilder EtaAt(DateTimeOffset at)

The arrival time — the device shows a live countdown with no further pushes.

Parameters

Returns LiveActivityBuilder

EtaAt()Copy Anchor Link

LiveActivityBuilder EtaAt(long unixTime)

The arrival time as unix seconds (milliseconds are detected and converted).

Parameters

Returns LiveActivityBuilder

Lang()Copy Anchor Link

LiveActivityBuilder Lang(string lang)

Forces one language for every recipient. Start only; default: each device's own.

Parameters

Returns LiveActivityBuilder

Priority()Copy Anchor Link

LiveActivityBuilder Priority(int priority)

Sets the APNs priority: 5 is routine and unmetered, 10 is immediate and metered against your Live Activity budget.

Parameters

Returns LiveActivityBuilder

Progress()Copy Anchor Link

LiveActivityBuilder Progress(double value)

Sets progress, 0.0–1.0 (or 0–100). Templated: toward the next step or along the bar.

Parameters

Returns LiveActivityBuilder

Set()Copy Anchor Link

LiveActivityBuilder Set(string key, object? value)

Sets any content-state field.

Parameters

Returns LiveActivityBuilder

Shared()Copy Anchor Link

LiveActivityBuilder Shared()

Makes this a shared activity that many people watch — a match, a launch, an incident — rather than one person's order.

Returns LiveActivityBuilder

StaleAt()Copy Anchor Link

LiveActivityBuilder StaleAt(DateTimeOffset when)

Marks the activity stale after this time, so the UI can dim it.

Parameters

Returns LiveActivityBuilder

StartAsync()Copy Anchor Link

Task<LiveActivityResult> StartAsync(CancellationToken cancellationToken = default)

Starts the activity.

Parameters

Returns Task<LiveActivityResult>

State()Copy Anchor Link

LiveActivityBuilder State(object state)

Merges several content-state fields at once.

Parameters

Returns LiveActivityBuilder

Status()Copy Anchor Link

LiveActivityBuilder Status(string value)

Sets the activity's status line.

Parameters

Returns LiveActivityBuilder

Step()Copy Anchor Link

LiveActivityBuilder Step(string step)

The current step — a step id or label of the template.

Parameters

Returns LiveActivityBuilder

Subtitle()Copy Anchor Link

LiveActivityBuilder Subtitle(string value)

Sets the activity's subtitle.

Parameters

Returns LiveActivityBuilder

Title()Copy Anchor Link

LiveActivityBuilder Title(string value)

Sets the activity's title.

Parameters

Returns LiveActivityBuilder

ToUser()Copy Anchor Link

LiveActivityBuilder ToUser(string distinctId)

Targets one person. Start only.

Parameters

Returns LiveActivityBuilder

ToUsers()Copy Anchor Link

LiveActivityBuilder ToUsers(IEnumerable<string> distinctIds)

Targets specific people. Start only.

Parameters

Returns LiveActivityBuilder

UpdateAsync()Copy Anchor Link

Task<LiveActivityResult> UpdateAsync(CancellationToken cancellationToken = default)

Pushes the change to every device showing the activity — templated: partial data, merged server-side; plain: the new content state.

Parameters

Returns Task<LiveActivityResult>

Value()Copy Anchor Link

LiveActivityBuilder Value(string key, object? value)

One value for the template's {{placeholder}}.

Parameters

Returns LiveActivityBuilder

Values()Copy Anchor Link

LiveActivityBuilder Values(object values)

Several placeholder values at once (an anonymous object or a dictionary).

Parameters

Returns LiveActivityBuilder