io.flutter.embedding.android.FlutterActivity.CachedEngineIntentBuilder Class Reference

Public Member Functions
	CachedEngineIntentBuilder ( @NonNull Class<? extends FlutterActivity > activityClass, @NonNull String engineId)
CachedEngineIntentBuilder	destroyEngineWithActivity (boolean destroyEngineWithActivity)
CachedEngineIntentBuilder	backgroundMode (@NonNull BackgroundMode backgroundMode)
Intent	build (@NonNull Context context)

Detailed Description

Builder to create an Intent that launches a FlutterActivity with an existing io.flutter.embedding.engine.FlutterEngine that is cached in io.flutter.embedding.engine.FlutterEngineCache.

Definition at line 370 of file FlutterActivity.java.

Constructor & Destructor Documentation

CachedEngineIntentBuilder()

io.flutter.embedding.android.FlutterActivity.CachedEngineIntentBuilder.CachedEngineIntentBuilder ( @NonNull Class<? extends FlutterActivity >  activityClass, @NonNull String  engineId  )

inline

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

Subclasses of FlutterActivity should provide their own static version of FlutterActivity#withCachedEngine(String), which returns an instance of
CachedEngineIntentBuilder constructed with a Class reference to the
FlutterActivity subclass, e.g.:

return new CachedEngineIntentBuilder(MyFlutterActivity.class, engineId);

Parameters

activityClass	A subclass of FlutterActivity.
engineId	The engine id.

Definition at line 390 of file FlutterActivity.java.

                                                                                           {
      this.activityClass = activityClass;
      this.cachedEngineId = engineId;
    }

Member Function Documentation

backgroundMode()

CachedEngineIntentBuilder io.flutter.embedding.android.FlutterActivity.CachedEngineIntentBuilder.backgroundMode ( @NonNull BackgroundMode  backgroundMode )

inline

The mode of FlutterActivity'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 FlutterActivity 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 FlutterActivity 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>.

Parameters

backgroundMode

The background mode

Returns

The builder.

Definition at line 430 of file FlutterActivity.java.

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

build()

Intent io.flutter.embedding.android.FlutterActivity.CachedEngineIntentBuilder.build ( @NonNull Context  context )

inline

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

Parameters

context

The context. e.g. An Activity.

Returns

The intent.

Definition at line 443 of file FlutterActivity.java.

                                                  {
      return new Intent(context, activityClass)
          .putExtra(EXTRA_CACHED_ENGINE_ID, cachedEngineId)
          .putExtra(EXTRA_DESTROY_ENGINE_WITH_ACTIVITY, destroyEngineWithActivity)
          .putExtra(EXTRA_BACKGROUND_MODE, backgroundMode);
    }

destroyEngineWithActivity()

CachedEngineIntentBuilder io.flutter.embedding.android.FlutterActivity.CachedEngineIntentBuilder.destroyEngineWithActivity ( boolean  destroyEngineWithActivity )

inline

Whether the cached io.flutter.embedding.engine.FlutterEngine should be destroyed and removed from the cache when this FlutterActivity is destroyed.

The default value is false.

Parameters

destroyEngineWithActivity

Whether to destroy the engine.

Returns

The builder.

Definition at line 405 of file FlutterActivity.java.

                                                                                                  {
      this.destroyEngineWithActivity = destroyEngineWithActivity;
      return this;
    }

---

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

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