firebase-functions/com.google.firebase.functions/FirebaseFunctions

FirebaseFunctions

actual class FirebaseFunctions(source)

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.

Not mirrored: useFunctionsEmulator (deprecated in the Android SDK, use useEmulator).

actual class FirebaseFunctions(source)
expect class FirebaseFunctions(source)

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.

Not mirrored: useFunctionsEmulator (deprecated in the Android SDK, use useEmulator).

actual class FirebaseFunctions(source)
actual class FirebaseFunctions(source)

Types

Link copied to clipboard
actual object Companion
actual object Companion
expect object Companion
actual object Companion
actual object Companion

Properties

Link copied to clipboard
val ios: FIRFunctions

The underlying Firebase iOS SDK object.

Link copied to clipboard
val js: Functions

The underlying Firebase JS SDK object.

val js: Functions

The underlying Firebase JS SDK object.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
open operator override fun equals(other: Any?): Boolean
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
actual fun getHttpsCallable(name: String): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name.

actual fun getHttpsCallable(name: String, options: HttpsCallableOptions): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name, called with options.

actual fun getHttpsCallable(name: String): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name.

actual fun getHttpsCallable(name: String, options: HttpsCallableOptions): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name, called with options.

expect fun getHttpsCallable(name: String): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name.

expect fun getHttpsCallable(name: String, options: HttpsCallableOptions): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name, called with options.

actual fun getHttpsCallable(name: String): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name.

actual fun getHttpsCallable(name: String, options: HttpsCallableOptions): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name, called with options.

actual fun getHttpsCallable(name: String): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name.

actual fun getHttpsCallable(name: String, options: HttpsCallableOptions): HttpsCallableReference

Returns a reference to the callable HTTPS trigger with the given name, called with options.

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

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

Link copied to clipboard
actual fun getHttpsCallableFromUrl(url: URL): HttpsCallableReference

A reference to the callable HTTPS trigger at url; Android/JVM only, common code passes the URL as a String to getHttpsCallableFromUrl. java.net.URL is itself a deprecated stand-in in common code, hence the suppression.

actual fun getHttpsCallableFromUrl(url: URL, options: HttpsCallableOptions): HttpsCallableReference

A reference to the callable HTTPS trigger at url called with options; Android/JVM only, see above.

actual fun getHttpsCallableFromUrl(url: URL): HttpsCallableReference

A reference to the callable HTTPS trigger at url; Android/JVM only, common code passes the URL as a String to getHttpsCallableFromUrl. java.net.URL is itself a deprecated stand-in in common code, hence the suppression.

actual fun getHttpsCallableFromUrl(url: URL, options: HttpsCallableOptions): HttpsCallableReference

A reference to the callable HTTPS trigger at url called with options; Android/JVM only, see above.

expect fun getHttpsCallableFromUrl(url: URL): HttpsCallableReference

A reference to the callable HTTPS trigger at url; Android/JVM only, common code passes the URL as a String to getHttpsCallableFromUrl. java.net.URL is itself a deprecated stand-in in common code, hence the suppression.

expect fun getHttpsCallableFromUrl(url: URL, options: HttpsCallableOptions): HttpsCallableReference

A reference to the callable HTTPS trigger at url called with options; Android/JVM only, see above.

actual fun getHttpsCallableFromUrl(url: URL): HttpsCallableReference

A reference to the callable HTTPS trigger at url; Android/JVM only, common code passes the URL as a String to getHttpsCallableFromUrl. java.net.URL is itself a deprecated stand-in in common code, hence the suppression.

actual fun getHttpsCallableFromUrl(url: URL, options: HttpsCallableOptions): HttpsCallableReference

A reference to the callable HTTPS trigger at url called with options; Android/JVM only, see above.

actual fun getHttpsCallableFromUrl(url: URL): HttpsCallableReference

A reference to the callable HTTPS trigger at url; Android/JVM only, common code passes the URL as a String to getHttpsCallableFromUrl. java.net.URL is itself a deprecated stand-in in common code, hence the suppression.

actual fun getHttpsCallableFromUrl(url: URL, options: HttpsCallableOptions): HttpsCallableReference

A reference to the callable HTTPS trigger at url called with options; Android/JVM only, see above.

Link copied to clipboard
actual fun FirebaseFunctions.getHttpsCallableFromUrl(url: String): HttpsCallableReference

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

actual fun FirebaseFunctions.getHttpsCallableFromUrl(url: String, options: HttpsCallableOptions): HttpsCallableReference

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

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

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

actual fun FirebaseFunctions.getHttpsCallableFromUrl(url: String): HttpsCallableReference

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

actual fun FirebaseFunctions.getHttpsCallableFromUrl(url: String, options: HttpsCallableOptions): HttpsCallableReference

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

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

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

expect fun FirebaseFunctions.getHttpsCallableFromUrl(url: String): HttpsCallableReference

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

expect fun FirebaseFunctions.getHttpsCallableFromUrl(url: String, options: HttpsCallableOptions): HttpsCallableReference

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

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

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

actual fun FirebaseFunctions.getHttpsCallableFromUrl(url: String): HttpsCallableReference

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

actual fun FirebaseFunctions.getHttpsCallableFromUrl(url: String, options: HttpsCallableOptions): HttpsCallableReference

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

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

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

actual fun FirebaseFunctions.getHttpsCallableFromUrl(url: String): HttpsCallableReference

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

actual fun FirebaseFunctions.getHttpsCallableFromUrl(url: String, options: HttpsCallableOptions): HttpsCallableReference

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

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

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

Link copied to clipboard
open override fun hashCode(): Int
open override fun hashCode(): Int
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String
open override fun toString(): String
open override fun toString(): String
Link copied to clipboard
actual fun useEmulator(host: String, port: Int)

Modifies this instance to communicate with the Cloud Functions emulator at host:port. Call it before using the instance for any function call.

actual fun useEmulator(host: String, port: Int)

Modifies this instance to communicate with the Cloud Functions emulator at host:port. Call it before using the instance for any function call.

expect fun useEmulator(host: String, port: Int)

Modifies this instance to communicate with the Cloud Functions emulator at host:port. Call it before using the instance for any function call.

actual fun useEmulator(host: String, port: Int)

Modifies this instance to communicate with the Cloud Functions emulator at host:port. Call it before using the instance for any function call.

actual fun useEmulator(host: String, port: Int)

Modifies this instance to communicate with the Cloud Functions emulator at host:port. Call it before using the instance for any function call.

Generated by Dokka
firebase-multiplatform, Apache License 2.0. Based on GitLive's firebase-kotlin-sdk.