Skip to content

__CAPGO_KEEP_0__

GitHub

AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. 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 개요

API

현재 App Check 토큰을 가져옵니다.

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';
await FirebaseAppCheck.getToken();

initialize

initialize

__CAPGO_KEEP_0__를 위한 앱 체크 활성화

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';
await FirebaseAppCheck.initialize();

setTokenAutoRefreshEnabled

__CAPGO_KEEP_1__ 복사

setTokenAutoRefreshEnabled

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';
await FirebaseAppCheck.setTokenAutoRefreshEnabled({} as SetTokenAutoRefreshEnabledOptions);

__CAPGO_KEEP_1__ 복사

타입 참조

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

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

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

TokenChangedListener

__CAPGO_KEEP_0__

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

GetPluginVersionResult

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

TokenChangedEvent

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

__CAPGO_KEEP_0__

실제 소스

이 페이지는 플러그인의 src/definitions.ts. upstream의 API가 변경되면 다시 싱크를 실행하세요.

Getting Started에서 계속

Getting Started에서 계속

이러한 기능을 사용 중이라면 Getting Started를 사용하여 대시보드와 __CAPGO_KEEP_0__를 계획하고, __CAPGO_KEEP_0__ Overview와 연결하세요. API Overview API Overview의 구현 세부 정보 for the implementation detail in API Overview, 소개의 구현 세부 정보 Getting Started API 키 implementation 세부 정보에 대한 API 키 장치 implementation 세부 정보에 대한 장치 배포 implementation 세부 정보에 대한 배포