HttpsCallableReference

class HttpsCallableReference

---

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

Summary

Public functions
Task<HttpsCallableResult>	call() Executes this HTTPS endpoint asynchronously without arguments.
Task<HttpsCallableResult>	call(data: Any?) Executes this Callable HTTPS trigger asynchronously.
Unit	setTimeout(timeout: Long, units: TimeUnit) Changes the timeout for calls from this instance of Functions.
HttpsCallableReference	withTimeout(timeout: Long, units: TimeUnit) Creates a new reference with the given timeout for calls.

Public properties
Long	timeout

Public functions

call

fun call(): Task<HttpsCallableResult>

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.

Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see com.google.firebase.iid.FirebaseInstanceId.deleteInstanceId. It will resume with a new Instance ID the next time you call this method.

Returns
Task<HttpsCallableResult>	A Task that will be completed when the HTTPS request has completed.

call

fun call(data: Any?): Task<HttpsCallableResult>

Executes this Callable HTTPS trigger asynchronously.

The data passed into the trigger can be any of the following types:

• Any primitive type, including null, int, long, float, and boolean.

• String

• List<?>, where the contained objects are also one of these types.

• Map<String, ?>>, where the values are also one of these types.

• org.json.JSONArray

• org.json.JSONObject

• org.json.JSONObject.NULL

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

• java.io.IOException

• if the HTTPS request failed to connect.

• FirebaseFunctionsException

• if the request connected, but the function returned an error.

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.

Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see com.google.firebase.iid.FirebaseInstanceId.deleteInstanceId. It will resume with a new Instance ID the next time you call this method.

Parameters
data: Any?	Parameters to pass to the trigger.

Returns
Task<HttpsCallableResult>	A Task that will be completed when the HTTPS request has completed.

See also
JSONArray
JSONObject
IOException
FirebaseFunctionsException

setTimeout

fun setTimeout(timeout: Long, units: TimeUnit): Unit

Changes the timeout for calls from this instance of Functions. The default is 60 seconds.

Parameters
timeout: Long	The length of the timeout, in the given units.
units: TimeUnit	The units for the specified timeout.

withTimeout

fun withTimeout(timeout: Long, units: TimeUnit): HttpsCallableReference

Creates a new reference with the given timeout for calls. The default is 60 seconds.

Parameters
timeout: Long	The length of the timeout, in the given units.
units: TimeUnit	The units for the specified timeout.

Public properties

timeout

val timeout: Long