Use https://github.com/CrossGeeks/PushNotificationPlugin instead.

Simple cross platform plugin to handle push notification events such as registering, unregistering and messages arrival on Android, iOS, UWP platforms.

Many things changed since I implemented this related to notifications on iOS and Android deprecated GCM now recommending to use FCM, I decided to completely revaluate the implementation and do it from scratch. So i'm currently not supporting this plugin anymore (if you are using GCM you can keep using it but should think at some point to migrate to FCM). There's a new version well documented which uses FCM for Android and APS for iOS (still not UWP support) that I will be fully supporting here: https://github.com/CrossGeeks/PushNotificationPlugin

• Available on NuGet: http://www.nuget.org/packages/Xam.Plugin.PushNotification
• Install into your PCL project and Client projects.

Platform Support

• Custom Notification Styling
• Badges control support
• Custom Notification processing handlers
• Push notification video tutorial
• Handling Notification click event

Call CrossPushNotification.Current from any project or PCL to gain access to APIs.

Must initialize plugin on each platform before use. If not initializated before using a method (Register/Unregister) will thow PushNotificationNotInitializedException.

CrossPushNotification.Initialize<'T'> This methods initializes push notification plugin. The generic T should be a class that implements IPushNotificationListener. This will be the class were you would listen to all push notifications events.

On the AppDelegate:

public override bool FinishedLaunching (UIApplication app, NSDictionary options)
{
	//Consider inizializing before application initialization, if using any CrossPushNotification method during application initialization.
	   CrossPushNotification.Initialize<CrossPushNotificationListener> ();
    //...
	return base.FinishedLaunching (app, options);
}

On the Android Application class, is better to use the OnCreate of the Android Application class so you can handle push notifications even when activities are closed or app not running by using our PushNotificationService to keep listening to push notifications.

But is that not a requirement you could do initialization on your MainActivity class.

public override void OnCreate()
{
	base.OnCreate();

	 //...
                        
    //Should specify android Sender Id as parameter 
    CrossPushNotification.Initialize<CrossPushNotificationListener>("<ANDROID SENDER ID>");            
    //...
}

IPushNotificationListener implementation

Must implement IPushNotificationListener. This would be commonly implemented in the Core project if sharing code between Android or iOS. In the case you are using the plugin only for a specific platform this would be implemented in that platform.

using Newtonsoft.Json.Linq;
using PushNotification.Plugin;
using PushNotification.Plugin.Abstractions;

....

public class  CrossPushNotificationListener : IPushNotificationListener
    {
        //Here you will receive all push notification messages
        //Messages arrives as a dictionary, the device type is also sent in order to check specific keys correctly depending on the platform.
        void IPushNotificationListener.OnMessage(JObject parameters, DeviceType deviceType)
        {
            Debug.WriteLine("Message Arrived");
        }
         //Gets the registration token after push registration
        void IPushNotificationListener.OnRegistered(string Token, DeviceType deviceType)
        {
            Debug.WriteLine(string.Format("Push Notification - Device Registered - Token : {0}", Token));
	}
         //Fires when device is unregistered
        void IPushNotificationListener.OnUnregistered(DeviceType deviceType)
        {
            Debug.WriteLine("Push Notification - Device Unnregistered");
       
        }
        
        //Fires when error
        void IPushNotificationListener.OnError(string message, DeviceType deviceType)
        {
            Debug.WriteLine(string.Format("Push notification error - {0}",message));
        }
        
         //Enable/Disable Showing the notification
        bool IPushNotificationListener.ShouldShowNotification()
        {
            return true;
        }
    }

Enum of Device Types:

/// <summary>
/// Device type.
/// </summary>
     public enum DeviceType
    {
        Android,
        iOS,
        WindowsPhone,
        Windows
    }

Register

Register device to receive push notifications. Should only be used after initialization, if not will get PushNotificationNotInitializedException.

void Register();

Unregister

Unregister device to stop receiving push notifications. Should only be used after initialization, if not will get PushNotificationNotInitializedException.

void Unregister();

• Must compile against 21+ as plugin is using API 21 specific things. Here is a great breakdown: http://redth.codes/such-android-api-levels-much-confuse-wow/
• The package name of your Android aplication must start with lower case or you will get the build error: Installation error: INSTALL_PARSE_FAILED_MANIFEST_MALFORMED
• Make sure you have updated your Android SDK Manager libraries:

