Live Activities

// access
$nexus->liveActivities()

LiveActivitiesCopy Anchor Link

class Inverge\Nexus\Resource\LiveActivities

Live Activities — a live, updating view of an in-progress event on the iOS Lock Screen / Dynamic Island and as an Android live notification. This is the classic server-side use case: your backend starts an activity when an order / ride / match begins, updates it as the status changes, and ends it when done.

Templated (recommended) — design it once in the Nexus console; the mobile SDKs render it on iOS + Android in each device's language, and you send only data: $nexus->liveActivities()->template('order_tracking', 'order_42')->step('pending')->etaAt($eta)->value('driver', 'Ahmed')->toUser('u_1')->start(); then $nexus->liveActivities()->activity('order_42')->step('arrived')->update();

Plain (your own iOS widget): $nexus->liveActivities()->activity('DeliveryAttributes', 'order_42')->status('Preparing')->progress(20)->toUser('u_1')->start();

__constructCopy Anchor Link

function __construct(Inverge\Nexus\NexusClient $client)

Parameters

activity()Copy Anchor Link

function activity(string $activityTypeOrId, ?string $activityId = NULL): Inverge\Nexus\LiveActivity\LiveActivityBuilder

Start a fluent Live Activity. Pass $activityType to start(); for update() / end() it may be omitted.

Parameters

Returns Inverge\Nexus\LiveActivity\LiveActivityBuilder

template()Copy Anchor Link

function template(array|string $template, string $activityId): Inverge\Nexus\LiveActivity\LiveActivityBuilder

A templated activity: $template is a template key from the Nexus console (e.g. 'order_tracking') or an inline design array.

Parameters

Returns Inverge\Nexus\LiveActivity\LiveActivityBuilder

startTemplate()Copy Anchor Link

function startTemplate(array|string $template, string $activityId, array $data = [], array $options = []): array

