io.flutter.view.FlutterNativeView Class Reference

Inheritance diagram for io.flutter.view.FlutterNativeView:

Public Member Functions
	FlutterNativeView (@NonNull Context context)
	FlutterNativeView (@NonNull Context context, boolean isBackgroundView)
void	detachFromFlutterView ()
void	destroy ()
DartExecutor	getDartExecutor ()
FlutterPluginRegistry	getPluginRegistry ()
void	attachViewAndActivity (FlutterView flutterView, Activity activity)
boolean	isAttached ()
void	assertAttached ()
void	runFromBundle (FlutterRunArguments args)
boolean	isApplicationRunning ()
TaskQueue	makeBackgroundTaskQueue (TaskQueueOptions options)
void	send (String channel, ByteBuffer message)
void	send (String channel, ByteBuffer message, BinaryReply callback)
void	setMessageHandler (String channel, BinaryMessageHandler handler)
void	setMessageHandler (String channel, BinaryMessageHandler handler, TaskQueue taskQueue)
void	enableBufferingIncomingMessages ()
void	disableBufferingIncomingMessages ()
Public Member Functions inherited from io.flutter.plugin.common.BinaryMessenger
default TaskQueue	makeBackgroundTaskQueue ()
default TaskQueue	makeBackgroundTaskQueue (TaskQueueOptions options)
void	send (@NonNull String channel, @Nullable ByteBuffer message)
void	send (@NonNull String channel, @Nullable ByteBuffer message, @Nullable BinaryReply callback)
void	setMessageHandler (@NonNull String channel, @Nullable BinaryMessageHandler handler)
default void	setMessageHandler ( @NonNull String channel, @Nullable BinaryMessageHandler handler, @Nullable TaskQueue taskQueue)
default void	enableBufferingIncomingMessages ()
default void	disableBufferingIncomingMessages ()

Static Public Member Functions
static String	getObservatoryUri ()
static String	getVMServiceUri ()

Package Functions
FlutterJNI	getFlutterJNI ()

Detailed Description

Deprecated:

io.flutter.embedding.android.FlutterView is the new API that now replaces this class. See https://flutter.dev/go/android-project-migration for more migration details.

Definition at line 25 of file FlutterNativeView.java.

Constructor & Destructor Documentation

FlutterNativeView() [1/2]

io.flutter.view.FlutterNativeView.FlutterNativeView ( @NonNull Context  context )

inline

Definition at line 51 of file FlutterNativeView.java.

                                                     {
    this(context, false);
  }

FlutterNativeView() [2/2]

io.flutter.view.FlutterNativeView.FlutterNativeView ( @NonNull Context  context, boolean  isBackgroundView  )

inline

Definition at line 55 of file FlutterNativeView.java.

                                                                               {
    if (isBackgroundView) {
      Log.w(TAG, "'isBackgroundView' is no longer supported and will be ignored");
    }
    mContext = context;
    mPluginRegistry = new FlutterPluginRegistry(this, context);
    mFlutterJNI = new FlutterJNI();
    mFlutterJNI.addIsDisplayingFlutterUiListener(flutterUiDisplayListener);
    this.dartExecutor = new DartExecutor(mFlutterJNI, context.getAssets());
    mFlutterJNI.addEngineLifecycleListener(new EngineLifecycleListenerImpl());
    attach(this);
    assertAttached();
  }

Member Function Documentation

assertAttached()

void io.flutter.view.FlutterNativeView.assertAttached ( )

inline

Definition at line 102 of file FlutterNativeView.java.

                               {
    if (!isAttached()) throw new AssertionError("Platform view is not attached");
  }

attachViewAndActivity()

void io.flutter.view.FlutterNativeView.attachViewAndActivity ( FlutterView  flutterView, Activity  activity  )

inline

Definition at line 93 of file FlutterNativeView.java.

                                                                                {
    mFlutterView = flutterView;
    mPluginRegistry.attach(flutterView, activity);
  }

destroy()

void io.flutter.view.FlutterNativeView.destroy ( )

inline

Definition at line 74 of file FlutterNativeView.java.

                        {
    mPluginRegistry.destroy();
    dartExecutor.onDetachedFromJNI();
    mFlutterView = null;
    mFlutterJNI.removeIsDisplayingFlutterUiListener(flutterUiDisplayListener);
    mFlutterJNI.detachFromNativeAndReleaseResources();
    applicationIsRunning = false;
  }

detachFromFlutterView()

void io.flutter.view.FlutterNativeView.detachFromFlutterView ( )

inline

Definition at line 69 of file FlutterNativeView.java.

                                      {
    mPluginRegistry.detach();
    mFlutterView = null;
  }

disableBufferingIncomingMessages()

void io.flutter.view.FlutterNativeView.disableBufferingIncomingMessages ( )

inline

Disables the ability to queue messages received from Dart.

This can be used after all pending channel handlers have been registered.

Implements io.flutter.plugin.common.BinaryMessenger.

