{"id":31069,"date":"2017-04-24T13:51:39","date_gmt":"2017-04-24T20:51:39","guid":{"rendered":"https:\/\/blog.xamarin.com\/?p=31069"},"modified":"2019-04-04T08:33:10","modified_gmt":"2019-04-04T15:33:10","slug":"implementing-push-notifications-android-apps","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/xamarin\/implementing-push-notifications-android-apps\/","title":{"rendered":"Implementing Push Notifications in Your Android Apps"},"content":{"rendered":"

\t\t\t\tAn important feature of almost every app is the ability to support push notifications. With push notifications, you can update your users without requiring the app to run at all times or having it poll a server, potentially running down the battery. With the introduction of Firebase Cloud Messaging (FCM), Google made it a little bit easier to implement push notifications in Android apps. FCM is the new and improved version of Google Cloud Messaging (GCM) that you can use to send remote notifications to your client app. For apps that will be targeting multiple platforms or need to take advantage of advanced push operations (like segmented push), we can use FCM with Azure Notification Hubs<\/a>.<\/p>\n

Unlike GCM, FCM takes care of most of the underlying messaging plumbing for you. With FCM, you no longer have to write code to register your app or include retry logic to update subscription tokens. You can add basic FCM push notifications to your app by doing the following:<\/p>\n

    \n
  1. Install a couple of Xamarin.Android NuGets and a credentials file.<\/li>\n
  2. Add a couple of <service><\/code> declarations to your AndroidManifest.xml<\/strong>.<\/li>\n
  3. Write a few lines of code to pull it all together.<\/li>\n<\/ol>\n

    Also, instead of writing a test program to send notifications, you can use the new web-based Firebase Console to send test notifications to your app.<\/p>\n

    Today, we’ll take a look at how to use the Xamarin.Firebase.Messaging<\/a> package to build FCM-based push notification features into your app.<\/p>\n

    Set Up Firebase Cloud Messaging<\/h2>\n

    Before you can use FCM services in your app, you have to create a Firebase Project<\/em> in the Firebase Console<\/a>. After you log in, click CREATE NEW PROJECT<\/strong>, enter a project name, and click CREATE PROJECT<\/strong>:<\/p>\n

    \"\"<\/p>\n

    Next, click Add Firebase to your Android app<\/strong>. When prompted, enter the package name for your app and click REGISTER APP<\/strong>:<\/p>\n

    \"\"
    \n\"\"<\/p>\n

    When you click REGISTER APP<\/strong>, credentials are automatically generated for your app to access Firebase servers. These credentials are packaged in a file called google-services.json<\/strong>, which is automatically downloaded after you click the REGISTER APP<\/strong> button. Save this file, as you’ll need it later!<\/p>\n

    Add Packages to Your Project<\/h2>\n

    Next, you’ll need to add two Xamarin NuGet packages to your app. Start the NuGet Package Manager<\/strong> (in Visual Studio, right-click References<\/strong> in the Solution Explorer and select Manage NuGet Packages<\/strong>), browse for Xamarin.GooglePlayServices.Base<\/strong>, select it, and click Install<\/strong>.<\/p>\n

    \"\"<\/p>\n

    The Google Play Services package must be installed in order for FCM to work. Next, do the same for Xamarin.Firebase.Messaging<\/strong>:<\/p>\n

    \"\"<\/p>\n

    Extra dependency packages will be installed for each of these packages.<\/p>\n

    Also, make sure that you have the Google Play Services<\/a> APK installed on your Android device. Firebase Messaging uses the Google Play Services APK to communicate with Firebase servers.<\/p>\n

    Add the Google Services JSON File to Your Project<\/h2>\n

    When you created a new project in the Firebase Console, you downloaded a google-services.json<\/strong> credentials file–it’s time to plug that file into your app!<\/p>\n

    Copy google-services.json<\/strong> to your project folder and add it to your project (in Visual Studio, you can click the Show All Files<\/strong> icon in the Solution Explorer<\/strong>, right-click google-services.json<\/strong>, then select Include in Project<\/strong>).<\/p>\n

    Save changes and close<\/strong> the Solution. Re-open<\/strong> the Solution and set the Build Action for google-services.json<\/strong> to GoogleServicesJson<\/strong> (in Visual Studio, the Build Action<\/strong> pull-down menu is in the Advanced<\/strong> section of the Properties<\/strong> pane):<\/p>\n

    \"\"<\/p>\n

    Now that google-services.json<\/strong> is part of your project, the Xamarin build process can extract the credentials and merge them into the generated AndroidManifest.xml<\/strong> file. Xamarin.Firebase.Messaging<\/strong> uses these credentials to access Firebase services.<\/p>\n

    Add an Instance ID Receiver<\/h2>\n

    Your client app has to first register with FCM before it can receive push notifications. The way this works is that Xamarin.Firebase.Messaging<\/strong> contacts FCM, sends it credentials, and gets back a registration token<\/em>. This token, which is updated on a regular basis, is used to create a secure channel to Firebase servers. You can also forward this token to your app server so that it can communicate with Firebase.<\/p>\n

    Your client app must implement a FirebaseInstanceIdService<\/code> to handle the creation and updating of registration tokens. This is actually a lot simpler than it sounds, as you’ll see next.<\/p>\n

    Declare the Instance ID Receiver in the Android Manifest<\/h3>\n

    Edit AndroidManifest.xml<\/strong> (under Properties<\/strong> in the Solution Explorer) and insert the following <receiver><\/code> elements into the <application><\/code> section:<\/p>\n

    \n\n    \n        \n        \n        \n    \n<\/code><\/pre>\n
    This declares the necessary receivers that will be used for managing registration tokens.<\/p>\n
    Add Internet Permissions<\/h3>\n
    If your app does not already have the INTERNET<\/code> permission enabled, enable it under Properties > Android Manifest > Required permissions<\/strong>:<\/p>\n
    \"\"<\/p>\n
    Implement the Firebase Instance ID Service<\/h3>\n
    Now it’s time to write some code! Add a new C# file to your project (in Visual Studio, right click your project name and select Add > New Item > Class<\/strong>). Give it the name MyFirebaseIIDService.cs<\/strong> and input the following code:<\/p>\n
    using System;\nusing Android.App;\nusing Firebase.Iid;\nusing Android.Util;\n\nnamespace FCMExample\n{\n    [Service]\n    [IntentFilter(new[] { \"com.google.firebase.INSTANCE_ID_EVENT\" })]\n    public class MyFirebaseIIDService : FirebaseInstanceIdService\n    {\n        const string TAG = \"MyFirebaseIIDService\";\n        public override void OnTokenRefresh()\n        {\n            var refreshedToken = FirebaseInstanceId.Instance.Token;\n            Log.Debug(TAG, \"Refreshed token: \" + refreshedToken);\n        }\n    }\n}<\/code><\/pre>\n
    Change the namespace FCMExample<\/code> above to the namespace of your app.<\/p>\n
    That’s all there is to it!<\/p>\n
    The OnTokenRefresh<\/code> method is invoked when the registration token is created or changed. Because the token is logged to the Output<\/strong> window whenever it’s updated, you’ll be able to see it while the app is running. You’ll enter this token into the Firebase Console when you’re ready to send a test notification to your app.<\/p>\n
    Try it!<\/h2>\n
    Now that your app has enough functionality to receive background notifications from FCM, it’s time for a test drive. Before you build your app, make sure that its package name matches the package name that you entered into the Firebase Console when you created your Firebase project.<\/p>\n
    Rebuild the app, run it, and watch the Output<\/strong> window until the token is displayed. For example:<\/p>\n
    \"\"<\/p>\n
    Copy this token to the clipboard; you’ll paste it into the Firebase Console in the next step.<\/p>\n
    Send a Message<\/h2>\n
    Sign in to the Firebase Console<\/a>, select your project, click Notifications<\/strong>, and click SEND YOUR FIRST MESSAGE<\/strong>:<\/p>\n
    \"\"<\/p>\n
    On the Compose message<\/strong> page, enter in a message under Message text<\/strong>. Select Single device<\/strong> as the target and paste in the registration token that you copied from the IDE Output<\/strong> window:<\/p>\n
    \"\"<\/p>\n
    Before you click SEND MESSAGE<\/strong>, background your app (you can tap the Android overview button and touch the home screen). Click SEND MESSAGE<\/strong> in the Firebase Console when you’re ready. When the Review message<\/strong> dialog is displayed, click SEND<\/strong>. The notification icon should appear on the Android device:<\/p>\n
    \"\"<\/p>\n
    Open the notification to view the message; the notification message should be exactly what you typed into the Firebase Console:<\/p>\n
    \"\"<\/p>\n
    Congratulations, you’ve just sent and received your first FCM push notification!<\/p>\n
    Learn More<\/h2>\n
    This simple example only touches the surface of what you can do with FCM and push notifications using Visual Studio. To learn more about Firebase Cloud Messaging with Xamarin.Android for Visual Studio and other platforms, be sure to read Firebase Cloud Messaging<\/a> and Remote Notifications with Firebase Cloud Messaging<\/a>. The FCMNotifications<\/a> sample app is also a good place to borrow code from if you’re building an app that uses FCM push notifications.<\/p>\n","protected":false},"excerpt":{"rendered":"
    An important feature of almost every app is the ability to support push notifications. With push notifications, you can update your users without requiring the app to run at all times or having it poll a server, potentially running down the battery. With the introduction of Firebase Cloud Messaging (FCM), Google made it a little […]<\/p>\n","protected":false},"author":555,"featured_media":31081,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[2],"tags":[5,4,16],"class_list":["post-31069","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-developers","tag-android","tag-xamarin-platform","tag-xamarin-forms"],"acf":[],"blog_post_summary":"
    An important feature of almost every app is the ability to support push notifications. With push notifications, you can update your users without requiring the app to run at all times or having it poll a server, potentially running down the battery. With the introduction of Firebase Cloud Messaging (FCM), Google made it a little […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts\/31069","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/users\/555"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/comments?post=31069"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts\/31069\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/media?parent=31069"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/categories?post=31069"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/tags?post=31069"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}