FlutterHeadlessDartRunner Class Reference

#include <FlutterHeadlessDartRunner.h>

Inheritance diagram for FlutterHeadlessDartRunner:

Instance Methods
(instancetype)	- initWithName:project:
(instancetype)	- initWithName:project:allowHeadlessExecution:
(instancetype)	- initWithName:project:allowHeadlessExecution:restorationEnabled:
(instancetype)	- init
Instance Methods inherited from FlutterEngine
(instancetype)	- initWithName:
(instancetype)	- initWithName:project:
(instancetype)	- initWithName:project:allowHeadlessExecution:
(instancetype)	- initWithName:project:allowHeadlessExecution:restorationEnabled:
(BOOL)	- run
(BOOL)	- runWithEntrypoint:
(BOOL)	- runWithEntrypoint:initialRoute:
(BOOL)	- runWithEntrypoint:libraryURI:
(BOOL)	- runWithEntrypoint:libraryURI:initialRoute:
(BOOL)	- runWithEntrypoint:libraryURI:initialRoute:entrypointArgs:
(void)	- destroyContext
(void)	- ensureSemanticsEnabled
(NSURL *observatoryUrl)	- FLUTTER_DEPRECATED
(nonnull instancetype)	- initWithName:project:
(nonnull instancetype)	- initWithName:project:allowHeadlessExecution:
(nonnull instancetype)	- NS_UNAVAILABLE
(BOOL)	- runWithEntrypoint:
(void)	- shutDownEngine
(void)	- setUpSceneLifecycleNotifications: [implementation]
(void)	- setUpApplicationLifecycleNotifications: [implementation]
(void)	- recreatePlatformViewController [implementation]
(flutter::IOSRenderingAPI)	- platformViewsRenderingAPI [implementation]
(void)	- dealloc [implementation]
(flutter::Shell &)	- shell [implementation]
(fml::WeakNSObject< FlutterEngine >)	- getWeakNSObject [implementation]
(void)	- updateViewportMetrics: [implementation]
(void)	- dispatchPointerDataPacket: [implementation]
(fml::WeakPtr< flutter::PlatformView >)	- platformView [implementation]
(flutter::PlatformViewIOS *)	- iosPlatformView [implementation]
(fml::RefPtr< fml::TaskRunner >)	- platformTaskRunner [implementation]
(fml::RefPtr< fml::TaskRunner >)	- uiTaskRunner [implementation]
(fml::RefPtr< fml::TaskRunner >)	- rasterTaskRunner [implementation]
(void)	- sendKeyEvent:callback:userData: [implementation]
(void)	- setViewController: [implementation]
(void)	- attachView [implementation]
(void)	- setFlutterViewControllerWillDeallocObserver: [implementation]
(void)	- notifyViewControllerDeallocated [implementation]
(FlutterPlatformPlugin *)	- platformPlugin [implementation]
(std::shared_ptr< flutter::FlutterPlatformViewsController > &)	- platformViewsController [implementation]
(FlutterTextInputPlugin *)	- textInputPlugin [implementation]
(FlutterUndoManagerPlugin *)	- undoManagerPlugin [implementation]
(FlutterRestorationPlugin *)	- restorationPlugin [implementation]
(FlutterMethodChannel *)	- undoManagerChannel [implementation]
(FlutterMethodChannel *)	- scribbleChannel [implementation]
(FlutterMethodChannel *)	- spellCheckChannel [implementation]
(NSURL *)	- observatoryUrl [implementation]
(void)	- resetChannels [implementation]
(void)	- startProfiler [implementation]
(void)	- setUpChannels [implementation]
(void)	- maybeSetupPlatformViewChannels [implementation]
(flutter::Rasterizer::Screenshot)	- screenshot:base64Encode: [implementation]
(void)	- launchEngine:libraryURI:entrypointArgs: [implementation]
(void)	- setUpShell:withVMServicePublication: [implementation]
(BOOL)	- createShell:libraryURI:initialRoute: [implementation]
(void)	- updateDisplays [implementation]
(BOOL)	- runWithEntrypoint:libraryURI: [implementation]
(BOOL)	- runWithEntrypoint: [implementation]
(BOOL)	- runWithEntrypoint:initialRoute: [implementation]
(BOOL)	- runWithEntrypoint:libraryURI:initialRoute: [implementation]
(BOOL)	- runWithEntrypoint:libraryURI:initialRoute:entrypointArgs: [implementation]
(void)	- notifyLowMemory [implementation]
(void)	- flutterTextInputView:updateEditingClient:withState: [implementation]
(void)	- flutterTextInputView:updateEditingClient:withState:withTag: [implementation]
(void)	- flutterTextInputView:updateEditingClient:withDelta: [implementation]
(void)	- flutterTextInputView:updateFloatingCursor:withClient:withPosition: [implementation]
(void)	- flutterTextInputView:performAction:withClient: [implementation]
(void)	- flutterTextInputView:showAutocorrectionPromptRectForStart:end:withClient: [implementation]
(void)	- flutterTextInputView:willDismissEditMenuWithTextInputClient: [implementation]
(void)	- flutterTextInputView:showToolbar: [implementation]
(void)	- flutterTextInputPlugin:focusElement:atPoint:result: [implementation]
(void)	- flutterTextInputPlugin:requestElementsInRect:result: [implementation]
(void)	- flutterTextInputViewScribbleInteractionBegan: [implementation]
(void)	- flutterTextInputViewScribbleInteractionFinished: [implementation]
(void)	- flutterTextInputView:insertTextPlaceholderWithSize:withClient: [implementation]
(void)	- flutterTextInputView:removeTextPlaceholder: [implementation]
(void)	- flutterTextInputView:didResignFirstResponderWithTextInputClient: [implementation]
(void)	- handleUndoWithDirection: [implementation]
(UIView< UITextInput > *)	- activeTextInputView [implementation]
(NSUndoManager *)	- undoManager [implementation]
(flutter::Rasterizer::Screenshot)	- takeScreenshot:asBase64Encoded: [implementation]
(void)	- flutterViewAccessibilityDidCall [implementation]
(void)	- setBinaryMessenger: [implementation]
(void)	- sendOnChannel:message: [implementation]
(void)	- sendOnChannel:message:binaryReply: [implementation]
(NSObject< FlutterTaskQueue > *)	- makeBackgroundTaskQueue [implementation]
	TODO(gaaclarke): Remove optional when macos supports Background Platform Channels.
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler: [implementation]
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:taskQueue: [implementation]
(void)	- cleanUpConnection: [implementation]
(int64_t)	- registerTexture: [implementation]
(void)	- unregisterTexture: [implementation]
(void)	- textureFrameAvailable: [implementation]
(NSString *)	- lookupKeyForAsset: [implementation]
(NSString *)	- lookupKeyForAsset:fromPackage: [implementation]
(id< FlutterPluginRegistry >)	- pluginRegistry [implementation]
(NSObject< FlutterPluginRegistrar > *)	- registrarForPlugin: [implementation]
(BOOL)	- hasPlugin: [implementation]
(NSObject *)	- valuePublishedByPlugin: [implementation]
(void)	- applicationWillEnterForeground: [implementation]
(void)	- applicationDidEnterBackground: [implementation]
(void)	- flutterWillEnterForeground: [implementation]
(void)	- flutterDidEnterBackground: [implementation]
(void)	- onMemoryWarning: [implementation]
(void)	- setIsGpuDisabled: [implementation]
(void)	- onLocaleUpdated: [implementation]
(void)	- waitForFirstFrame:callback: [implementation]
(FlutterEngine *)	- spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs: [implementation]
(const flutter::ThreadHost &)	- threadHost [implementation]
(FlutterDartProject *)	- project [implementation]
(BOOL)	- isUsingImpeller [implementation]
(void)	- loadAOTData: [implementation]
(void)	- registerViewController:forIdentifier: [implementation]
(void)	- viewControllerViewDidLoad: [implementation]
(void)	- deregisterViewControllerForIdentifier: [implementation]
(void)	- shutDownIfNeeded [implementation]
(FlutterViewController *)	- viewControllerForIdentifier: [implementation]
(FlutterCompositor *)	- createFlutterCompositor [implementation]
(void)	- addViewController: [implementation]
(void)	- removeViewController: [implementation]
(BOOL)	- running [implementation]
(void)	- updateDisplayConfig: [implementation]
(NSArray< NSScreen * > *)	- screens [implementation]
(void)	- updateDisplayConfig [implementation]
(void)	- onSettingsChanged: [implementation]
(void)	- sendInitialSettings [implementation]
(FlutterEngineProcTable &)	- embedderAPI [implementation]
(nonnull NSString *)	- executableName [implementation]
(void)	- updateWindowMetricsForViewController: [implementation]
(void)	- sendPointerEvent: [implementation]
(void)	- sendKeyEvent:callback:userData: [implementation]
(void)	- setSemanticsEnabled: [implementation]
(void)	- dispatchSemanticsAction:toTarget:withData: [implementation]
(FlutterPlatformViewController *)	- platformViewController [implementation]
(void)	- sendUserLocales [implementation]
(void)	- engineCallbackOnPlatformMessage: [implementation]
(void)	- engineCallbackOnPreEngineRestart [implementation]
(void)	- onVSync: [implementation]
(void)	- setUpPlatformViewChannel [implementation]
(void)	- setUpAccessibilityChannel [implementation]
(void)	- setUpNotificationCenterListeners [implementation]
(void)	- addInternalPlugins [implementation]
(void)	- didUpdateMouseCursor: [implementation]
(void)	- applicationWillTerminate: [implementation]
(void)	- windowDidChangeScreen: [implementation]
(void)	- onAccessibilityStatusChanged: [implementation]
(void)	- handleAccessibilityEvent: [implementation]
(void)	- announceAccessibilityMessage:withPriority: [implementation]
(void)	- handleMethodCall:result: [implementation]
(void)	- playSystemSound: [implementation]
(NSDictionary *)	- getClipboardData: [implementation]
(void)	- setClipboardData: [implementation]
(BOOL)	- clipboardHasStrings [implementation]
(std::vector< std::string >)	- switches [implementation]
(FlutterThreadSynchronizer *)	- testThreadSynchronizer [implementation]
(void)	- setApplicationState: [implementation]
(void)	- handleWillBecomeActive: [implementation]
(void)	- handleWillResignActive: [implementation]
(void)	- handleDidChangeOcclusionState: [implementation]
(void)	- sendOnChannel:message: [implementation]
(void)	- sendOnChannel:message:binaryReply: [implementation]
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler: [implementation]
(int64_t)	- registerTexture: [implementation]
(BOOL)	- registerTextureWithID: [implementation]
(BOOL)	- markTextureFrameAvailable: [implementation]
(BOOL)	- unregisterTextureWithID: [implementation]
(void)	- runTaskOnEmbedder: [implementation]
(void)	- postMainThreadTask:targetTimeInNanoseconds: [implementation]
(flutter::FlutterCompositor *)	- macOSCompositor [implementation]
(instancetype)	- initWithScenario:withCompletion:
(void)	- sceneWillEnterForeground:
(void)	- sceneDidEnterBackground:
Instance Methods inherited from <FlutterPluginRegistry>
(nonnull id< FlutterPluginRegistrar >)	- registrarForPlugin:
(nullable NSObject *)	- valuePublishedByPlugin:
Instance Methods inherited from <FlutterBinaryMessenger>
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:taskQueue:
(void)	- sendOnChannel:message:
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:
Instance Methods inherited from <FlutterMouseCursorPluginDelegate>
(void)	- didUpdateMouseCursor:

