firebase-functions/io.github.corneloaie.firebase.functions

Package-level declarations

Types

FirebaseFunctions lets you call Cloud Functions for Firebase.

typealias FirebaseFunctionsException = com.google.firebase.functions.FirebaseFunctionsException

Exception that gets thrown when an operation on Firebase Functions fails; its code is a FunctionsExceptionCode and its details the error details the function sent.

FunctionsExceptionCode

typealias FunctionsExceptionCode = FirebaseFunctionsException.Code

The set of error status codes that can be returned from a Callable HTTPS tigger. These are the canonical error codes for Google APIs, as documented here: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto#L26

HttpsCallableReference

class HttpsCallableReference

A reference to a particular Callable HTTPS trigger in Cloud Functions.

HttpsCallableResult

class HttpsCallableResult(val compat: HttpsCallableResult)

The result of a call through an HttpsCallableReference.

Properties

android

val FirebaseFunctions.android: FirebaseFunctions

val HttpsCallableReference.android: HttpsCallableReference

val HttpsCallableResult.android: HttpsCallableResult

The underlying Firebase Android SDK object.

code

val FirebaseFunctionsException.~~code~~: FunctionsExceptionCode

code is a member of FirebaseFunctionsException now; this extension keeps an explicit import of it compiling.

details

val FirebaseFunctionsException.~~details~~: Any?

details is a member of FirebaseFunctionsException now; this extension keeps an explicit import of it compiling.

functions

val Firebase.functions: FirebaseFunctions

Returns the FirebaseFunctions instance of the default FirebaseApp.

ios

val FirebaseFunctions.ios: FIRFunctions

val HttpsCallableReference.ios: FIRHTTPSCallable

val HttpsCallableResult.ios: FIRHTTPSCallableResult

The underlying Firebase iOS SDK object.

val FirebaseFunctions.js: Functions

val HttpsCallableResult.js: HttpsCallableResult

The underlying Firebase JS SDK object.

val HttpsCallableReference.js: HttpsCallable

The underlying Firebase JS SDK callable, created with the reference's current timeout.

val FirebaseFunctions.js: Functions

val HttpsCallableResult.js: HttpsCallableResult

The underlying Firebase JS SDK object.

val HttpsCallableReference.js: HttpsCallable

The underlying Firebase JS SDK callable, created with the reference's current timeout.

Functions

data

inline fun <T> HttpsCallableResult.data(): T

The CompatHttpsCallableResult.data deserialized as T with kotlinx.serialization.

inline fun <T> HttpsCallableResult.data(strategy: DeserializationStrategy<T>, buildSettings: DecodeSettings.Builder.() -> Unit = {}): T

The CompatHttpsCallableResult.data deserialized with strategy.

functions

fun Firebase.functions(app: FirebaseApp): FirebaseFunctions

Returns the FirebaseFunctions instance of a given FirebaseApp.

fun Firebase.functions(region: String): FirebaseFunctions

Returns the FirebaseFunctions instance of a given region.

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

Returns the FirebaseFunctions instance of a given FirebaseApp and region.

httpsCallable

fun FirebaseFunctions.~~httpsCallable~~(name: String, timeout: Long): HttpsCallableReference

invoke

suspend operator fun HttpsCallableReference.invoke(): HttpsCallableResult

Executes this callable HTTPS trigger without arguments and suspends until the result arrives; see invoke.

inline suspend operator fun <T> HttpsCallableReference.invoke(data: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}): HttpsCallableResult

Executes this callable HTTPS trigger with data, serialized with kotlinx.serialization, and suspends until the result arrives. A failed call throws a FirebaseFunctionsException. See CompatHttpsCallableReference.call.

inline suspend operator fun <T> HttpsCallableReference.invoke(strategy: SerializationStrategy<T>, data: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}): HttpsCallableResult

Executes this callable HTTPS trigger with data serialized by strategy; see invoke.