• If you wish to receive push notitfications even when app closed. Instead of initializing the plugin in the MainActivity.cs. Do the following:

  Implement an Android Application class in your Droid project and initialize plugin there. Here a brief snippet:

  [Application]
  public class YourAndroidApplication : Application
  {
       public static Context AppContext;
  
       public YourAndroidApplication(IntPtr javaReference, JniHandleOwnership transfer) : base(javaReference, transfer)
       {
  
       }
  
       public override void OnCreate()
       {
           base.OnCreate();
  
           AppContext = this.ApplicationContext;
  
            //TODO: Initialize CrossPushNotification Plugin
            //TODO: Replace string parameter with your Android SENDER ID
            //TODO: Specify the listener class implementing IPushNotificationListener interface in the Initialize generic
            CrossPushNotification.Initialize<CrossPushNotificationListener>("<ANDROID SENDER ID>");
  
            //This service will keep your app receiving push even when closed.             
            StartPushService();
       }
  
       public static void StartPushService()
       {
           AppContext.StartService(new Intent(AppContext, typeof(PushNotificationService)));
  
           if (Android.OS.Build.VERSION.SdkInt >= Android.OS.BuildVersionCodes.Kitkat)
           {
  
               PendingIntent pintent = PendingIntent.GetService(AppContext, 0, new Intent(AppContext, typeof(PushNotificationService)), 0);
               AlarmManager alarm = (AlarmManager)AppContext.GetSystemService(Context.AlarmService);
               alarm.Cancel(pintent);
           }
       }
  
       public static void StopPushService()
       {
           AppContext.StopService(new Intent(AppContext, typeof(PushNotificationService)));
                       if (Android.OS.Build.VERSION.SdkInt >= Android.OS.BuildVersionCodes.Kitkat)
           {
               PendingIntent pintent = PendingIntent.GetService(AppContext, 0, new Intent(AppContext, typeof(PushNotificationService)), 0);
               AlarmManager alarm = (AlarmManager)AppContext.GetSystemService(Context.AlarmService);
               alarm.Cancel(pintent);
           }
      }
   }
  

Just move your initialization stuff from MainActivity.cs to this Android Application class. Also Replace YourAndroidApplication name to your App name.

• There are a few things you can configure in Android project using the following properties from CrossPushNotification class:

  //The sets the key associated with the value will be used to show the title for the notification
  public static string NotificationContentTitleKey { get; set; }
  
  //The sets the key associated with the value will be used to show the text for the notification
  public static string NotificationContentTextKey { get; set; }
  
  //The sets the key associated with the root value will be used to show the text inside it for the notification
  public static string NotificationContentDataKey { get; set; }
  
  //The sets the resource id for the icon will be used for the notification
  public static int IconResource { get; set; }
  
  //The sets the sound  uri will be used for the notification
  public static Android.Net.Uri SoundUri { get; set; }
  
  

• By default displays a notification looking for the key title to display notification title and message to display notification message. If title key not present will use the application name.
• If you send a key called silent with value true it won't display a notification just will listen to message arrival.

• Application should have push notification enabled and active push certificates on Apple Developer Portal.
• iOS Application Bundle identifier must be the same corresponding to the profile used for code signing the app.
• Must checkout the helper class on content folder: PushNotificationApplicationDelegate.txt. In order to setup correctly.

• On Android project initialize the plugin on an Application class on android and start a sticky service so you can still receive notifications when application is closed. Consider that this application class and service can't have any Xamarin Forms related dependencies since Xamarin Forms is not initialized when app is closed, so it will crash if Xamarin dependencies are being used.

• On some phones android background services might be blocked by some application. This is the case of ASUS Zenfone 3 that has an Auto-start manager, which disables background services by default. You need to make sure that your push notification service is not being blocked by some application like this one, since you won't receive push notifications when app is closed if so.

• Use this plugin instead https://github.com/CrossGeeks/FirebasePushNotificationPlugin

• rdelrosario
• aflorenzan
• totemika
• howbazaar
• jmeadecvlt
• cupn
• charri
• timbrand
• kentcb
• Alessandro Moscatelli
• havalli
• cschwarz
• rhishikeshj

Thanks!

Licensed under main repo license