-
Notifications
You must be signed in to change notification settings - Fork 29.2k
Closed
flutter/packages
#3705Labels
P3Issues that are less important to the Flutter projectIssues that are less important to the Flutter projectp: pigeonrelated to pigeon messaging codegen toolrelated to pigeon messaging codegen toolpackageflutter/packages repository. See also p: labels.flutter/packages repository. See also p: labels.r: fixedIssue is closed as already fixed in a newer versionIssue is closed as already fixed in a newer version
Description
Use case
The documentation and example of pigeon describe the usage of @HostApi
, which is used to call into native code from flutter.
But Pigeon also supports @FlutterApi
, which enables the native code to call into Flutter code, typically used for Steam-like updates that are not initiated from the Flutter side, but from the OS/native side.
This feature is not mentioned only briefly in the README and there are no examples that showcase it.
Proposal
Pigeon should have better documentation for@FlutterApi
in the README and either add an example project or at least link to a third-party package that uses it.
In a quick search I only found these third-party projects using it:
- https://github.com/fluttercandies/ff_native_screenshot/ simple package for listening to native screenshots, good candidate IMO
- https://github.com/zero-li/flutter_pigeon_plugin very minimal example project using @FlutterApi, would be a good candidate but the documentation is in Chinese
- https://gitlab.com/twilio-flutter/conversations complex-ish package using @FlutterApi
apalala-dev, mzdm, Swirastlynn and ferraridamiano
Metadata
Metadata
Assignees
Labels
P3Issues that are less important to the Flutter projectIssues that are less important to the Flutter projectp: pigeonrelated to pigeon messaging codegen toolrelated to pigeon messaging codegen toolpackageflutter/packages repository. See also p: labels.flutter/packages repository. See also p: labels.r: fixedIssue is closed as already fixed in a newer versionIssue is closed as already fixed in a newer version