Files
noodl-docs/library/modules/parse-cloud-function/README.md
Eric Tuvesson 656e5fc8d2 chore: Upgrade Docusaurus from v2 to v3 (#52)
* chore: Upgrade Docusaurus from v2 to v3

* chore: Update "Test build" GH workflow

* fix: build

All markdown is processed as MDX

* fix: Broken links
2024-01-12 16:53:22 +01:00

59 lines
3.4 KiB
Markdown

---
title: Parse Cloud Function
hide_title: true
---
{/*##head##*/}
# Parse Cloud Function
This node is used to make calls to [Parse Platform](https://parseplatform.org) cloud functions. To use Parse cloud functions you need to have an external Parse backend and have attached cloud functions-
<div className="ndl-image-with-background l">
![](parse-cloud-function-node.png)
</div>
You need to specify the name of the cloud function you want to call. This is done via the **Function Name** property.
<div className="ndl-image-with-background">
![](func-name.png)
</div>
You can also provide parameters that you want to be passed to the cloud function by adding them using the **Parameters** property. Once a parameter is added the corresponding input is available on the node. You provide the input values via regular Noodl connections.
<div className="ndl-image-with-background">
![](parameters.png)
</div>
The cloud function returns the result of the cloud function on the **Result** output.
{/*##head##*/}
## Inputs
| Data | Description |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Function Name</span> | {/*##input:functionName##*/}The name of the cloud function to call.{/*##input##*/} |
| <span className="ndl-data">Custom Parameters</span> | {/*##input:pm-*##*/}A parameter that will be passed to the function. Any parameters you add will become available as inputs on the node.{/*##input##*/} |
| Signal | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Call</span> | {/*##input:call##*/}Send a signal on this input to issue the request to the backend.{/*##input##*/} |
## Outputs
| Data | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Result</span> | {/*##output:result##*/}This output will contain the result that the **Cloud Function** returns upon completion. {/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This is sent if the function returns a success code and a result object.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This is sent if the function returns a failure code.{/*##output##*/} |