Interface PushAdmin

channelSubscriptions

deviceRegistrations

Experimental liveActivity

createApnsBroadcast

• createApnsBroadcast(options): Promise<PushApnsBroadcast>
• Experimental

  Creates an APNs broadcast channel for use with an iOS Live Activity. Call once before starting the Live Activity and persist the returned ids for the session.

  This is a preview feature and may change in a future non-major release.

  Parameters

  • options: PushApnsBroadcastOptions

    Options for the broadcast, including the messageStoragePolicy.

  Returns Promise<PushApnsBroadcast>

  A promise resolving to the broadcast { id, apnsChannelId }.

publish

• publish(recipient, payload): Promise<void>

• Sends a push notification directly to a device, or a group of devices sharing the same clientId.

  Parameters

  • recipient: any

    A JSON object containing the recipient details using clientId, deviceId or the underlying notifications service.

  • payload: any

    A JSON object containing the push notification payload.

  Returns Promise<void>

  A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.