#include <FlutterSceneLifeCycle.h>

Inheritance diagram for FlutterPluginSceneLifeCycleDelegate:

Instance Methods
(void)	- scene:willConnectToSession:options:

(void)	- sceneDidDisconnect:

(void)	- sceneWillEnterForeground:

(void)	- sceneDidBecomeActive:

(void)	- sceneWillResignActive:

(void)	- sceneDidEnterBackground:

(void)	- scene:openURLContexts:

(void)	- scene:continueUserActivity:

(void)	- windowScene:performActionForShortcutItem:completionHandler:

(void)	- updateFlutterManagedEnginesInScene:

(void)	- scene:willConnectToSession:flutterEngine:options:

(NSArray *)	- allEngines

Instance Methods inherited from <FlutterSceneLifeCycleEngineRegistration>
(BOOL)	- registerSceneLifeCycleWithFlutterEngine:

(BOOL)	- unregisterSceneLifeCycleWithFlutterEngine:

Properties
UISceneConnectionOptions *	connectionOptions

NSPointerArray *	flutterManagedEngines

NSPointerArray *	developerManagedEngines

Detailed Description

Forwards UISceneDelegate and UIWindowSceneDelegate callbacks to plugins that register for them.

This class is responsible for receiving UISceneDelegate and UIWindowSceneDelegate callbacks and forwarding them to any plugins.

Definition at line 149 of file FlutterSceneLifeCycle.h.

Method Documentation

◆ allEngines

- (NSArray *) allEngines

Provided by category FlutterPluginSceneLifeCycleDelegate(Test).

◆ scene:continueUserActivity:

- (void) scene:	(UIScene*)	scene
continueUserActivity:	(NSUserActivity*)	userActivity

Calls all plugins registered for UIWindowScene callbacks in order of registration until a plugin handles the request.

Definition at line 36 of file FlutterSceneLifeCycle.mm.

             :(UIScene*)scene continueUserActivity:(NSUserActivity*)userActivity {
  [self updateFlutterManagedEnginesInScene:scene];
 
  // Track engines that had this event handled by a plugin.
  NSMutableSet<FlutterEngine*>* enginesHandledByPlugin = [NSMutableSet set];
  for (FlutterEngine* engine in [self allEngines]) {
    if ([engine.sceneLifeCycleDelegate scene:scene continueUserActivity:userActivity]) {
      [enginesHandledByPlugin addObject:engine];
    }
  }
 
  // If no plugins handled this, give the application fallback a chance to handle it.
  if (enginesHandledByPlugin.count == 0) {
    if ([[self applicationLifeCycleDelegate] sceneFallbackContinueUserActivity:userActivity]) {
      // If the application fallback handles it, don't do any deeplinking.
      return;
    }
  }
 
  // For any engine that was not handled by a plugin, do deeplinking.
  for (FlutterEngine* engine in [self allEngines]) {
    if ([enginesHandledByPlugin containsObject:engine]) {
      continue;
    }
    [self handleDeeplink:userActivity.webpageURL flutterEngine:engine relayToSystemIfUnhandled:YES];
  }
}

◆ scene:openURLContexts:

- (void) scene:	(UIScene*)	scene
openURLContexts:	(NSSet<UIOpenURLContext>)	URLContexts

Calls all plugins registered for UIWindowScene callbacks in order of registration until a plugin handles the request.

Definition at line 36 of file FlutterSceneLifeCycle.mm.

             :(UIScene*)scene openURLContexts:(NSSet<UIOpenURLContext*>*)URLContexts {
  [self updateFlutterManagedEnginesInScene:scene];
 
  // Track engines that had this event handled by a plugin.
  NSMutableSet<FlutterEngine*>* enginesHandledByPlugin = [NSMutableSet set];
  for (FlutterEngine* engine in [self allEngines]) {
    if ([engine.sceneLifeCycleDelegate scene:scene openURLContexts:URLContexts]) {
      [enginesHandledByPlugin addObject:engine];
    }
  }
 
  // If no plugins handled this, give the application fallback a chance to handle it.
  if (enginesHandledByPlugin.count == 0) {
    if ([[self applicationLifeCycleDelegate] sceneFallbackOpenURLContexts:URLContexts]) {
      // If the application fallback handles it, don't do any deeplinking.
      return;
    }
  }
 
  // For any engine that was not handled by a plugin, do deeplinking.
  for (FlutterEngine* engine in [self allEngines]) {
    if ([enginesHandledByPlugin containsObject:engine]) {
      continue;
    }
    for (UIOpenURLContext* urlContext in URLContexts) {
      if ([self handleDeeplink:urlContext.URL flutterEngine:engine relayToSystemIfUnhandled:NO]) {
        break;
      }
    }
  }
}

◆ scene:willConnectToSession:flutterEngine:options:

- (void) scene:	(UIScene *)	scene
willConnectToSession:	(UISceneSession *)	session
flutterEngine:	(FlutterEngine *)	engine
options:	(UISceneConnectionOptions *)	connectionOptions

