io.flutter.embedding.android.FlutterFragmentActivity.NewEngineInGroupIntentBuilder Class Reference

Public Member Functions
	NewEngineInGroupIntentBuilder ( @NonNull Class<? extends FlutterFragmentActivity > activityClass, @NonNull String engineGroupId)
NewEngineInGroupIntentBuilder	dartEntrypoint (@NonNull String dartEntrypoint)
NewEngineInGroupIntentBuilder	initialRoute (@NonNull String initialRoute)
NewEngineInGroupIntentBuilder	backgroundMode (@NonNull BackgroundMode backgroundMode)
Intent	build (@NonNull Context context)

Detailed Description

Builder to create an Intent that launches a FlutterFragmentActivity with a new FlutterEngine by FlutterEngineGroup::createAndRunEngine.

Definition at line 281 of file FlutterFragmentActivity.java.

Constructor & Destructor Documentation

NewEngineInGroupIntentBuilder()

io.flutter.embedding.android.FlutterFragmentActivity.NewEngineInGroupIntentBuilder.NewEngineInGroupIntentBuilder ( @NonNull Class<? extends FlutterFragmentActivity >  activityClass, @NonNull String  engineGroupId  )

inline

Constructor that allows this NewEngineInGroupIntentBuilder to be used by subclasses of FlutterActivity.

Subclasses of FlutterFragmentActivity should provide their own static version of withNewEngineInGroup, which returns an instance of
NewEngineInGroupIntentBuilder constructed with a Class reference to the
FlutterFragmentActivity subclass, e.g.:

return new NewEngineInGroupIntentBuilder(FlutterFragmentActivity.class,
cacheedEngineGroupId);

Parameters

activityClass	A subclass of FlutterFragmentActivity.
engineGroupId	The engine group id.

Definition at line 303 of file FlutterFragmentActivity.java.

                                       {
      this.activityClass = activityClass;
      this.cachedEngineGroupId = engineGroupId;
    }

Member Function Documentation

backgroundMode()

NewEngineInGroupIntentBuilder io.flutter.embedding.android.FlutterFragmentActivity.NewEngineInGroupIntentBuilder.backgroundMode ( @NonNull BackgroundMode  backgroundMode )

inline

The mode of FlutterFragmentActivity's background, either BackgroundMode#opaque or BackgroundMode#transparent.

The default background mode is BackgroundMode#opaque.

Choosing a background mode of BackgroundMode#transparent will configure the inner FlutterView of this FlutterFragmentActivity to be configured with a FlutterTextureView to support transparency. This choice has a non-trivial performance impact. A transparent background should only be used if it is necessary for the app design being implemented.

A FlutterFragmentActivity that is configured with a background mode of BackgroundMode#transparent must have a theme applied to it that includes the following property: <item name="android:windowIsTranslucent">true</item>.

Definition at line 350 of file FlutterFragmentActivity.java.

                                                                                                {
      this.backgroundMode = backgroundMode.name();
      return this;
    }

build()

Intent io.flutter.embedding.android.FlutterFragmentActivity.NewEngineInGroupIntentBuilder.build ( @NonNull Context  context )

inline

Creates and returns an Intent that will launch a FlutterFragmentActivity with the desired configuration.

Definition at line 360 of file FlutterFragmentActivity.java.

                                                  {
      return new Intent(context, activityClass)
          .putExtra(EXTRA_DART_ENTRYPOINT, dartEntrypoint)
          .putExtra(EXTRA_INITIAL_ROUTE, initialRoute)
          .putExtra(EXTRA_CACHED_ENGINE_GROUP_ID, cachedEngineGroupId)
          .putExtra(EXTRA_BACKGROUND_MODE, backgroundMode)
          .putExtra(EXTRA_DESTROY_ENGINE_WITH_ACTIVITY, true);
    }

dartEntrypoint()

NewEngineInGroupIntentBuilder io.flutter.embedding.android.FlutterFragmentActivity.NewEngineInGroupIntentBuilder.dartEntrypoint ( @NonNull String  dartEntrypoint )

inline

The Dart entrypoint that will be executed as soon as the Dart snapshot is loaded, default to "main".

Parameters

dartEntrypoint

The dart entrypoint's name

Returns

The engine group intent builder

Definition at line 318 of file FlutterFragmentActivity.java.

                                                                                        {
      this.dartEntrypoint = dartEntrypoint;
      return this;
    }

initialRoute()

NewEngineInGroupIntentBuilder io.flutter.embedding.android.FlutterFragmentActivity.NewEngineInGroupIntentBuilder.initialRoute ( @NonNull String  initialRoute )

inline

The initial route that a Flutter app will render in this FlutterFragmentActivity, defaults to "/".

Definition at line 328 of file FlutterFragmentActivity.java.

                                                                                    {
      this.initialRoute = initialRoute;
      return this;
    }

---

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

• shell/platform/android/io/flutter/embedding/android/FlutterFragmentActivity.java