com.google.firebase.functions

Classes

FirebaseFunctions

FirebaseFunctions lets you call Cloud Functions for Firebase.

HttpsCallableOptions

Options for configuring the callable function.

HttpsCallableOptions.Builder

Builder class for 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.

Exceptions

FirebaseFunctionsException

The class for all Exceptions thrown by FirebaseFunctions.

Enums

FirebaseFunctionsException.Code

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

Extension functions summary

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

Returns the FirebaseFunctions instance of a given FirebaseApp and regionOrCustomDomain.

FirebaseFunctions

Returns the FirebaseFunctions instance of a given FirebaseApp.

FirebaseFunctions
Firebase.functions(regionOrCustomDomain: String)

Returns the FirebaseFunctions instance of a given regionOrCustomDomain.

HttpsCallableReference

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

HttpsCallableReference

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

Extension properties summary

FirebaseFunctions

Returns the FirebaseFunctions instance of the default FirebaseApp.

Extension functions

functions

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

Returns the FirebaseFunctions instance of a given FirebaseApp and regionOrCustomDomain.

functions

fun Firebase.functions(app: FirebaseApp): FirebaseFunctions

Returns the FirebaseFunctions instance of a given FirebaseApp.

functions

fun Firebase.functions(regionOrCustomDomain: String): FirebaseFunctions

Returns the FirebaseFunctions instance of a given regionOrCustomDomain.

getHttpsCallable

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.

getHttpsCallableFromUrl

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.

Extension properties

functions

val Firebase.functionsFirebaseFunctions

Returns the FirebaseFunctions instance of the default FirebaseApp.