firebase-functions/dev.gitlive.firebase.functions/HttpsCallableReference/invoke

invoke

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

Executes this Callable HTTPS trigger asynchronously.

If the returned task fails, the Exception will be one of the following types:

The request to the Cloud Functions backend made by this method automatically includes a Firebase Instance ID token to identify the app instance. If a user is logged in with Firebase Auth, an auth token for the user will also be automatically included.

Return

A Task that will be completed when the HTTPS request has completed.

Parameters

data

Parameters to pass to the trigger.

See also

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

suspend operator fun invoke(): HttpsCallableResult(source)

Executes this HTTPS endpoint asynchronously without arguments.

The request to the Cloud Functions backend made by this method automatically includes a Firebase Instance ID token to identify the app instance. If a user is logged in with Firebase Auth, an auth token for the user will also be automatically included.

Return

A HttpsCallableResult that will contain the result.

inline suspend operator fun <T> invoke(data: T, encodeDefaults: Boolean): HttpsCallableResult(source)

Deprecated

Deprecated. Use builder instead

Replace with

invoke(data) { this.encodeDefaults = encodeDefaults }
Content copied to clipboard
suspend operator fun <T> invoke(strategy: SerializationStrategy<T>, data: T, encodeDefaults: Boolean): HttpsCallableResult(source)

Deprecated

Deprecated. Use builder instead

Replace with

invoke(strategy, data) { this.encodeDefaults = encodeDefaults }
Content copied to clipboard