Skip to content

@capgo/capacitor-permissions

Check and request runtime permissions on iOS, Android, and web with one PermissionName enum and normalized status codes

Check and request runtime permissions on iOS, Android, and web with one PermissionName enum and normalized status codes

Start with check() and the other core methods listed below.

PlatformSupportNotes
iOSYesNative
AndroidYesNative
WebNoGuard with Capacitor.getPlatform()
  • check - Read the current status of one permission without prompting.
  • request - Request one permission from the user.
  • checkMultiple - Check several permissions without prompting.
  • requestMultiple - Request several permissions sequentially.
MethodDescription
checkRead the current status of one permission without prompting.
requestRequest one permission from the user.
checkMultipleCheck several permissions without prompting.
requestMultipleRequest several permissions sequentially.
shouldShowRationaleWhether Android should show a rationale before requesting again.
openSettingsOpen application or notification settings when access is blocked.
requestPreciseLocationUpgrade to precise location on iOS and fine location on Android.
getPluginVersionReturns the platform implementation version marker.

This reference is synced from src/definitions.ts in capacitor-permissions.

Keep going from @capgo/capacitor-permissions

Section titled “Keep going from @capgo/capacitor-permissions”

If you are using @capgo/capacitor-permissions in your Capacitor app, connect it with Using @capgo/capacitor-permissions for the SEO tutorial and related Capgo plugin docs.