Skip to content

Latest commit

 

History

History
287 lines (196 loc) · 10.5 KB

GettingStarted.md

File metadata and controls

287 lines (196 loc) · 10.5 KB
Raw

Starting with Android

Android Configuration

Edit AndroidManifest.xml and insert the following receiver elements inside the application section:

<receiver 
    android:name="com.google.firebase.iid.FirebaseInstanceIdInternalReceiver" 
    android:exported="false" />
<receiver 
    android:name="com.google.firebase.iid.FirebaseInstanceIdReceiver" 
    android:exported="true" 
    android:permission="com.google.android.c2dm.permission.SEND">
    <intent-filter>
        <action android:name="com.google.android.c2dm.intent.RECEIVE" />
        <action android:name="com.google.android.c2dm.intent.REGISTRATION" />
        <category android:name="${applicationId}" />
    </intent-filter>
</receiver>

Also add this permission:

<uses-permission android:name="android.permission.INTERNET" />

Add google-services.json to Android project. Make sure build action is GoogleServicesJson

ADD JSON

Must compile against 26+ as plugin is using API 26 specific things. Here is a great breakdown: http://redth.codes/such-android-api-levels-much-confuse-wow/ (Android project must be compiled using 8.0+ target framework)

Android Initialization

You should initialize the plugin on an Android Application class if you don't have one on your project, should create an application class. Then call PushNotificationManager.Initialize method on OnCreate.

There are 3 overrides to PushNotificationManager.Initialize:

  • PushNotificationManager.Initialize(Context context, bool resetToken,bool createDefaultNotificationChannel, bool autoRegistration) : Default method to initialize plugin without supporting any user notification categories. Uses a DefaultPushHandler to provide the ui for the notification.

  • PushNotificationManager.Initialize(Context context, NotificationUserCategory[] categories, bool resetToken,bool createDefaultNotificationChannel, bool autoRegistration) : Initializes plugin using user notification categories. Uses a DefaultPushHandler to provide the ui for the notification supporting buttons based on the action_click send on the notification

  • PushNotificationManager.Initialize(Context context,IPushNotificationHandler pushHandler, bool resetToken,bool createDefaultNotificationChannel, bool autoRegistration) : Initializes the plugin using a custom push notification handler to provide custom ui and behaviour notifications receipt and opening.

Important: While debugging set resetToken parameter to true.

Example of initialization:

    [Application]
    public class MainApplication : Application
    {
        public MainApplication(IntPtr handle, JniHandleOwnership transer) :base(handle, transer)
        {
        }

        public override void OnCreate()
        {
            base.OnCreate();
            
            //If debug you should reset the token each time.
            #if DEBUG
              PushNotificationManager.Initialize(this,true);
            #else
              PushNotificationManager.Initialize(this,false);
            #endif

              //Handle notification when app is closed here
              CrossPushNotification.Current.OnNotificationReceived += (s,p) =>
              {


              };

			//Set the default notification channel for your app when running Android Oreo
            if (Build.VERSION.SdkInt >= Android.OS.BuildVersionCodes.O)
            {
                //Change for your default notification channel id here
                PushNotificationManager.DefaultNotificationChannelId = "DefaultChannel";

                //Change for your default notification channel name here
                PushNotificationManager.DefaultNotificationChannelName = "General";
            }
         }
    }

By default the plugin launches the activity where ProcessIntent method is called when you tap at a notification, but you can change this behaviour by setting the type of the activity you want to be launch on PushNotificationManager.NotificationActivityType

If you set PushNotificationManager.NotificationActivityType then put the following call on the OnCreate of activity of the type set. If not set then put it on your main launcher activity OnCreate method (On the Activity you got MainLauncher= true set)

        protected override void OnCreate(Bundle bundle)
        {
            base.OnCreate(bundle);

			//Other initialization stuff

            PushNotificationManager.ProcessIntent(this,Intent);
        }

Note: When using Xamarin Forms do it just after LoadApplication call.

By default the plugin launches the activity when you tap at a notification with activity flags: ActivityFlags.ClearTop | ActivityFlags.SingleTop.

You can change this behaviour by setting PushNotificationManager.NotificationActivityFlags.

If you set PushNotificationManager.NotificationActivityFlags to ActivityFlags.SingleTop or using default plugin behaviour then make this call on OnNewIntent method of the same activity on the previous step.

       protected override void OnNewIntent(Intent intent)
       {
           base.OnNewIntent(intent);
           PushNotificationManager.ProcessIntent(this,intent);
       }