Additional Inherited Members
Class Methods inherited from FlutterEngine
(BOOL)	+ isProfilerEnabled [implementation]
(NSString *)	+ generateThreadLabel: [implementation]
(flutter::ThreadHost)	+ makeThreadHost: [implementation]
(static void)	+ SetEntryPoint [implementation]
(static void)	+ SetThreadPriority [implementation]
Protected Attributes inherited from FlutterEngine
	: NSObject <FlutterTextureRegistry
	FlutterPluginRegistry
Properties inherited from FlutterEngine
FlutterViewController *	viewController
FlutterMethodChannel *	localizationChannel
FlutterMethodChannel *	navigationChannel
FlutterMethodChannel *	restorationChannel
FlutterMethodChannel *	platformChannel
FlutterMethodChannel *	textInputChannel
FlutterBasicMessageChannel *	lifecycleChannel
FlutterBasicMessageChannel *	systemChannel
FlutterBasicMessageChannel *	settingsChannel
FlutterBasicMessageChannel *	keyEventChannel
NSURL *	vmServiceUrl
NSObject< FlutterBinaryMessenger > *	binaryMessenger
NSObject< FlutterTextureRegistry > *	textureRegistry
NSString *	isolateId
BOOL	isGpuDisabled
id< FlutterBinaryMessenger >	binaryMessenger
NSMutableDictionary *	pluginPublications [implementation]
NSMutableDictionary< NSString *, FlutterEngineRegistrar * > *	registrars [implementation]
NSString *	initialRoute [implementation]
id< NSObject >	flutterViewControllerWillDeallocObserver [implementation]
BOOL	enableEmbedderAPI [implementation]
NSMutableArray< NSNumber * > *	isResponseValid [implementation]
NSPointerArray *	pluginAppDelegates [implementation]
NSMutableDictionary< NSString *, FlutterEngineRegistrar * > *	pluginRegistrars [implementation]
FlutterRenderer *	renderer [implementation]
BOOL	semanticsEnabled [implementation]
FlutterPasteboard *	pasteboard [implementation]
FlutterEngineTerminationHandler *	terminationHandler [implementation]
Properties inherited from <FlutterUndoManagerDelegate>
Properties inherited from <FlutterViewEngineDelegate>

