firebase-admin.app-check package
Firebase App Check.
Functions
| Function | Description |
|---|---|
| getAppCheck(app) | Gets theAppCheck service for the default app or a given app.getAppCheck() can be called with no arguments to access the default app'sAppCheck service or asgetAppCheck(app) to access theAppCheck service associated with a specific app. |
Classes
| Class | Description |
|---|---|
| AppCheck | The FirebaseAppCheck service interface. |
Interfaces
| Interface | Description |
|---|---|
| AppCheckToken | Interface representing an App Check token. |
| AppCheckTokenOptions | Interface representing App Check token options. |
| DecodedAppCheckToken | Interface representing a decoded Firebase App Check token, returned from theAppCheck.verifyToken() method. |
| VerifyAppCheckTokenOptions | Interface representing options for theAppCheck.verifyToken() method. |
| VerifyAppCheckTokenResponse | Interface representing a verified App Check token response. |
getAppCheck(app)
Gets theAppCheck service for the default app or a given app.
getAppCheck() can be called with no arguments to access the default app'sAppCheck service or asgetAppCheck(app) to access theAppCheck service associated with a specific app.
Signature:
exportdeclarefunctiongetAppCheck(app?:App):AppCheck;Parameters
| Parameter | Type | Description |
|---|---|---|
| app | App | Optional app for which to return theAppCheck service. If not provided, the defaultAppCheck service is returned. |
Returns:
The defaultAppCheck service if no app is provided, or theAppCheck service associated with the provided app.
Example 1
// Get the `AppCheck` service for the default appconstdefaultAppCheck=getAppCheck();Example 2
// Get the `AppCheck` service for a given appconstotherAppCheck=getAppCheck(otherApp);Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-16 UTC.