app-check package

SDK Web Kiểm tra ứng dụng Firebase.

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

Hàm

Chức năng Mô tả
hàm(app, ...)
startupAppCheck(ứng dụng, lựa chọn) Kích hoạt tính năng Kiểm tra ứng dụng cho ứng dụng cụ thể. Chỉ có thể gọi điện một lần cho mỗi ứng dụng.
hàm(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance) Yêu cầu mã thông báo Kiểm tra ứng dụng Firebase. Bạn chỉ nên sử dụng phương thức này nếu cần cho phép các yêu cầu gửi đến một phần phụ trợ không phải của Firebase.Trả về mã thông báo có giới hạn để sử dụng với các điểm cuối phụ trợ không phải của Firebase và được bảo vệ bằng tính năng Chống 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().
getToken(appCheckInstance, forceRefresh) Lấy mã thông báo Kiểm tra ứng dụng hiện tại. Nếu forceRefresh là false, trước tiên, hàm này sẽ kiểm tra mã thông báo hợp lệ trong bộ nhớ, sau đó là tính năng cố định cục bộ (IndexedDB). Nếu không tìm thấy hoặc nếu forceRefresh là true, thì ứng dụng sẽ gửi yêu cầu đến điểm cuối Kiểm tra ứng dụng để nhận mã thông báo mới. Yêu cầu đó sẽ đính kèm với yêu cầu đang bay gần đây nhất (nếu có).
onTokenChanged(appCheckInstance, trình quan sát) Đăng ký trình nghe cho các thay đổi về 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 thực thể Kiểm tra ứng dụng. Trình nghe sẽ gọi lại trên luồng giao diện người dùng bất cứ khi nào mã thông báo hiện tại liên kết với thực thể Kiểm tra ứng dụng này thay đổi.
onTokenChanged(appCheckInstance, onNext, onError, onCompletion) Đăng ký trình nghe cho các thay đổi về 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 thực thể Kiểm tra ứng dụng. Trình nghe sẽ gọi lại trên luồng giao diện người dùng bất cứ khi nào mã thông báo hiện tại liên kết với thực thể Kiểm tra ứng dụng này thay đổi.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) Đặt xem tính năng Kiểm tra ứng dụng có tự động làm mới mã thông báo khi cần hay không.

Lớp học

Hạng Mô tả
CustomProvider (Trình cung cấp tuỳ chỉnh) Lớp trình cung cấp tuỳ chỉnh.
ReCaptchaEnterpriseProvider Nhà cung cấp dịch vụ Kiểm tra ứng dụng có thể lấy mã thông báo reCAPTCHA Enterprise và đổi lấy mã thông báo Kiểm tra ứng dụng.
ReCaptchaV3Provider Nhà cung cấp dịch vụ Kiểm tra ứng dụng có thể lấy mã thông báo reCAPTCHA V3 và đổi lấy mã thông báo Kiểm tra ứng dụng.

Giao diện

Giao diện Mô tả
Kiểm tra ứng dụng Giao diện của dịch vụ Kiểm tra ứng dụng Firebase.
AppCheckOptions Các tuỳ chọn khởi chạy tính năng Kiểm tra ứng dụng.
AppCheckToken Mã thông báo được trả về từ nhà cung cấp Kiểm tra ứng dụng.
AppCheckTokenResult Kết quả do getToken() trả về.
CustomProviderOptions Các tuỳ chọn khi tạo một CustomProvider.

Nhập bí danh

Nhập bí danh Mô tả
AppCheckTokenListener Một 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.

function(app, ...)

khởi độngAppCheck(ứng dụng, tuỳ chọn)

Kích hoạt tính năng Kiểm tra ứng dụng cho ứng dụng cụ thể. Chỉ có thể gọi điện 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ố

Thông số Loại Mô tả
ứng dụng Ứng dụng Firebase | chưa xác định FirebaseApp để kích hoạt tính năng Kiểm tra ứng dụng
tuỳ chọn AppCheckOptions Tuỳ chọn khởi chạy tính năng Kiểm tra ứng dụng

Trường hợp trả lại hàng:

Kiểm tra ứng dụng

function(appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

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

Trả về mã thông báo giới hạn dùng để dùng với các điểm cuối phụ trợ không phải của Firebase và được bảo vệ bằng tính năng Chống 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ố

Thông số Loại Mô tả
appCheckInstance Kiểm tra ứng dụng Thực thể của dịch vụ Kiểm tra ứng dụng.

Trường hợp trả lại hàng:

Hứa hẹn<AppCheckTokenResult>

Mã thông báo sử dụng có giới hạn.

getToken(appCheckInstance, forceRefresh)

Lấy mã thông báo Kiểm tra ứng dụng hiện tại. Nếu forceRefresh là false, trước tiên, hàm này sẽ kiểm tra mã thông báo hợp lệ trong bộ nhớ, sau đó là tính năng cố định cục bộ (IndexedDB). Nếu không tìm thấy hoặc nếu forceRefresh là true, thì ứng dụng sẽ gửi yêu cầu đến điểm cuối Kiểm tra ứng dụng để nhận mã thông báo mới. Yêu cầu đó sẽ đính kèm với yêu cầu đang bay gần đây nhất (nếu có).

Chữ ký:

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

Thông số

Thông số Loại Mô tả
appCheckInstance Kiểm tra ứng dụng Thực thể của dịch vụ Kiểm tra ứng dụng.
Bắt buộc làm mới boolean Nếu đúng, sẽ luôn cố gắng tìm nạp mã thông báo mới. Nếu đặt là false, sẽ sử dụng một mã thông báo đã lưu vào bộ nhớ đệm nếu tìm thấy mã này trong bộ nhớ.

Trường hợp trả lại hàng:

Hứa hẹn<AppCheckTokenResult>

onTokenChanged(appCheckInstance, trình quan sát)

Đăng ký trình nghe cho các thay đổi về 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 thực thể Kiểm tra ứng dụng. Trình nghe sẽ gọi lại trên luồng giao diện người dùng bất cứ khi nào mã thông báo hiện tại đã liên kết với thực thể 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ố

Thông số Loại Mô tả
appCheckInstance Kiểm tra ứng dụng Thực thể của dịch vụ Kiểm tra ứng dụng.
đối tượng tiếp nhận dữ liệu PartObserver<AppCheckTokenResult> Một đối tượng có các thuộc tính next, error và complete. next được gọi bằng một AppCheckTokenResult bất cứ khi nào mã thông báo thay đổi. error là không bắt buộc và được gọi nếu trình nghe gửi lỗi (hàm next). Không dùng complete vì luồng mã thông báo không kết thúc.

Trường hợp trả lại hàng:

Huỷ đăng ký

Một hàm huỷ đăng ký trình nghe này.

onTokenChanged(appCheckInstance, onNext, onError, onCompletion)

Đăng ký trình nghe cho các thay đổi về 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 thực thể Kiểm tra ứng dụng. Trình nghe sẽ gọi lại trên luồng giao diện người dùng bất cứ khi nào mã thông báo hiện tại liên kết với thực thể 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ố

Thông số Loại Mô tả
appCheckInstance Kiểm tra ứng dụng Thực thể của dịch vụ Kiểm tra ứng dụng.
onNext (tokenResult: AppCheckTokenResult) => trống Khi mã thông báo thay đổi, hàm này được gọi bằng một AppCheckTokenResult.
lỗi onError (lỗi: Lỗi) => trống Không bắt buộc. Được gọi nếu có lỗi mà trình nghe gửi (hàm onNext).
hoàn thành () => trống Hiện không được sử dụng vì luồng mã thông báo không kết thúc.

Trường hợp trả lại hàng:

Huỷ đăng ký

Một hàm huỷ đăng ký trình nghe này.

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

Đặt xem tính năng 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ố

Thông số Loại Mô tả
appCheckInstance Kiểm tra ứng dụng Thực thể của dịch vụ Kiểm tra ứng dụng.
isTokenAutoRefreshEnabled boolean Nếu đúng, SDK sẽ tự động làm mới mã thông báo của tính năng Kiểm tra ứng dụng nếu cần. Giá trị này sẽ ghi đè mọi giá trị được đặt trong initializeAppCheck().

Trường hợp trả lại hàng:

trống

Trình nghe AppCheckToken

Một 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;