Detailed Description

The deprecated FlutterHeadlessDartRunner runs Flutter Dart code with a null rasterizer, and no native drawing surface. It is appropriate for use in running Dart code e.g. in the background from a plugin.

Most callers should prefer using FlutterEngine directly; this interface exists for legacy support.

Definition at line 34 of file FlutterHeadlessDartRunner.h.

Method Documentation

init

- (instancetype) init

Not recommended for use - will initialize with a default label ("io.flutter.headless") and the default FlutterDartProject.

Reimplemented from FlutterEngine.

initWithName:project:

- (instancetype) initWithName:		(NSString *)	labelPrefix
project:		(FlutterDartProject *)	projectOrNil

Initialize this FlutterHeadlessDartRunner with a FlutterDartProject.

If the FlutterDartProject is not specified, the FlutterHeadlessDartRunner will attempt to locate the project in a default location.

A newly initialized engine will not run the FlutterDartProject until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI is called.

Parameters

labelPrefix	The label prefix used to identify threads for this instance. Should be unique across FlutterEngine instances
projectOrNil	The FlutterDartProject to run.

Reimplemented from FlutterEngine.

initWithName:project:allowHeadlessExecution:

- (instancetype) initWithName:		(NSString *)	labelPrefix
project:		(FlutterDartProject *)	projectOrNil
allowHeadlessExecution:		(BOOL)	allowHeadlessExecution

