io.flutter.embedding.engine.systemchannels.DeferredComponentChannel Class Reference

Public Member Functions
	DeferredComponentChannel (@NonNull DartExecutor dartExecutor)
void	setDeferredComponentManager ( @Nullable DeferredComponentManager deferredComponentManager)
void	completeInstallSuccess (String componentName)
void	completeInstallError (String componentName, String errorMessage)

Package Attributes
final MethodChannel.MethodCallHandler	parsingMethodHandler

Detailed Description

Method channel that handles manual installation requests and queries for installation state for deferred components.

This channel is able to handle multiple simultaneous installation requests

Definition at line 28 of file DeferredComponentChannel.java.

Constructor & Destructor Documentation

DeferredComponentChannel()

io.flutter.embedding.engine.systemchannels.DeferredComponentChannel.DeferredComponentChannel ( @NonNull DartExecutor  dartExecutor )

inline

Constructs a DeferredComponentChannel that connects Android to the Dart code running in dartExecutor.

The given dartExecutor is permitted to be idle or executing code.

See DartExecutor.

Definition at line 84 of file DeferredComponentChannel.java.

                                                                      {
    this.channel =
        new MethodChannel(dartExecutor, "flutter/deferredcomponent", StandardMethodCodec.INSTANCE);
    channel.setMethodCallHandler(parsingMethodHandler);
    deferredComponentManager = FlutterInjector.instance().deferredComponentManager();
    componentNameToResults = new HashMap<>();
  }

Member Function Documentation

completeInstallError()

void io.flutter.embedding.engine.systemchannels.DeferredComponentChannel.completeInstallError ( String  componentName, String  errorMessage  )

inline

Finishes the installDeferredComponent method channel call for the specified componentName with an error/failure.

Parameters

componentName	The name of the android deferred component install request to complete.
errorMessage	The error message to display to complete the future with.

Definition at line 126 of file DeferredComponentChannel.java.

                                                                              {
    if (componentNameToResults.containsKey(componentName)) {
      for (MethodChannel.Result result : componentNameToResults.get(componentName)) {
        result.error("DeferredComponent Install failure", errorMessage, null);
      }
      componentNameToResults.get(componentName).clear();
    }
    return;
  }

completeInstallSuccess()

void io.flutter.embedding.engine.systemchannels.DeferredComponentChannel.completeInstallSuccess ( String  componentName )

inline

Finishes the installDeferredComponent method channel call for the specified componentName with a success.

Parameters

componentName

The name of the android deferred component install request to complete.

Definition at line 109 of file DeferredComponentChannel.java.

                                                           {
    if (componentNameToResults.containsKey(componentName)) {
      for (MethodChannel.Result result : componentNameToResults.get(componentName)) {
        result.success(null);
      }
      componentNameToResults.get(componentName).clear();
    }
    return;
  }

setDeferredComponentManager()

void io.flutter.embedding.engine.systemchannels.DeferredComponentChannel.setDeferredComponentManager ( @Nullable DeferredComponentManager  deferredComponentManager )

inline

Sets the DeferredComponentManager to exectue method channel calls with.

Parameters

deferredComponentManager

the DeferredComponentManager to use.

Definition at line 98 of file DeferredComponentChannel.java.

                                                                   {
    this.deferredComponentManager = deferredComponentManager;
  }

Member Data Documentation

parsingMethodHandler

final MethodChannel.MethodCallHandler io.flutter.embedding.engine.systemchannels.DeferredComponentChannel.parsingMethodHandler

package

Definition at line 39 of file DeferredComponentChannel.java.

                                            {
        @Override
        public void onMethodCall(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
          if (deferredComponentManager == null) {
            // If no DeferredComponentManager has been injected, then this channel is a no-op.
            return;
          }
          String method = call.method;
          Map<String, Object> args = call.arguments();
          Log.v(TAG, "Received '" + method + "' message.");
          final int loadingUnitId = (int) args.get("loadingUnitId");
          final String componentName = (String) args.get("componentName");
          switch (method) {
            case "installDeferredComponent":
              deferredComponentManager.installDeferredComponent(loadingUnitId, componentName);
              if (!componentNameToResults.containsKey(componentName)) {
                componentNameToResults.put(componentName, new ArrayList<>());
              }
              componentNameToResults.get(componentName).add(result);
              break;
            case "getDeferredComponentInstallState":
              result.success(
                  deferredComponentManager.getDeferredComponentInstallState(
                      loadingUnitId, componentName));
              break;
            case "uninstallDeferredComponent":
              deferredComponentManager.uninstallDeferredComponent(loadingUnitId, componentName);
              result.success(null);
              break;
            default:
              result.notImplemented();
              break;
          }
        }
      };

---

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

• shell/platform/android/io/flutter/embedding/engine/systemchannels/DeferredComponentChannel.java