Package-level declarations

Types

Link copied to clipboard
actual class FirebaseFunctions

The entry point for Cloud Functions for Firebase, mirroring com.google.firebase.functions.FirebaseFunctions from the Firebase Android SDK: creates references to callable HTTPS functions.

actual class FirebaseFunctions
expect class FirebaseFunctions

The entry point for Cloud Functions for Firebase, mirroring com.google.firebase.functions.FirebaseFunctions from the Firebase Android SDK: creates references to callable HTTPS functions.

actual class FirebaseFunctions
actual class FirebaseFunctions
Link copied to clipboard

The exception a call through an HttpsCallableReference fails with, mirroring com.google.firebase.functions.FirebaseFunctionsException from the Firebase Android SDK. Plain common code: on Android and the JVM it is a header stub for the SDK's own class.

Link copied to clipboard

Options for calling a callable HTTPS trigger, mirroring com.google.firebase.functions.HttpsCallableOptions from the Firebase Android SDK; created with a Builder. Plain common code: on Android and the JVM it is a header stub for the SDK's own class.

Link copied to clipboard

A reference to a callable HTTPS trigger in Cloud Functions, mirroring com.google.firebase.functions.HttpsCallableReference from the Firebase Android SDK. Obtained from FirebaseFunctions.getHttpsCallable or getHttpsCallableFromUrl.

A reference to a callable HTTPS trigger in Cloud Functions, mirroring com.google.firebase.functions.HttpsCallableReference from the Firebase Android SDK. Obtained from FirebaseFunctions.getHttpsCallable or getHttpsCallableFromUrl.

The JS SDK fixes a callable's options, including its timeout, when the callable is created, so the reference keeps what it needs to create one and js is created on demand with the current timeout.

The JS SDK fixes a callable's options, including its timeout, when the callable is created, so the reference keeps what it needs to create one and js is created on demand with the current timeout.

Link copied to clipboard
actual class HttpsCallableResult

The result of a call through an HttpsCallableReference, mirroring com.google.firebase.functions.HttpsCallableResult from the Firebase Android SDK.

actual class HttpsCallableResult
expect class HttpsCallableResult

The result of a call through an HttpsCallableReference, mirroring com.google.firebase.functions.HttpsCallableResult from the Firebase Android SDK.

actual class HttpsCallableResult
actual class HttpsCallableResult
Link copied to clipboard
abstract class StreamResponse

An element of a streamed call's response, as the Android SDK's com.google.firebase.functions.StreamResponse: a Message for every chunk the function sends while it runs, then one Result with its return value. Plain common code: on Android and the JVM it is a header stub for the SDK's own class. Common code receives them from streamAsFlow.

Properties

Link copied to clipboard

The FirebaseFunctions instance of the default FirebaseApp; the Android SDK's Firebase.functions.

Functions

Link copied to clipboard

A reference to the callable HTTPS trigger name, with the HttpsCallableOptions built by init.

Link copied to clipboard

A reference to the callable HTTPS trigger at url, e.g. https://us-central1-project.cloudfunctions.net/function.

A reference to the callable HTTPS trigger at url, called with options.

A reference to the callable HTTPS trigger at url, with the HttpsCallableOptions built by init.

A reference to the callable HTTPS trigger at url, e.g. https://us-central1-project.cloudfunctions.net/function.

A reference to the callable HTTPS trigger at url, called with options.

A reference to the callable HTTPS trigger at url, with the HttpsCallableOptions built by init.

A reference to the callable HTTPS trigger at url, e.g. https://us-central1-project.cloudfunctions.net/function.

A reference to the callable HTTPS trigger at url, called with options.

A reference to the callable HTTPS trigger at url, with the HttpsCallableOptions built by init.

A reference to the callable HTTPS trigger at url, e.g. https://us-central1-project.cloudfunctions.net/function.

A reference to the callable HTTPS trigger at url, called with options.

A reference to the callable HTTPS trigger at url, with the HttpsCallableOptions built by init.

A reference to the callable HTTPS trigger at url, e.g. https://us-central1-project.cloudfunctions.net/function.

A reference to the callable HTTPS trigger at url, called with options.

A reference to the callable HTTPS trigger at url, with the HttpsCallableOptions built by init.

Link copied to clipboard

Sets the timeout of the calls made through this reference.

Sets the timeout of the calls made through this reference.

Sets the timeout of the calls made through this reference.

Sets the timeout of the calls made through this reference.

Sets the timeout of the calls made through this reference.

Link copied to clipboard

Calls the function with data and streams its response: a StreamResponse.Message for every chunk the function sends while it runs, then a StreamResponse.Result with its return value, after which the flow completes. A failed call fails the flow with a FirebaseFunctionsException.

Fails: the iOS SDK's streaming API (Callable.stream) is Swift-only, which Kotlin/Native cannot call.

expect fun HttpsCallableReference.streamAsFlow(data: Any? = null): Flow<StreamResponse>

Calls the function with data and streams its response: a StreamResponse.Message for every chunk the function sends while it runs, then a StreamResponse.Result with its return value, after which the flow completes. A failed call fails the flow with a FirebaseFunctionsException.

Over the JS SDK's callable.stream(data): its async iterable of chunks, then its data promise.

Over the JS SDK's callable.stream(data): its async iterable of chunks, then its data promise.

Link copied to clipboard

A copy of this reference whose calls use the given timeout.

A copy of this reference whose calls use the given timeout.

A copy of this reference whose calls use the given timeout.

A copy of this reference whose calls use the given timeout.

A copy of this reference whose calls use the given timeout.