pigeon
library
Classes
ConfigurePigeon
Metadata annotation used to configure how Pigeon will generate code.
CppOptions
Options that control how C++ code will be generated.
DartOptions
Options that control how Dart code will be generated.
Error
Represents an error as a result of parsing and generating code.
EventChannelApi
Metadata to annotate a pigeon API that contains event channels.
Float64List
A fixed-length list of IEEE 754 double-precision binary floating-point
numbers that is viewable as a TypedData .
FlutterApi
Metadata to annotate a Pigeon API implemented by Flutter.
GObjectOptions
Options that control how GObject code will be generated.
HostApi
Metadata to annotate a Pigeon API implemented by the host-platform.
Int32List
A fixed-length list of 32-bit signed integers that is viewable as a
TypedData .
Int64List
A fixed-length list of 64-bit signed integers that is viewable as a
TypedData .
JavaOptions
Options that control how Java code will be generated.
KotlinEventChannelOptions
Options for Kotlin implementation of Event Channels.
KotlinOptions
Options that control how Kotlin code will be generated.
KotlinProxyApiOptions
Options that control how Kotlin code will be generated for a specific
ProxyApi.
ObjcOptions
Options that control how Objective-C code will be generated.
ObjCSelector
Metadata to annotation methods to control the selector used for objc output.
The number of components in the provided selector must match the number of
arguments in the annotated method.
For example:
@ObjcSelector('divideValue:by:') double divide(int x, int y);
ParseResults
A collection of an AST represented as a Root and Error 's.
Pigeon
Tool for generating code to facilitate platform channels usage.
PigeonOptions
Options used when configuring Pigeon.
ProxyApi
Metadata to annotate a ProxyAPI.
SwiftClass
Metadata to annotate data classes to be defined as class in Swift output.
SwiftEventChannelOptions
Options for Swift implementation of Event Channels.
SwiftFunction
Metadata to annotate methods to control the signature used for Swift output.
SwiftOptions
Options that control how Swift code will be generated.
SwiftProxyApiOptions
Options that control how Swift code will be generated for a specific
ProxyApi.
TaskQueue
Metadata annotation to control how handlers are dispatched for HostApi's.
Note that the TaskQueue API might not be available on the target version of
Flutter, see also:
https://docs.flutter.dev/development/platform-integration/platform-channels .
Uint8List
A fixed-length list of 8-bit unsigned integers.
Enums
TaskQueueType
Type of TaskQueue which determines how handlers are dispatched for
HostApi's.
Constants
async → const Object
Metadata to annotate a Api method as asynchronous
attached → const Object
Metadata to annotate the field of a ProxyApi as an Attached Field.
static → const Object
Metadata to annotate a field of a ProxyApi as static.
