Push

// access
nexus.push

NexusPushCopy Anchor Link

Push notifications. Send transactional push to users or segments; campaigns, provider credentials, segments and templates are managed in the console.

Prefer the fluent builder: nexus.push.notification().title('…').setSegments(['vip']).send().

NexusPushCopy Anchor Link

new NexusPush(http: NexusHttp, id: NexusIdentity)

Parameters

Returns NexusPush

notification()Copy Anchor Link

notification(): NexusPushBuilder

Start a fluent push notification.

Returns NexusPushBuilder

send()Copy Anchor Link

send(distinctIds: string[], message: PushMessage): Promise<PushSendResult>

Send a plain notification to specific users (by distinctId).

Parameters

Returns Promise<PushSendResult>

sendToUser()Copy Anchor Link

sendToUser(distinctId: string, message: PushMessage): Promise<PushSendResult>

Parameters

Returns Promise<PushSendResult>

sendRaw()Copy Anchor Link

async sendRaw(payload: Record<string, unknown>): Promise<PushSendResult>

Send a fully-assembled payload (title + targeting). Used by the builder.

Parameters

Returns Promise<PushSendResult>

registerToken()Copy Anchor Link

async registerToken(token: string, platform: 'ios' | 'android' | 'web', options: { provider?: string; distinctId?: string; deviceKey?: string; appVersion?: string; osType?: string; osVersion?: string; lang?: string; tags?: Record<string, string>; } = {}): Promise<void>

Register (or refresh) a device token. Normally the client SDK does this.

Parameters

unregister()Copy Anchor Link

async unregister(token: string): Promise<void>

Parameters

NexusPushBuilderCopy Anchor Link

Fluent builder for a transactional push.

NexusPushBuilderCopy Anchor Link

new NexusPushBuilder(http: NexusHttp)

Parameters

Returns NexusPushBuilder

title()Copy Anchor Link

title(v: string): this

Parameters

Returns this

body()Copy Anchor Link

body(v: string): this

Parameters

Returns this

image()Copy Anchor Link

image(url: string): this

Parameters

Returns this

data()Copy Anchor Link

data(data: Record<string, unknown>): this

Parameters

Returns this

button()Copy Anchor Link

button(id: string, text: string, opts: Omit<PushActionButton, 'id' | 'text'> = {}): this

Parameters

Returns this

iosBadge()Copy Anchor Link

iosBadge(count: number): this

Parameters

Returns this

iosInterruptionLevel()Copy Anchor Link

iosInterruptionLevel(level: PushOptions['iosInterruptionLevel']): this

Parameters

Returns this

androidVisibility()Copy Anchor Link

androidVisibility(v: PushOptions['androidVisibility']): this

Parameters

Returns this

androidLargeIcon()Copy Anchor Link

androidLargeIcon(url: string): this

Parameters

Returns this

androidBigPicture()Copy Anchor Link

androidBigPicture(url: string): this

Parameters

Returns this

option()Copy Anchor Link

option(key: string, value: unknown): this

Set any option field directly.

Parameters

Returns this

options()Copy Anchor Link

options(options: PushOptions): this

Parameters

Returns this

toUsers()Copy Anchor Link

toUsers(distinctIds: string[]): this

Parameters

Returns this

toUser()Copy Anchor Link

toUser(distinctId: string): this

Parameters

Returns this

setSegments()Copy Anchor Link

setSegments(segmentIds: string[]): this

Target saved segments (union). toSegments is an alias.

Parameters

Returns this

toSegments()Copy Anchor Link

toSegments(segmentIds: string[]): this

Parameters

Returns this

toSegment()Copy Anchor Link

toSegment(segmentId: string): this

Parameters

Returns this

where()Copy Anchor Link

where(filter: Record<string, unknown>): this

Ad-hoc device filter (platform, lang, osType, appVersion, lastSeenDays, tags).

Parameters

Returns this

toAll()Copy Anchor Link

toAll(): this

Everyone (overrides other targets).

Returns this

send()Copy Anchor Link

async send(): Promise<PushSendResult>

Deliver the notification.

Returns Promise<PushSendResult>

PushMessageCopy Anchor Link

titleCopy Anchor Link

title: string

bodyCopy Anchor Link

body?: string

imageUrlCopy Anchor Link

imageUrl?: string

dataCopy Anchor Link

data?: Record<string, unknown>

optionsCopy Anchor Link

options?: PushOptions

PushOptionsCopy Anchor Link

Rich per-platform options — same fields as the console composer.

buttonsCopy Anchor Link

buttons?: PushActionButton[]

androidLargeIconCopy Anchor Link

androidLargeIcon?: string

androidBigPictureCopy Anchor Link

androidBigPicture?: string

androidSmallIconCopy Anchor Link

androidSmallIcon?: string

androidVisibilityCopy Anchor Link

androidVisibility?: 'public' | 'private' | 'secret'

androidAccentColorCopy Anchor Link

androidAccentColor?: string

iosBadgeCopy Anchor Link

iosBadge?: number

iosRelevanceScoreCopy Anchor Link

iosRelevanceScore?: number

iosInterruptionLevelCopy Anchor Link

iosInterruptionLevel?: 'passive' | 'active' | 'time-sensitive' | 'critical'

iosSubtitleCopy Anchor Link

iosSubtitle?: string

webIconCopy Anchor Link

webIcon?: string

webImageCopy Anchor Link

webImage?: string

webBadgeCopy Anchor Link

webBadge?: string

PushActionButtonCopy Anchor Link

idCopy Anchor Link

id: string

textCopy Anchor Link

text: string

actionCopy Anchor Link

action?: 'dismiss' | 'url' | 'event'

urlCopy Anchor Link

url?: string

eventCopy Anchor Link

event?: string

iconCopy Anchor Link

icon?: string

styleCopy Anchor Link

style?: string

PushSendResultCopy Anchor Link

sentCopy Anchor Link

sent: number

failedCopy Anchor Link

failed: number

recipientsCopy Anchor Link

recipients?: number