Provided by category FlutterPluginSceneLifeCycleDelegate(Test).

◆ scene:willConnectToSession:options:

- (void) scene:	(UIScene*)	scene
willConnectToSession:	(UISceneSession*)	session
options:	(UISceneConnectionOptions*)	connectionOptions

Calls all plugins registered for UIWindowScene callbacks in order of registration until a plugin handles the request.

Definition at line 36 of file FlutterSceneLifeCycle.mm.

             :(UIScene*)scene
    willConnectToSession:(UISceneSession*)session
                 options:(UISceneConnectionOptions*)connectionOptions {
  self.connectionOptions = connectionOptions;
  if ([scene.delegate conformsToProtocol:@protocol(UIWindowSceneDelegate)]) {
    NSObject<UIWindowSceneDelegate>* sceneDelegate =
        (NSObject<UIWindowSceneDelegate>*)scene.delegate;
    if ([sceneDelegate.window.rootViewController isKindOfClass:[FlutterViewController class]]) {
      FlutterViewController* rootViewController =
          (FlutterViewController*)sceneDelegate.window.rootViewController;
      [self addFlutterManagedEngine:rootViewController.engine];
    }
  }
 
  [self updateFlutterManagedEnginesInScene:scene];
 
  for (FlutterEngine* engine in [self allEngines]) {
    [self scene:scene willConnectToSession:session flutterEngine:engine options:connectionOptions];
  }
}

◆ sceneDidBecomeActive:

- (void) sceneDidBecomeActive: (UIScene*) scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                            :(UIScene*)scene {
  [self updateFlutterManagedEnginesInScene:scene];
  for (FlutterEngine* engine in [self allEngines]) {
    [engine.sceneLifeCycleDelegate sceneDidBecomeActive:scene];
  }
  [[self applicationLifeCycleDelegate] sceneDidBecomeActiveFallback];
}

◆ sceneDidDisconnect:

- (void) sceneDidDisconnect: (UIScene*) scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                          :(UIScene*)scene {
  [self updateFlutterManagedEnginesInScene:scene];
  for (FlutterEngine* engine in [self allEngines]) {
    [engine.sceneLifeCycleDelegate sceneDidDisconnect:scene];
  }
  // There is no application equivalent for this event and therefore no fallback.
}

◆ sceneDidEnterBackground:

- (void) sceneDidEnterBackground: (UIScene*) scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                               :(UIScene*)scene {
  [self updateFlutterManagedEnginesInScene:scene];
  for (FlutterEngine* engine in [self allEngines]) {
    [engine.sceneLifeCycleDelegate sceneDidEnterBackground:scene];
  }
  [[self applicationLifeCycleDelegate] sceneDidEnterBackgroundFallback];
}

◆ sceneWillEnterForeground:

- (void) sceneWillEnterForeground: (UIScene*) scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                                :(UIScene*)scene {
  [self updateFlutterManagedEnginesInScene:scene];
  for (FlutterEngine* engine in [self allEngines]) {
    [engine.sceneLifeCycleDelegate sceneWillEnterForeground:scene];
  }
  [[self applicationLifeCycleDelegate] sceneWillEnterForegroundFallback];
}

◆ sceneWillResignActive:

- (void) sceneWillResignActive: (UIScene*) scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                             :(UIScene*)scene {
  [self updateFlutterManagedEnginesInScene:scene];
  for (FlutterEngine* engine in [self allEngines]) {
    [engine.sceneLifeCycleDelegate sceneWillResignActive:scene];
  }
  [[self applicationLifeCycleDelegate] sceneWillResignActiveFallback];
}

◆ updateFlutterManagedEnginesInScene:

- (void) updateFlutterManagedEnginesInScene: (UIScene *) scene

Provided by category FlutterPluginSceneLifeCycleDelegate(Test).

◆ windowScene:performActionForShortcutItem:completionHandler:

- (void) windowScene:	(UIWindowScene*)	windowScene
performActionForShortcutItem:	(UIApplicationShortcutItem*)	shortcutItem
completionHandler:	(void(^)(BOOL succeeded))	completionHandler

Calls all plugins registered for UIWindowScene callbacks in order of registration until a plugin handles the request.

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                   :(UIWindowScene*)windowScene
    performActionForShortcutItem:(UIApplicationShortcutItem*)shortcutItem
               completionHandler:(void (^)(BOOL succeeded))completionHandler {
  [self updateFlutterManagedEnginesInScene:windowScene];
 
  BOOL handledByPlugin = NO;
  for (FlutterEngine* engine in [self allEngines]) {
    BOOL result = [engine.sceneLifeCycleDelegate windowScene:windowScene
                                performActionForShortcutItem:shortcutItem
                                           completionHandler:completionHandler];
    if (result) {
      handledByPlugin = YES;
    }
  }
  if (!handledByPlugin) {
    [[self applicationLifeCycleDelegate]
        sceneFallbackPerformActionForShortcutItem:shortcutItem
                                completionHandler:completionHandler];
  }
}