Skip to content

docs: add @NativePlugin removal to Capacitor 9 upgrade guide #586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OS-ruimoreiramendes wants to merge 4 commits into
base: chore/RMET-5304-cap9-android-deprecated-apis
Choose a base branch
from
+21 −1
Open

docs: add @NativePlugin removal to Capacitor 9 upgrade guide #586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
526389a
docs: add @NativePlugin removal to Capacitor 9 upgrade guide
OS-ruimoreiramendes Aug 10, 2026
066527d
note that @NativePlugin was removed in Capacitor 9
OS-ruimoreiramendes Aug 10, 2026
3075614
docs: add Plugin.hasPermission removal to Capacitor 9 upgrade guide
OS-ruimoreiramendes Aug 10, 2026
9ed7925
docs: add @CapacitorPlugin.requestCodes and Bridge.getPluginWithReque…
OS-ruimoreiramendes Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/main/updating/9-0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,23 @@ Capacitor 9 removes the Java APIs that were deprecated in previous major version
| `Bridge.CAPACITOR_HTTPS_INTERCEPTOR_START` | `CAPACITOR_HTTP_INTERCEPTOR_START`, all proxied requests are handled by it |
| `Plugin.getConfigValue(String)` | `getConfig()` and the typed accessors on `PluginConfig` |
| `MessageHandler(Bridge, WebView, Object)` constructor | `MessageHandler(Bridge, WebView)` |

### Removal of the legacy `@NativePlugin` annotation

The `@NativePlugin` annotation, deprecated since Capacitor 3.0 in favor of `@CapacitorPlugin`, has been removed in Capacitor 9 along with the deprecated permission and activity-result APIs that only existed to support it. For the overall migration pattern (annotation switch, callback-based activity and permission results, new Permissions API), see the [Capacitor 3 plugin migration guide](/updating/plugins/3-0). The specific method replacements removed in this release are listed below.

| Removed | Replacement |
| :------ | :---------- |
| `@NativePlugin` | `@CapacitorPlugin` |
| `@CapacitorPlugin(requestCodes = {...})` attribute | Use `Plugin.startActivityForResult(PluginCall, Intent, String)` with `@ActivityCallback` for activity results, and `Plugin.requestPermissionForAlias(...)` / `requestPermissionForAliases(...)` / `requestAllPermissions(...)` with `@PermissionCallback` for permission requests |
| `Bridge.getPluginWithRequestCode(int)` | No replacement — use the callback-based `@ActivityCallback` / `@PermissionCallback` pattern instead |
| `Plugin.saveCall(PluginCall)` | `Bridge.saveCall(PluginCall)` or `PluginCall.setKeepAlive(true)` |
| `Plugin.getSavedCall()` (no-arg) | `Bridge.getSavedCall(String)` |
| `Plugin.freeSavedCall()` | `PluginCall.release(Bridge)` |
| `Plugin.hasDefinedPermissions(String[])` | `Plugin.isPermissionDeclared(String)` |
| `Plugin.hasPermission(String)` | `Plugin.getPermissionState(String)` / `getPermissionStates()`, or `ActivityCompat.checkSelfPermission(Context, String)` |
| `Plugin.pluginRequestPermission(String, int)` | `Plugin.requestPermissionForAlias(...)` with `@PermissionCallback` |
| `Plugin.pluginRequestPermissions(String[], int)` | `Plugin.requestPermissionForAliases(...)` with `@PermissionCallback` |
| `Plugin.pluginRequestAllPermissions()` | `Plugin.requestAllPermissions(PluginCall, String)` with `@PermissionCallback` |
| `Plugin.startActivityForResult(PluginCall, Intent, int)` | `Plugin.startActivityForResult(PluginCall, Intent, String)` with `@ActivityCallback` |
| `Bridge.startActivityForPluginWithResult(PluginCall, Intent, int)` | `Plugin.startActivityForResult(PluginCall, Intent, String)` with `@ActivityCallback` |
2 changes: 1 addition & 1 deletion docs/plugins/creating-plugins/android-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Before following this section, make sure you've set up your permission aliases a

### Annotation Changes

> Still using `@NativePlugin`? See the [upgrade guide](/main/updating/plugins/3-0.md#use-the-new-capacitorplugin-annotation) to switch to `@CapacitorPlugin`.
> The `@NativePlugin` annotation was removed in Capacitor 9. If your plugin still uses it, see the [upgrade guide](/main/updating/plugins/3-0.md#use-the-new-capacitorplugin-annotation) to switch to `@CapacitorPlugin`.

```diff
@CapacitorPlugin(
Expand Down