Definition at line 175 of file FlutterNativeView.java.

{}

enableBufferingIncomingMessages()

void io.flutter.view.FlutterNativeView.enableBufferingIncomingMessages ( )

inline

Enables the ability to queue messages received from Dart.

This is useful when there are pending channel handler registrations. For example, Dart may be initialized concurrently, and prior to the registration of the channel handlers. This implies that Dart may start sending messages while plugins are being registered.

Implements io.flutter.plugin.common.BinaryMessenger.

Definition at line 172 of file FlutterNativeView.java.

{}

getDartExecutor()

DartExecutor io.flutter.view.FlutterNativeView.getDartExecutor ( )

inline

Definition at line 84 of file FlutterNativeView.java.

                                        {
    return dartExecutor;
  }

getFlutterJNI()

FlutterJNI io.flutter.view.FlutterNativeView.getFlutterJNI ( )

inlinepackage

Definition at line 177 of file FlutterNativeView.java.

                               {
    return mFlutterJNI;
  }

getObservatoryUri()

static String io.flutter.view.FlutterNativeView.getObservatoryUri ( )

inlinestatic

Definition at line 128 of file FlutterNativeView.java.

                                           {
    return FlutterJNI.getVMServiceUri();
  }

getPluginRegistry()

FlutterPluginRegistry io.flutter.view.FlutterNativeView.getPluginRegistry ( )

inline

Definition at line 89 of file FlutterNativeView.java.

                                                   {
    return mPluginRegistry;
  }

getVMServiceUri()

static String io.flutter.view.FlutterNativeView.getVMServiceUri ( )

inlinestatic

Definition at line 132 of file FlutterNativeView.java.

                                         {
    return FlutterJNI.getVMServiceUri();
  }

isApplicationRunning()

boolean io.flutter.view.FlutterNativeView.isApplicationRunning ( )

inline

Definition at line 123 of file FlutterNativeView.java.

                                        {
    return applicationIsRunning;
  }

isAttached()

boolean io.flutter.view.FlutterNativeView.isAttached ( )

inline

Definition at line 98 of file FlutterNativeView.java.

                              {
    return mFlutterJNI.isAttached();
  }

makeBackgroundTaskQueue()

TaskQueue io.flutter.view.FlutterNativeView.makeBackgroundTaskQueue ( TaskQueueOptions  options )

inline

Creates a TaskQueue that executes the tasks serially on a background thread.

TaskQueueOptions can be used to configure the task queue to execute tasks concurrently. Doing so can be more performant, though users need to ensure that the task handlers are thread-safe.

Implements io.flutter.plugin.common.BinaryMessenger.

Definition at line 138 of file FlutterNativeView.java.

                                                                     {
    return dartExecutor.getBinaryMessenger().makeBackgroundTaskQueue(options);
  }

runFromBundle()

void io.flutter.view.FlutterNativeView.runFromBundle ( FlutterRunArguments  args )

inline

Definition at line 106 of file FlutterNativeView.java.

                                                      {
    if (args.entrypoint == null) {
      throw new AssertionError("An entrypoint must be specified");
    }
    assertAttached();
    if (applicationIsRunning)
      throw new AssertionError("This Flutter engine instance is already running an application");
    mFlutterJNI.runBundleAndSnapshotFromLibrary(
        args.bundlePath,
        args.entrypoint,
        args.libraryPath,
        mContext.getResources().getAssets(),
        null);
 
    applicationIsRunning = true;
  }

send() [1/2]

void io.flutter.view.FlutterNativeView.send ( String  channel, ByteBuffer  message  )

inline

Definition at line 144 of file FlutterNativeView.java.

                                                       {
    dartExecutor.getBinaryMessenger().send(channel, message);
  }

send() [2/2]

void io.flutter.view.FlutterNativeView.send ( String  channel, ByteBuffer  message, BinaryReply  callback  )

inline

Definition at line 150 of file FlutterNativeView.java.

                                                                             {
    if (!isAttached()) {
      Log.d(TAG, "FlutterView.send called on a detached view, channel=" + channel);
      return;
    }
 
    dartExecutor.getBinaryMessenger().send(channel, message, callback);
  }

setMessageHandler() [1/2]

void io.flutter.view.FlutterNativeView.setMessageHandler ( String  channel, BinaryMessageHandler  handler  )

inline

Definition at line 161 of file FlutterNativeView.java.

                                                                              {
    dartExecutor.getBinaryMessenger().setMessageHandler(channel, handler);
  }

setMessageHandler() [2/2]

void io.flutter.view.FlutterNativeView.setMessageHandler ( String  channel, BinaryMessageHandler  handler, TaskQueue  taskQueue  )

inline

Definition at line 167 of file FlutterNativeView.java.

                                                                                                   {
    dartExecutor.getBinaryMessenger().setMessageHandler(channel, handler, taskQueue);
  }

---

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

• shell/platform/android/io/flutter/view/FlutterNativeView.java