io.flutter.embedding.engine.FlutterEngineGroup.Options Class Reference

Public Member Functions
	Options (@NonNull Context context)
Context	getContext ()
DartEntrypoint	getDartEntrypoint ()
String	getInitialRoute ()
List< String >	getDartEntrypointArgs ()
PlatformViewsController	getPlatformViewsController ()
boolean	getAutomaticallyRegisterPlugins ()
boolean	getWaitForRestorationData ()
Options	setDartEntrypoint (DartEntrypoint dartEntrypoint)
Options	setInitialRoute (String initialRoute)
Options	setDartEntrypointArgs (List< String > dartEntrypointArgs)
Options	setPlatformViewsController ( @NonNull PlatformViewsController platformViewsController)
Options	setAutomaticallyRegisterPlugins (boolean automaticallyRegisterPlugins)
Options	setWaitForRestorationData (boolean waitForRestorationData)

Detailed Description

Options that control how a FlutterEngine should be created.

Definition at line 218 of file FlutterEngineGroup.java.

Constructor & Destructor Documentation

Options()

io.flutter.embedding.engine.FlutterEngineGroup.Options.Options ( @NonNull Context  context )

inline

Definition at line 227 of file FlutterEngineGroup.java.

                                             {
      this.context = context;
    }

Member Function Documentation

getAutomaticallyRegisterPlugins()

boolean io.flutter.embedding.engine.FlutterEngineGroup.Options.getAutomaticallyRegisterPlugins ( )

inline

If plugins are automatically registered, then they are registered during the io.flutter.embedding.engine.FlutterEngine's constructor.

Definition at line 266 of file FlutterEngineGroup.java.

                                                     {
      return automaticallyRegisterPlugins;
    }

getContext()

Context io.flutter.embedding.engine.FlutterEngineGroup.Options.getContext ( )

inline

Definition at line 231 of file FlutterEngineGroup.java.

                                {
      return context;
    }

getDartEntrypoint()

DartEntrypoint io.flutter.embedding.engine.FlutterEngineGroup.Options.getDartEntrypoint ( )

inline

dartEntrypoint specifies the DartEntrypoint the new engine should run. It doesn't need to be the same entrypoint as the current engine but must be built in the same AOT or snapshot.

Definition at line 240 of file FlutterEngineGroup.java.

                                              {
      return dartEntrypoint;
    }

getDartEntrypointArgs()

List< String > io.flutter.embedding.engine.FlutterEngineGroup.Options.getDartEntrypointArgs ( )

inline

Arguments passed as a list of string to Dart's entrypoint function.

Definition at line 253 of file FlutterEngineGroup.java.

                                                {
      return dartEntrypointArgs;
    }

getInitialRoute()

String io.flutter.embedding.engine.FlutterEngineGroup.Options.getInitialRoute ( )

inline

The name of the initial Flutter Navigator Route to load. If this is null, it will default to the "/" route.

Definition at line 248 of file FlutterEngineGroup.java.

                                    {
      return initialRoute;
    }

getPlatformViewsController()

PlatformViewsController io.flutter.embedding.engine.FlutterEngineGroup.Options.getPlatformViewsController ( )

inline

Manages platform views.

Definition at line 258 of file FlutterEngineGroup.java.

                                                                {
      return platformViewsController;
    }

getWaitForRestorationData()

boolean io.flutter.embedding.engine.FlutterEngineGroup.Options.getWaitForRestorationData ( )

inline

The waitForRestorationData flag controls whether the engine delays responding to requests from the framework for restoration data until that data has been provided to the engine via RestorationChannel.setRestorationData(byte[] data).

Definition at line 275 of file FlutterEngineGroup.java.

                                               {
      return waitForRestorationData;
    }

setAutomaticallyRegisterPlugins()

Options io.flutter.embedding.engine.FlutterEngineGroup.Options.setAutomaticallyRegisterPlugins ( boolean  automaticallyRegisterPlugins )

inline

Setter for automaticallyRegisterPlugins property.

Parameters

automaticallyRegisterPlugins

If plugins are automatically registered, then they are registered during the execution of io.flutter.embedding.engine.FlutterEngine's constructor.

Definition at line 330 of file FlutterEngineGroup.java.

                                                                                         {
      this.automaticallyRegisterPlugins = automaticallyRegisterPlugins;
      return this;
    }

setDartEntrypoint()

Options io.flutter.embedding.engine.FlutterEngineGroup.Options.setDartEntrypoint ( DartEntrypoint  dartEntrypoint )

inline

Setter for dartEntrypoint property.

Parameters

dartEntrypoint

specifies the DartEntrypoint the new engine should run. It doesn't need to be the same entrypoint as the current engine but must be built in the same AOT or snapshot.

Definition at line 286 of file FlutterEngineGroup.java.

                                                                    {
      this.dartEntrypoint = dartEntrypoint;
      return this;
    }

setDartEntrypointArgs()

Options io.flutter.embedding.engine.FlutterEngineGroup.Options.setDartEntrypointArgs ( List< String >  dartEntrypointArgs )

inline

Setter for dartEntrypointArgs property.

Parameters

dartEntrypointArgs

Arguments passed as a list of string to Dart's entrypoint function.

Definition at line 307 of file FlutterEngineGroup.java.

                                                                          {
      this.dartEntrypointArgs = dartEntrypointArgs;
      return this;
    }

setInitialRoute()

Options io.flutter.embedding.engine.FlutterEngineGroup.Options.setInitialRoute ( String  initialRoute )

inline

Setter for initialRoute property.

Parameters

initialRoute

The name of the initial Flutter Navigator Route to load. If this is null, it will default to the "/" route.

Definition at line 297 of file FlutterEngineGroup.java.

                                                        {
      this.initialRoute = initialRoute;
      return this;
    }

setPlatformViewsController()

Options io.flutter.embedding.engine.FlutterEngineGroup.Options.setPlatformViewsController ( @NonNull PlatformViewsController  platformViewsController )

inline

Setter for platformViewsController property.

Parameters

platformViewsController

Manages platform views.

Definition at line 317 of file FlutterEngineGroup.java.

                                                                  {
      this.platformViewsController = platformViewsController;
      return this;
    }

setWaitForRestorationData()

Options io.flutter.embedding.engine.FlutterEngineGroup.Options.setWaitForRestorationData ( boolean  waitForRestorationData )

inline

Setter for waitForRestorationData property.

Parameters

waitForRestorationData

The waitForRestorationData flag controls whether the engine delays responding to requests from the framework for restoration data until that data has been provided to the engine via RestorationChannel.setRestorationData(byte[] data).

Definition at line 343 of file FlutterEngineGroup.java.

                                                                             {
      this.waitForRestorationData = waitForRestorationData;
      return this;
    }

---

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

• shell/platform/android/io/flutter/embedding/engine/FlutterEngineGroup.java