Class FirebaseMessagingAdapter

Implementation to send Firebase Cloud Messaging (FCM) notifications using firebase-admin.

Hierarchy (View Summary)

AbstractMessagingAdapter
- FirebaseMessagingAdapter

Implements

NotificationCapableAdapter

Index

Constructors

Properties

_messaging _params

Methods

_initializeFirebase sendNotification sendNotifications

Constructors

constructor

new FirebaseMessagingAdapter(
params?: MessagingParameters,
): FirebaseMessagingAdapter
Parameters
- params: MessagingParameters = {}
Returns FirebaseMessagingAdapter
Overrides AbstractMessagingAdapter.constructor
- Defined in messaging-firebase/src/FirebaseMessagingAdapter.ts:22

Properties

`Protected`_messaging

_messaging: any

`Protected`_params

_params: MessagingParameters = {}

Methods

`Protected`_initializeFirebase

_initializeFirebase(): void
Returns void
- Defined in messaging-firebase/src/FirebaseMessagingAdapter.ts:27

sendNotification

sendNotification(
recipient: MessagingRecipient,
message: NotificationMessage,
): Promise<string>
Sends a notification to a single recipient via Firebase Cloud Messaging
Parameters
- recipient: MessagingRecipient
  The message recipient containing contact info and FCM token
- message: NotificationMessage
  The notification message with title, body, and optional data
Returns Promise<string>
Promise - The Firebase message ID on successful delivery

Throws
Error if recipient has no message token or Firebase send fails
Implementation of NotificationCapableAdapter.sendNotification
- Defined in messaging-firebase/src/FirebaseMessagingAdapter.ts:56

sendNotifications

sendNotifications(
recipients: MessagingRecipient[],
message: NotificationMessage,
): Promise<{ failureCount: number; responses: any[]; successCount: number }>
Dispatches a batch push notification payload to multiple devices simultaneously.
Parameters
- recipients: MessagingRecipient[]
  Array of target contacts containing their FCM tokens.
- message: NotificationMessage
  The Notification schema.
Returns Promise<{ failureCount: number; responses: any[]; successCount: number }>
Response summarizing successful and failed deliveries.
Implementation of NotificationCapableAdapter.sendNotifications
- Defined in messaging-firebase/src/FirebaseMessagingAdapter.ts:97