FlutterEngineRegistrar Class Reference

Inheritance diagram for FlutterEngineRegistrar:

Instance Methods
(instancetype)	- initWithPlugin:flutterEngine:
(instancetype)	- initWithPlugin:flutterEngine:
(nullable NSView *)	- viewForIdentifier:
(void)	- dealloc [implementation]
(NSObject< FlutterBinaryMessenger > *)	- messenger [implementation]
(NSObject< FlutterTextureRegistry > *)	- textures [implementation]
(void)	- publish: [implementation]
(void)	- addMethodCallDelegate:channel: [implementation]
(void)	- addApplicationDelegate: [implementation]
(NSString *)	- lookupKeyForAsset: [implementation]
(NSString *)	- lookupKeyForAsset:fromPackage: [implementation]
(void)	- registerViewFactory:withId: [implementation]
(void)	- registerViewFactory:withId:gestureRecognizersBlockingPolicy: [implementation]
(NSView *)	- view [implementation]
(void)	- addMethodCallDelegate:channel: [implementation]
(void)	- addApplicationDelegate: [implementation]
(void)	- registerViewFactory:withId: [implementation]
Instance Methods inherited from <FlutterPluginRegistrar>
(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:
(void)	- addApplicationDelegate:
(void)	- registerViewFactory:withId:
(void)	- publish:
(nonnull NSString *)	- lookupKeyForAsset:
(nonnull NSString *)	- lookupKeyForAsset:fromPackage:

Properties
FlutterEngine *	flutterEngine
NSObject *	publishedValue
Properties inherited from <FlutterPluginRegistrar>
id< FlutterBinaryMessenger >	messenger
id< FlutterTextureRegistry >	textures
NSView *	view

Detailed Description

FlutterPluginRegistrar implementation handling a single plugin.

Definition at line 89 of file FlutterEngine.mm.

Method Documentation

addApplicationDelegate: [1/2]

- (void) addApplicationDelegate: ("Disallowed in plugins used in app extensions")  NS_EXTENSION_UNAVAILABLE_IOS

implementation

Registers the plugin as a receiver of UIApplicationDelegate calls.

Parameters

delegate

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

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

                              :(NSObject<FlutterPlugin>*)delegate
    NS_EXTENSION_UNAVAILABLE_IOS("Disallowed in plugins used in app extensions") {
  id<UIApplicationDelegate> appDelegate = [[UIApplication sharedApplication] delegate];
  if ([appDelegate conformsToProtocol:@protocol(FlutterAppLifeCycleProvider)]) {
    id<FlutterAppLifeCycleProvider> lifeCycleProvider =
        (id<FlutterAppLifeCycleProvider>)appDelegate;
    [lifeCycleProvider addApplicationLifeCycleDelegate:delegate];
  }
}

addApplicationDelegate: [2/2]

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

implementation

Definition at line 323 of file FlutterEngine.mm.

                              :(NSObject<FlutterAppLifecycleDelegate>*)delegate {
  id<NSApplicationDelegate> appDelegate = [[NSApplication sharedApplication] delegate];
  if ([appDelegate conformsToProtocol:@protocol(FlutterAppLifecycleProvider)]) {
    id<FlutterAppLifecycleProvider> lifeCycleProvider =
        static_cast<id<FlutterAppLifecycleProvider>>(appDelegate);
    [lifeCycleProvider addApplicationLifecycleDelegate:delegate];
    [_flutterEngine.pluginAppDelegates addPointer:(__bridge void*)delegate];
  }
}

addMethodCallDelegate:channel: [1/2]

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

implementation

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

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 323 of file FlutterEngine.mm.

                             :(nonnull id<FlutterPlugin>)delegate
                      channel:(nonnull FlutterMethodChannel*)channel {
  [channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
    [delegate handleMethodCall:call result:result];
  }];
}

addMethodCallDelegate:channel: [2/2]

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

implementation

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

Parameters

delegate	The receiving object, such as the plugin's main class.
channel	The channel

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

                             :(NSObject<FlutterPlugin>*)delegate
                      channel:(FlutterMethodChannel*)channel {
  [channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
    [delegate handleMethodCall:call result:result];
  }];
}

dealloc

- (void) dealloc

implementation

Definition at line 822 of file FlutterEngine.mm.

                {
  [_pluginKey release];
  [super dealloc];
}

initWithPlugin:flutterEngine: [1/2]

- (instancetype) initWithPlugin:		(nonnull NSString *)	pluginKey
flutterEngine:		(nonnull FlutterEngine *)	flutterEngine

initWithPlugin:flutterEngine: [2/2]

- (instancetype) initWithPlugin:		(NSString*)	pluginKey
flutterEngine:		(FlutterEngine*)	flutterEngine