Start a templated activity. $data: step, state, progress (0–1), etaAt (unix seconds), values (for the template's {{placeholders}}). Each device gets its own language unless lang forces one.

Parameters

Returns array<mixed> — { ios, android, iosTargets, iosWarning? }

updateData()Copy Anchor Link

function updateData(string $activityId, array $data, array $options = []): array

Update a templated activity with partial data — merged server-side (a null inside $data clears that field).

Parameters

Returns array<mixed> — { ios, android }

start()Copy Anchor Link

function start(string $activityType, string $activityId, array $contentState, array $options = []): array

Start a live activity. Omit distinctIds for a shared activity (many users watching the same event); pass them to target specific users/orders.

Parameters

Returns array<mixed> — { ios, android } — devices reached

update()Copy Anchor Link

function update(string $activityId, array $contentState, array $options = []): array

Push a new content state to every device on this activity. Use priority 5 for routine (unmetered) updates, 10 for immediate (metered).

Parameters

Returns array<mixed> — { ios, android }

end()Copy Anchor Link

function end(string $activityId, array $options = []): array

End the activity. Optionally pass a final contentState (templated: final data, e.g. ['step' => 'completed']) and a dismissalDate (ISO-8601) controlling when iOS removes it.

Parameters

Returns array<mixed> — { ios, android }

registerPushToStartToken()Copy Anchor Link

function registerPushToStartToken(string $activityType, string $token, array $options = []): array

Register an iOS push-to-start token (normally the client SDK does this).

Parameters

Returns array<mixed>

registerActivity()Copy Anchor Link

function registerActivity(string $activityId, string $activityType, array $options = []): array

Register a running activity instance's update token (client-side; exposed for BYO integrations).

Parameters

Returns array<mixed>

event()Copy Anchor Link

function event(string $activityId, string $type, array $options = []): array

Report a delivery receipt / click / failure for analytics.

Parameters

Returns array<mixed>

LiveActivityBuilderCopy Anchor Link

class Inverge\Nexus\LiveActivity\LiveActivityBuilder

Fluent builder for a Live Activity. Compose the data / content-state and targeting, then start(), update(), or end().

Templated (recommended) — template-only setters (step, etaAt, value, canceled, …) send data, merged server-side on update:

$nexus->liveActivities()->template('order_tracking', 'order_42')
    ->step('pending')->etaAt(new DateTimeImmutable('+25 minutes'))
    ->values(['driver' => 'Ahmed'])->toUser('user_1')
    ->start();

$nexus->liveActivities()->activity('order_42')->step('arrived')->update();
$nexus->liveActivities()->activity('order_42')->step('completed')->end();

Plain (your own iOS widget) — progress() and the texts on their own keep sending a contentState:

$nexus->liveActivities()->activity('DeliveryAttributes', 'order_42')
    ->title('Order #42')->status('Preparing')->progress(20)
    ->toUsers(['user_1'])->priority(10)
    ->start();

$nexus->liveActivities()->activity('order_42')
    ->status('On the way')->progress(70)->priority(5)->update();

$nexus->liveActivities()->activity('order_42')->status('Delivered')->end();

__constructCopy Anchor Link

function __construct(Inverge\Nexus\NexusClient $client, string $activityId, ?string $activityType = NULL, array|string|null $template = NULL)

Parameters

step()Copy Anchor Link

function step(string $step): self

The current step (a step id or label of the template). */

Parameters

Returns self

etaAt()Copy Anchor Link

function etaAt(DateTimeInterface|int|float $at): self

Arrival time → a live countdown on the device (DateTime, unix seconds or ms). */

Parameters

Returns self

eta()Copy Anchor Link

function eta(string $text): self

A fixed ETA text instead of a countdown, e.g. '8 min'. */

Parameters

Returns self

value()Copy Anchor Link

function value(string $key, string|int|float|bool $value): self

One {{placeholder}} value. */

Parameters

Returns self

values()Copy Anchor Link

function values(array $values): self

Parameters

Returns self

canceled()Copy Anchor Link

function canceled(): self

Show the canceled state. */

Returns self

done()Copy Anchor Link

function done(): self

Show the finished state. */

Returns self

data()Copy Anchor Link

function data(array $data): self

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

Parameters

Returns self

lang()Copy Anchor Link

function lang(string $lang): self

Start only: force one language for every recipient (default: each device's own). */

Parameters

Returns self

alert()Copy Anchor Link

function alert(string $title, ?string $body = NULL): self

Start only: the iOS alert shown with the start. */

Parameters

Returns self

title()Copy Anchor Link

function title(string $v): self

Parameters

Returns self

subtitle()Copy Anchor Link

function subtitle(string $v): self

Parameters

Returns self

body()Copy Anchor Link

function body(string $v): self

Parameters

Returns self

status()Copy Anchor Link

function status(string $v): self

Parameters

Returns self

progress()Copy Anchor Link

function progress(int|float $v): self

Progress, 0.0–1.0 (or 0–100). Templated: toward the next step / along the bar. */

Parameters

Returns self

set()Copy Anchor Link

function set(string $key, mixed $value): self

Set any content-state field. */

Parameters

Returns self

state()Copy Anchor Link

function state(array $state): self

Merge multiple content-state fields.

Parameters

Returns self

toUsers()Copy Anchor Link

function toUsers(array $distinctIds): self

Target specific users (per-user/order activity). Omit for a shared activity.

Parameters

Returns self

toUser()Copy Anchor Link

function toUser(string $distinctId): self

Parameters

Returns self

shared()Copy Anchor Link

function shared(): self

A shared activity — everyone who registered (a match, a launch, an incident). */

Returns self

attributes()Copy Anchor Link

function attributes(array $attributes): self

Fixed attributes set at start (iOS ActivityKit).

Parameters

Returns self

priority()Copy Anchor Link

function priority(int $priority): self

APNs priority: 5 = routine (unmetered), 10 = immediate (metered). */

Parameters

Returns self

staleAt()Copy Anchor Link

function staleAt(string $iso): self

ISO-8601 — mark the activity stale after this time. */

Parameters

Returns self

dismissAt()Copy Anchor Link

function dismissAt(string $iso): self

ISO-8601 — when iOS should remove the activity (end only). */

Parameters

Returns self

start()Copy Anchor Link

function start(): array

Start the activity.

Returns array<mixed> — { ios, android }

update()Copy Anchor Link

function update(): array

Push a new content-state.

Returns array<mixed> — { ios, android }

end()Copy Anchor Link

function end(): array

End the activity (with an optional final content-state and dismissal time).

Returns array<mixed> — { ios, android }