Guide
How to use Firebase App Check in Capacitor
Using @capgo/capacitor-firebase-app-check
Capacitor plugin for Firebase App Check.
Install
bun add @capgo/capacitor-firebase-app-check
bunx cap sync
bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.
Import
import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';
API at a glance
| Method | Description |
|---|---|
getToken |
Get the current App Check token. |
initialize |
Activate App Check for the given app. Can be called only once per app. |
setTokenAutoRefreshEnabled |
Set whether the App Check token should be refreshed automatically or not. |
Examples
getToken()
Get the current App Check token.
import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';
const result = await FirebaseAppCheck.getToken();
// The result holds sensitive values: use it without logging it.
initialize()
Activate App Check for the given app. Can be called only once per app.
import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';
await FirebaseAppCheck.initialize();
setTokenAutoRefreshEnabled()
Set whether the App Check token should be refreshed automatically or not.
import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';
await FirebaseAppCheck.setTokenAutoRefreshEnabled({ enabled: true });
Listen to events
addListener returns a handle. Call handle.remove() when the screen unmounts, or FirebaseAppCheck.removeAllListeners() to clear every listener.
Full reference
Keep going from Using @capgo/capacitor-firebase-app-check
If you are using Using @capgo/capacitor-firebase-app-check to plan native plugin work, connect it with Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives, and Capgo Native Builds for the product workflow in Capgo Native Builds.