app-check package

SDK web kiểm tra ứng dụng Firebase.

Kiểm tra ứng dụng Firebase không hoạt động trong môi trường Node.js bằng ReCaptchaV3Provider hoặc ReCaptchaEnterpriseProvider , nhưng có thể được sử dụng trong Node.js nếu bạn sử dụng CustomProvider và viết phương thức chứng thực của riêng mình.

Chức năng

Các lớp học

Giao diện

Nhập bí danh

chức năng (ứng dụng, ...)

khởi tạoAppCheck(ứng dụng, tùy chọn)

Kích hoạt Kiểm tra ứng dụng cho ứng dụng đã cho. Chỉ có thể được gọi một lần cho mỗi ứng dụng.

Chữ ký:

export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;

Thông số

Trả về:

Kiểm tra ứng dụng

hàm(appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

Yêu cầu mã thông báo Kiểm tra ứng dụng Firebase. Phương pháp này chỉ nên được sử dụng nếu bạn cần ủy quyền các yêu cầu tới chương trình phụ trợ không phải của Firebase.

Trả về các mã thông báo có mức sử dụng giới hạn được thiết kế để sử dụng với các điểm cuối phụ trợ không phải của Firebase được bảo vệ bằng Bảo vệ phát lại . Phương thức này không ảnh hưởng đến hành vi tạo mã thông báo của phương thức #getAppCheckToken().

Chữ ký:

export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;

Thông số

Trả về:

Lời hứa< AppCheckTokenResult >

Mã thông báo sử dụng hạn chế.

getToken(appCheckInstance, ForceRefresh)

Nhận mã thông báo Kiểm tra ứng dụng hiện tại. Đính kèm với yêu cầu trên chuyến bay gần đây nhất nếu có. Trả về null nếu không có mã thông báo nào và không có yêu cầu mã thông báo nào đang được thực hiện.

Chữ ký:

export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;

Thông số

Trả về:

Lời hứa< AppCheckTokenResult >

onTokenChanged(appCheckInstance, người quan sát)

Đăng ký người nghe để thay đổi trạng thái mã thông báo. Có thể có nhiều trình nghe được đăng ký cùng lúc cho một hoặc nhiều phiên bản Kiểm tra ứng dụng. Trình nghe gọi lại trên chuỗi giao diện người dùng bất cứ khi nào mã thông báo hiện tại được liên kết với phiên bản Kiểm tra ứng dụng này thay đổi.

Chữ ký:

export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;

Thông số

Trả về:

Hủy đăng ký

Một chức năng hủy đăng ký người nghe này.

onTokenChanged(appCheckInstance, onNext, onError, onCompletion)

Đăng ký người nghe để thay đổi trạng thái mã thông báo. Có thể có nhiều trình nghe được đăng ký cùng lúc cho một hoặc nhiều phiên bản Kiểm tra ứng dụng. Trình nghe gọi lại trên chuỗi giao diện người dùng bất cứ khi nào mã thông báo hiện tại được liên kết với phiên bản Kiểm tra ứng dụng này thay đổi.

Chữ ký:

export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;

Thông số

Trả về:

Hủy đăng ký

Một chức năng hủy đăng ký người nghe này.

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

Đặt xem Kiểm tra ứng dụng có tự động làm mới mã thông báo khi cần hay không.

Chữ ký:

export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;

Thông số

Trả về:

trống rỗng

AppCheckTokenListener

Trình nghe được gọi bất cứ khi nào mã thông báo Kiểm tra ứng dụng thay đổi.

Chữ ký:

export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;