Firebase Cloud Messaging for Flutter #

A Flutter plugin to use the Firebase Cloud Messaging (FCM) API.

With this plugin, your Flutter app can receive and process push notifications as well as data messages on Android and iOS. Read Firebase's About FCM Messages to learn more about the differences between notification messages and data messages.

For Flutter plugins for other Firebase products, see FlutterFire.md.

Note: This plugin is still under development, and some APIs might not be available yet. Feedback and Pull Requests are most welcome!

Usage #

To use this plugin, add firebase_messaging as a dependency in your pubspec.yaml file.

Getting Started #

Check out the example directory for a sample app using Firebase Cloud Messaging.

Android Integration #

To integrate your plugin into the Android part of your app, follow these steps:

Using the Firebase Console add an Android app to your project: Follow the assistant, download the generated google-services.json file and place it inside android/app. Next, modify the android/build.gradle file and the android/app/build.gradle file to add the Google services plugin as described by the Firebase assistant.
(optional, but recommended) If want to be notified in your app (via onResume and onLaunch, see below) when the user clicks on a notification in the system tray include the following intent-filter within the <activity> tag of your android/app/src/main/AndroidManifest.xml:

  <intent-filter>
      <action android:name="FLUTTER_NOTIFICATION_CLICK" />
      <category android:name="android.intent.category.DEFAULT" />
  </intent-filter>

iOS Integration #

To integrate your plugin into the iOS part of your app, follow these steps:

Generate the certificates required by Apple for receiving push notifications following this guide in the Firebase docs. You can skip the section titled "Create the Provisioning Profile".
Using the Firebase Console add an iOS app to your project: Follow the assistant, download the generated GoogleService-Info.plist file, open ios/Runner.xcworkspace with Xcode, and within Xcode place the file inside ios/Runner. Don't follow the steps named "Add Firebase SDK" and "Add initialization code" in the Firebase assistant.
In Xcode, select Runner in the Project Navigator. In the Capabilities Tab turn on Push Notifications and Background Modes, and enable Background fetch and Remote notifications under Background Modes.
Follow the steps in the "Upload your APNs certificate" section of the Firebase docs.

Dart/Flutter Integration #

From your Dart code, you need to import the plugin and instantiate it:

import 'package:firebase_messaging/firebase_messaging.dart';

final FirebaseMessaging _firebaseMessaging = FirebaseMessaging();

Next, you should probably request permissions for receiving Push Notifications. For this, call _firebaseMessaging.requestNotificationPermissions(). This will bring up a permissions dialog for the user to confirm on iOS. It's a no-op on Android. Last, but not least, register onMessage, onResume, and onLaunch callbacks via _firebaseMessaging.configure() to listen for incoming messages (see table below for more information).

Receiving Messages #

Messages are sent to your Flutter app via the onMessage, onLaunch, and onResume callbacks that you configured with the plugin during setup. Here is how different message types are delivered on the supported platforms:

	App in Foreground	App in Background	App Terminated
Notification on Android	`onMessage`	Notification is delivered to system tray. When the user clicks on it to open app `onResume` fires if `click_action: FLUTTER_NOTIFICATION_CLICK` is set (see below).	Notification is delivered to system tray. When the user clicks on it to open app `onLaunch` fires if `click_action: FLUTTER_NOTIFICATION_CLICK` is set (see below).
Notification on iOS	`onMessage`	Notification is delivered to system tray. When the user clicks on it to open app `onResume` fires.	Notification is delivered to system tray. When the user clicks on it to open app `onLaunch` fires.
Data Message on Android	`onMessage`	`onMessage` while app stays in the background.	not supported by plugin, message is lost
Data Message on iOS	`onMessage`	Message is stored by FCM and delivered to app via `onMessage` when the app is brought back to foreground.	Message is stored by FCM and delivered to app via `onMessage` when the app is brought back to foreground.

Additional reading: Firebase's About FCM Messages.

Sending Messages #

Refer to the Firebase documentation about FCM for all the details about sending messages to your app. When sending a notification message to an Android device, you need to make sure to set the click_action property of the message to FLUTTER_NOTIFICATION_CLICK. Otherwise the plugin will be unable to deliver the notification to your app when the users clicks on it in the system tray.

For testing purposes, the simplest way to send a notification is via the Firebase Console. Make sure to include click_action: FLUTTER_NOTIFICATION_CLICK as a "Custom data" key-value-pair (under "Advanced options") when targeting an Android device. The Firebase Console does not support sending data messages.

