Skip to content

[pigeon] Better documentation for @FlutterApi usageΒ #108531

@knaeckeKami

Description

@knaeckeKami

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:

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Issues that are less important to the Flutter projectp: pigeonrelated to pigeon messaging codegen toolpackageflutter/packages repository. See also p: labels.r: fixedIssue is closed as already fixed in a newer version

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions