firebase::
#include <callable_reference.h>
Represents a reference to a Cloud Functions object.
Summary
Developers can call HTTPS Callable Functions.
Constructors and Destructors |
|
|---|---|
HttpsCallableReference()
Default constructor.
|
|
HttpsCallableReference(const HttpsCallableReference & reference)
Copy constructor.
|
|
HttpsCallableReference(HttpsCallableReference && other)
Move constructor.
|
|
~HttpsCallableReference()
|
Public functions |
|
|---|---|
Call()
|
Calls the function.
|
Call(const Variant & data)
|
Calls the function.
|
functions()
|
Gets the firebase::functions::Functions instance to which we refer.
|
is_valid() const
|
bool
Returns true if this HttpsCallableReference is valid, false if it is not valid.
|
operator=(const HttpsCallableReference & reference)
|
Copy assignment operator.
|
operator=(HttpsCallableReference && other)
|
Move assignment operator.
|
Public functions
Call
Future< HttpsCallableResult > Call()
Calls the function.
| Details | |
|---|---|
| Returns |
The result of the call;
|
Call
Future< HttpsCallableResult > Call( const Variant & data )
Calls the function.
| Details | |||
|---|---|---|---|
| Parameters |
|
||
| Returns |
The result of the call;
|
HttpsCallableReference
HttpsCallableReference()
Default constructor.
This creates an invalid HttpsCallableReference. Attempting to perform any operations on this reference will fail unless a valid HttpsCallableReference has been assigned to it.
HttpsCallableReference
HttpsCallableReference( const HttpsCallableReference & reference )
Copy constructor.
It's totally okay (and efficient) to copy HttpsCallableReference instances, as they simply point to the same location.
| Details | |||
|---|---|---|---|
| Parameters |
|
HttpsCallableReference
HttpsCallableReference( HttpsCallableReference && other )
Move constructor.
Moving is an efficient operation for HttpsCallableReference instances.
| Details | |||
|---|---|---|---|
| Parameters |
|
functions
Functions * functions()
Gets the firebase::functions::Functions instance to which we refer.
The pointer will remain valid indefinitely.
| Details | |
|---|---|
| Returns |
The firebase::functions::Functions instance that this HttpsCallableReference refers to.
|
is_valid
bool is_valid() const
Returns true if this HttpsCallableReference is valid, false if it is not valid.
An invalid HttpsCallableReference indicates that the reference is uninitialized (created with the default constructor) or that there was an error retrieving the reference.
| Details | |
|---|---|
| Returns |
true if this HttpsCallableReference is valid, false if this HttpsCallableReference is invalid.
|
operator=
HttpsCallableReference & operator=( const HttpsCallableReference & reference )
Copy assignment operator.
It's totally okay (and efficient) to copy HttpsCallableReference instances, as they simply point to the same location.
| Details | |||
|---|---|---|---|
| Parameters |
|
||
| Returns |
Reference to the destination HttpsCallableReference.
|
operator=
HttpsCallableReference & operator=( HttpsCallableReference && other )
Move assignment operator.
Moving is an efficient operation for HttpsCallableReference instances.
| Details | |||
|---|---|---|---|
| Parameters |
|
||
| Returns |
Reference to the destination HttpsCallableReference.
|
~HttpsCallableReference
~HttpsCallableReference()