#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

(nonnull instancetype)	- initWithName:project:

(nonnull instancetype)	- initWithName:project:allowHeadlessExecution:

(nonnull instancetype)	- NS_UNAVAILABLE

(BOOL)	- runWithEntrypoint:

(void)	- shutDownEngine

(instancetype)	- initWithScenario:withCompletion:

(FlutterEngine *)	- spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs:

(flutter::Shell &)	- shell

(flutter::PlatformViewIOS *)	- platformView

(void)	- setBinaryMessenger:

(flutter::IOSRenderingAPI)	- platformViewsRenderingAPI

(void)	- waitForFirstFrame:callback:

(const flutter::ThreadHost &)	- threadHost

(void)	- updateDisplays

(void)	- flutterTextInputView:performAction:withClient:

(void)	- sceneWillEnterForeground:

(void)	- sceneDidEnterBackground:

(void)	- applicationWillEnterForeground:

(void)	- applicationDidEnterBackground:

(NSString *)	- lookupKeyForAsset:

(NSString *)	- lookupKeyForAsset:fromPackage:

Instance Methods inherited from <FlutterPluginRegistry>
(nullable NSObject< FlutterPluginRegistrar > *)	- registrarForPlugin:

(BOOL)	- hasPlugin:

(nullable NSObject *)	- valuePublishedByPlugin:

(nonnull id< FlutterPluginRegistrar >)	- registrarForPlugin:

(nullable NSObject *)	- valuePublishedByPlugin:

Additional Inherited Members
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

FlutterEngineProcTable &	embedderAPI

BOOL	enableEmbedderAPI

NSMutableDictionary *	pluginPublications

FlutterRestorationPlugin *	restorationPlugin

flutter::FlutterCompositor *	macOSCompositor

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.

Definition at line 26 of file FlutterHeadlessDartRunner.mm.

                     {
  return [self initWithName:@"io.flutter.headless" project:nil];
}

References initWithName:project:allowHeadlessExecution:.

◆ 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.

Definition at line 26 of file FlutterHeadlessDartRunner.mm.

                            :(NSString*)labelPrefix project:(FlutterDartProject*)projectOrNil {
  return [self initWithName:labelPrefix project:projectOrNil allowHeadlessExecution:YES];
}

◆ 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`.

Definition at line 26 of file FlutterHeadlessDartRunner.mm.

                            :(NSString*)labelPrefix
                     project:(FlutterDartProject*)projectOrNil
      allowHeadlessExecution:(BOOL)allowHeadlessExecution {
  NSAssert(allowHeadlessExecution == YES,
           @"Cannot initialize a FlutterHeadlessDartRunner without headless execution.");
  return [self initWithName:labelPrefix
                     project:projectOrNil
      allowHeadlessExecution:allowHeadlessExecution
          restorationEnabled:NO];
}

Referenced by init.

◆ 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`.

Definition at line 26 of file FlutterHeadlessDartRunner.mm.

                            :(NSString*)labelPrefix
                     project:(FlutterDartProject*)projectOrNil
      allowHeadlessExecution:(BOOL)allowHeadlessExecution
          restorationEnabled:(BOOL)restorationEnabled {
  NSAssert(allowHeadlessExecution == YES,
           @"Cannot initialize a FlutterHeadlessDartRunner without headless execution.");
  return [super initWithName:labelPrefix
                     project:projectOrNil
      allowHeadlessExecution:allowHeadlessExecution
          restorationEnabled:restorationEnabled];
}

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

shell/platform/darwin/ios/framework/Headers/FlutterHeadlessDartRunner.h
shell/platform/darwin/ios/framework/Source/FlutterHeadlessDartRunner.mm

Instance Methods

Additional Inherited Members

Detailed Description

Method Documentation

◆ init

◆ initWithName:project:

◆ initWithName:project:allowHeadlessExecution:

◆ initWithName:project:allowHeadlessExecution:restorationEnabled: