io.flutter.embedding.engine.plugins.shim.ShimPluginRegistry Class Reference

Inheritance diagram for io.flutter.embedding.engine.plugins.shim.ShimPluginRegistry:

Public Member Functions
	ShimPluginRegistry (@NonNull FlutterEngine flutterEngine)
Registrar	registrarFor (@NonNull String pluginKey)
boolean	hasPlugin (@NonNull String pluginKey)
Public Member Functions inherited from io.flutter.embedding.engine.plugins.PluginRegistry
void	add (@NonNull FlutterPlugin plugin)
void	add (@NonNull Set< FlutterPlugin > plugins)
boolean	has (@NonNull Class<? extends FlutterPlugin > pluginClass)
FlutterPlugin	get (@NonNull Class<? extends FlutterPlugin > pluginClass)
void	remove (@NonNull Class<? extends FlutterPlugin > pluginClass)
void	remove (@NonNull Set< Class<? extends FlutterPlugin > > plugins)
void	removeAll ()

Package Functions
public< T > T	valuePublishedByPlugin (@NonNull String pluginKey)

Detailed Description

A PluginRegistry that is shimmed to let old plugins use the new Android embedding and plugin API behind the scenes.

The following is an example usage of ShimPluginRegistry within a
FlutterActivity:

// Create the FlutterEngine that will back the Flutter UI.
FlutterEngineGroup group = new FlutterEngineGroup(context);
FlutterEngine flutterEngine = group.createAndRunDefaultEngine(context);

// Create a ShimPluginRegistry and wrap the FlutterEngine with the shim.
ShimPluginRegistry shimPluginRegistry = new ShimPluginRegistry(flutterEngine, platformViewsController);

// Use the GeneratedPluginRegistrant to add every plugin that's in the pubspec.
GeneratedPluginRegistrant.registerWith(shimPluginRegistry);

Definition at line 38 of file ShimPluginRegistry.java.

Constructor & Destructor Documentation

ShimPluginRegistry()

io.flutter.embedding.engine.plugins.shim.ShimPluginRegistry.ShimPluginRegistry ( @NonNull FlutterEngine  flutterEngine )

inline

Definition at line 45 of file ShimPluginRegistry.java.

                                                                  {
    this.flutterEngine = flutterEngine;
    this.shimRegistrarAggregate = new ShimRegistrarAggregate();
    this.flutterEngine.getPlugins().add(shimRegistrarAggregate);
  }

Member Function Documentation

hasPlugin()

boolean io.flutter.embedding.engine.plugins.shim.ShimPluginRegistry.hasPlugin ( @NonNull String  pluginKey )

inline

Definition at line 65 of file ShimPluginRegistry.java.

                                                      {
    return pluginMap.containsKey(pluginKey);
  }

registrarFor()

Registrar io.flutter.embedding.engine.plugins.shim.ShimPluginRegistry.registrarFor ( @NonNull String  pluginKey )

inline

Definition at line 53 of file ShimPluginRegistry.java.

                                                           {
    Log.v(TAG, "Creating plugin Registrar for '" + pluginKey + "'");
    if (pluginMap.containsKey(pluginKey)) {
      throw new IllegalStateException("Plugin key " + pluginKey + " is already in use");
    }
    pluginMap.put(pluginKey, null);
    ShimRegistrar registrar = new ShimRegistrar(pluginKey, pluginMap);
    shimRegistrarAggregate.addPlugin(registrar);
    return registrar;
  }

valuePublishedByPlugin()

public< T > T io.flutter.embedding.engine.plugins.shim.ShimPluginRegistry.valuePublishedByPlugin ( @NonNull String  pluginKey )

inlinepackage

Definition at line 71 of file ShimPluginRegistry.java.

                                                                 {
    return (T) pluginMap.get(pluginKey);
  }

---

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

• shell/platform/android/io/flutter/embedding/engine/plugins/shim/ShimPluginRegistry.java