Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utilice el siguiente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-app-check` plugin in my project.

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-firebase-app-check
bunx cap sync

Importar

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';

API Resumen

getToken

Obtén el token de App Check actual.

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';

await FirebaseAppCheck.getToken();

initialize

Activar App Check para la aplicación dada. Solo se puede llamar una vez por aplicación.

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';

await FirebaseAppCheck.initialize();

setTokenAutoRefreshEnabled

Establecer si el token de App Check debe ser actualizado automáticamente o no.

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';

await FirebaseAppCheck.setTokenAutoRefreshEnabled({} as SetTokenAutoRefreshEnabledOptions);

Referencia de tipos

GetTokenOptions

export interface GetTokenOptions {
  /**
   * If `true`, will always try to fetch a fresh token.
   * If `false`, will use a cached token if found in storage.
   *
   * @since 1.3.0
   * @default false
   */
  forceRefresh?: boolean;
}

GetTokenResult

export interface GetTokenResult {
  /**
   * The App Check token in JWT format.
   *
   * @since 1.3.0
   */
  token: string;
  /**
   * The timestamp after which the token will expire in milliseconds since epoch.
   *
   * Only available for Android and iOS.
   *
   * @since 1.3.0
   */
  expireTimeMillis?: number;
}

InitializeOptions

export interface InitializeOptions {
  /**
   * If `true`, the debug provider is used.
   *
   * ⚠️ **Attention**: The debug provider allows access to your Firebase resources from unverified devices.
   * Don't use the debug provider in production builds of your app, and don't share your debug builds with untrusted parties.
   *
   * ⚠️ **Deprecated**: Use `debugToken` instead. This option will be removed in the next major version.
   *
   * Read more: https://firebase.google.com/docs/app-check/web/debug-provider
   *
   * @since 1.3.0
   * @deprecated Use `debugToken` instead. This option will be removed in the next major version.
   * @default false
   */
  debug?: boolean;
  /**
   * If `true`, the debug provider is used.
   *
   * On **Web**, you can also set a predefined debug token string instead of `true`. On Android and iOS, you have to use environment variables for this.
   *
   * ⚠️ **Attention**: The debug provider allows access to your Firebase resources from unverified devices.
   * Don't use the debug provider in production builds of your app, and don't share your debug builds with untrusted parties.
   *
   * @since 7.1.0
   * @default false
   * @see https://firebase.google.com/docs/app-check/android/debug-provider#ci
   * @see https://firebase.google.com/docs/app-check/ios/debug-provider#ci
   * @see https://firebase.google.com/docs/app-check/web/debug-provider
   */
  debugToken?: boolean | string;
  /**
   * If `true`, the SDK automatically refreshes App Check tokens as needed.
   *
   * @since 1.3.0
   * @default false
   */
  isTokenAutoRefreshEnabled?: boolean;
  /**
   * The provider to use for App Check. Must be an instance of
   * `ReCaptchaV3Provider`, `ReCaptchaEnterpriseProvider`, or `CustomProvider`.
   *
   * Only available for Web.
   *
   * @since 7.1.0
   * @default ReCaptchaV3Provider
   * @see https://firebase.google.com/docs/app-check/web/custom-provider
   */
  provider?: any;
  /**
   * The reCAPTCHA v3 site key (public key). This option is ignored when `provider` is set.
   *
   * Only available for Web.
   *
   * @deprecated Use `provider` instead.
   * @since 1.3.0
   */
  siteKey?: string;
}

SetTokenAutoRefreshEnabledOptions

export interface SetTokenAutoRefreshEnabledOptions {
  /**
   * If `true`, the SDK automatically refreshes App Check tokens as needed.
   * This overrides any value set during initializeAppCheck().
   *
   * @since 1.3.0
   */
  enabled: boolean;
}

TokenChangedListener

Callback para recibir el evento de cambio de token.

export type TokenChangedListener = (event: TokenChangedEvent) => void;

GetPluginVersionResult

export interface GetPluginVersionResult {
  /**
   * The semantic version of this plugin.
   *
   * @since 8.0.1
   */
  version: string;
}

TokenChangedEvent

export interface TokenChangedEvent {
  /**
   * The App Check token in JWT format.
   *
   * @since 1.3.0
   */
  token: string;
}

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.ts . Vuelva a ejecutar la sincronización cuando los archivos públicos API cambien en la fuente.

Siga adelante desde Getting Started

Si está utilizando Getting Started para planificar la consola de dashboard y API operaciones, conecte con API Overview para obtener detalles de implementación en API Overview, Introducción para obtener detalles de implementación en Introducción, API Claves para el detalle de implementación en API Claves, Dispositivos para el detalle de implementación en Dispositivos, y Paquetes para el detalle de implementación en Paquetes.