Initial value:

{
  NSString* _pluginKey

Definition at line 822 of file FlutterEngine.mm.

                              :(NSString*)pluginKey flutterEngine:(FlutterEngine*)flutterEngine {
  self = [super init];
  NSAssert(self, @"Super init cannot be nil");
  _pluginKey = [pluginKey copy];
  _flutterEngine = flutterEngine;
  return self;
}

lookupKeyForAsset:

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

implementation

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

asset

The name of the asset. The name can be hierarchical.

Returns

the file name to be used for lookup in the main bundle.

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

                              :(NSString*)asset {
  return [_flutterEngine lookupKeyForAsset:asset];
}

lookupKeyForAsset:fromPackage:

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

implementation

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

asset	The name of the asset. The name can be hierarchical.
package	The name of the package from which the asset originates.

Returns

the file name to be used for lookup in the main bundle.

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

                              :(NSString*)asset fromPackage:(NSString*)package {
  return [_flutterEngine lookupKeyForAsset:asset fromPackage:package];
}

messenger

- (id< FlutterBinaryMessenger >) messenger

implementation

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

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

                                               {
  return _flutterEngine.binaryMessenger;
}

publish:

- (void) publish: (NSObject *)  value

implementation

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

value

The value to be published.

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

               :(NSObject*)value {
  _flutterEngine.pluginPublications[_pluginKey] = value;
}

registerViewFactory:withId: [1/2]

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

implementation

Registers a FlutterPlatformViewFactory for creation of platform views.

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

Parameters

factory	The view factory that will be registered.
factoryId	A 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.

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 323 of file FlutterEngine.mm.

                           :(nonnull NSObject<FlutterPlatformViewFactory>*)factory
                     withId:(nonnull NSString*)factoryId {
  [[_flutterEngine platformViewController] registerViewFactory:factory withId:factoryId];
}

registerViewFactory:withId: [2/2]

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

implementation

Registers a FlutterPlatformViewFactory for creation of platform views.

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

Parameters

factory	The view factory that will be registered.
factoryId	A 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.

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

                           :(NSObject<FlutterPlatformViewFactory>*)factory
                     withId:(NSString*)factoryId {
  [self registerViewFactory:factory
                                withId:factoryId
      gestureRecognizersBlockingPolicy:FlutterPlatformViewGestureRecognizersBlockingPolicyEager];
}

registerViewFactory:withId:gestureRecognizersBlockingPolicy:

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

implementation

Registers a FlutterPlatformViewFactory for creation of platform views.

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

Parameters

factory	The view factory that will be registered.
factoryId	A 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.
gestureRecognizersBlockingPolicy	How UIGestureRecognizers on the platform views are blocked.

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

                           :(NSObject<FlutterPlatformViewFactory>*)factory
                              withId:(NSString*)factoryId
    gestureRecognizersBlockingPolicy:
        (FlutterPlatformViewGestureRecognizersBlockingPolicy)gestureRecognizersBlockingPolicy {
  [_flutterEngine platformViewsController]->RegisterViewFactory(factory, factoryId,
                                                                gestureRecognizersBlockingPolicy);
}

textures

- (id< FlutterTextureRegistry >) textures

implementation

Returns a FlutterTextureRegistry for registering textures provided by the plugin.

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 822 of file FlutterEngine.mm.

                                              {
  return _flutterEngine.textureRegistry;
}

view

- (NSView *) view

implementation

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.

Reimplemented from <FlutterPluginRegistrar>.

Definition at line 323 of file FlutterEngine.mm.

                {
  return [self viewForIdentifier:kFlutterImplicitViewId];
}

viewForIdentifier:

- (NSView *) viewForIdentifier:

(FlutterViewIdentifier)

viewIdentifier

Definition at line 323 of file FlutterEngine.mm.

                            :(FlutterViewIdentifier)viewIdentifier {
  FlutterViewController* controller = [_flutterEngine viewControllerForIdentifier:viewIdentifier];
  if (controller == nil) {
    return nil;
  }
  if (!controller.viewLoaded) {
    [controller loadView];
  }
  return controller.flutterView;
}

Property Documentation

flutterEngine

- (FlutterEngine*) flutterEngine

readwritenonatomicassign

Definition at line 90 of file FlutterEngine.mm.

publishedValue

- (NSObject*) publishedValue

readnonatomicassign

The value published by this plugin, or NSNull if nothing has been published.

The unusual NSNull is for the documented behavior of valuePublishedByPlugin:.

Definition at line 318 of file FlutterEngine.mm.

---

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

• shell/platform/darwin/ios/framework/Source/FlutterEngine.mm
• shell/platform/darwin/macos/framework/Source/FlutterEngine.mm