Push

// access
$nexus->push()

PushCopy Anchor Link

class Inverge\Nexus\Resource\Push

Push notifications. Server-side you mainly send transactional notifications to users or segments; campaigns, provider credentials, segments and templates are managed in the Nexus console. Delivered via FCM / APNs / Web Push.

Prefer the fluent builder for anything beyond a plain send: $nexus->push()->notification()->title('…')->setSegments(['vip'])->send();

__constructCopy Anchor Link

function __construct(Inverge\Nexus\NexusClient $client)

Parameters

notification()Copy Anchor Link

function notification(): Inverge\Nexus\Push\PushBuilder

Start a fluent push notification. */

Returns Inverge\Nexus\Push\PushBuilder

send()Copy Anchor Link

function send(array $distinctIds, array $message): array

Send a transactional push to one or more users (by distinctId), delivered across each user's registered devices.

$message:

• title (string, required)
• body, imageUrl (string)
• data (array<string,mixed>) — custom key/values delivered to the app
• options (array) — rich per-platform options: buttons, androidLargeIcon, androidBigPicture, androidVisibility, iosBadge, iosRelevanceScore, iosInterruptionLevel, webIcon, … (see the console composer).

Parameters

Returns array<mixed> — { sent, failed }

sendRaw()Copy Anchor Link

function sendRaw(array $payload): array

Send a fully-assembled payload (title + targeting: distinctIds / segmentIds / filter / all). Used by the builder; call it directly if you prefer.

Parameters

Returns array<mixed> — { sent, failed, recipients }

sendToUser()Copy Anchor Link

function sendToUser(string $distinctId, array $message): array

Send the same notification to a single user.

Parameters

Returns array<mixed>

registerToken()Copy Anchor Link

function registerToken(string $token, string $platform, array $options = []): array

Register (or refresh) a device token. Normally the client SDK does this; exposed for server-driven / BYO-token flows.

Parameters

Returns array<mixed>

unregister()Copy Anchor Link

function unregister(string $token): array

Stop delivering to a device token (e.g. on logout / uninstall).

Parameters

Returns array<mixed>

PushBuilderCopy Anchor Link

class Inverge\Nexus\Push\PushBuilder

Fluent builder for a transactional push. Compose content, rich per-platform options and the audience, then send().

$nexus->push()->notification()
    ->title('Your order shipped')
    ->body('Track it in the app')
    ->data(['screen' => '/orders/42'])
    ->button('track', 'Track', ['url' => 'https://x/track'])
    ->iosBadge(1)
    ->androidVisibility('public')
    ->setSegments(['vip', 'active_7d'])   // or ->toUsers([...]) / ->toAll()
    ->send();                              // → ['sent' => .., 'failed' => .., 'recipients' => ..]

__constructCopy Anchor Link

function __construct(Inverge\Nexus\NexusClient $client)

Parameters

title()Copy Anchor Link

function title(string $title): self

Parameters

Returns self

body()Copy Anchor Link

function body(string $body): self

Parameters

Returns self

image()Copy Anchor Link

function image(string $url): self

Parameters

Returns self

data()Copy Anchor Link

function data(array $data): self

Custom key/values delivered to the app (merged with any prior data).

Parameters

Returns self

button()Copy Anchor Link

function button(string $id, string $text, array $opts = []): self

Add an action button. $opts: url, event, icon, style (primary|secondary|text).

Parameters

Returns self

iosBadge()Copy Anchor Link

function iosBadge(int $count): self

Parameters

Returns self

iosRelevanceScore()Copy Anchor Link

function iosRelevanceScore(float $score): self

Parameters

Returns self

iosInterruptionLevel()Copy Anchor Link

function iosInterruptionLevel(string $level): self

Parameters

Returns self

iosSubtitle()Copy Anchor Link

function iosSubtitle(string $subtitle): self

Parameters

Returns self

androidVisibility()Copy Anchor Link

function androidVisibility(string $visibility): self

Android lockscreen visibility: public | private | secret. */

Parameters

Returns self

androidLargeIcon()Copy Anchor Link

function androidLargeIcon(string $url): self

Parameters

Returns self

androidBigPicture()Copy Anchor Link

function androidBigPicture(string $url): self

Parameters

Returns self

androidAccentColor()Copy Anchor Link

function androidAccentColor(string $color): self

Parameters

Returns self

option()Copy Anchor Link

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

Set any option field directly (escape hatch). */

Parameters

Returns self

options()Copy Anchor Link

function options(array $options): self

Merge multiple options at once.

Parameters

Returns self

toUsers()Copy Anchor Link

function toUsers(array $distinctIds): self

Target specific users by distinctId.

Parameters

Returns self

toUser()Copy Anchor Link

function toUser(string $distinctId): self

Parameters

Returns self

setSegments()Copy Anchor Link

function setSegments(array $segmentIds): self

Target saved segments (union). setSegments / toSegments are aliases.

Parameters

Returns self

toSegments()Copy Anchor Link

function toSegments(array $segmentIds): self

Parameters

Returns self

toSegment()Copy Anchor Link

function toSegment(string $segmentId): self

Parameters

Returns self

where()Copy Anchor Link

function where(array $filter): self

Target an ad-hoc device filter (platform, lang, osType, appVersion, lastSeenDays, tags).

Parameters

Returns self

toAll()Copy Anchor Link

function toAll(): self

Target every subscribed device (overrides other targets). Use with care. */

Returns self

send()Copy Anchor Link

function send(): array

Deliver the notification.

Returns array<mixed> — { sent, failed, recipients }

toArray()Copy Anchor Link

function toArray(): array

The assembled request payload (without sending) — handy for testing.

Returns array<string, — mixed>