Mulai

Instal

Anda dapat menggunakan Pengaturan Bantu AI untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

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

Import

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

API Ringkasan

getToken

Mendapatkan token App Check saat ini.

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

await FirebaseAppCheck.getToken();

initialize

Salin ke papan klip

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

await FirebaseAppCheck.initialize();

setTokenAutoRefreshEnabled

Referensi Tipe

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

await FirebaseAppCheck.setTokenAutoRefreshEnabled({} as SetTokenAutoRefreshEnabledOptions);

Salin ke papan klip

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

Panggilan Balik untuk Menerima Peristiwa Perubahan 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;
}

Sumber Kebenaran

Halaman ini dibuat dari plugin’s src/definitions.ts. Re-run sinkronisasi ketika publik API berubah di atas

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan API Overview untuk detail implementasi di API Panduan Umum, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, Perangkat untuk detail implementasi di Perangkat, dan Bundel untuk detail implementasi di Bundel.