HttpsCallableReference

public final class HttpsCallableReference

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

Summary

Public fields
`final long`	`timeout`

Public methods
`final @NonNull Task<@NonNull HttpsCallableResult>`	`call()` Executes this HTTPS endpoint asynchronously without arguments.
`final @NonNull Task<@NonNull HttpsCallableResult>`	`call(Object data)` Executes this Callable HTTPS trigger asynchronously.
`final void`	`setTimeout(long timeout, @NonNull TimeUnit units)` Changes the timeout for calls from this instance of Functions.
`final @NonNull HttpsCallableReference`	`withTimeout(long timeout, @NonNull TimeUnit units)` Creates a new reference with the given timeout for calls.

Public fields

timeout

public final long timeout

Public methods

call

public final @NonNull Task<@NonNull HttpsCallableResult> call()

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
`@NonNull Task<@NonNull HttpsCallableResult>`	A Task that will be completed when the HTTPS request has completed.

call

public final @NonNull Task<@NonNull HttpsCallableResult> call(Object data)

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.

Parameters
`Object data`	Parameters to pass to the trigger.

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

See also
`JSONArray`
`JSONObject`
`IOException`
`FirebaseFunctionsException`

setTimeout

public final void setTimeout(long timeout, @NonNull TimeUnit units)

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

Parameters
`long timeout`	The length of the timeout, in the given units.
`@NonNull TimeUnit units`	The units for the specified timeout.

withTimeout

public final @NonNull HttpsCallableReference withTimeout(long timeout, @NonNull TimeUnit units)

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

Parameters
`long timeout`	The length of the timeout, in the given units.
`@NonNull TimeUnit units`	The units for the specified timeout.