Migrate protocol_handler's custom protocol and deep-link capabilities to NativeAPI

未关闭
#27 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
dart, flutter, typescript
领域
api, desktop

调研方向

Start with the linked protocol_handler README and public API references to map the existing registration, launch URL, event, and listener behavior. Then inspect NativeAPI's UrlOpener and its Dart/Flutter bindings and platform integrations. Done means equivalent APIs, setup documentation and a migration example cover Android, iOS, macOS, and Windows, with the listed scenarios validated on each.

由索引模型根据 Issue 内容生成。

描述

Goal

Bring the full public capability set of protocol_handler into NativeAPI so Flutter apps can migrate without losing functionality.

Scope

Provide equivalents for:

  • register(String scheme) for custom protocol registration/configuration.
  • getInitialUrl() for retrieving the URL that launched the app.
  • onUrlReceived for incoming URL events.
  • ProtocolListener.onProtocolUrlReceived(String url), listener attachment/removal, and listeners / hasListeners inspection.

API names may change, but the migration guide should map every existing public capability to its NativeAPI equivalent.

Platform coverage

Match the source plugin's documented support: Android, iOS, macOS and Windows. Document the required Android intent filters, iOS/macOS URL scheme declarations, Windows runner integration and MSIX protocol activation configuration.

Acceptance criteria
  • Expose equivalent APIs to Dart/Flutter.
  • Document platform support, setup requirements and limitations.
  • Provide a migration guide and example covering registration, launch URLs, incoming events and listener cleanup.
  • Validate these scenarios on all four source-supported platforms.
Notes

NativeAPI's existing UrlOpener handles outbound URLs, not incoming protocol activations. The source plugin exposes no unregister API, so unregistration is not assumed to be part of migration parity. Linux support and other language bindings can be scoped separately.

References
主要语言
TypeScript
星标
172
派生
16
平均合并
40 分钟
30 天内合并 PR
2

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

libnativeapi/nativeapi 的其他 Issue

查看 libnativeapi/nativeapi 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。