HttpsCallableStreamOptions interface
Stay organized with collections
Save and categorize content based on your preferences.
An interface for metadata about how a stream call should be executed.
Signature:
export interface HttpsCallableStreamOptions
Properties
| Property |
Type |
Description |
| limitedUseAppCheckTokens |
boolean |
If set to true, uses a limited-use App Check token for callable function requests from this instance of Functions. You must use limited-use tokens to call functions with replay protection enabled. By default, this is false. |
| signal |
AbortSignal |
An AbortSignal that can be used to cancel the streaming response. When the signal is aborted, the underlying HTTP connection will be terminated. |
HttpsCallableStreamOptions.limitedUseAppCheckTokens
If set to true, uses a limited-use App Check token for callable function requests from this instance of Functions. You must use limited-use tokens to call functions with replay protection enabled. By default, this is false.
Signature:
limitedUseAppCheckTokens?: boolean;
HttpsCallableStreamOptions.signal
An AbortSignal that can be used to cancel the streaming response. When the signal is aborted, the underlying HTTP connection will be terminated.
Signature:
signal?: AbortSignal;
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-12-13 UTC.
[null,null,["Last updated 2024-12-13 UTC."],[],[],null,["An interface for metadata about how a stream call should be executed.\n\n**Signature:** \n\n export interface HttpsCallableStreamOptions \n\nProperties\n\nHttpsCallableStreamOptions.limitedUseAppCheckTokens\n\nIf set to true, uses a limited-use App Check token for callable function requests from this instance of [Functions](./functions.functions.md#functions_interface). You must use limited-use tokens to call functions with replay protection enabled. By default, this is false.\n\n**Signature:** \n\n limitedUseAppCheckTokens?: boolean;\n\nHttpsCallableStreamOptions.signal\n\nAn `AbortSignal` that can be used to cancel the streaming response. When the signal is aborted, the underlying HTTP connection will be terminated.\n\n**Signature:** \n\n signal?: AbortSignal;"]]
