HttpsCallableReference

public class HttpsCallableReference


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

Summary

Public methods

@NonNull Task<HttpsCallableResult>

Executes this HTTPS endpoint asynchronously without arguments.

@NonNull Task<HttpsCallableResult>

Executes this Callable HTTPS trigger asynchronously.

long

Returns the timeout for calls from this instance of Functions.

void
setTimeout(long timeout, @NonNull TimeUnit units)

Changes the timeout for calls from this instance of Functions.

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

Creates a new reference with the given timeout for calls.

Public methods

call

public @NonNull Task<HttpsCallableResultcall()

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 deleteInstanceId. It will resume with a new Instance ID the next time you call this method.

Returns
@NonNull Task<HttpsCallableResult>

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

call

public @NonNull Task<HttpsCallableResultcall(@Nullable Object data)

Executes this Callable HTTPS trigger asynchronously.

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

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.

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

Parameters
@Nullable Object data

Parameters to pass to the trigger.

Returns
@NonNull Task<HttpsCallableResult>

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

getTimeout

public long getTimeout()

Returns the timeout for calls from this instance of Functions.

Returns
long

The timeout, in milliseconds.

setTimeout

public 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 @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.