FlutterEnginePluginSceneLifeCycleDelegate Class Reference

#import <FlutterSceneLifeCycle_Internal.h>

Inheritance diagram for FlutterEnginePluginSceneLifeCycleDelegate:

Instance Methods
(void)	- addDelegate:
(BOOL)	- scene:willConnectToSession:options:
(void)	- sceneDidDisconnect:
(void)	- sceneWillEnterForeground:
(void)	- sceneDidBecomeActive:
(void)	- sceneWillResignActive:
(void)	- sceneDidEnterBackground:
(BOOL)	- scene:openURLContexts:
(BOOL)	- scene:continueUserActivity:
(BOOL)	- windowScene:performActionForShortcutItem:completionHandler:

Detailed Description

Forwards callbacks to registered plugins.

Definition at line 511 of file FlutterSceneLifeCycle.mm.

Method Documentation

addDelegate:

- (void) addDelegate:

(NSObject<FlutterSceneLifeCycleDelegate>*)

delegate

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                   :(NSObject<FlutterSceneLifeCycleDelegate>*)delegate {
  [_delegates addPointer:(__bridge void*)delegate];
 
  // NSPointerArray is clever and assumes that unless a mutation operation has occurred on it that
  // has set one of its values to nil, nothing could have changed and it can skip compaction.
  // That's reasonable behaviour on a regular NSPointerArray but not for a weakObjectPointerArray.
  // As a workaround, we mutate it first. See: http://www.openradar.me/15396578
  [_delegates addPointer:nil];
  [_delegates compact];
}

scene:continueUserActivity:

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

Definition at line 36 of file FlutterSceneLifeCycle.mm.

             :(UIScene*)scene continueUserActivity:(NSUserActivity*)userActivity {
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      if ([delegate scene:scene continueUserActivity:userActivity]) {
        // Only allow one plugin to process this event.
        return YES;
      }
    }
  }
  return NO;
}

scene:openURLContexts:

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

Definition at line 36 of file FlutterSceneLifeCycle.mm.

             :(UIScene*)scene openURLContexts:(NSSet<UIOpenURLContext*>*)URLContexts {
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      if ([delegate scene:scene openURLContexts:URLContexts]) {
        // Only allow one plugin to process this event.
        return YES;
      }
    }
  }
  return NO;
}

scene:willConnectToSession:options:

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

Definition at line 36 of file FlutterSceneLifeCycle.mm.

             :(UIScene*)scene
    willConnectToSession:(UISceneSession*)session
                 options:(UISceneConnectionOptions*)connectionOptions {
  BOOL handledByPlugin = NO;
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      // If this event has already been consumed by a plugin, send the event with nil options.
      // Only allow one plugin to process the connection options.
      if ([delegate scene:scene
              willConnectToSession:session
                           options:(handledByPlugin ? nil : connectionOptions)]) {
        handledByPlugin = YES;
      }
    }
  }
  return handledByPlugin;
}

sceneDidBecomeActive:

- (void) sceneDidBecomeActive:

(UIScene*)

scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                            :(UIScene*)scene {
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      [delegate sceneDidBecomeActive:scene];
    }
  }
}

sceneDidDisconnect:

- (void) sceneDidDisconnect:

(UIScene*)

scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                          :(UIScene*)scene {
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      [delegate sceneDidDisconnect:scene];
    }
  }
}

sceneDidEnterBackground:

- (void) sceneDidEnterBackground:

(UIScene*)

scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                               :(UIScene*)scene {
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      [delegate sceneDidEnterBackground:scene];
    }
  }
}

sceneWillEnterForeground:

- (void) sceneWillEnterForeground:

(UIScene*)

scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                                :(UIScene*)scene {
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      [delegate sceneWillEnterForeground:scene];
    }
  }
}

sceneWillResignActive:

- (void) sceneWillResignActive:

(UIScene*)

scene

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                             :(UIScene*)scene {
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      [delegate sceneWillResignActive:scene];
    }
  }
}

windowScene:performActionForShortcutItem:completionHandler:

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

Definition at line 36 of file FlutterSceneLifeCycle.mm.

                   :(UIWindowScene*)windowScene
    performActionForShortcutItem:(UIApplicationShortcutItem*)shortcutItem
               completionHandler:(void (^)(BOOL succeeded))completionHandler {
  for (NSObject<FlutterSceneLifeCycleDelegate>* delegate in _delegates.allObjects) {
    if ([delegate respondsToSelector:_cmd]) {
      if ([delegate windowScene:windowScene
              performActionForShortcutItem:shortcutItem
                         completionHandler:completionHandler]) {
        // Only allow one plugin to process this event.
        return YES;
      }
    }
  }
  return NO;
}

---

The documentation for this class was generated from the following files:

• shell/platform/darwin/ios/framework/Source/FlutterSceneLifeCycle.mm
• shell/platform/darwin/ios/framework/Source/FlutterSceneLifeCycle_Internal.h