Class PushAdminPromise

Enables the management of device registrations and push notification subscriptions. Also enables the publishing of push notifications to devices.

Hierarchy

PushAdminPromise

Index

Constructors

Properties

channelSubscriptions deviceRegistrations

Methods

Constructors

constructor

new PushAdminPromise(): PushAdminPromise
Returns PushAdminPromise

Properties

channelSubscriptions

channelSubscriptions: PushChannelSubscriptionsPromise

A PushChannelSubscriptionsPromise object.

deviceRegistrations

deviceRegistrations: PushDeviceRegistrationsPromise

A PushDeviceRegistrationsPromise object.

Methods

publish

publish(recipient: any, payload: any): Promise<void>
Sends a push notification directly to a device, or a group of devices sharing the same clientId.

Returns

A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
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>
- Defined in ably.d.ts:3606

Generated using TypeDoc