Flutter Engine
The Flutter Engine
Public Member Functions | List of all members
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.

227 {
228 this.context = context;
229 }

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.

266 {
267 return automaticallyRegisterPlugins;
268 }

◆ getContext()

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

Definition at line 231 of file FlutterEngineGroup.java.

231 {
232 return context;
233 }

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

240 {
241 return dartEntrypoint;
242 }

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

253 {
254 return dartEntrypointArgs;
255 }

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

248 {
249 return initialRoute;
250 }

◆ getPlatformViewsController()

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

Manages platform views.

Definition at line 258 of file FlutterEngineGroup.java.

258 {
259 return platformViewsController;
260 }

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

275 {
276 return waitForRestorationData;
277 }

◆ setAutomaticallyRegisterPlugins()

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

Setter for automaticallyRegisterPlugins property.

Parameters
automaticallyRegisterPluginsIf 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.

330 {
331 this.automaticallyRegisterPlugins = automaticallyRegisterPlugins;
332 return this;
333 }

◆ setDartEntrypoint()

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

Setter for dartEntrypoint property.

Parameters
dartEntrypointspecifies 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.

286 {
287 this.dartEntrypoint = dartEntrypoint;
288 return this;
289 }

◆ setDartEntrypointArgs()

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

Setter for dartEntrypointArgs property.

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

Definition at line 307 of file FlutterEngineGroup.java.

307 {
308 this.dartEntrypointArgs = dartEntrypointArgs;
309 return this;
310 }

◆ setInitialRoute()

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

Setter for initialRoute property.

Parameters
initialRouteThe 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.

297 {
298 this.initialRoute = initialRoute;
299 return this;
300 }

◆ setPlatformViewsController()

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

Setter for platformViewsController property.

Parameters
platformViewsControllerManages platform views.

Definition at line 317 of file FlutterEngineGroup.java.

318 {
319 this.platformViewsController = platformViewsController;
320 return this;
321 }

◆ setWaitForRestorationData()

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

Setter for waitForRestorationData property.

Parameters
waitForRestorationDataThe 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.

343 {
344 this.waitForRestorationData = waitForRestorationData;
345 return this;
346 }

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