Merge pull request MaikuB#122 from MaikuB/dev

Temporarily remove code for triggering callback when a notification is shown and library updates

Author: MaikuB

CHANGELOG.md

@@ -1,7 +1,9 @@
 # [0.4.1]
-* [Android/iOS] New `onShowNotification` callback for when a notification is shown that can handled when calling the `initialize` function. This uses the latest changes to the Flutter engine that supports headless execution i.e. the ability to execute Dart code without the app running. See [here](https://github.com/flutter/flutter/issues/6192) for a link to the issue in the main Flutter repository about this. Note that the function handling this callback must be top-level function as this is requirement for executing headless Dart code. The example for the plugin has been updated to provide sample code on to handle the callback. **IMPORTANT** the callback only works on Android and iOS 10+. Note support on iOS is difficult to verify at the moment since Flutter engine support for executing headless Dart code on iOS doesn't support plugins at the moment.
 * **BREAKING CHANGE** renamed the `selectNotification` callback exposed by the `initialize` function to `onSelectNotification`
+* **BREAKING CHANGE** updated plugin to Android Support Library version 28.0, compile and target SDK version to 28
 * Address issue [115](https://github.com/MaikuB/flutter_local_notifications/issues/115) by adding validation to the notification ID values. This ensure they're within the range of a 32-bit integer as notification IDs on Android need to be within that range. Note that an `ArgumentError` is thrown when a value is out of range. 
+* Updated the Android Integration section around registering receivers via the Android manifest as per the suggestion in [116](https://github.com/MaikuB/flutter_local_notifications/issues/116)
+* Updated version of the http dependency for used by the example app
 
 # [0.4.0]
 * [Android] Fix issue [112](https://github.com/MaikuB/flutter_local_notifications/issues/112) where big picture notifications wouldn't show
@@ -14,7 +16,7 @@
 * Added documentation around ProGuard configuration to Android Integration section of the README
 
 ## [0.3.7]
-* [Android] Fix issues [88](https://github.com/MaikuB/flutter_local_notifications/issues/88) where cancelled notifications could reappear on reboot.
+* [Android] Fix issue [88](https://github.com/MaikuB/flutter_local_notifications/issues/88) where cancelled notifications could reappear on reboot.
 
 ## [0.3.6]
 * [Android] Add mapping to the setOnlyAlertOnce method [83](https://github.com/MaikuB/flutter_local_notifications/issues/83). Allows the sound, vibrate and ticker to be played if the notification is not already showing

README.md

@@ -68,11 +68,10 @@ var initializationSettings = new InitializationSettings(
     initializationSettingsAndroid, initializationSettingsIOS);
 flutterLocalNotificationsPlugin = new FlutterLocalNotificationsPlugin();
 flutterLocalNotificationsPlugin.initialize(initializationSettings,
-    onSelectNotification: onSelectNotification
-    onShowNotification: onShowNotification);
+    onSelectNotification: onSelectNotification);
 ```
 
-Here we specify we have specified the default icon to use for notifications on Android (refer to the Android Integration section) and designated the function (onSelectNotification) that should fire when a notification has been tapped on. Specifying this callback is entirely optional. In this example, it will trigger navigation to another page and display the payload associated with the notification. It is also possible to handle the `onShowNotification` that will invoke code when a notification is shown. Note that the function handling this callback must be top-level function as this is requirement for executing headless Dart code.
+Here we specify we have specified the default icon to use for notifications on Android (refer to the Android Integration section) and designated the function (onSelectNotification) that should fire when a notification has been tapped on. Specifying this callback is entirely optional. In this example, it will trigger navigation to another page and display the payload associated with the notification.
 
 ```
 Future onSelectNotification(String payload) async {
@@ -262,6 +261,7 @@ If your application needs the ability to schedule notifications then you need to
 
 ```xml
 <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
+```
 
 The following is also needed to ensure scheduled notifications remain scheduled upon a reboot (this is handled by the plugin)
 
@@ -272,7 +272,6 @@ The following is also needed to ensure scheduled notifications remain scheduled
     </intent-filter>
 </receiver>
 ```
-```
 
 Developers will also need to add the following so that plugin can handle displaying scheduled notifications
 
@@ -286,12 +285,6 @@ If the vibration pattern of an Android notification will be customised then add
 <uses-permission android:name="android.permission.VIBRATE" />
 ```
 
-If your application is looking to handle the `onShowNotification` callback, then the following permission is required
-
-```xml
-<uses-permission android:name="android.permission.WAKE_LOCK" />
-```
-
 Notification icons should be added as a drawable resource. The example project/code shows how to set default icon for all notifications and how to specify one for each notification. It is possible to use launcher icon/mipmap and this by default is `@mipmap/ic_launcher` in the Android manifest and can be passed `AndroidInitializationSettings` constructor. However, the offical Android guidance is that you should use drawable resources. Custom notification sounds should be added as a raw resource and the sample illustrates how to play a notification with a custom sound. Refer to the following links around Android resources and notification icons.
 
  * https://developer.android.com/guide/topics/resources/providing-resources
@@ -314,15 +307,15 @@ allprojects {
             resolutionStrategy.eachDependency { details ->
                 if (details.requested.group == 'com.android.support'
                         && !details.requested.name.contains('multidex') ) {
-                    details.useVersion "27.1.0"
+                    details.useVersion "28.0.0"
                 }
             }
         }
     }
 }
 ```
 
-Note though this will force other plugins to use the same version of the library that this plugin depends on so may not be desirable, particularly if they use a more recent version than 27.1. If you have another suggestion on how to solve this please do let me know :)
+Note though this will force other plugins to use the same version of the library that this plugin depends on so may not be desirable. If you have another suggestion on how to solve this please do let me know :)
 
 When doing a release build of your app, you'll likely need to customise your ProGuard configuration file as per this [link](https://developer.android.com/studio/build/shrink-code#keep-code) and add the following line
 

android/build.gradle

@@ -22,7 +22,7 @@ rootProject.allprojects {
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion 27
+    compileSdkVersion 28
 
     defaultConfig {
         minSdkVersion 16
@@ -34,6 +34,6 @@ android {
 }
 
 dependencies {
-    implementation "com.android.support:support-compat:27.1.0"
+    implementation "com.android.support:support-compat:28.0.0"
     implementation "com.google.code.gson:gson:2.8.2"
 }

android/src/main/java/com/dexterous/flutterlocalnotifications/FlutterLocalNotificationsPlugin.java

@@ -46,6 +46,7 @@
 import io.flutter.plugin.common.MethodChannel.Result;
 import io.flutter.plugin.common.PluginRegistry;
 import io.flutter.plugin.common.PluginRegistry.Registrar;
+import io.flutter.view.FlutterNativeView;
 
 /**
  * FlutterLocalNotificationsPlugin
@@ -75,10 +76,10 @@ public class FlutterLocalNotificationsPlugin implements MethodCallHandler, Plugi
     private static final String INVALID_DRAWABLE_RESOURCE_ERROR_MESSAGE = "The resource %s could not be found. Please make sure it has been added as a drawable resource to your Android head project.";
     private static final String INVALID_RAW_RESOURCE_ERROR_MESSAGE = "The resource %s could not be found. Please make sure it has been added as a raw resource to your Android head project.";
 
-    public static final String ON_NOTIFICATION_ACTION = "onNotification";
+    /*public static final String ON_NOTIFICATION_ACTION = "onNotification";
     public static final String ON_NOTIFICATION_ARGS = "onNotificationArgs";
     public static final String CALLBACK_DISPATCHER = "callbackDispatcher";
-    public static final String ON_NOTIFICATION_CALLBACK_DISPATCHER = "onNotificationCallbackDispatcher";
+    public static final String ON_NOTIFICATION_CALLBACK_DISPATCHER = "onNotificationCallbackDispatcher";*/
     public static final String SHARED_PREFERENCES_KEY = "notification_plugin_cache";
     public static String NOTIFICATION_ID = "notification_id";
     public static String NOTIFICATION = "notification";
@@ -485,13 +486,10 @@ public void onMethodCall(MethodCall call, Result result) {
         switch (call.method) {
 
             case INITIALIZE_METHOD: {
+                // initializeHeadlessService(call, result);
                 initialize(call, result);
                 break;
             }
-            case INITIALIZE_HEADLESS_SERVICE_METHOD: {
-                initializeHeadlessService(call, result);
-                break;
-            }
             case GET_NOTIFICATION_APP_LAUNCH_DETAILS_METHOD: {
                 getNotificationAppLaunchDetails(result);
                 break;
@@ -522,16 +520,20 @@ public void onMethodCall(MethodCall call, Result result) {
         }
     }
 
-    private void initializeHeadlessService(MethodCall call, Result result) {
+    /*private void initializeHeadlessService(MethodCall call, Result result) {
         Map<String, Object> arguments = call.arguments();
-        SharedPreferences.Editor editor = registrar.context().getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE)
-                .edit();
+        SharedPreferences sharedPreferences = registrar.context().getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
+        SharedPreferences.Editor editor = sharedPreferences.edit();
 
-        Object callbackDispatcher = arguments.get(CALLBACK_DISPATCHER);
-        if(callbackDispatcher instanceof Long) {
-            editor.putLong(CALLBACK_DISPATCHER, (Long)callbackDispatcher);
-        } else if(callbackDispatcher instanceof  Integer) {
-            editor.putLong(CALLBACK_DISPATCHER, (Integer)callbackDispatcher);
+        if(arguments.containsKey(CALLBACK_DISPATCHER)) {
+            Object callbackDispatcher = arguments.get(CALLBACK_DISPATCHER);
+            if (callbackDispatcher instanceof Long) {
+                editor.putLong(CALLBACK_DISPATCHER, (Long) callbackDispatcher);
+            } else if (callbackDispatcher instanceof Integer) {
+                editor.putLong(CALLBACK_DISPATCHER, (Integer) callbackDispatcher);
+            }
+        } else if(sharedPreferences.contains(CALLBACK_DISPATCHER)){
+            editor.remove(CALLBACK_DISPATCHER);
         }
 
         if(arguments.containsKey(ON_NOTIFICATION_CALLBACK_DISPATCHER)) {
@@ -541,10 +543,12 @@ private void initializeHeadlessService(MethodCall call, Result result) {
             } else if(onNotificationCallbackDispatcher instanceof Integer) {
                 editor.putLong(ON_NOTIFICATION_CALLBACK_DISPATCHER, (Integer)onNotificationCallbackDispatcher);
             }
+        } else if(sharedPreferences.contains(ON_NOTIFICATION_CALLBACK_DISPATCHER)){
+            editor.remove(ON_NOTIFICATION_CALLBACK_DISPATCHER);
         }
 
         editor.commit();
-    }
+    }*/
 
     private void cancel(MethodCall call, Result result) {
         Integer id = call.arguments();
@@ -679,7 +683,7 @@ public static void showNotification(Context context, NotificationDetails notific
         Notification notification = createNotification(context, notificationDetails);
         NotificationManagerCompat notificationManagerCompat = getNotificationManager(context);
         notificationManagerCompat.notify(notificationDetails.id, notification);
-        SharedPreferences sharedPreferences = context.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
+        /*SharedPreferences sharedPreferences = context.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
         if(sharedPreferences.contains(ON_NOTIFICATION_CALLBACK_DISPATCHER)) {
             long callbackHandle = sharedPreferences.getLong(ON_NOTIFICATION_CALLBACK_DISPATCHER, 0);
             HashMap<String, Object> callbackArgs = new HashMap<>();
@@ -692,7 +696,7 @@ public static void showNotification(Context context, NotificationDetails notific
             intent.setAction(ON_NOTIFICATION_ACTION);
             intent.putExtra(ON_NOTIFICATION_ARGS, callbackArgs);
             NotificationService.enqueueWork(context, intent);
-        }
+        }*/
     }
 
     private static NotificationManagerCompat getNotificationManager(Context context) {

android/src/main/java/com/dexterous/flutterlocalnotifications/NotificationService.java

@@ -1,4 +1,4 @@
-package com.dexterous.flutterlocalnotifications;
+/*package com.dexterous.flutterlocalnotifications;
 
 import android.content.Context;
 import android.content.Intent;
@@ -22,44 +22,44 @@
 
 public class NotificationService extends JobIntentService implements MethodChannel.MethodCallHandler {
     private static final String TAG = "NotificationService";
-    private static final String BACKGROUND_CHANNEL = "dexterous.com/flutter/local_notifications_background";
+    private static final String BACKGROUND_CHANNEL = "dexterous.com/flutter/local_notifications";
     private static final int JOB_ID = (int)UUID.randomUUID().getMostSignificantBits();
     private static final String INITIALIZED_HEADLESS_SERVICE_METHOD = "initializedHeadlessService";
     private static final String ON_NOTIFICATION_METHOD = "onNotification";
-    private static AtomicBoolean started = new AtomicBoolean(false);
+    private static final AtomicBoolean started = new AtomicBoolean(false);
     private static PluginRegistrantCallback pluginRegistrantCallback;
     private MethodChannel backgroundChannel;
     private ArrayDeque onNotificationQueue = new ArrayDeque<Map<String, Object>>();
     private FlutterNativeView backgroundFlutterView;
 
     public static void enqueueWork(Context context, Intent intent) {
+        FlutterMain.ensureInitializationComplete(context, null);
         enqueueWork(context, NotificationService.class, JOB_ID, intent);
     }
 
     private void startNotificationService(Context context) {
         synchronized (started) {
-            FlutterMain.ensureInitializationComplete(context, null);
-
-            long callbackHandle = context.getSharedPreferences(
-                    FlutterLocalNotificationsPlugin.SHARED_PREFERENCES_KEY,
-                    Context.MODE_PRIVATE)
-                    .getLong(FlutterLocalNotificationsPlugin.CALLBACK_DISPATCHER, 0);
-            FlutterCallbackInformation callbackInfo = FlutterCallbackInformation.lookupCallbackInformation(callbackHandle);
-            if (callbackInfo == null) {
-                Log.e(TAG, "Fatal: failed to find callback");
-                return;
-            }
-            backgroundFlutterView = new FlutterNativeView(context, true);
-            FlutterRunArguments args = new FlutterRunArguments();
-            args.bundlePath = FlutterMain.findAppBundlePath(context);
-            args.entrypoint = callbackInfo.callbackName;
-            args.libraryPath = callbackInfo.callbackLibraryPath;
-            backgroundFlutterView.runFromBundle(args);
-            if (pluginRegistrantCallback != null) {
-                pluginRegistrantCallback.registerWith(backgroundFlutterView.getPluginRegistry());
+            if(backgroundFlutterView == null) {
+                long callbackHandle = context.getSharedPreferences(
+                        FlutterLocalNotificationsPlugin.SHARED_PREFERENCES_KEY,
+                        Context.MODE_PRIVATE)
+                        .getLong(FlutterLocalNotificationsPlugin.CALLBACK_DISPATCHER, 0);
+                FlutterCallbackInformation callbackInfo = FlutterCallbackInformation.lookupCallbackInformation(callbackHandle);
+                if (callbackInfo == null) {
+                    Log.e(TAG, "Fatal: failed to find callback");
+                    return;
+                }
+                backgroundFlutterView = new FlutterNativeView(context, true);
+                if (pluginRegistrantCallback != null) {
+                    pluginRegistrantCallback.registerWith(backgroundFlutterView.getPluginRegistry());
+                }
+                FlutterRunArguments args = new FlutterRunArguments();
+                args.bundlePath = FlutterMain.findAppBundlePath(context);
+                args.entrypoint = callbackInfo.callbackName;
+                args.libraryPath = callbackInfo.callbackLibraryPath;
+                backgroundFlutterView.runFromBundle(args);
             }
 
-
         }
         backgroundChannel = new MethodChannel(backgroundFlutterView, BACKGROUND_CHANNEL);
         backgroundChannel.setMethodCallHandler(this);
@@ -111,4 +111,4 @@ public void onMethodCall(MethodCall call, MethodChannel.Result result) {
             result.notImplemented();
         }
     }
-}
+}*/

example/android/app/build.gradle

@@ -15,7 +15,7 @@ apply plugin: 'com.android.application'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 27
+    compileSdkVersion 28
 
     lintOptions {
         disable 'InvalidPackage'
@@ -25,7 +25,7 @@ android {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "com.dexterous.flutterlocalnotificationsexample"
         minSdkVersion 16
-        targetSdkVersion 27
+        targetSdkVersion 28
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
@@ -48,5 +48,5 @@ dependencies {
     testImplementation 'junit:junit:4.12'
     androidTestImplementation 'com.android.support.test:runner:1.0.1'
     androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.1'
-    implementation "com.android.support:support-compat:27.1.0"
+    implementation "com.android.support:support-compat:28.0.0"
 }

example/android/app/src/main/AndroidManifest.xml

@@ -16,7 +16,7 @@
          additional functionality it is fine to subclass or reimplement
          FlutterApplication and put your custom class here. -->
     <application
-        android:name=".Application"
+        android:name="io.flutter.app.FlutterApplication"
         android:label="flutter_local_notifications_example"
         android:icon="@mipmap/ic_launcher">
         <activity
@@ -44,9 +44,5 @@
                 <action android:name="android.intent.action.BOOT_COMPLETED"></action>
             </intent-filter>
         </receiver>
-        <service
-            android:name="com.dexterous.flutterlocalnotifications.NotificationService"
-            android:permission="android.permission.BIND_JOB_SERVICE"
-            android:exported="true"/>
     </application>
 </manifest>

example/android/app/src/main/java/com/dexterous/flutterlocalnotificationsexample/Application.java

@@ -1,4 +1,4 @@
-package com.dexterous.flutterlocalnotificationsexample;
+/*package com.dexterous.flutterlocalnotificationsexample;
 
 import com.dexterous.flutterlocalnotifications.NotificationService;
 
@@ -17,4 +17,4 @@ public void onCreate() {
     public void registerWith(PluginRegistry registry) {
         GeneratedPluginRegistrant.registerWith(registry);
     }
-}
+}*/

example/android/build.gradle

@@ -5,7 +5,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.1.3'
+        classpath 'com.android.tools.build:gradle:3.2.1'
     }
 }
 

example/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Thu Mar 29 16:20:55 AEDT 2018
+#Sat Nov 10 09:17:46 AEDT 2018
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip