Flutter Engine
<FlutterPluginRegistrar > Protocol Reference

#import <FlutterPlugin.h>

Inheritance diagram for <FlutterPluginRegistrar >:

Instance Methods

(NSObject< FlutterBinaryMessenger > *) - messenger
 
(NSObject< FlutterTextureRegistry > *) - textures
 
(void) - registerViewFactory:withId:
 
(void) - registerViewFactory:withId:gestureRecognizersBlockingPolicy:
 
(void) - publish:
 
(void) - addMethodCallDelegate:channel:
 
(void) - addApplicationDelegate:
 
(NSString *) - lookupKeyForAsset:
 
(NSString *) - lookupKeyForAsset:fromPackage:
 
(void) - addMethodCallDelegate:channel:
 

Properties

id< FlutterBinaryMessenger > messenger
 
id< FlutterTextureRegistry > textures
 
NSView * view
 

Detailed Description

Registration context for a single FlutterPlugin, providing a one stop shop for the plugin to access contextual information and register callbacks for various application events.

Registrars are obtained from a FlutterPluginRegistry which keeps track of the identity of registered plugins and provides basic support for cross-plugin coordination.

The protocol for an object managing registration for a plugin. It provides access to application context, as as allowing registering for callbacks for handling various conditions.

Currently the macOS PluginRegistrar has very limited functionality, but is expected to expand over time to more closely match the functionality of FlutterPluginRegistrar.

Definition at line 277 of file FlutterPlugin.h.

Method Documentation

◆ addApplicationDelegate:()

- (void FlutterPluginRegistrar) addApplicationDelegate: (NSObject< FlutterPlugin > *)  delegate

Registers the plugin as a receiver of UIApplicationDelegate calls.

Parameters
delegateThe receiving object, such as the plugin's main class.

◆ addMethodCallDelegate:channel:() [1/2]

- (void FlutterPluginRegistrar) addMethodCallDelegate: (nonnull id< FlutterPlugin >)  delegate
channel: (nonnull FlutterMethodChannel *)  channel 

Registers |delegate| to receive handleMethodCall:result: callbacks for the given |channel|.

◆ addMethodCallDelegate:channel:() [2/2]

- (void FlutterPluginRegistrar) addMethodCallDelegate: (NSObject< FlutterPlugin > *)  delegate
channel: (FlutterMethodChannel *)  channel 

Registers the plugin as a receiver of incoming method calls from the Dart side on the specified FlutterMethodChannel.

Parameters
delegateThe receiving object, such as the plugin's main class.
channelThe channel

◆ lookupKeyForAsset:()

- (NSString* FlutterPluginRegistrar) lookupKeyForAsset: (NSString *)  asset

Returns the file name for the given asset. The returned file name can be used to access the asset in the application's main bundle.

Parameters
assetThe name of the asset. The name can be hierarchical.
Returns
the file name to be used for lookup in the main bundle.

◆ lookupKeyForAsset:fromPackage:()

- (NSString* FlutterPluginRegistrar) lookupKeyForAsset: (NSString *)  asset
fromPackage: (NSString *)  package 

Returns the file name for the given asset which originates from the specified package. The returned file name can be used to access the asset in the application's main bundle.

Parameters
assetThe name of the asset. The name can be hierarchical.
packageThe name of the package from which the asset originates.
Returns
the file name to be used for lookup in the main bundle.

◆ messenger()

- (NSObject<FlutterBinaryMessenger>* FlutterPluginRegistrar) messenger

Returns a FlutterBinaryMessenger for creating Dart/iOS communication channels to be used by the plugin.

Returns
The messenger.

◆ publish:()

- (void FlutterPluginRegistrar) publish: (NSObject *)  value

Publishes a value for external use of the plugin.

Plugins may publish a single value, such as an instance of the plugin's main class, for situations where external control or interaction is needed.

The published value will be available from the FlutterPluginRegistry. Repeated calls overwrite any previous publication.

Parameters
valueThe value to be published.

◆ registerViewFactory:withId:()

- (void FlutterPluginRegistrar) registerViewFactory: (NSObject< FlutterPlatformViewFactory > *)  factory
withId: (NSString *)  factoryId 

Registers a FlutterPlatformViewFactory for creation of platform views.

Plugins expose UIView for embedding in Flutter apps by registering a view factory.

Parameters
factoryThe view factory that will be registered.
factoryIdA unique identifier for the factory, the Dart code of the Flutter app can use this identifier to request creation of a UIView by the registered factory.

◆ registerViewFactory:withId:gestureRecognizersBlockingPolicy:()

- (void FlutterPluginRegistrar) registerViewFactory: (NSObject< FlutterPlatformViewFactory > *)  factory
withId: (NSString *)  factoryId
gestureRecognizersBlockingPolicy: (FlutterPlatformViewGestureRecognizersBlockingPolicy gestureRecognizersBlockingPolicy 

Registers a FlutterPlatformViewFactory for creation of platform views.

Plugins can expose a UIView for embedding in Flutter apps by registering a view factory.

Parameters
factoryThe view factory that will be registered.
factoryIdA unique identifier for the factory, the Dart code of the Flutter app can use this identifier to request creation of a UIView by the registered factory.
gestureRecognizersBlockingPolicyHow UIGestureRecognizers on the platform views are blocked.

◆ textures()

- (NSObject<FlutterTextureRegistry>* FlutterPluginRegistrar) textures

Returns a FlutterTextureRegistry for registering textures provided by the plugin.

Returns
The texture registry.

Property Documentation

◆ messenger

- (id<FlutterBinaryMessenger> FlutterPluginRegistrar) messenger
readatomicassign

The binary messenger used for creating channels to communicate with the Flutter engine.

Definition at line 29 of file FlutterPluginRegistrarMacOS.h.

◆ textures

- (id<FlutterTextureRegistry> FlutterPluginRegistrar) textures
readatomicassign

Returns a FlutterTextureRegistry for registering textures provided by the plugin.

Definition at line 35 of file FlutterPluginRegistrarMacOS.h.

◆ view

- (NSView* FlutterPluginRegistrar) view
readatomicassign

The view displaying Flutter content. May return |nil|, for instance in a headless environment.

WARNING: If/when multiple Flutter views within the same application are supported (#30701), this API will change.

Definition at line 43 of file FlutterPluginRegistrarMacOS.h.


The documentation for this protocol was generated from the following files: