[firebase_messaging] Update README (firebase#1664)

* Update README.md
thang510023 · Dec 16, 2019 · d28d870 · d28d870
1 parent 6d22cdd
commit d28d870
Show file tree

Hide file tree

Showing 3 changed files with 88 additions and 62 deletions.
diff --git a/packages/firebase_messaging/CHANGELOG.md b/packages/firebase_messaging/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 6.0.10
+
+* Update README to explain how to correctly implement Android background message handling with the new v2 embedding. 
+
 ## 6.0.9
 
 * Update Android Gradle plugin dependency to 3.5.3, update documentation and example.

diff --git a/packages/firebase_messaging/README.md b/packages/firebase_messaging/README.md
@@ -61,77 +61,99 @@ for more.
 
 By default background messaging is not enabled. To handle messages in the background:
 
+1. Add the `com.google.firebase:firebase-messaging` dependency in your app-level `build.gradle` file that is typically located at `<app-name>/android/app/build.gradle`.
+
+   ```gradle
+   dependencies {
+     // ...
+   
+     implementation 'com.google.firebase:firebase-messaging:<latest_version>'
+   }
+   ```
+
+   Note: you can find out what the latest version of the plugin is [here ("Cloud Messaging")](https://firebase.google.com/support/release-notes/android#latest_sdk_versions).
+
 1. Add an `Application.java` class to your app in the same directory as your `MainActivity.java`. This is typically found in `<app-name>/android/app/src/main/java/<app-organization-path>/`.
 
-    ```
-    package io.flutter.plugins.firebasemessagingexample;
-    
-    import io.flutter.app.FlutterApplication;
-    import io.flutter.plugin.common.PluginRegistry;
-    import io.flutter.plugin.common.PluginRegistry.PluginRegistrantCallback;
-    import io.flutter.plugins.GeneratedPluginRegistrant;
-    import io.flutter.plugins.firebasemessaging.FlutterFirebaseMessagingService;
-    
-    public class Application extends FlutterApplication implements PluginRegistrantCallback {
-      @Override
-      public void onCreate() {
-        super.onCreate();
-        FlutterFirebaseMessagingService.setPluginRegistrant(this);
-      }
-    
-      @Override
-      public void registerWith(PluginRegistry registry) {
-        GeneratedPluginRegistrant.registerWith(registry);
-      }
-    }
-    ```
+   ```java
+   package io.flutter.plugins.firebasemessagingexample;
+
+   import io.flutter.app.FlutterApplication;
+   import io.flutter.plugin.common.PluginRegistry;
+   import io.flutter.plugin.common.PluginRegistry.PluginRegistrantCallback;
+   import io.flutter.plugins.GeneratedPluginRegistrant;
+   import io.flutter.plugins.firebasemessaging.FlutterFirebaseMessagingService;
+
+   public class Application extends FlutterApplication implements PluginRegistrantCallback {
+     @Override
+     public void onCreate() {
+       super.onCreate();
+       FlutterFirebaseMessagingService.setPluginRegistrant(this);
+     }
+
+     @Override
+     public void registerWith(PluginRegistry registry) {
+       GeneratedPluginRegistrant.registerWith(registry);
+     }
+   }
+   ```
+
 1. In `Application.java`, make sure to change `package io.flutter.plugins.firebasemessagingexample;` to your package's identifier. Your package's identifier should be something like `com.domain.myapplication`.
-    ```
-    package com.domain.myapplication;
-    ```
+
+   ```java
+   package com.domain.myapplication;
+   ```
+
 1. Set name property of application in `AndroidManifest.xml`. This is typically found in `<app-name>/android/app/src/main/`.
-    ```
-    <application android:name=".Application" ...>
-    ```
+
+   ```xml
+   <application android:name=".Application" ...>
+   ```
+
 1. Define a **TOP-LEVEL** or **STATIC** function to handle background messages
-    ```
-    Future<dynamic> myBackgroundMessageHandler(Map<String, dynamic> message) {
-      if (message.containsKey('data')) {
-        // Handle data message
-        final dynamic data = message['data'];
-      }
-    
-      if (message.containsKey('notification')) {
-        // Handle notification message
-        final dynamic notification = message['notification'];
-      }
-    
-      // Or do other work.
-    }
-    ```
+
+   ```dart
+   Future<dynamic> myBackgroundMessageHandler(Map<String, dynamic> message) {
+     if (message.containsKey('data')) {
+       // Handle data message
+       final dynamic data = message['data'];
+     }
+   
+     if (message.containsKey('notification')) {
+       // Handle notification message
+       final dynamic notification = message['notification'];
+     }
+   
+     // Or do other work.
+   }
+   ```
+
    Note: the protocol of `data` and `notification` are in line with the
    fields defined by a [RemoteMessage](https://firebase.google.com/docs/reference/android/com/google/firebase/messaging/RemoteMessage). 
+
 1. Set `onBackgroundMessage` handler when calling `configure`
-    ```
-    _firebaseMessaging.configure(
-          onMessage: (Map<String, dynamic> message) async {
-            print("onMessage: $message");
-            _showItemDialog(message);
-          },
-          onBackgroundMessage: myBackgroundMessageHandler,
-          onLaunch: (Map<String, dynamic> message) async {
-            print("onLaunch: $message");
-            _navigateToItemDetail(message);
-          },
-          onResume: (Map<String, dynamic> message) async {
-            print("onResume: $message");
-            _navigateToItemDetail(message);
-          },
-        );
-    ```
+
+   ```dart
+   _firebaseMessaging.configure(
+         onMessage: (Map<String, dynamic> message) async {
+           print("onMessage: $message");
+           _showItemDialog(message);
+         },
+         onBackgroundMessage: myBackgroundMessageHandler,
+         onLaunch: (Map<String, dynamic> message) async {
+           print("onLaunch: $message");
+           _navigateToItemDetail(message);
+         },
+         onResume: (Map<String, dynamic> message) async {
+           print("onResume: $message");
+           _navigateToItemDetail(message);
+         },
+       );
+   ```
+
    Note: `configure` should be called early in the lifecycle of your application
    so that it can be ready to receive messages as early as possible. See the
-   example app for a demonstration.
+   [example app](https://github.com/FirebaseExtended/flutterfire/tree/master/packages/firebase_messaging/example) for a demonstration.
 
 ### iOS Integration
 

diff --git a/packages/firebase_messaging/pubspec.yaml b/packages/firebase_messaging/pubspec.yaml
@@ -2,7 +2,7 @@ name: firebase_messaging
 description: Flutter plugin for Firebase Cloud Messaging, a cross-platform
   messaging solution that lets you reliably deliver messages on Android and iOS.
 homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/firebase_messaging
-version: 6.0.9
+version: 6.0.10
 
 flutter:
   plugin: