35 @property(nonatomic, assign) BOOL sceneWillConnectEventHandledByPlugin;
36 @property(nonatomic, assign) BOOL sceneWillConnectFallbackCalled;
41 - (instancetype)init {
42 if (
self = [super init]) {
43 _flutterManagedEngines = [NSPointerArray weakObjectsPointerArray];
44 _developerManagedEngines = [NSPointerArray weakObjectsPointerArray];
45 _sceneWillConnectFallbackCalled = NO;
46 _sceneWillConnectEventHandledByPlugin = NO;
51 #pragma mark - Manual Engine Registration
53 - (BOOL)registerSceneLifeCycleWithFlutterEngine:(
FlutterEngine*)engine {
56 [
self removeFlutterManagedEngine:engine];
59 if ([
self manuallyRegisteredEngine:
engine]) {
63 [
self.developerManagedEngines addPointer:(__bridge void*)engine];
65 [
self compactNSPointerArray:self.developerManagedEngines];
67 engine.manuallyRegisteredToScene = YES;
72 - (BOOL)unregisterSceneLifeCycleWithFlutterEngine:(
FlutterEngine*)engine {
73 NSUInteger index = [
self.developerManagedEngines.allObjects indexOfObject:engine];
74 if (index != NSNotFound) {
75 [
self.developerManagedEngines removePointerAtIndex:index];
82 return [
self.developerManagedEngines.allObjects containsObject:engine];
85 #pragma mark - Automatic Flutter Engine Registration
94 if (
engine.manuallyRegisteredToScene) {
98 [
self.flutterManagedEngines addPointer:(__bridge void*)engine];
100 [
self compactNSPointerArray:self.flutterManagedEngines];
105 NSUInteger index = [
self.flutterManagedEngines.allObjects indexOfObject:engine];
106 if (index != NSNotFound) {
107 [
self.flutterManagedEngines removePointerAtIndex:index];
113 - (void)updateFlutterManagedEnginesInScene:(UIScene*)scene {
117 for (NSUInteger i = 0; i <
self.flutterManagedEngines.count; i++) {
122 [
self.flutterManagedEngines removePointerAtIndex:i];
136 UIWindowScene* actualScene =
engine.viewController.view.window.windowScene;
137 if (actualScene != nil && actualScene != scene) {
138 [
self.flutterManagedEngines removePointerAtIndex:i];
142 id<FlutterSceneLifeCycleProvider> lifeCycleProvider =
143 (id<FlutterSceneLifeCycleProvider>)actualScene.delegate;
144 [lifeCycleProvider.sceneLifeCycleDelegate addFlutterManagedEngine:
engine];
152 return [_flutterManagedEngines.allObjects
153 arrayByAddingObjectsFromArray:_developerManagedEngines.allObjects];
163 if ([appDelegate respondsToSelector:
@selector(lifeCycleDelegate)]) {
164 id lifecycleDelegate = [appDelegate lifeCycleDelegate];
166 return lifecycleDelegate;
172 #pragma mark - Connecting and disconnecting the scene
177 BOOL added = [
self addFlutterManagedEngine:engine];
185 willConnectToSession:scene.session
187 options:self.connectionOptions];
191 - (void)scene:(UIScene*)scene
192 willConnectToSession:(UISceneSession*)session
193 options:(UISceneConnectionOptions*)connectionOptions {
195 if ([scene.delegate conformsToProtocol:
@protocol(UIWindowSceneDelegate)]) {
196 NSObject<UIWindowSceneDelegate>* sceneDelegate =
197 (NSObject<UIWindowSceneDelegate>*)scene.delegate;
201 [
self addFlutterManagedEngine:rootViewController.
engine];
205 [
self updateFlutterManagedEnginesInScene:scene];
208 [
self scene:scene willConnectToSession:session flutterEngine:engine options:connectionOptions];
212 - (void)scene:(UIScene*)scene
213 willConnectToSession:(UISceneSession*)session
215 options:(UISceneConnectionOptions*)connectionOptions {
218 if (
self.sceneWillConnectEventHandledByPlugin) {
219 availableOptions = nil;
221 BOOL handledByPlugin = [engine.sceneLifeCycleDelegate scene:scene
222 willConnectToSession:session
223 options:availableOptions];
227 if (!handledByPlugin && !
self.sceneWillConnectFallbackCalled) {
228 self.sceneWillConnectFallbackCalled = YES;
229 if ([[
self applicationLifeCycleDelegate] sceneWillConnectFallback:
connectionOptions]) {
230 handledByPlugin = YES;
233 if (handledByPlugin) {
234 self.sceneWillConnectEventHandledByPlugin = YES;
237 if (!
self.sceneWillConnectEventHandledByPlugin) {
239 [
self handleDeeplinkingForEngine:engine options:connectionOptions];
243 - (void)sceneDidDisconnect:(UIScene*)scene {
244 [
self updateFlutterManagedEnginesInScene:scene];
246 [engine.sceneLifeCycleDelegate sceneDidDisconnect:scene];
251 #pragma mark - Transitioning to the foreground
253 - (void)sceneWillEnterForeground:(UIScene*)scene {
254 [
self updateFlutterManagedEnginesInScene:scene];
258 [[
self applicationLifeCycleDelegate] sceneWillEnterForegroundFallback];
261 - (void)sceneDidBecomeActive:(UIScene*)scene {
262 [
self updateFlutterManagedEnginesInScene:scene];
264 [engine.sceneLifeCycleDelegate sceneDidBecomeActive:scene];
266 [[
self applicationLifeCycleDelegate] sceneDidBecomeActiveFallback];
269 #pragma mark - Transitioning to the background
271 - (void)sceneWillResignActive:(UIScene*)scene {
272 [
self updateFlutterManagedEnginesInScene:scene];
274 [engine.sceneLifeCycleDelegate sceneWillResignActive:scene];
276 [[
self applicationLifeCycleDelegate] sceneWillResignActiveFallback];
279 - (void)sceneDidEnterBackground:(UIScene*)scene {
280 [
self updateFlutterManagedEnginesInScene:scene];
284 [[
self applicationLifeCycleDelegate] sceneDidEnterBackgroundFallback];
287 #pragma mark - Opening URLs
289 - (void)scene:(UIScene*)scene openURLContexts:(NSSet<UIOpenURLContext*>*)URLContexts {
290 [
self updateFlutterManagedEnginesInScene:scene];
293 NSMutableSet<FlutterEngine*>* enginesHandledByPlugin = [NSMutableSet set];
295 if ([
engine.sceneLifeCycleDelegate scene:scene openURLContexts:URLContexts]) {
296 [enginesHandledByPlugin addObject:engine];
301 if (enginesHandledByPlugin.count == 0) {
302 if ([[
self applicationLifeCycleDelegate] sceneFallbackOpenURLContexts:URLContexts]) {
310 if ([enginesHandledByPlugin containsObject:
engine]) {
313 for (UIOpenURLContext* urlContext in URLContexts) {
314 if ([
self handleDeeplink:urlContext.URL flutterEngine:
engine]) {
321 #pragma mark - Continuing user activities
323 - (void)scene:(UIScene*)scene continueUserActivity:(NSUserActivity*)userActivity {
324 [
self updateFlutterManagedEnginesInScene:scene];
327 NSMutableSet<FlutterEngine*>* enginesHandledByPlugin = [NSMutableSet set];
329 if ([
engine.sceneLifeCycleDelegate scene:scene continueUserActivity:userActivity]) {
330 [enginesHandledByPlugin addObject:engine];
335 if (enginesHandledByPlugin.count == 0) {
336 if ([[
self applicationLifeCycleDelegate] sceneFallbackContinueUserActivity:userActivity]) {
344 if ([enginesHandledByPlugin containsObject:
engine]) {
347 [
self handleDeeplink:userActivity.webpageURL flutterEngine:engine];
351 #pragma mark - Saving the state of the scene
353 - (NSUserActivity*)stateRestorationActivityForScene:(UIScene*)scene {
355 NSUserActivity* activity = scene.userActivity;
357 activity = [[NSUserActivity alloc] initWithActivityType:scene.session.configuration.name];
360 [
self updateFlutterManagedEnginesInScene:scene];
364 NSString* restorationId = vc.restorationIdentifier;
366 NSData* restorationData = [engine.restorationPlugin restorationData];
367 if (restorationData) {
368 [activity addUserInfoEntriesFromDictionary:@{restorationId : restorationData}];
369 [activity addUserInfoEntriesFromDictionary:@{
370 kRestorationStateAppModificationKey : [NSNumber numberWithLongLong:appBundleModifiedTime]
379 - (void)scene:(UIScene*)scene
380 restoreInteractionStateWithUserActivity:(NSUserActivity*)stateRestorationActivity {
382 NSDictionary<NSString*, id>* userInfo = stateRestorationActivity.userInfo;
383 [
self updateFlutterManagedEnginesInScene:scene];
385 NSNumber* stateDateNumber = userInfo[kRestorationStateAppModificationKey];
386 int64_t stateDate = 0;
387 if (stateDateNumber && [stateDateNumber isKindOfClass:[NSNumber
class]]) {
388 stateDate = [stateDateNumber longLongValue];
390 if (appBundleModifiedTime != stateDate) {
396 UIViewController* vc = (UIViewController*)
engine.viewController;
397 NSString* restorationId = vc.restorationIdentifier;
399 NSData* restorationData = userInfo[restorationId];
400 if ([restorationData isKindOfClass:[NSData
class]]) {
401 [engine.restorationPlugin setRestorationData:restorationData];
407 #pragma mark - Performing tasks
409 - (void)windowScene:(UIWindowScene*)windowScene
410 performActionForShortcutItem:(UIApplicationShortcutItem*)shortcutItem
411 completionHandler:(
void (^)(BOOL succeeded))completionHandler {
412 [
self updateFlutterManagedEnginesInScene:windowScene];
414 BOOL handledByPlugin = NO;
416 BOOL result = [engine.sceneLifeCycleDelegate windowScene:windowScene
417 performActionForShortcutItem:shortcutItem
418 completionHandler:completionHandler];
420 handledByPlugin = YES;
423 if (!handledByPlugin) {
424 [[
self applicationLifeCycleDelegate]
425 sceneFallbackPerformActionForShortcutItem:shortcutItem
426 completionHandler:completionHandler];
430 #pragma mark - Helpers
433 options:(UISceneConnectionOptions*)connectionOptions {
439 if ([
self handleDeeplink:userActivity.webpageURL flutterEngine:
engine]) {
448 if ([
self handleDeeplink:urlContext.URL flutterEngine:
engine]) {
454 - (BOOL)handleDeeplink:(NSURL*)url flutterEngine:(
FlutterEngine*)engine {
463 [engine sendDeepLinkToFramework:url
464 completionHandler:^(BOOL success){
472 NSObject<FlutterSceneLifeCycleProvider>* sceneProvider =
473 (NSObject<FlutterSceneLifeCycleProvider>*)scene.delegate;
474 return sceneProvider.sceneLifeCycleDelegate;
480 NSObject<FlutterSceneLifeCycleProvider>* sceneProvider =
481 (NSObject<FlutterSceneLifeCycleProvider>*)scene.delegate;
482 if ([sceneProvider respondsToSelector:
@selector(sceneLifeCycleDelegate)]) {
483 id sceneLifeCycleDelegate = sceneProvider.sceneLifeCycleDelegate;
492 - (void)compactNSPointerArray:(NSPointerArray*)array {
497 [array addPointer:nil];
507 - (instancetype)init {
508 if (
self = [super init]) {
509 _delegates = [NSPointerArray weakObjectsPointerArray];
515 [_delegates addPointer:(__bridge void*)delegate];
521 [_delegates addPointer:nil];
522 [_delegates compact];
525 #pragma mark - Connecting and disconnecting the scene
527 - (BOOL)scene:(UIScene*)scene
528 willConnectToSession:(UISceneSession*)session
529 options:(UISceneConnectionOptions*)connectionOptions {
530 BOOL handledByPlugin = NO;
531 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
532 if ([delegate respondsToSelector:_cmd]) {
535 if ([delegate scene:scene
536 willConnectToSession:session
537 options:(handledByPlugin ? nil : connectionOptions)]) {
538 handledByPlugin = YES;
542 return handledByPlugin;
545 - (void)sceneDidDisconnect:(UIScene*)scene {
546 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
547 if ([delegate respondsToSelector:_cmd]) {
548 [delegate sceneDidDisconnect:scene];
553 #pragma mark - Transitioning to the foreground
555 - (void)sceneWillEnterForeground:(UIScene*)scene {
556 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
557 if ([delegate respondsToSelector:_cmd]) {
558 [delegate sceneWillEnterForeground:scene];
563 - (void)sceneDidBecomeActive:(UIScene*)scene {
564 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
565 if ([delegate respondsToSelector:_cmd]) {
566 [delegate sceneDidBecomeActive:scene];
571 #pragma mark - Transitioning to the background
573 - (void)sceneWillResignActive:(UIScene*)scene {
574 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
575 if ([delegate respondsToSelector:_cmd]) {
576 [delegate sceneWillResignActive:scene];
581 - (void)sceneDidEnterBackground:(UIScene*)scene {
582 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
583 if ([delegate respondsToSelector:_cmd]) {
584 [delegate sceneDidEnterBackground:scene];
589 #pragma mark - Opening URLs
591 - (BOOL)scene:(UIScene*)scene openURLContexts:(NSSet<UIOpenURLContext*>*)URLContexts {
592 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
593 if ([delegate respondsToSelector:_cmd]) {
594 if ([delegate scene:scene openURLContexts:URLContexts]) {
603 #pragma mark - Continuing user activities
605 - (BOOL)scene:(UIScene*)scene continueUserActivity:(NSUserActivity*)userActivity {
606 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
607 if ([delegate respondsToSelector:_cmd]) {
608 if ([delegate scene:scene continueUserActivity:userActivity]) {
617 #pragma mark - Performing tasks
619 - (BOOL)windowScene:(UIWindowScene*)windowScene
620 performActionForShortcutItem:(UIApplicationShortcutItem*)shortcutItem
621 completionHandler:(
void (^)(BOOL succeeded))completionHandler {
622 for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in
_delegates.allObjects) {
623 if ([delegate respondsToSelector:_cmd]) {
624 if ([delegate windowScene:windowScene
625 performActionForShortcutItem:shortcutItem
626 completionHandler:completionHandler]) {
NSPointerArray * _delegates
NSPointerArray * developerManagedEngines
NSPointerArray * flutterManagedEngines
UISceneConnectionOptions * connectionOptions
void sceneWillEnterForeground:(ios(13.0) API_AVAILABLE)
void sceneDidEnterBackground:(ios(13.0) API_AVAILABLE)
UIApplication * application
int64_t lastAppModificationTime
BOOL isFlutterDeepLinkingEnabled()