FlutterChannels.h File Reference

#import "FlutterBinaryMessenger.h"
#import "FlutterCodecs.h"

Go to the source code of this file.

Classes
class	FlutterBasicMessageChannel
class	FlutterMethodChannel
protocol	<FlutterStreamHandler>
class	FlutterEventChannel

Typedefs
typedef void(^	FlutterMessageHandler) (id _Nullable message, FlutterReply callback)
typedef void(^	FlutterResult) (id _Nullable result)
typedef void(^	FlutterMethodCallHandler) (FlutterMethodCall *call, FlutterResult result)
typedef void(^	FlutterEventSink) (id _Nullable event)

Variables
NS_ASSUME_NONNULL_BEGIN typedef void(^	FlutterReply )(id _Nullable reply)
FLUTTER_DARWIN_EXPORT NSObject const *	FlutterMethodNotImplemented
FLUTTER_DARWIN_EXPORT NSObject const *	FlutterEndOfEventStream

Typedef Documentation

FlutterEventSink

typedef void(^ FlutterEventSink) (id _Nullable event)

An event sink callback.

Parameters

event

The event.

Definition at line 350 of file FlutterChannels.h.

FlutterMessageHandler

typedef void(^ FlutterMessageHandler) (id _Nullable message, FlutterReply callback)

A strategy for handling incoming messages from Flutter and to send asynchronous replies back to Flutter.

Parameters

message	The message.
callback	A callback for submitting a reply to the sender which can be invoked from any thread.

Definition at line 30 of file FlutterChannels.h.

FlutterMethodCallHandler

typedef void(^ FlutterMethodCallHandler) (FlutterMethodCall *call, FlutterResult result)

A strategy for handling method calls.

Parameters

call	The incoming method call.
result	A callback to asynchronously submit the result of the call. Invoke the callback with a FlutterError to indicate that the call failed. Invoke the callback with FlutterMethodNotImplemented to indicate that the method was unknown. Any other values, including nil, are interpreted as successful results. This can be invoked from any thread.

Definition at line 206 of file FlutterChannels.h.

FlutterResult

typedef void(^ FlutterResult) (id _Nullable result)

A method call result callback.

Used for submitting a method call result back to a Flutter caller. Also used in the dual capacity for handling a method call result received from Flutter.

Parameters

result

The result.

Definition at line 194 of file FlutterChannels.h.

Variable Documentation

FlutterEndOfEventStream

FLUTTER_DARWIN_EXPORT NSObject const* FlutterEndOfEventStream

A constant used with FlutterEventChannel to indicate end of stream.

FlutterMethodNotImplemented

FLUTTER_DARWIN_EXPORT NSObject const* FlutterMethodNotImplemented

A constant used with FlutterMethodCallHandler to respond to the call of an unknown method.

Referenced by FlutterPlatformPlugin::handleMethodCall:result:, FlutterUndoManagerPlugin::handleMethodCall:result:, FlutterTextInputPlugin::handleMethodCall:result:, and FlutterPlatformViewsController::onMethodCall:result:.

FlutterReply

NS_ASSUME_NONNULL_BEGIN typedef void(^ FlutterReply) (id _Nullable reply)

A message reply callback.

Used for submitting a reply back to a Flutter message sender. Also used in the dual capacity for handling a message reply received from Flutter.

Parameters

reply

The reply.