[flutter_local_notifications] Change plugin to use platform interface (#444)

* progress on using platform interface

* move more code to use platform interface

* connect onSelectNotification callback

* shuffle more types, periodicallyShow and showDailyAtTime

* reference new version of platform interface, move more methods to platform specific implementations of plugin

* fix periodcallyShow to pass platform specifics

* hide method channel implmentation of plugin, update tests

* remove unused imports

* add more API docs

* reorganise methods, update changelog and pubspec for new release

* update changelog  to mention change on how iOS launch notifications are processed

* remove notification channel methods from Android implementation

Author: MaikuB

flutter_local_notifications/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [1.1.0]
+* Updated plugin to make use of `flutter_local_notifications_platform_interface` version 1.0.1. This allows for platform-specific
+  implementations of the platform interface to now be accessible.
+* **BREAKING CHANGE** Plugin callbacks are no longer publicly accessible
+* **BREAKING CHANGE** [iOS] Local notifications that launched the app should now only be processed by the plugin if they were created by the plugin.
+
 # [1.0.0]
 * **BREAKING CHANGE** [iOS] Added checks to ensure callbacks are only invoked for notifications originating from the plugin to improve compatibility with other notification plugins.
 * [Android] Bump Gradle plugin to 3.5.3

flutter_local_notifications/analysis_options.yaml

@@ -1,4 +1,4 @@
-include: package:pedantic/analysis_options.yaml
+include: package:pedantic/analysis_options.1.8.0.yaml
 
 linter:
   rules:

flutter_local_notifications/ios/Classes/FlutterLocalNotificationsPlugin.m

@@ -6,15 +6,15 @@
 
 @implementation FlutterLocalNotificationsPlugin{
     FlutterMethodChannel* _channel;
-    bool displayAlert;
-    bool playSound;
-    bool updateBadge;
-    bool initialized;
-    bool launchingAppFromNotification;
-    NSUserDefaults *persistentState;
+    bool _displayAlert;
+    bool _playSound;
+    bool _updateBadge;
+    bool _initialized;
+    bool _launchingAppFromNotification;
+    NSUserDefaults *_persistentState;
     NSObject<FlutterPluginRegistrar> *_registrar;
-    NSString *launchPayload;
-    UILocalNotification *launchNotification;
+    NSString *_launchPayload;
+    UILocalNotification *_launchNotification;
 }
 
 NSString *const INITIALIZE_METHOD = @"initialize";
@@ -85,7 +85,7 @@ - (instancetype)initWithChannel:(FlutterMethodChannel *)channel registrar:(NSObj
     if (self) {
         _channel = channel;
         _registrar = registrar;
-        persistentState = [NSUserDefaults standardUserDefaults];
+        _persistentState = [NSUserDefaults standardUserDefaults];
     }
 
     return self;
@@ -137,13 +137,13 @@ - (void)pendingNotificationRequests:(FlutterResult _Nonnull)result {
 - (void)initialize:(FlutterMethodCall * _Nonnull)call result:(FlutterResult _Nonnull)result {
     NSDictionary *arguments = [call arguments];
     if(arguments[DEFAULT_PRESENT_ALERT] != [NSNull null]) {
-        displayAlert = [[arguments objectForKey:DEFAULT_PRESENT_ALERT] boolValue];
+        _displayAlert = [[arguments objectForKey:DEFAULT_PRESENT_ALERT] boolValue];
     }
     if(arguments[DEFAULT_PRESENT_SOUND] != [NSNull null]) {
-        playSound = [[arguments objectForKey:DEFAULT_PRESENT_SOUND] boolValue];
+        _playSound = [[arguments objectForKey:DEFAULT_PRESENT_SOUND] boolValue];
     }
     if(arguments[DEFAULT_PRESENT_BADGE] != [NSNull null]) {
-        updateBadge = [[arguments objectForKey:DEFAULT_PRESENT_BADGE] boolValue];
+        _updateBadge = [[arguments objectForKey:DEFAULT_PRESENT_BADGE] boolValue];
     }
     bool requestedSoundPermission = false;
     bool requestedAlertPermission = false;
@@ -172,8 +172,8 @@ - (void)initialize:(FlutterMethodCall * _Nonnull)call result:(FlutterResult _Non
             authorizationOptions += UNAuthorizationOptionBadge;
         }
         [center requestAuthorizationWithOptions:(authorizationOptions) completionHandler:^(BOOL granted, NSError * _Nullable error) {
-            if(self->launchPayload != nil) {
-                [self handleSelectNotification:self->launchPayload];
+            if(self->_launchPayload != nil) {
+                [self handleSelectNotification:self->_launchPayload];
             }
             result(@(granted));
         }];
@@ -190,13 +190,13 @@ - (void)initialize:(FlutterMethodCall * _Nonnull)call result:(FlutterResult _Non
         }
         UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:notificationTypes categories:nil];
         [[UIApplication sharedApplication] registerUserNotificationSettings:settings];
-        if(launchNotification != nil && [self isAFlutterLocalNotification:launchNotification.userInfo]) {
-            NSString *payload = launchNotification.userInfo[PAYLOAD];
+        if(_launchNotification != nil && [self isAFlutterLocalNotification:_launchNotification.userInfo]) {
+            NSString *payload = _launchNotification.userInfo[PAYLOAD];
             [self handleSelectNotification:payload];
         }
         result(@YES);
     }
-    initialized = true;
+    _initialized = true;
 }
 
 - (void)showNotification:(FlutterMethodCall * _Nonnull)call result:(FlutterResult _Nonnull)result {
@@ -209,9 +209,9 @@ - (void)showNotification:(FlutterMethodCall * _Nonnull)call result:(FlutterResul
         notificationDetails.body = call.arguments[BODY];
     }
     notificationDetails.payload = call.arguments[PAYLOAD];
-    notificationDetails.presentAlert = displayAlert;
-    notificationDetails.presentSound = playSound;
-    notificationDetails.presentBadge = updateBadge;
+    notificationDetails.presentAlert = _displayAlert;
+    notificationDetails.presentSound = _playSound;
+    notificationDetails.presentBadge = _updateBadge;
     if(call.arguments[PLATFORM_SPECIFICS] != [NSNull null]) {
         NSDictionary *platformSpecifics = call.arguments[PLATFORM_SPECIFICS];
 
@@ -299,12 +299,12 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
         [self cancelAllNotifications:result];
     } else if([GET_NOTIFICATION_APP_LAUNCH_DETAILS_METHOD isEqualToString:call.method]) {
         NSString *payload;
-        if(launchNotification != nil) {
-            payload = launchNotification.userInfo[PAYLOAD];
+        if(_launchNotification != nil) {
+            payload = _launchNotification.userInfo[PAYLOAD];
         } else {
-            payload = launchPayload;
+            payload = _launchPayload;
         }
-        NSDictionary *notificationAppLaunchDetails = [NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:launchingAppFromNotification], NOTIFICATION_LAUNCHED_APP, payload, PAYLOAD, nil];
+        NSDictionary *notificationAppLaunchDetails = [NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:_launchingAppFromNotification], NOTIFICATION_LAUNCHED_APP, payload, PAYLOAD, nil];
         result(notificationAppLaunchDetails);
     } else if([PENDING_NOTIFICATIONS_REQUESTS_METHOD isEqualToString:call.method]) {
         [self pendingNotificationRequests:result];
@@ -476,11 +476,11 @@ - (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNot
         presentationOptions |= UNNotificationPresentationOptionBadge;
     }
 
-    
     completionHandler(presentationOptions);
 }
 
 - (void)handleSelectNotification:(NSString *)payload {
+    NSLog(@"handleSelectNotification");
     [_channel invokeMethod:@"selectNotification" arguments:payload];
 }
 
@@ -489,19 +489,22 @@ - (void)userNotificationCenter:(UNUserNotificationCenter *)center
          withCompletionHandler:(void (^)(void))completionHandler NS_AVAILABLE_IOS(10.0) {
     if ([response.actionIdentifier isEqualToString:UNNotificationDefaultActionIdentifier] && [self isAFlutterLocalNotification:response.notification.request.content.userInfo]) {
         NSString *payload = (NSString *) response.notification.request.content.userInfo[PAYLOAD];
-        if(initialized) {
+        if(_initialized) {
             [self handleSelectNotification:payload];
         } else {
-            launchPayload = payload;
-            launchingAppFromNotification = true;
+            _launchPayload = payload;
+            _launchingAppFromNotification = true;
         }
     }
 }
 - (BOOL)application:(UIApplication *)application
 didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     if (launchOptions != nil) {
-        launchNotification = (UILocalNotification *)[launchOptions objectForKey:UIApplicationLaunchOptionsLocalNotificationKey];
-        launchingAppFromNotification = launchNotification != nil;
+        UILocalNotification *launchNotification = (UILocalNotification *)[launchOptions objectForKey:UIApplicationLaunchOptionsLocalNotificationKey];
+        _launchingAppFromNotification = launchNotification != nil && [self isAFlutterLocalNotification:launchNotification.userInfo];
+        if(_launchingAppFromNotification) {
+            _launchNotification = launchNotification;
+        }
     }
 
     return YES;

flutter_local_notifications/lib/flutter_local_notifications.dart

@@ -1,4 +1,5 @@
-library flutter_local_notifications;
+export 'package:flutter_local_notifications_platform_interface/flutter_local_notifications_platform_interface.dart'
+    show PendingNotificationRequest, RepeatInterval;
 
 export 'src/platform_specifics/android/styles/style_information.dart';
 export 'src/platform_specifics/android/styles/default_style_information.dart';
@@ -15,6 +16,8 @@ export 'src/platform_specifics/ios/initialization_settings.dart';
 export 'src/platform_specifics/ios/notification_details.dart';
 export 'src/notification_details.dart';
 export 'src/initialization_settings.dart';
-export 'src/flutter_local_notifications.dart';
-export 'src/notification_app_launch_details.dart';
-export 'src/pending_notification_request.dart';
+export 'src/flutter_local_notifications_plugin.dart';
+export 'src/platform_flutter_local_notifications.dart'
+    hide MethodChannelFlutterLocalNotificationsPlugin;
+export 'src/types.dart';
+export 'src/typedefs.dart';