Flutter macOS Embedder
<FlutterPluginRegistrar> Protocol Reference

#import <FlutterPluginRegistrarMacOS.h>

Inheritance diagram for <FlutterPluginRegistrar>:
FakePluginRegistrar FlutterEngineRegistrar

Instance Methods

(void) - addMethodCallDelegate:channel:
 
(void) - addApplicationDelegate:
 
(void) - registerViewFactory:withId:
 
(void) - publish:
 
(nonnull NSString *) - lookupKeyForAsset:
 
(nonnull NSString *) - lookupKeyForAsset:fromPackage:
 

Properties

id< FlutterBinaryMessengermessenger
 
id< FlutterTextureRegistrytextures
 
NSView * view
 

Detailed Description

The protocol for an object managing registration for a plugin. It provides access to application context, 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 25 of file FlutterPluginRegistrarMacOS.h.

Method Documentation

◆ addApplicationDelegate:

- (void) addApplicationDelegate: (nonnull NSObject< FlutterAppLifecycleDelegate > *)  delegate

Registers the plugin as a receiver of NSApplicationDelegate calls.

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

◆ addMethodCallDelegate:channel:

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

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

Referenced by FlutterMenuPlugin::registerWithRegistrar:.

◆ lookupKeyForAsset:

- (nonnull NSString*) lookupKeyForAsset: (nonnull 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:

- (nonnull NSString*) lookupKeyForAsset: (nonnull NSString *)  asset
fromPackage: (nonnull 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.

◆ publish:

- (void) publish: (nonnull 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) registerViewFactory: (nonnull NSObject< FlutterPlatformViewFactory > *)  factory
withId: (nonnull NSString *)  factoryId 

Registers a FlutterPlatformViewFactory for creation of platform views.

Plugins expose NSView 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 NSView by the registered factory.

Property Documentation

◆ messenger

- (id<FlutterBinaryMessenger>) messenger
readatomicassign

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

Definition at line 30 of file FlutterPluginRegistrarMacOS.h.

◆ textures

- (id<FlutterTextureRegistry>) textures
readatomicassign

Returns a FlutterTextureRegistry for registering textures provided by the plugin.

Definition at line 36 of file FlutterPluginRegistrarMacOS.h.

◆ view

- (NSView*) view
readatomicassign

The view displaying Flutter content.

This property is provided for backwards compatibility for apps that assume a single view. This will eventually be replaced by a multi-view API variant.

This method may return |nil|, for instance in a headless environment.

Definition at line 47 of file FlutterPluginRegistrarMacOS.h.


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