Initialize this FlutterHeadlessDartRunner with a FlutterDartProject.

If the FlutterDartProject is not specified, the FlutterHeadlessDartRunner will attempt to locate the project in a default location.

A newly initialized engine will not run the FlutterDartProject until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI is called.

Parameters

labelPrefix	The label prefix used to identify threads for this instance. Should be unique across FlutterEngine instances
projectOrNil	The FlutterDartProject to run.
allowHeadlessExecution	Must be set to YES.

Reimplemented from FlutterEngine.

initWithName:project:allowHeadlessExecution:restorationEnabled:

- (instancetype) initWithName:		(NSString *)	labelPrefix
project:		(FlutterDartProject *)	projectOrNil
allowHeadlessExecution:		(BOOL)	allowHeadlessExecution
restorationEnabled:		(BOOL)	NS_DESIGNATED_INITIALIZER

Initialize this FlutterHeadlessDartRunner with a FlutterDartProject.

If the FlutterDartProject is not specified, the FlutterHeadlessDartRunner will attempt to locate the project in a default location.

A newly initialized engine will not run the FlutterDartProject until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI is called.

Parameters

labelPrefix	The label prefix used to identify threads for this instance. Should be unique across FlutterEngine instances
projectOrNil	The FlutterDartProject to run.
allowHeadlessExecution	Must be set to YES.
restorationEnabled	Must be set to NO.

Reimplemented from FlutterEngine.

---

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

• shell/platform/darwin/ios/framework/Headers/FlutterHeadlessDartRunner.h