More information on PushNotificationManager.NotificationActivityType and PushNotificationManager.NotificationActivityFlags and other android customizations here:

Android Customization

Starting with iOS

iOS Configuration

On Info.plist enable remote notification background mode

Remote notifications

iOS Initialization

There are 3 overrides to PushNotificationManager.Initialize:

  • PushNotificationManager.Initialize(NSDictionary options,bool autoRegistration) : Default method to initialize plugin without supporting any user notification categories. Auto registers for push notifications if second parameter is true.

  • PushNotificationManager.Initialize(NSDictionary options, NotificationUserCategory[] categories,bool autoRegistration) : Initializes plugin using user notification categories to support iOS notification actions.

  • PushNotificationManager.Initialize(NSDictionary options,IPushNotificationHandler pushHandle,bool autoRegistration) : Initializes the plugin using a custom push notification handler to provide native feedback of notifications event on the native platform.

Call PushNotificationManager.Initialize on AppDelegate FinishedLaunching

PushNotificationManager.Initialize(options,true);

Note: When using Xamarin Forms do it just after LoadApplication call.

Also should override these methods and make the following calls:

        public override void RegisteredForRemoteNotifications(UIApplication application, NSData deviceToken)
        {
             PushNotificationManager.DidRegisterRemoteNotifications(deviceToken);
        }

        public override void FailedToRegisterForRemoteNotifications(UIApplication application, NSError error)
        {
            PushNotificationManager.RemoteNotificationRegistrationFailed(error);

        }
        // To receive notifications in foregroung on iOS 9 and below.
        // To receive notifications in background in any iOS version
        public override void DidReceiveRemoteNotification(UIApplication application, NSDictionary userInfo, Action<UIBackgroundFetchResult> completionHandler)
        {
            
            PushNotificationManager.DidReceiveMessage(userInfo);
        }

Using Push Notification APIs

It is drop dead simple to gain access to the PushNotification APIs in any project. All you need to do is get a reference to the current instance of IPushNotification via CrossPushNotification.Current:

On Demand Registration

When plugin initializes by default auto registers the device for push notifications. If needed you can do on demand registration by turning off auto registration when initializing the plugin.

Use the following method for on demand registration:

   CrossPushNotification.Current.RegisterForPushNotifications();

Events

Once token is registered/refreshed you will get it on OnTokenRefresh event.

   /// <summary>
   /// Event triggered when token is refreshed
   /// </summary>
    event PushNotificationTokenEventHandler OnTokenRefresh;
  /// <summary>
  /// Event triggered when a notification is received
  /// </summary>
  event PushNotificationResponseEventHandler OnNotificationReceived;
  /// <summary>
  /// Event triggered when a notification is opened
  /// </summary>
  event PushNotificationResponseEventHandler OnNotificationOpened;
   /// <summary>
   /// Event triggered when a notification is deleted (Android Only)
   /// </summary>
   event PushNotificationDataEventHandler OnNotificationDeleted;
  /// <summary>
  /// Event triggered when there's an error
  /// </summary>
  event PushNotificationErrorEventHandler OnNotificationError;

Token event usage sample:

  CrossPushNotification.Current.OnTokenRefresh += (s,p) =>
  {
        System.Diagnostics.Debug.WriteLine($"TOKEN : {p.Token}");
  };

Push message received event usage sample:

  CrossPushNotification.Current.OnNotificationReceived += (s,p) =>
  {
 
        System.Diagnostics.Debug.WriteLine("Received");
    
  };

Push message opened event usage sample:

  
  CrossPushNotification.Current.OnNotificationOpened += (s,p) =>
  {
                System.Diagnostics.Debug.WriteLine("Opened");
                foreach(var data in p.Data)
                {
                    System.Diagnostics.Debug.WriteLine($"{data.Key} : {data.Value}");
                }

                if(!string.IsNullOrEmpty(p.Identifier))
                {
                    System.Diagnostics.Debug.WriteLine($"ActionId: {p.Identifier}");
                }
             
 };

Push message deleted event usage sample: (Android Only)

  CrossPushNotification.Current.OnNotificationDeleted+= (s,p) =>
  {
 
        System.Diagnostics.Debug.WriteLine("Deleted");
    
  };

Plugin by default provides some notification customization features for each platform. Check out the Android Customization and iOS Customization sections.

<= Back to Table of Contents