はじめから始めよう

インストール

CapgoのAIアシストセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを使用してください。

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

次に、以下のプロンプトを使用してください。

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

この手順では、以下のコマンドを実行し、下記のプラットフォーム固有の手順に従って、プラグインをインストールしてください。

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

インポート

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

API の概要

getToken

現在のApp Checkトークンを取得します。

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

await FirebaseAppCheck.getToken();

initialize

指定されたアプリのApp Checkを有効にします。 アプリごとに一度だけ呼び出してください。

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

await FirebaseAppCheck.initialize();

setTokenAutoRefreshEnabled

App Checkのトークンが自動で更新されるかどうかを設定します。

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

await FirebaseAppCheck.setTokenAutoRefreshEnabled({} as SetTokenAutoRefreshEnabledOptions);

Type Reference

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

__CAPGO_KEEP_0__

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;
}

__CAPGO_KEEP_0__

このページはプラグインの src/definitions.ts。 公開用 API がアップストリームで変更された場合、再度同期を実行してください。

「Getting Started」から続けてください。

「Getting Started」を使用して、ダッシュボードと __CAPGO_KEEP_0__ の操作を計画する場合、 「__CAPGO_KEEP_0__ Overview」 「API Overview」で API の実装詳細を確認してください。 API Overview for the implementation detail in API Overview, 「Getting Started」 「Getting Started」 API キー API キーに関する実装詳細 デバイス デバイスに関する実装詳細 バンドル バンドルに関する実装詳細