| Flutter iOS Embedder |

Instance Methods | Class Methods | List of all members
<FlutterPlugin> Protocol Reference

`#import <FlutterPlugin.h>`

Inheritance diagram for <FlutterPlugin>:

## Instance Methods
(void) | - handleMethodCall:result:
(void) | - detachFromEngineForRegistrar:
Instance Methods inherited from <FlutterApplicationLifeCycleDelegate>
(BOOL) | - application:didFinishLaunchingWithOptions:
(BOOL) | - application:willFinishLaunchingWithOptions:
(void) | - applicationDidBecomeActive:
(void) | - applicationWillResignActive:
(void) | - applicationDidEnterBackground:
(void) | - applicationWillEnterForeground:
(void) | - applicationWillTerminate:
(void) | - application:didRegisterUserNotificationSettings:
(void) | - application:didRegisterForRemoteNotificationsWithDeviceToken:
(void) | - application:didFailToRegisterForRemoteNotificationsWithError:
(BOOL) | - application:didReceiveRemoteNotification:fetchCompletionHandler:
(void) | - application:didReceiveLocalNotification:
(BOOL) | - application:openURL:options:
(BOOL) | - application:handleOpenURL:
(BOOL) | - application:openURL:sourceApplication:annotation:
(BOOL) | - application:performActionForShortcutItem:completionHandler:
(BOOL) | - application:handleEventsForBackgroundURLSession:completionHandler:
(BOOL) | - application:performFetchWithCompletionHandler:
(BOOL) | - application:continueUserActivity:restorationHandler:

## Class Methods
(void) | + registerWithRegistrar:
(void) | + setPluginRegistrantCallback:

## Detailed Description

Implemented by the iOS part of a Flutter plugin.

Defines a set of optional callback methods and a method to set up the plugin and register it to be called by other application components.

Definition at line 190 of file FlutterPlugin.h.

## Method Documentation

## ◆ detachFromEngineForRegistrar:

- (void) detachFromEngineForRegistrar: |  | (NSObject< FlutterPluginRegistrar > *) | registrar |
| optional

Called when a plugin is being removed from a `FlutterEngine`, which is usually the result of the `FlutterEngine` being deallocated. This method provides the opportunity to do necessary cleanup.

You will only receive this method if you registered your plugin instance with the `FlutterEngine` via `-[FlutterPluginRegistry publish:]`.

Parameters

  registrar | The registrar that was used to publish the plugin.

## ◆ handleMethodCall:result:

- (void) handleMethodCall: |  | (FlutterMethodCall *) | call
result: |  | (FlutterResult) | result
| optional

Called if this plugin has been registered to receive `FlutterMethodCall`s.

Parameters

  call | The method call command object.
  result | A callback for submitting the result of the call.

## ◆ registerWithRegistrar:

+ (void) registerWithRegistrar: |  | (NSObject< FlutterPluginRegistrar > *) | registrar |
| static required

Registers this plugin using the context information and callback registration methods exposed by the given registrar.

The registrar is obtained from a `FlutterPluginRegistry` which keeps track of the identity of registered plugins and provides basic support for cross-plugin coordination.

The caller of this method, a plugin registrant, is usually autogenerated by Flutter tooling based on declared plugin dependencies. The generated registrant asks the registry for a registrar for each plugin, and calls this method to allow the plugin to initialize itself and register callbacks with application objects available through the registrar protocol.

Parameters

  registrar | A helper providing application context and methods for registering callbacks.

## ◆ setPluginRegistrantCallback:

+ (void) setPluginRegistrantCallback: |  | (FlutterPluginRegistrantCallback) | callback |
| static optional

Set a callback for registering plugins to an additional `FlutterPluginRegistry`, including headless `FlutterEngine` instances.

This method is typically called from within an application's `AppDelegate` at startup to allow for plugins which create additional `FlutterEngine` instances to register the application's plugins.

Parameters

  callback | A callback for registering some set of plugins with a `FlutterPluginRegistry`.

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

- shell/platform/darwin/ios/framework/Headers/FlutterPlugin.h