cordova-plugin-fcm-ng
Advanced tools
Extremely easy plug&play push notification plugin for Cordova applications with Google Firebase FCM.
cordova-android v7.1.4.logEvent, setUserId and setUserProperty) (only iOS).@ionic-native/fcm is not required any more. You need to install a new one FCMNGMake sure you have ‘google-services.json’ for Android or ‘GoogleService-Info.plist’ for iOS in your Cordova project root folder. You don´t need to configure anything else in order to have push notification working for both platforms, everything is magic.
cordova plugin add cordova-plugin-fcm-ng
Get the needed configuration files for Android or iOS from the Firebase Console (see docs: https://firebase.google.com/docs/).
Put the downloaded file 'google-services.json' in the Cordova project root folder.
You will need to ensure that you have installed the appropiate Android SDK libraries.
For Android >5.0 status bar icon, you must include transparent solid color icon with name fcm_push_icon.png in the 'res' folder in the same way you add the other application icons.
If you do not set this resource, then the SDK will use the default icon for your app which may not meet the standards for Android >5.0.
Put the downloaded file 'GoogleService-Info.plist' in the Cordova project root folder.
It's highly recommended to use REST API to send push notifications because Firebase console does not have all the functionalities. Pay attention to the payload example in order to use the plugin properly.
//FCMPluginNG.onTokenRefresh( onTokenRefreshCallback(token) );
//Note that this callback will be fired everytime a new token is generated, including the first time.
FCMPluginNG.onTokenRefresh(function(token){
alert( token );
});
//FCMPluginNG.getToken( successCallback(token), errorCallback(err) );
//Keep in mind the function will return null if the token has not been established yet.
FCMPluginNG.getToken(function(token){
alert(token);
});
//FCMPluginNG.subscribeToTopic( topic, successCallback(msg), errorCallback(err) );
//All devices are subscribed automatically to 'all' and 'ios' or 'android' topic respectively.
//Must match the following regular expression: "[a-zA-Z0-9-_.~%]{1,900}".
FCMPluginNG.subscribeToTopic('topicExample');
//FCMPluginNG.unsubscribeFromTopic( topic, successCallback(msg), errorCallback(err) );
FCMPluginNG.unsubscribeFromTopic('topicExample');
//FCMPluginNG.onNotification( onNotificationCallback(data), successCallback(msg), errorCallback(err) )
//Here you define your application behaviour based on the notification data.
FCMPluginNG.onNotification(function(data){
if(data.wasTapped){
//Notification was received on device tray and tapped by the user.
alert( JSON.stringify(data) );
}else{
//Notification was received in foreground. Maybe the user needs to be notified.
alert( JSON.stringify(data) );
}
});
Full documentation: https://firebase.google.com/docs/cloud-messaging/http-server-ref
//POST: https://fcm.googleapis.com/fcm/send
//HEADER: Content-Type: application/json
//HEADER: Authorization: key=AIzaSy*******************
{
"notification":{
"title":"Notification title",
"body":"Notification body",
"sound":"default",
"click_action":"FCM_PLUGIN_ACTIVITY",
"icon":"fcm_push_icon"
},
"data":{
"param1":"value1",
"param2":"value2"
},
"to":"/topics/topicExample",
"priority":"high",
"restricted_package_name":""
}
//sound: optional field if you want sound with the notification
//click_action: must be present with the specified value for Android
//icon: white icon resource name for Android >5.0
//data: put any "param":"value" and retreive them in the JavaScript notification callback
//to: device token or /topic/topicExample
//priority: must be set to "high" for delivering notifications on closed iOS apps
//restricted_package_name: optional field if you want to send only to a restricted app package (i.e: com.myapp.test)
Send a push notification to a single device or topic.
Every method returns a promise that fulfills when a call was successful.
Logs an app event.
FCMPluginNG.analytics.logEvent("my_event", {param1: "value1"});
Be aware of automatically collected events.
Sets the user ID property.
FCMPluginNG.setUserId("12345");
This feature must be used in accordance with Google's Privacy Policy.
Sets a user property to a given value.
FCMPluginNG.setUserProperty("name1", "value1");
The MIT License
Copyright (c) 2017 Felipe Echanique Torres (felipe.echanique in the gmail.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
FAQs
Google Firebase Cloud Messaging Cordova Plugin
The npm package cordova-plugin-fcm-ng receives a total of 65 weekly downloads. As such, cordova-plugin-fcm-ng popularity was classified as not popular.
We found that cordova-plugin-fcm-ng demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.