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 1 commit into from
+19 −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
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions docs/main/updating/plugins/9-0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,24 @@ slug: /updating/plugins/9-0

# Breaking changes in code

## Android

The `@NativePlugin` annotation and several deprecated permission and activity-result APIs from that era have been removed. For the overall migration pattern, see the [Capacitor 3 plugin migration guide](/updating/plugins/3-0).

| Removed | Replacement |
| :------ | :---------- |
| `@NativePlugin` annotation | `@CapacitorPlugin` |
| `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` |

# Updating Capacitor to 9.0 in your plugin

:::note
Expand Down
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