FlutterSceneLifeCycle_Internal.h

Go to the documentation of this file.

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
#ifndef FLUTTER_SHELL_PLATFORM_DARWIN_IOS_FRAMEWORK_SOURCE_FLUTTERSCENELIFECYCLE_INTERNAL_H_
#define FLUTTER_SHELL_PLATFORM_DARWIN_IOS_FRAMEWORK_SOURCE_FLUTTERSCENELIFECYCLE_INTERNAL_H_
 
#import "flutter/shell/platform/darwin/ios/framework/Headers/FlutterSceneLifeCycle.h"
#import "flutter/shell/platform/darwin/ios/framework/Headers/FlutterViewController.h"
 
/**
 * Forwards `UIWindowSceneDelegate` callbacks to the `FlutterEngine`'s
 * `FlutterPluginSceneLifeCycleDelegate` to then be forwarded to registered plugins.
 */
@interface FlutterPluginSceneLifeCycleDelegate ()
 
/**
 * Associates the `FlutterEngine` with the `FlutterPluginSceneLifeCycleDelegate` so that it will
 * forward scene events to the plugins within the engine.
 *
 * Returns NO if the engine is already associated with the delegate.
 */
- (BOOL)addFlutterManagedEngine:(FlutterEngine*)engine;
 
/**
 * Removes the `FlutterEngine` from the `FlutterPluginSceneLifeCycleDelegate` so that it will no
 * longer forward scene events to the plugins within the engine.
 *
 * Returns NO if the engine is not associated with the delegate.
 */
- (BOOL)removeFlutterManagedEngine:(FlutterEngine*)engine;
 
- (void)engine:(FlutterEngine*)engine receivedConnectNotificationFor:(UIScene*)scene;
 
- (NSUserActivity*)stateRestorationActivityForScene:(UIScene*)scene;
 
- (void)scene:(UIScene*)scene
    restoreInteractionStateWithUserActivity:(NSUserActivity*)stateRestorationActivity;
 
+ (FlutterPluginSceneLifeCycleDelegate*)fromScene:(UIScene*)scene;
 
@end
 
/**
 * Forwards callbacks to registered plugins.
 */
@interface FlutterEnginePluginSceneLifeCycleDelegate : NSObject
 
- (void)addDelegate:(NSObject<FlutterSceneLifeCycleDelegate>*)delegate;
 
#pragma mark - Connecting and disconnecting the scene
 
- (BOOL)scene:(UIScene*)scene
    willConnectToSession:(UISceneSession*)session
                 options:(UISceneConnectionOptions*)connectionOptions;
 
- (void)sceneDidDisconnect:(UIScene*)scene;
 
#pragma mark - Transitioning to the foreground
 
- (void)sceneWillEnterForeground:(UIScene*)scene;
 
- (void)sceneDidBecomeActive:(UIScene*)scene;
 
#pragma mark - Transitioning to the background
 
- (void)sceneWillResignActive:(UIScene*)scene;
 
- (void)sceneDidEnterBackground:(UIScene*)scene;
 
#pragma mark - Opening URLs
 
- (BOOL)scene:(UIScene*)scene openURLContexts:(NSSet<UIOpenURLContext*>*)URLContexts;
 
#pragma mark - Continuing user activities
 
- (BOOL)scene:(UIScene*)scene continueUserActivity:(NSUserActivity*)userActivity;
 
#pragma mark - Performing tasks
 
- (BOOL)windowScene:(UIWindowScene*)windowScene
    performActionForShortcutItem:(UIApplicationShortcutItem*)shortcutItem
               completionHandler:(void (^)(BOOL succeeded))completionHandler;
 
@end
 
#endif  // FLUTTER_SHELL_PLATFORM_DARWIN_IOS_FRAMEWORK_SOURCE_FLUTTERSCENELIFECYCLE_INTERNAL_H_