Alternatively, a notification or data message can be sent from a terminal:

DATA='{"notification": {"body": "this is a body","title": "this is a title"}, "priority": "high", "data": {"click_action": "FLUTTER_NOTIFICATION_CLICK", "id": "1", "status": "done"}, "to": "<FCM TOKEN>"}'
curl https://fcm.googleapis.com/fcm/send -H "Content-Type:application/json" -X POST -d "$DATA" -H "Authorization: key=<FCM SERVER KEY>"

Remove the notification property in DATA to send a data message.

5.0.4 #

Automatically use version from pubspec.yaml when reporting usage to Firebase.

5.0.3 #

Update Dart code to conform to current Dart formatter.

5.0.2 #

Add missing template type parameter to invokeMethod calls.
Bump minimum Flutter version to 1.5.0.
Replace invokeMethod with invokeMapMethod wherever necessary.

5.0.1+1 #

Enable support for onMessage on iOS using shouldEstablishDirectChannel.

5.0.1 #

Fix error in the logs on startup if unable to retrieve token on startup on Android.

5.0.0 #

Update Android dependencies to latest.

4.0.0+4 #

Remove obsolete use_frameworks! instruction.

4.0.0+3 #

Update iOS configuration documentation.

4.0.0+2 #

Fix example app's floating action button that stopped working due to a breaking change.

4.0.0+1 #

Log messages about automatic configuration of the default app are now less confusing.

4.0.0 #

Breaking Change Update message structure for onMessage to match onLaunch and onResume

3.0.1 #

Log a more detailed warning at build time about the previous AndroidX migration.

3.0.0 #

Breaking change. Migrate from the deprecated original Android Support Library to AndroidX. This shouldn't result in any functional changes, but it requires any Android apps using this plugin to also migrate if they're using the original support library.

This was originally incorrectly pushed in the 2.2.0 update.

2.2.0+1 #

Revert the breaking 2.2.0 update. 2.2.0 was known to be breaking and should have incremented the major version number instead of the minor. This revert is in and of itself breaking for anyone that has already migrated however. Anyone who has already migrated their app to AndroidX should immediately update to 3.0.0 instead. That's the correctly versioned new push of 2.2.0.

2.2.0 #

BAD. This was a breaking change that was incorrectly published on a minor version upgrade, should never have happened. Reverted by 2.2.0+1.
Breaking change. Migrate from the deprecated original Android Support Library to AndroidX. This shouldn't result in any functional changes, but it requires any Android apps using this plugin to also migrate if they're using the original support library.

2.1.0 #

Adding support for deleteInstanceID(), autoInitEnabled() and setAutoInitEnabled().

2.0.3 #

Removing local cache of getToken() in the dart part of the plugin. Now getToken() calls directly its counterparts in the iOS and Android implementations. This enables obtaining its value without calling configure() or having to wait for a new token refresh.

2.0.2 #

Use boolean values when checking for notification types on iOS.

2.0.1 #

Bump Android dependencies to latest.

2.0.0 #

Updated Android to send Remote Message's title and body to Dart.

1.0.5 #

Bumped test and mockito versions to pick up Dart 2 support.

1.0.4 #

Bump Android and Firebase dependency versions.

1.0.3 #

Updated iOS token hook from 'didRefreshRegistrationToken' to 'didReceiveRegistrationToken'

1.0.2 #

Updated Gradle tooling to match Android Studio 3.2.2.

1.0.1 #

