firebase-admin.app-check package
Stay organized with collections
Save and categorize content based on your preferences.
Firebase App Check.
Functions
Function |
Description |
getAppCheck(app) |
Gets the AppCheck service for the default app or a given app.getAppCheck() can be called with no arguments to access the default app's AppCheck service or as getAppCheck(app) to access the AppCheck service associated with a specific app. |
Classes
Class |
Description |
AppCheck |
The Firebase AppCheck service interface. |
Interfaces
getAppCheck(app)
Gets the AppCheck service for the default app or a given app.
getAppCheck()
can be called with no arguments to access the default app's AppCheck
service or as getAppCheck(app)
to access the AppCheck
service associated with a specific app.
Signature:
export declare function getAppCheck(app?: App): AppCheck;
Parameters
Parameter |
Type |
Description |
app |
App |
Optional app for which to return the AppCheck service. If not provided, the default AppCheck service is returned. |
Returns:
AppCheck
The default AppCheck
service if no app is provided, or the AppCheck
service associated with the provided app.
Example 1
// Get the `AppCheck` service for the default app
const defaultAppCheck = getAppCheck();
Example 2
// Get the `AppCheck` service for a given app
const otherAppCheck = getAppCheck(otherApp);
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-16 UTC.
[null,null,["Last updated 2024-04-16 UTC."],[],[],null,["# firebase-admin.app-check package\n\nFirebase App Check.\n\nFunctions\n---------\n\n| Function | Description |\n|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getAppCheck(app)](./firebase-admin.app-check.md#getappcheck_8a40afc) | Gets the [AppCheck](./firebase-admin.app-check.appcheck.md#appcheck_class) service for the default app or a given app.`getAppCheck()` can be called with no arguments to access the default app's `AppCheck` service or as `getAppCheck(app)` to access the `AppCheck` service associated with a specific app. |\n\nClasses\n-------\n\n| Class | Description |\n|-------------------------------------------------------------------|--------------------------------------------|\n| [AppCheck](./firebase-admin.app-check.appcheck.md#appcheck_class) | The Firebase `AppCheck` service interface. |\n\nInterfaces\n----------\n\n| Interface | Description |\n|--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [AppCheckToken](./firebase-admin.app-check.appchecktoken.md#appchecktoken_interface) | Interface representing an App Check token. |\n| [AppCheckTokenOptions](./firebase-admin.app-check.appchecktokenoptions.md#appchecktokenoptions_interface) | Interface representing App Check token options. |\n| [DecodedAppCheckToken](./firebase-admin.app-check.decodedappchecktoken.md#decodedappchecktoken_interface) | Interface representing a decoded Firebase App Check token, returned from the [AppCheck.verifyToken()](./firebase-admin.app-check.appcheck.md#appcheckverifytoken) method. |\n| [VerifyAppCheckTokenOptions](./firebase-admin.app-check.verifyappchecktokenoptions.md#verifyappchecktokenoptions_interface) | Interface representing options for the [AppCheck.verifyToken()](./firebase-admin.app-check.appcheck.md#appcheckverifytoken) method. |\n| [VerifyAppCheckTokenResponse](./firebase-admin.app-check.verifyappchecktokenresponse.md#verifyappchecktokenresponse_interface) | Interface representing a verified App Check token response. |\n\ngetAppCheck(app)\n----------------\n\nGets the [AppCheck](./firebase-admin.app-check.appcheck.md#appcheck_class) service for the default app or a given app.\n\n`getAppCheck()` can be called with no arguments to access the default app's `AppCheck` service or as `getAppCheck(app)` to access the `AppCheck` service associated with a specific app.\n\n**Signature:** \n\n export declare function getAppCheck(app?: App): AppCheck;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|------|-----------------------------------------------------------------------------------------------------------------------|\n| app | App | Optional app for which to return the `AppCheck` service. If not provided, the default `AppCheck` service is returned. |\n\n**Returns:**\n\n[AppCheck](./firebase-admin.app-check.appcheck.md#appcheck_class)\n\nThe default `AppCheck` service if no app is provided, or the `AppCheck` service associated with the provided app.\n\n### Example 1\n\n // Get the `AppCheck` service for the default app\n const defaultAppCheck = getAppCheck();\n\n### Example 2\n\n // Get the `AppCheck` service for a given app\n const otherAppCheck = getAppCheck(otherApp);"]]