alerts.AlertEvent interface
Stay organized with collections
Save and categorize content based on your preferences.
A custom CloudEvent for Firebase Alerts (with custom extension attributes).
Signature:
export interface AlertEvent<T> extends CloudEvent<FirebaseAlertData<T>>
Extends: CloudEvent<FirebaseAlertData<T>>
Properties
Property |
Type |
Description |
alertType |
string |
The type of the alerts that got triggered. |
appId |
string |
The Firebase App ID that’s associated with the alert. This is optional, and only present when the alert is targeting at a specific Firebase App. |
data |
FirebaseAlertData<T> |
Data for an AlertEvent is a FirebaseAlertData object with a given payload. |
alerts.AlertEvent.alertType
The type of the alerts that got triggered.
Signature:
alertType: string;
alerts.AlertEvent.appId
The Firebase App ID that’s associated with the alert. This is optional, and only present when the alert is targeting at a specific Firebase App.
Signature:
appId?: string;
alerts.AlertEvent.data
Data for an AlertEvent
is a FirebaseAlertData
object with a given payload.
Signature:
data: FirebaseAlertData<T>;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-04-18 UTC.
[null,null,["Last updated 2023-04-18 UTC."],[],[],null,["A custom CloudEvent for Firebase Alerts (with custom extension attributes).\n\n**Signature:** \n\n export interface AlertEvent\u003cT\u003e extends CloudEvent\u003cFirebaseAlertData\u003cT\u003e\u003e \n\n**Extends:** [CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[FirebaseAlertData](./firebase-functions.alerts.firebasealertdata.md#alertsfirebasealertdata_interface)\\\u003cT\\\u003e\\\u003e\n\nProperties\n\nalerts.AlertEvent.alertType\n\nThe type of the alerts that got triggered.\n\n**Signature:** \n\n alertType: string;\n\nalerts.AlertEvent.appId\n\nThe Firebase App ID that's associated with the alert. This is optional, and only present when the alert is targeting at a specific Firebase App.\n\n**Signature:** \n\n appId?: string;\n\nalerts.AlertEvent.data\n\nData for an `AlertEvent` is a `FirebaseAlertData` object with a given payload.\n\n**Signature:** \n\n data: FirebaseAlertData\u003cT\u003e;"]]