Fix for Android where the onLaunch event is not triggered when the Activity is killed by the OS (or if the Don't keep activities toggle is enabled)

1.0.0 #

Bump to released version

0.2.5 #

Fixed Dart 2 type error.

0.2.4 #

Updated Google Play Services dependencies to version 15.0.0.

0.2.3 #

Updated package channel name

0.2.2 #

Simplified podspec for Cocoapods 1.5.0, avoiding link issues in app archives.

0.2.1 #

Fixed Dart 2 type errors.

0.2.0 #

Breaking change. Set SDK constraints to match the Flutter beta release.

0.1.4 #

Fixed Dart 2 type error in example project.

0.1.3 #

Enabled use in Swift projects.

0.2.2 #

Fix for APNS not being correctly registered on iOS when reinstalling application.

0.1.1 #

Simplified and upgraded Android project template to Android SDK 27.
Updated package description.

0.1.0 #

Breaking change. Upgraded to Gradle 4.1 and Android Studio Gradle plugin 3.0.1. Older Flutter projects need to upgrade their Gradle setup as well in order to use this version of the plugin. Instructions can be found here.
Relaxed GMS dependency to [11.4.0,12.0[

0.0.8 #

Added FLT prefix to iOS types
Change GMS dependency to 11.4.+

0.0.7 #

In FirebaseMessagingPlugin.m:

moved logic from 'tokenRefreshNotification' to 'didRefreshRegistrationToken'
removed 'tokenRefreshNotification' as well as observer registration
removed 'connectToFcm' method and related calls
removed unnecessary FIRMessaging disconnect

0.0.6 #

Change GMS dependency to 11.+

0.0.5+2 #

Fixed README example for "click_action"

0.0.5+1 #

Aligned author name with rest of repo.

0.0.5 #

Updated to Firebase SDK to always use latest patch version for 11.0.x builds

0.0.4 #

Updated to Firebase SDK Version 11.0.1

0.0.3 #

Updated README.md
Bumped buildToolsVersion to 25.0.3

0.0.2+2 #

Updated README.md

0.0.2+1 #

Added workaround for https://github.com/flutter/flutter/issues/9694 to README
Moved code to https://github.com/flutter/plugins

0.0.2 #

Updated to latest plugin API

0.0.2.2 #

Downgraded gradle dependency for example app to make flutter run happy

0.0.1+1 #

Updated README with installation instructions
Added CHANGELOG

0.0.1 #

Initial Release

example/README.md

firebase_messaging_example #

Demonstrates how to use the firebase_messaging plugin.

Getting Started #

For help getting started with Flutter, view our online documentation.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  firebase_messaging: ^5.0.4

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:firebase_messaging/firebase_messaging.dart';

Version	Uploaded	Documentation	Archive
5.0.4	Jun 19, 2019
5.0.3	Jun 12, 2019
5.0.2	May 31, 2019
5.0.1+1	May 10, 2019
5.0.1	May 7, 2019
5.0.0	May 7, 2019
4.0.0+4	Apr 23, 2019
4.0.0+3	Apr 12, 2019
4.0.0+2	Apr 9, 2019
4.0.0+1	Feb 21, 2019

All 47 versions...

Popularity: Describes how popular the package is relative to other packages. [more]	100
Health: Code health derived from static analysis. [more]	100
Maintenance: Reflects how tidy and up-to-date the package is. [more]	90
Overall: Weighted score of the above. [more]	98

Learn more about scoring.

We analyzed this package on Jun 26, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

Dart: 2.3.2
pana: 0.12.18
Flutter: 1.5.4-hotfix.2

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (1 direct: meta).

Dependencies

Package	Constraint	Resolved	Available
Direct dependencies
Dart SDK	>=2.0.0-dev.28.0 <3.0.0
flutter		0.0.0
meta	^1.0.4	1.1.6	1.1.7
platform	^2.0.0	2.2.0
Transitive dependencies
collection		1.14.11
sky_engine		0.0.99
typed_data		1.1.6
vector_math		2.0.8
Dev dependencies
firebase_core	^0.4.0
flutter_test
mockito	^3.0.0
test	^1.3.0

firebase_messaging 5.0.4

Firebase Cloud Messaging for Flutter #

Usage #

Getting Started #

Android Integration #

iOS Integration #

Dart/Flutter Integration #

Receiving Messages #

Sending Messages #

5.0.4 #

5.0.3 #

5.0.2 #

5.0.1+1 #

5.0.1 #

5.0.0 #

4.0.0+4 #

4.0.0+3 #

4.0.0+2 #

4.0.0+1 #

4.0.0 #

3.0.1 #

3.0.0 #

2.2.0+1 #

2.2.0 #

2.1.0 #

2.0.3 #

2.0.2 #

2.0.1 #

2.0.0 #

1.0.5 #

1.0.4 #

1.0.3 #

1.0.2 #

1.0.1 #

1.0.0 #

0.2.5 #

0.2.4 #

0.2.3 #

0.2.2 #

0.2.1 #

0.2.0 #

0.1.4 #

0.1.3 #

0.2.2 #

0.1.1 #

0.1.0 #

0.0.8 #

0.0.7 #

0.0.6 #

0.0.5+2 #

0.0.5+1 #

0.0.5 #

0.0.4 #

0.0.3 #

0.0.2+2 #

0.0.2+1 #

0.0.2 #

0.0.2.2 #

0.0.1+1 #

0.0.1 #

firebase_messaging_example #

Getting Started #

Use this package as a library

1. Depend on it

2. Install it

3. Import it

Platforms

Maintenance issues and suggestions

Dependencies