Push

PushNotificationBuilderCopy Anchor Link

class Inverge.Nexus.Builders.PushNotificationBuilder

Composes a transactional push notification, then sends it.

Targeting is a union: users, segments and an ad-hoc filter combine. ToEveryone overrides all of them.

AndroidAccentColor()Copy Anchor Link

PushNotificationBuilder AndroidAccentColor(string color)

Sets the Android accent colour.

Parameters

Returns PushNotificationBuilder

AndroidBigPicture()Copy Anchor Link

PushNotificationBuilder AndroidBigPicture(string url)

Sets the Android big-picture image.

Parameters

Returns PushNotificationBuilder

AndroidLargeIcon()Copy Anchor Link

PushNotificationBuilder AndroidLargeIcon(string url)

Sets the Android large icon.

Parameters

Returns PushNotificationBuilder

AndroidVisibility()Copy Anchor Link

PushNotificationBuilder AndroidVisibility(string visibility)

Sets Android lock-screen visibility: public, private or secret.

Parameters

Returns PushNotificationBuilder

Body()Copy Anchor Link

PushNotificationBuilder Body(string body)

The notification body.

Parameters

Returns PushNotificationBuilder

Build()Copy Anchor Link

JsonObject Build()

The assembled payload, without sending. Useful in tests.

Returns JsonObject

Button()Copy Anchor Link

PushNotificationBuilder Button(string id, string text, string? url = null, string? event = null, string? icon = null, string? style = null)

Adds an action button.

Parameters

Returns PushNotificationBuilder

Data()Copy Anchor Link

PushNotificationBuilder Data(object data)

Custom key/values delivered to the app rather than displayed. Merged with anything set earlier.

Parameters

Returns PushNotificationBuilder

Image()Copy Anchor Link

PushNotificationBuilder Image(string url)

A large image to show in the expanded notification.

Parameters

Returns PushNotificationBuilder

IosBadge()Copy Anchor Link

PushNotificationBuilder IosBadge(int count)

Sets the iOS app badge count.

Parameters

Returns PushNotificationBuilder

IosInterruptionLevel()Copy Anchor Link

PushNotificationBuilder IosInterruptionLevel(string level)

Sets the iOS interruption level: passive, active, time-sensitive or critical.

time-sensitive and critical break through Focus modes and need an Apple entitlement; without it the notification is delivered at active instead.

Parameters

Returns PushNotificationBuilder

IosRelevanceScore()Copy Anchor Link

PushNotificationBuilder IosRelevanceScore(double score)

Sets the iOS relevance score, which orders notifications in a summary.

Parameters

Returns PushNotificationBuilder

IosSubtitle()Copy Anchor Link

PushNotificationBuilder IosSubtitle(string subtitle)

Sets the iOS subtitle line.

Parameters

Returns PushNotificationBuilder

Option()Copy Anchor Link

PushNotificationBuilder Option(string key, object? value)

Sets any option field directly — the escape hatch for a server option newer than this SDK.

Parameters

Returns PushNotificationBuilder

Options()Copy Anchor Link

PushNotificationBuilder Options(object options)

Merges several options at once.

Parameters

Returns PushNotificationBuilder

SendAsync()Copy Anchor Link

Task<PushSendResult> SendAsync(CancellationToken cancellationToken = default)

Sends the notification.

Parameters

Returns Task<PushSendResult>

Title()Copy Anchor Link

PushNotificationBuilder Title(string title)

The notification title. Required.

Parameters

Returns PushNotificationBuilder

ToEveryone()Copy Anchor Link

PushNotificationBuilder ToEveryone()

Targets every subscribed device, overriding the other targets.

This reaches your entire install base in one call. It is deliberately spelled out rather than implied by sending with no target.

Returns PushNotificationBuilder

ToSegment()Copy Anchor Link

PushNotificationBuilder ToSegment(string segmentId)

Targets one saved segment.

Parameters

Returns PushNotificationBuilder

ToSegments()Copy Anchor Link

PushNotificationBuilder ToSegments(IEnumerable<string> segmentIds)

Targets the union of saved segments.

Parameters

Returns PushNotificationBuilder

ToUser()Copy Anchor Link

PushNotificationBuilder ToUser(string distinctId)

Targets one person.

Parameters

Returns PushNotificationBuilder

ToUsers()Copy Anchor Link

PushNotificationBuilder ToUsers(IEnumerable<string> distinctIds)

Targets specific people, across every device each has registered.

Parameters

Returns PushNotificationBuilder

Where()Copy Anchor Link

PushNotificationBuilder Where(object filter)

Targets devices matching an ad-hoc filter: platform, lang, osType, appVersion, lastSeenDays, tags.

Parameters

Returns PushNotificationBuilder

PushResourceCopy Anchor Link

class Inverge.Nexus.Resources.PushResource

Push notifications — transactional sends to people, segments or filters.

Campaigns, provider credentials, segments and templates live in the console. This resource is for the one-off, event-driven sends your backend makes: "your order shipped", "someone replied to you".

Notification()Copy Anchor Link

PushNotificationBuilder Notification()

Starts a fluent notification — the recommended way to send.

Returns PushNotificationBuilder

OpenedAsync()Copy Anchor Link

Task<NexusAck> OpenedAsync(string campaignId, string token, CancellationToken cancellationToken = default)

Records that a notification was opened, which is what makes the console's open rates real.

Parameters

Returns Task<NexusAck>

RegisterTokenAsync()Copy Anchor Link

Task<NexusAck> RegisterTokenAsync(string token, string platform, string? provider = null, string? lang = null, IReadOnlyDictionary<string, string>? tags = null, NexusTelemetryContext? context = null, CancellationToken cancellationToken = default)

Registers or refreshes a device token.

The device SDKs normally do this themselves. Use it for server-driven and bring-your-own-token flows.

Parameters

Returns Task<NexusAck>

SendAsync()Copy Anchor Link

Task<PushSendResult> SendAsync(IEnumerable<string> distinctIds, string title, string? body = null, string? imageUrl = null, object? data = null, object? options = null, CancellationToken cancellationToken = default)

Sends to specific people, across every device each has registered.

Parameters

Returns Task<PushSendResult>

SendRawAsync()Copy Anchor Link

Task<PushSendResult> SendRawAsync(JsonObject payload, CancellationToken cancellationToken = default)

Sends a fully assembled payload — what the builder calls, and the escape hatch for a payload shape newer than this SDK.

Parameters

Returns Task<PushSendResult>

SendToSegmentsAsync()Copy Anchor Link

Task<PushSendResult> SendToSegmentsAsync(IEnumerable<string> segmentIds, string title, string? body = null, object? data = null, CancellationToken cancellationToken = default)

Sends to the union of saved segments.

Parameters

Returns Task<PushSendResult>

SendToUserAsync()Copy Anchor Link

Task<PushSendResult> SendToUserAsync(string distinctId, string title, string? body = null, string? imageUrl = null, object? data = null, object? options = null, CancellationToken cancellationToken = default)

Sends to one person.

Parameters

Returns Task<PushSendResult>

UnregisterAsync()Copy Anchor Link

Task<NexusAck> UnregisterAsync(string token, CancellationToken cancellationToken = default)

Stops delivering to a token — on logout or uninstall.

Parameters

Returns Task<NexusAck>