[PAID] FCM: Send and Receive Push Notifications with Firebase Cloud Messaging [$10 or INR 701]

vknow360 · October 30, 2023, 3:46pm

1.Introduction

Description: Using this extension you can send and receive Push Notifications with FCM's latest SDK (23.3.0).
Latest Version: 1.3
Released: 2023-10-29T18:30:00Z
Last Updated: 2024-02-05T18:30:00Z
Aix size: 476 kb

2. Blocks

3. Docs

Events

MessageReceived	Event raised when message is received. No notification is shown for messages. _{data \| dictionary}
NotificationReceived	Event raised when notification is received while app is in foreground. A notification is shown to user in system tray. _{id \| text title \| text body \| text data \| dictionary}
SubscribeSuccessful	Event raised if subscribe was successful _{topic \| text}
UnsubscribeSuccessful	Event raised if unsubscribe was successful _{topic \| text}
ErrorOccurred	Event raised whenever an error occurrs. Most of the methods raise this event in case of error. _{errorMsg \| text}
GotToken	Event raised after getting FCM token _{token \| text}
NotificationSent	Event raised after notification has been sent to FCM server _{successful \| boolean response \| dictionary}
MessageSent	Event raised after message has been sent to FCM server _{successful \| boolean response \| dictionary}
GotData	Event raised when current screen has been opened by clicking notification. This event is raised automatically. _{data \| dictionary}

Methods

AskNotificationPermission	Asks notification permission which is required on Android 13 and above
ClearNotification	Clear notification from system tray _{id \| number}
Init	Initialize Firebase Messaging Client with provided credentials. You need to call this method only once and then extension will auto init client itself. _{projectId \| text apiKey \| text appId \| text senderId \| text}
IsInitialized	Returns whether FCM has been initialized or not
Subscribe	Subscribe to given topic to receive notifications _{topic \| text}
RegisterForNotifClick	Registers screen which will be opened when user clicks on notification which is shown while app is in foreground. Notifications which are shown when app is not opened, will always open Screen1. _{screen \| text startValue \| text}
RetrieveData	Retrieve notification's data which opened current screen.Response is Dictionary.
Unsubscribe	Unsubscribe from the given topic _{topic \| text}
GetToken	Gets user's FCM token which can be used to send individual notifications
SendNotificationToTopic	Send notification to topic. 'largeIcon' argument is optional. _{topic \| text serverKey \| text title \| text body \| text largeIcon \| text data \| dictionary}
SendMessageToTopic	Send message to topic. _{topic \| text serverKey \| text data \| dictionary}
SendNotificationToTokens	Send notification to token(s) _{tokens \| list serverKey \| text title \| text body \| text largeIcon \| text data \| dictionary}
SendMessageToTokens	Send message to tokens _{tokens \| list serverKey \| text data \| dictionary}
SendCustomNotification	Send notification or message with given json content _{serverKey \| text jsonNotif \| text}

Properties

Importance	Sets importance of notification channel Property Type : write-only Accepts : text
SoundOn	Sets whether to enable sound for notification channel or not Property Type : write-only Accepts : boolean
SmallIcon	Sets small icon shown in notification. If not specified then app's icon is shown. Property Type : write-only Accepts : text

4. Usages

First initialize FCM Client. You need to call Init method once and next time it would be auto initialized.

Ask for notification permission

Required on Android 13 and above

Now subscribe to a topic

If subscription was successful then you can send a notification/message to users who have subscribed to topic

Server key is located at Project Settings > Cloud Messaging
Enabled legacy version from GCloud console to obtain it.

You can send notifications/messages to token(s) also

User receives notifications and clicks on it
There can be two scenarios here:-

App in foreground ie. being used by user
Notification will open registered screen.

GotData even will be raised upon screen initialization if screen opened through notification.

You can obtain data from RetrieveData method also.

App not opened by user.
Notification click will open Screen1 always and GotData event will be raised.

Retrieve all received messages

5. Purchase

Paypal:

UPI:
vknow360@apl

6. Demo

7. Updates

ChangeLog Version 1.1

[PAID] FCM: Send and Receive Push Notifications with Firebase Cloud Messaging [$10 or INR 701] - #3 by vknow360

ChangeLog Version 1.2

[PAID] FCM: Send and Receive Push Notifications with Firebase Cloud Messaging [$10 or INR 701] - #4 by vknow360

ChangeLog Version 1.3

[PAID] FCM: Send and Receive Push Notifications with Firebase Cloud Messaging [$10 or INR 701] - #5 by vknow360

Thank you.
Hope it helps!

vknow360 · October 31, 2023, 4:33am

Setup video:

vknow360 · November 9, 2023, 3:54pm

ChangeLog Version 1.1

Added ClearNotification block
Added feature to store all messages in Tiny DB with tag as timestamp
Set namespace to FCM_DATA to retrieve those messages

image889×364 27.1 KB
Fixed inconsistency in SendNotificationToTokens and SendMessageToTokens blocks
Some internal changes to make future improvements easier to adapt

vknow360 · November 26, 2023, 4:03pm

ChangeLog Version 1.2

Removed SoundOn property
Custom Notification sound feature
Beta tested by @Franklin_Lopez

To send a notification with custom sound, upload mp3 file to assets and send payload like this:

{\"notification\": {\"body\": \"this is a body\", \"default\": \"this is a title\", \"sound2\":\"default\",\"icon\":\"https://res.cloudinary.com/andromedaviewflyvipul/image/upload/c_scale,h_20,w_20/v1571472765/ktvu4bapylsvnykoyhdm.png\"},\n    \"priority\": \"high\",\n    \"data\": {\n      \"click_action\": \"FCM_MESSAGE\",\n      \"id\": \"1\",\n      \"status\": \"done\"\n    },\n    \"to\": \"/topics/FCMTEST\""}

Value for sound2 key can be file name ( like test for test.mp3 ) or none for no sound or default for default notification sound.
This key must be present in notification payload otherwise no sound will be played.

Aix size is 500 kb now.

vknow360 · February 6, 2024, 2:09pm

ChangeLog Version 1.3

Compatible with FSA extension
Tested by @Franklin_Lopez
Aix size reduced to 476 kb