com.google.firebase.functions
bookmark_border Stay organized with collections Save and categorize content based on your preferences.

Classes

`FirebaseFunctions`	FirebaseFunctions lets you call Cloud Functions for Firebase.
`HttpsCallableOptions`	Options for configuring the callable function.
`HttpsCallableOptions.Builder`	A builder for creating `com.google.firebase.functions.HttpsCallableOptions`.
`HttpsCallableReference`	A reference to a particular Callable HTTPS trigger in Cloud Functions.
`HttpsCallableResult`	The result of calling a `HttpsCallableReference` function.
`StreamResponse`	Represents a response from a Server-Sent Event (SSE) stream.
`StreamResponse.Message`	An event message received during the stream.
`StreamResponse.Result`	The final result of the computation, marking the end of the stream.

FirebaseFunctionsException

The class for all Exceptions thrown by FirebaseFunctions.

FirebaseFunctionsException.Code

The set of error status codes that can be returned from a Callable HTTPS tigger.

`FirebaseFunctions`	`Firebase.functions(app: FirebaseApp, regionOrCustomDomain: String)` Returns the `FirebaseFunctions` instance of a given `FirebaseApp` and `regionOrCustomDomain`.
`FirebaseFunctions`	`Firebase.functions(app: FirebaseApp)` Returns the `FirebaseFunctions` instance of a given `FirebaseApp`.
`FirebaseFunctions`	`Firebase.functions(regionOrCustomDomain: String)` Returns the `FirebaseFunctions` instance of a given `regionOrCustomDomain`.
`HttpsCallableReference`	`FirebaseFunctions.getHttpsCallable(name: String, init: HttpsCallableOptions.Builder.() -> Unit)` Returns a reference to the Callable HTTPS trigger with the given name and call options.
`HttpsCallableReference`	`FirebaseFunctions.getHttpsCallableFromUrl(url: URL, init: HttpsCallableOptions.Builder.() -> Unit)` Returns a reference to the Callable HTTPS trigger with the given URL and call options.

FirebaseFunctions

Firebase.functions

Returns the FirebaseFunctions instance of the default FirebaseApp.

fun Firebase.functions(app: FirebaseApp, regionOrCustomDomain: String): FirebaseFunctions

fun Firebase.functions(app: FirebaseApp): FirebaseFunctions

Returns the FirebaseFunctions instance of a given FirebaseApp.

fun Firebase.functions(regionOrCustomDomain: String): FirebaseFunctions

Returns the FirebaseFunctions instance of a given regionOrCustomDomain.

fun FirebaseFunctions.getHttpsCallable(name: String, init: HttpsCallableOptions.Builder.() -> Unit): HttpsCallableReference

Returns a reference to the Callable HTTPS trigger with the given name and call options.

fun FirebaseFunctions.getHttpsCallableFromUrl(url: URL, init: HttpsCallableOptions.Builder.() -> Unit): HttpsCallableReference

Returns a reference to the Callable HTTPS trigger with the given URL and call options.

val Firebase.functions: FirebaseFunctions

Returns the FirebaseFunctions instance of the default FirebaseApp.