HttpsCallableStreamOptions interface

An interface for metadata about how a stream call should be executed.

Signature:

exportinterfaceHttpsCallableStreamOptions

Properties

PropertyTypeDescription
limitedUseAppCheckTokensbooleanIf set to true, uses a limited-use App Check token for callable function requests from this instance ofFunctions. You must use limited-use tokens to call functions with replay protection enabled. By default, this is false.
signalAbortSignalAnAbortSignal 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 ofFunctions. You must use limited-use tokens to call functions with replay protection enabled. By default, this is false.

Signature:

limitedUseAppCheckTokens?:boolean;

HttpsCallableStreamOptions.signal

AnAbortSignal 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 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-12-13 UTC.