notification

Notification

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• elements_notification_create_fcm_registration
• elements_notification_update_registration
• elements_notification_delete_fcm_registration

---

Back To Top

elements_notification_create_fcm_registration

Elements Operation: createFcmRegistration

Supplying FCM registration token, this function will create a new token based on the information supplied to the endpoint. The response will contain the token as it was written to the database. Clients may subsequently update the token string with new values as they are issued by Firebase.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_notification_create_fcm_registration(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsFCMRegistration	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsFCMRegistration
_request	ElementsRequest

---

Back To Top

elements_notification_update_registration

Elements Operation: updateRegistration

Supplying FCM registration token, this will update the token string with the supplied values. Clients may update the same registration with a different token issued with Firebase if they wish to simply retain the association with the

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_notification_update_registration(_fcm_registration_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_fcm_registration_id	String	The unique ID of the token stored in the database.
_body	ElementsFCMRegistration	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsFCMRegistration
_request	ElementsRequest

---

Back To Top

elements_notification_delete_fcm_registration

Elements Operation: deleteFCMRegistration

This function deletes the given FCM registration.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_notification_delete_fcm_registration(_fcm_registration_id, _callback=undefined)

Argument	Type	Description
_fcm_registration_id	String	The unique ID of the token stored in the database.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	Undefined
_request	ElementsRequest