https.CallableContext interface
Stay organized with collections
Save and categorize content based on your preferences.
The interface for metadata for the API as passed to the handler.
Signature:
export interface CallableContext
Properties
| Property |
Type |
Description |
| app |
AppCheckData |
The result of decoding and verifying a Firebase AppCheck token. |
| auth |
AuthData |
The result of decoding and verifying a Firebase Auth ID token. |
| instanceIdToken |
string |
An unverified token for a Firebase Instance ID. |
| rawRequest |
Request |
The raw request handled by the callable. |
https.CallableContext.app
The result of decoding and verifying a Firebase AppCheck token.
Signature:
app?: AppCheckData;
https.CallableContext.auth
The result of decoding and verifying a Firebase Auth ID token.
Signature:
auth?: AuthData;
https.CallableContext.instanceIdToken
An unverified token for a Firebase Instance ID.
Signature:
instanceIdToken?: string;
The raw request handled by the callable.
Signature:
rawRequest: Request;
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 2022-09-13 UTC.
[null,null,["Last updated 2022-09-13 UTC."],[],[],null,["# https.CallableContext interface\n\nThe interface for metadata for the API as passed to the handler.\n\n**Signature:** \n\n export interface CallableContext \n\nProperties\n----------\n\n| Property | Type | Description |\n|------------------------------------------------------------------------------------------------------|--------------|-----------------------------------------------------------------|\n| [app](./firebase-functions.https.callablecontext.md#httpscallablecontextapp) | AppCheckData | The result of decoding and verifying a Firebase AppCheck token. |\n| [auth](./firebase-functions.https.callablecontext.md#httpscallablecontextauth) | AuthData | The result of decoding and verifying a Firebase Auth ID token. |\n| [instanceIdToken](./firebase-functions.https.callablecontext.md#httpscallablecontextinstanceidtoken) | string | An unverified token for a Firebase Instance ID. |\n| [rawRequest](./firebase-functions.https.callablecontext.md#httpscallablecontextrawrequest) | Request | The raw request handled by the callable. |\n\nhttps.CallableContext.app\n-------------------------\n\nThe result of decoding and verifying a Firebase AppCheck token.\n\n**Signature:** \n\n app?: AppCheckData;\n\nhttps.CallableContext.auth\n--------------------------\n\nThe result of decoding and verifying a Firebase Auth ID token.\n\n**Signature:** \n\n auth?: AuthData;\n\nhttps.CallableContext.instanceIdToken\n-------------------------------------\n\nAn unverified token for a Firebase Instance ID.\n\n**Signature:** \n\n instanceIdToken?: string;\n\nhttps.CallableContext.rawRequest\n--------------------------------\n\nThe raw request handled by the callable.\n\n**Signature:** \n\n rawRequest: Request;"]]
