Firebase 앱 체크 웹 SDK.
ReCaptchaV3Provider
또는 ReCaptchaEnterpriseProvider
사용하는 Node.js 환경에서는 Firebase 앱 체크가 작동하지 않습니다. 하지만 CustomProvider
사용하고 자체 증명 방법을 작성하는 경우 Node.js에서 사용할 수 있습니다.
기능
기능 | 설명 |
---|---|
기능(앱, ...) | |
초기화AppCheck(앱, 옵션) | 해당 앱에 대해 앱 체크를 활성화합니다. 앱당 한 번만 호출할 수 있습니다. |
함수(appCheckInstance, ...) | |
getLimitedUseToken(appCheckInstance) | Firebase 앱 체크 토큰을 요청합니다. 이 방법은 Firebase가 아닌 백엔드에 대한 요청을 승인해야 하는 경우에만 사용해야 합니다. Replay Protection 으로 보호되는 Firebase가 아닌 백엔드 엔드포인트에 사용하기 위한 제한적으로 사용되는 토큰을 반환합니다. 이 메소드는 #getAppCheckToken() 메소드의 토큰 생성 동작에 영향을 주지 않습니다. |
getToken(appCheckInstance, forceRefresh) | 현재 앱 체크 토큰을 가져옵니다. 가장 최근의 진행 중인 요청이 있는 경우 해당 요청에 첨부합니다. 토큰이 없고 진행 중인 토큰 요청이 없으면 null을 반환합니다. |
onTokenChanged(appCheckInstance, 관찰자) | 토큰 상태 변경에 대한 리스너를 등록합니다. 하나 이상의 앱 체크 인스턴스에 대해 동시에 등록된 수신기가 두 개 이상 있을 수 있습니다. 리스너는 이 앱 체크 인스턴스와 연결된 현재 토큰이 변경될 때마다 UI 스레드에서 콜백합니다. |
onTokenChanged(appCheckInstance, onNext, onError, onCompletion) | 토큰 상태 변경에 대한 리스너를 등록합니다. 하나 이상의 앱 체크 인스턴스에 대해 동시에 등록된 수신기가 두 개 이상 있을 수 있습니다. 리스너는 이 앱 체크 인스턴스와 연결된 현재 토큰이 변경될 때마다 UI 스레드에서 콜백합니다. |
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | 앱 체크가 필요에 따라 자동으로 토큰을 새로 고칠지 여부를 설정합니다. |
클래스
수업 | 설명 |
---|---|
CustomProvider | 사용자 정의 공급자 클래스. |
ReCaptchaEnterpriseProvider | reCAPTCHA Enterprise 토큰을 획득하고 이를 앱 체크 토큰으로 교환할 수 있는 앱 체크 제공업체입니다. |
ReCaptchaV3공급자 | reCAPTCHA V3 토큰을 획득하고 이를 앱 체크 토큰으로 교환할 수 있는 앱 체크 제공업체입니다. |
인터페이스
상호 작용 | 설명 |
---|---|
앱체크 | Firebase 앱 체크 서비스 인터페이스입니다. |
AppCheck옵션 | 앱 체크 초기화 옵션입니다. |
AppCheckToken | 앱 체크 제공자로부터 반환된 토큰입니다. |
AppCheckTokenResult | getToken() 에서 반환된 결과입니다. |
CustomProviderOptions | CustomProvider 생성 시 옵션 . |
유형 별칭
유형 별칭 | 설명 |
---|---|
AppCheckTokenListener | 앱 체크 토큰이 변경될 때마다 호출되는 리스너입니다. |
기능(앱, ...)
초기화AppCheck(앱, 옵션)
해당 앱에 대해 앱 체크를 활성화합니다. 앱당 한 번만 호출할 수 있습니다.
서명:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
앱 | Firebase앱 | 한정되지 않은 | 앱 체크를 활성화할 FirebaseApp |
옵션 | AppCheck옵션 | 앱 체크 초기화 옵션 |
보고:
함수(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
Firebase 앱 체크 토큰을 요청합니다. 이 방법은 Firebase가 아닌 백엔드에 대한 요청을 승인해야 하는 경우에만 사용해야 합니다.
Replay Protection 으로 보호되는 Firebase가 아닌 백엔드 엔드포인트에 사용하기 위한 제한적으로 사용되는 토큰을 반환합니다. 이 메소드는 #getAppCheckToken() 메소드의 토큰 생성 동작에 영향을 주지 않습니다.
서명:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
appCheckInstance | 앱체크 | 앱 체크 서비스 인스턴스입니다. |
보고:
약속< AppCheckTokenResult >
제한된 사용 토큰입니다.
getToken(appCheckInstance, forceRefresh)
현재 앱 체크 토큰을 가져옵니다. 가장 최근의 진행 중인 요청이 있는 경우 해당 요청에 첨부합니다. 토큰이 없고 진행 중인 토큰 요청이 없으면 null을 반환합니다.
서명:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
appCheckInstance | 앱체크 | 앱 체크 서비스 인스턴스입니다. |
강제 새로 고침 | 부울 | true인 경우 항상 새로운 토큰을 가져오려고 시도합니다. false인 경우 저장소에 있는 경우 캐시된 토큰을 사용합니다. |
보고:
약속< AppCheckTokenResult >
onTokenChanged(appCheckInstance, 관찰자)
토큰 상태 변경에 대한 리스너를 등록합니다. 하나 이상의 앱 체크 인스턴스에 대해 동시에 등록된 수신기가 두 개 이상 있을 수 있습니다. 리스너는 이 앱 체크 인스턴스와 연결된 현재 토큰이 변경될 때마다 UI 스레드에서 콜백합니다.
서명:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
appCheckInstance | 앱체크 | 앱 체크 서비스 인스턴스입니다. |
관찰자 | 부분관찰자 < AppCheckTokenResult > | next , error 및 complete 속성이 있는 객체입니다. next 는 토큰이 변경될 때마다 AppCheckTokenResult 와 함께 호출됩니다. error 는 선택 사항이며 리스너( next 함수)에서 오류가 발생하면 호출됩니다. 토큰 스트림이 끝나지 않으므로 complete 사용되지 않습니다. |
보고:
이 리스너를 구독 취소하는 함수입니다.
onTokenChanged(appCheckInstance, onNext, onError, onCompletion)
토큰 상태 변경에 대한 리스너를 등록합니다. 하나 이상의 앱 체크 인스턴스에 대해 동시에 등록된 수신기가 두 개 이상 있을 수 있습니다. 리스너는 이 앱 체크 인스턴스와 연결된 현재 토큰이 변경될 때마다 UI 스레드에서 콜백합니다.
서명:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
appCheckInstance | 앱체크 | 앱 체크 서비스 인스턴스입니다. |
다음 | (토큰결과: AppCheckTokenResult ) => 무효 | 토큰이 변경되면 AppCheckTokenResult 와 함께 이 함수가 호출됩니다. . |
오류 시 | (오류: 오류) => 무효 | 선택 과목. 리스너( onNext 함수)에서 오류가 발생한 경우 호출됩니다. |
완료 시 | () => 무효 | 토큰 스트림이 끝이 없기 때문에 현재는 사용되지 않습니다. |
보고:
이 리스너를 구독 취소하는 함수입니다.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
앱 체크가 필요에 따라 자동으로 토큰을 새로 고칠지 여부를 설정합니다.
서명:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
appCheckInstance | 앱체크 | 앱 체크 서비스 인스턴스입니다. |
isTokenAutoRefreshEnabled | 부울 | true인 경우 SDK는 필요에 따라 앱 체크 토큰을 자동으로 새로 고칩니다. 이는 initializeAppCheck() 중에 설정된 모든 값을 재정의합니다. |
보고:
무효의
AppCheckTokenListener
앱 체크 토큰이 변경될 때마다 호출되는 리스너입니다.
서명:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;