https.CallableRequest interface
Stay organized with collections
Save and categorize content based on your preferences.
The request used to call a callable function.
Signature:
export interface CallableRequest<T = any>
Properties
Property |
Type |
Description |
acceptsStreaming |
boolean |
Whether this is a streaming request. Code can be optimized by not trying to generate a stream of chunks to call response.sendChunk if request.acceptsStreaming is false. It is always safe, however, to call response.sendChunk as this will noop if acceptsStreaming is false. |
app |
AppCheckData |
The result of decoding and verifying a Firebase App Check token. |
auth |
AuthData |
The result of decoding and verifying a Firebase Auth ID token. |
data |
T |
The parameters used by a client when calling this function. |
instanceIdToken |
string |
An unverified token for a Firebase Instance ID. |
rawRequest |
Request |
The raw request handled by the callable. |
https.CallableRequest.acceptsStreaming
Whether this is a streaming request. Code can be optimized by not trying to generate a stream of chunks to call response.sendChunk
if request.acceptsStreaming
is false. It is always safe, however, to call response.sendChunk
as this will noop if acceptsStreaming
is false.
Signature:
acceptsStreaming: boolean;
https.CallableRequest.app
The result of decoding and verifying a Firebase App Check token.
Signature:
app?: AppCheckData;
https.CallableRequest.auth
The result of decoding and verifying a Firebase Auth ID token.
Signature:
auth?: AuthData;
https.CallableRequest.data
The parameters used by a client when calling this function.
Signature:
data: T;
https.CallableRequest.instanceIdToken
An unverified token for a Firebase Instance ID.
Signature:
instanceIdToken?: string;
https.CallableRequest.rawRequest
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 2025-01-23 UTC.
[null,null,["Last updated 2025-01-23 UTC."],[],[],null,["# https.CallableRequest interface\n\nThe request used to call a callable function.\n\n**Signature:** \n\n export interface CallableRequest\u003cT = any\u003e \n\nProperties\n----------\n\n| Property | Type | Description |\n|--------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [acceptsStreaming](./firebase-functions.https.callablerequest.md#httpscallablerequestacceptsstreaming) | boolean | Whether this is a streaming request. Code can be optimized by not trying to generate a stream of chunks to call `response.sendChunk` if `request.acceptsStreaming` is false. It is always safe, however, to call `response.sendChunk` as this will noop if `acceptsStreaming` is false. |\n| [app](./firebase-functions.https.callablerequest.md#httpscallablerequestapp) | AppCheckData | The result of decoding and verifying a Firebase App Check token. |\n| [auth](./firebase-functions.https.callablerequest.md#httpscallablerequestauth) | AuthData | The result of decoding and verifying a Firebase Auth ID token. |\n| [data](./firebase-functions.https.callablerequest.md#httpscallablerequestdata) | T | The parameters used by a client when calling this function. |\n| [instanceIdToken](./firebase-functions.https.callablerequest.md#httpscallablerequestinstanceidtoken) | string | An unverified token for a Firebase Instance ID. |\n| [rawRequest](./firebase-functions.https.callablerequest.md#httpscallablerequestrawrequest) | [Request](./firebase-functions.https.request.md#httpsrequest_interface) | The raw request handled by the callable. |\n\nhttps.CallableRequest.acceptsStreaming\n--------------------------------------\n\nWhether this is a streaming request. Code can be optimized by not trying to generate a stream of chunks to call `response.sendChunk` if `request.acceptsStreaming` is false. It is always safe, however, to call `response.sendChunk` as this will noop if `acceptsStreaming` is false.\n\n**Signature:** \n\n acceptsStreaming: boolean;\n\nhttps.CallableRequest.app\n-------------------------\n\nThe result of decoding and verifying a Firebase App Check token.\n\n**Signature:** \n\n app?: AppCheckData;\n\nhttps.CallableRequest.auth\n--------------------------\n\nThe result of decoding and verifying a Firebase Auth ID token.\n\n**Signature:** \n\n auth?: AuthData;\n\nhttps.CallableRequest.data\n--------------------------\n\nThe parameters used by a client when calling this function.\n\n**Signature:** \n\n data: T;\n\nhttps.CallableRequest.instanceIdToken\n-------------------------------------\n\nAn unverified token for a Firebase Instance ID.\n\n**Signature:** \n\n instanceIdToken?: string;\n\nhttps.CallableRequest.rawRequest\n--------------------------------\n\nThe raw request handled by the callable.\n\n**Signature:** \n\n rawRequest: Request;"]]