Send feedback
firebase_functions.alerts_fn module
Stay organized with collections
Save and categorize content based on your preferences.
Cloud functions to handle events from Firebase Alerts.
Classes
AlertEvent class firebase_functions.alerts_fn. AlertEvent ( specversion : str , id : str , source : str , type : str , time : datetime , data : T , subject : str | None , alert_type : str , app_id : str | None )
Bases: CloudEvent
[T
]
A custom CloudEvent for Firebase Alerts (with custom extension attributes).
alert_type : str
The type of the alerts that got triggered.
app_id : str | None
The Firebase App ID that's associated with the alert. This is optional,
and only present when the alert is targeting a specific Firebase App.
Functions
on_alert_published firebase_functions.alerts_fn. on_alert_published ( ** kwargs ) → Callable[ [ Callable[ [ AlertEvent [ FirebaseAlertData[ T] ] ] , None] ] , Callable[ [ AlertEvent [ FirebaseAlertData[ T] ] ] , None] ]
Event handler that triggers when a Firebase Alerts event is published.
Example:
from firebase_functions import alerts_fn
@alerts_fn . on_alert_published (
alert_type = alerts_fn . AlertType . CRASHLYTICS_NEW_FATAL_ISSUE ,
)
def example ( alert : alerts_fn . AlertEvent [ alerts_fn . FirebaseAlertData ]) -> None :
print ( alert )
Parameters:
**kwargs (as firebase_functions.options.FirebaseAlertOptions
) -- Options.
Return type:
typing.Callable
[ [ firebase_functions.alerts_fn.AlertEvent
[
firebase_functions.alerts_fn.FirebaseAlertData
[
typing.Any
] ] ], None ]
A function that takes a AlertEvent and returns None.
Constants
OnAlertPublishedCallable firebase_functions.alerts_fn. OnAlertPublishedCallable
The type of the callable for 'on_alert_published' functions.
alias of Callable
[[AlertEvent
[FirebaseAlertData
[T
]]], None
]
OnAlertPublishedEvent firebase_functions.alerts_fn. OnAlertPublishedEvent
The type of the event for 'on_alert_published' functions.
alias of AlertEvent
[FirebaseAlertData
[T
]]
Send feedback
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-11-06 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-11-06 UTC."],[],[]]