firebase::
#include <callable_reference.h>
Represents a reference to a CloudFunctions object.
Summary
Developers can call HTTPS CallableFunctions.
Constructors and Destructors | |
|---|---|
HttpsCallableReference()Default constructor. | |
HttpsCallableReference(constHttpsCallableReference & reference)Copy constructor. | |
HttpsCallableReference(HttpsCallableReference && other)Move constructor. | |
~HttpsCallableReference() |
Public functions | |
|---|---|
Call() | Calls the function. |
Call(constVariant & data) | Calls the function. |
functions() | Gets thefirebase::functions::Functions instance to which we refer. |
is_valid() const | boolReturns true if thisHttpsCallableReference is valid, false if it is not valid. |
operator=(constHttpsCallableReference & reference) | Copy assignment operator. |
operator=(HttpsCallableReference && other) | Move assignment operator. |
Public functions
Call
Future<HttpsCallableResult>Call(constVariant&data)
Calls the function.
| Details | |||
|---|---|---|---|
| Parameters |
| ||
| Returns | The result of the call; |
HttpsCallableReference
HttpsCallableReference()
Default constructor.
This creates an invalidHttpsCallableReference. Attempting to perform any operations on this reference will fail unless a validHttpsCallableReference has been assigned to it.
HttpsCallableReference
HttpsCallableReference(constHttpsCallableReference&reference)
Copy constructor.
It's totally okay (and efficient) to copyHttpsCallableReference instances, as they simply point to the same location.
| Details | |||
|---|---|---|---|
| Parameters |
|
HttpsCallableReference
HttpsCallableReference(HttpsCallableReference&&other)
Move constructor.
Moving is an efficient operation forHttpsCallableReference instances.
| Details | |||
|---|---|---|---|
| Parameters |
|
functions
Functions*functions()
Gets thefirebase::functions::Functions instance to which we refer.
The pointer will remain valid indefinitely.
| Details | |
|---|---|
| Returns | Thefirebase::functions::Functions instance that thisHttpsCallableReference refers to. |
is_valid
boolis_valid()const
Returns true if thisHttpsCallableReference is valid, false if it is not valid.
An invalidHttpsCallableReference indicates that the reference is uninitialized (created with the default constructor) or that there was an error retrieving the reference.
| Details | |
|---|---|
| Returns | true if thisHttpsCallableReference is valid, false if thisHttpsCallableReference is invalid. |
operator=
HttpsCallableReference&operator=(constHttpsCallableReference&reference)
Copy assignment operator.
It's totally okay (and efficient) to copyHttpsCallableReference instances, as they simply point to the same location.
| Details | |||
|---|---|---|---|
| Parameters |
| ||
| Returns | Reference to the destinationHttpsCallableReference. |
operator=
HttpsCallableReference&operator=(HttpsCallableReference&&other)
Move assignment operator.
Moving is an efficient operation forHttpsCallableReference instances.
| Details | |||
|---|---|---|---|
| Parameters |
| ||
| Returns | Reference to the destinationHttpsCallableReference. |
~HttpsCallableReference
~HttpsCallableReference()
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-01-23 UTC.