mirror of
https://github.com/noodlapp/noodl-docs.git
synced 2026-01-11 23:02:54 +01:00
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
This commit is contained in:
Eric Tuvesson
GitHub
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Add Record Relation node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Add Record Relation
|
||||
|
||||
@@ -22,31 +22,31 @@ You need to provide the <span className="ndl-data">Id</span> of the owning recor
|
||||
|
||||
Finally, send a <span className="ndl-signal">signal</span> to <span className="ndl-signal">Do</span> to perform the action.
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Class</span> | The **Class** of the owning record where you want to add the related object to. |
|
||||
| <span className="ndl-data">Id</span> | <##input:id##>Specify the **Id** of the record that you want to use as the owning record to add a relation to.<##input##> This input is only valid if **Id Source** is set to **Specify explicitly**. |
|
||||
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Specify the **Id** of the record that you want to use as the owning record to add a relation to.{/*##input##*/} This input is only valid if **Id Source** is set to **Specify explicitly**. |
|
||||
| <span className="ndl-data">Relation</span> | You need to choose the **Relation** property of the owning class to use when creating the relation. |
|
||||
| <span className="ndl-data">Target Record Id</span> | <##input:target record id##>This input should be connected to the **Id** of the target record of the new relation.<##input##> |
|
||||
| <span className="ndl-data">Target Record Id</span> | {/*##input:target record id##*/}This input should be connected to the **Id** of the target record of the new relation.{/*##input##*/} |
|
||||
|
||||
@include "../_id-source.md"
|
||||
|
||||
| Signal | Description |
|
||||
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Do</span> | <##input:do##>When a signal is received on this input the relation will be created in the backend.<##input##> |
|
||||
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}When a signal is received on this input the relation will be created in the backend.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Id</span> | <##output:id##>This is the **Id** of the owning record that have / will receive the new relation. It is simply a mirror of the **Id** input.<##output##> |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>The error message in case something went wrong when attempting to add the relation in the backend.<##output##> |
|
||||
| <span className="ndl-data">Id</span> | {/*##output:id##*/}This is the **Id** of the owning record that have / will receive the new relation. It is simply a mirror of the **Id** input.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The error message in case something went wrong when attempting to add the relation in the backend.{/*##output##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent on this output when the relation has been added successfully in the backend.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when adding the relation in the backend. The error message will be outputed on the **Error** output.<##output##> |
|
||||
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent on this output when the relation has been added successfully in the backend.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when adding the relation in the backend. The error message will be outputed on the **Error** output.{/*##output##*/} |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Cloud File node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Cloud File
|
||||
|
||||
@@ -23,17 +23,17 @@ Represents a file that has been uploaded to the Noodl Cloud Services and stored
|
||||
|
||||
|
||||
</div>
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Cloud File</span> | <##input:cloud file##>A file that has been stored in the Noodl Cloud Services. Often used in combination with a **Record** to retrieve the **Name** and **URL** of a file.<##input##> |
|
||||
| <span className="ndl-data">Cloud File</span> | {/*##input:cloud file##*/}A file that has been stored in the Noodl Cloud Services. Often used in combination with a **Record** to retrieve the **Name** and **URL** of a file.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| -------------------------------------- | -------------------------------------------------- |
|
||||
| <span className="ndl-data">URL</span> | <##output:url##>The URL of the file.<##output##> |
|
||||
| <span className="ndl-data">Name</span> | <##output:name##>The Name of the file.<##output##> |
|
||||
| <span className="ndl-data">URL</span> | {/*##output:url##*/}The URL of the file.{/*##output##*/} |
|
||||
| <span className="ndl-data">Name</span> | {/*##output:name##*/}The Name of the file.{/*##output##*/} |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Cloud Function node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Cloud Function
|
||||
|
||||
@@ -38,7 +38,7 @@ If a **Failure** signal is emitted you can also use the **Error** output that wi
|
||||
|
||||
If a **Success** signal is sent the result parameters will be available as outputs on the **Cloud Function** node.
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
:::note
|
||||
|
||||
@@ -53,25 +53,25 @@ This does not happen when running Cloud Functions locally where there is no time
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-data">Function</span> | <##input:functionName##>The cloud function component that this node will call.<##input##> |
|
||||
| <span className="ndl-data">Function</span> | {/*##input:functionName##*/}The cloud function component that this node will call.{/*##input##*/} |
|
||||
|
||||
### Parameters
|
||||
The **Cloud Function** node will receive all parameters specified in the [Request](/nodes/cloud-functions/request) node in the cloud function component as inputs. When the <span className="ndl-signal">Call</span> signal is received the values on the inputs will be sent to the cloud funciton.
|
||||
|
||||
| Signal | Description |
|
||||
| ---------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Call</span> | <##input:call##>Send a signal on this input to issue the request to the cloud function.<##input##> |
|
||||
| <span className="ndl-signal">Call</span> | {/*##input:call##*/}Send a signal on this input to issue the request to the cloud function.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>If the cloud function results in an error status, this output will contain the error message. <##output##> |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}If the cloud function results in an error status, this output will contain the error message. {/*##output##*/} |
|
||||
|
||||
### Result
|
||||
The **Cloud Function** node will receive all result parameters specified in any [Response](/nodes/cloud-functions/response) node in the cloud function component that is called. When the cloud function completes and retuns a **Sucess** status, any result parameters sent back will be available on these outputs.
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Success</span> | <##output:success##>This is sent if the cloud function returns a **Success** status.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>This is sent if the cloud function returns a **Failure** status.<##output##> |
|
||||
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This is sent if the cloud function returns a **Success** status.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This is sent if the cloud function returns a **Failure** status.{/*##output##*/} |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Config node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Config
|
||||
|
||||
@@ -24,7 +24,7 @@ You pick a **Parameter** in the properties of the node. First you must specify t
|
||||
|
||||
</div>
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
When creating a parameter you can specify if it requires the **Master Key** or not. Requiring the master key means that you can only access these parameters in cloud functions, which is important for config parameters that needs to be kept secure.
|
||||
|
||||
@@ -58,20 +58,20 @@ For the node above we want a special config parameter for when running locally s
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-data">Parameter</span> | <##input:configKey##>The config parameter to use for this node.<##input##> |
|
||||
| <span className="ndl-data">Parameter</span> | {/*##input:configKey##*/}The config parameter to use for this node.{/*##input##*/} |
|
||||
|
||||
## Local Override
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-data">Enable</span> | <##input:useDevValue##>Checking this will provide a special value for this node when running in the editor or from ```localhost```<##input##> |
|
||||
| <span className="ndl-data">Value</span> | <##input:devValue##>The value to return from this node when running in the editor or on ```localhost```<##input##> |
|
||||
| <span className="ndl-data">Enable</span> | {/*##input:useDevValue##*/}Checking this will provide a special value for this node when running in the editor or from ```localhost```{/*##input##*/} |
|
||||
| <span className="ndl-data">Value</span> | {/*##input:devValue##*/}The value to return from this node when running in the editor or on ```localhost```{/*##input##*/} |
|
||||
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-data">Value</span> | <##output:value##>The value for this config parameter for the current active cloud service, or the local override. <##output##> |
|
||||
| <span className="ndl-data">Value</span> | {/*##output:value##*/}The value for this config parameter for the current active cloud service, or the local override. {/*##output##*/} |
|
||||
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Create New Record node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Create New Record
|
||||
|
||||
@@ -18,19 +18,19 @@ This node is used to create a new record of a given class. You specify the class
|
||||
|
||||
You can also provide values for the properties of the record either via connections or by typing the values in the property panel.
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Class</span> | Choose a class for the record that you want to create. |
|
||||
| <span className="ndl-data">Source Object Id</span> | <##input:source object id##>This input can be used to provide an object whose properties will be used as the initial values of the newly created record. <##input##> |
|
||||
| <span className="ndl-data">Property Inputs</span> | When the class of the record to be created is choosen, all properties of that class will be available as inputs. When the **Do** signal is received a new record will be created with the values of the properties either specified in the property panel or via connections. <##input:prop-\*##>The value of these inputs will become the properties of the newly created record.<##input##> |
|
||||
| <span className="ndl-data">Source Object Id</span> | {/*##input:source object id##*/}This input can be used to provide an object whose properties will be used as the initial values of the newly created record. {/*##input##*/} |
|
||||
| <span className="ndl-data">Property Inputs</span> | When the class of the record to be created is choosen, all properties of that class will be available as inputs. When the **Do** signal is received a new record will be created with the values of the properties either specified in the property panel or via connections. {/*##input:prop-\*##*/}The value of these inputs will become the properties of the newly created record.{/*##input##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| -------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal on this input to create a new record.<##input##> |
|
||||
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal on this input to create a new record.{/*##input##*/} |
|
||||
|
||||
@include "../_acl.md"
|
||||
|
||||
@@ -38,10 +38,10 @@ You can also provide values for the properties of the record either via connecti
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the new record that was created if the action was successful.<##output##> |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>The specific error message in case something went wrong when creating the record.<##output##> |
|
||||
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the new record that was created if the action was successful.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The specific error message in case something went wrong when creating the record.{/*##output##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent here when the new record have been created successfully.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when creating the record.<##output##> You can find the specific error in the **Error** output. |
|
||||
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent here when the new record have been created successfully.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when creating the record.{/*##output##*/} You can find the specific error in the **Error** output. |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Delete Record node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Delete Record
|
||||
|
||||
@@ -20,29 +20,29 @@ You will need to provide the **Id** of the record to be deleted, there are multi
|
||||
|
||||
Then send a signal on the **Do** input to perform the action.
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Class</span> | You need to select the **Class** of records that this node will act on. |
|
||||
| <span className="ndl-data">Id</span> | <##input:id##>Specify the **Id** of the record that you want to delete.<##input##> This input is only valid if **Id Source** is set to **Specify explicitly**. |
|
||||
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Specify the **Id** of the record that you want to delete.{/*##input##*/} This input is only valid if **Id Source** is set to **Specify explicitly**. |
|
||||
|
||||
@include "../_id-source.md"
|
||||
|
||||
| Signal | Description |
|
||||
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Do</span> | <##input:do##>When a signal is received on this input the record will be deleted on the backend.<##input##> |
|
||||
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}When a signal is received on this input the record will be deleted on the backend.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the record that will be / was deleted by this node. Simply reflecting the **Id** input.<##output##> |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>If something went wrong when deleting the record in the backend, this output will contain the error message.<##output##> |
|
||||
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the record that will be / was deleted by this node. Simply reflecting the **Id** input.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}If something went wrong when deleting the record in the backend, this output will contain the error message.{/*##output##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent on this output when the record have been successfully deleted in the backend.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when attempting to delete the record in the backend.<##output##> |
|
||||
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent on this output when the record have been successfully deleted in the backend.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when attempting to delete the record in the backend.{/*##output##*/} |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Filter Record node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Filter Record
|
||||
|
||||
@@ -23,32 +23,32 @@ You can specify both filter and sorting visually.
|
||||
|
||||
|
||||
</div>
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Enabled</span> | <##input:enabled##>If disabled the node will simply pass the input array through without change, if enabled the input array will be filtered and sorted.<##input##> |
|
||||
| <span className="ndl-data">Enabled</span> | {/*##input:enabled##*/}If disabled the node will simply pass the input array through without change, if enabled the input array will be filtered and sorted.{/*##input##*/} |
|
||||
| <span className="ndl-data">Class</span> | The **Class** of records that the input array is assumed to contain. |
|
||||
| <span className="ndl-data">Use Limit</span> | <##input:use limit##>Enabled or disable limiting of the input array to a specific number of maximum records.<##input##> |
|
||||
| <span className="ndl-data">Limit</span> | <##input:limit##>The number of maximum records to limit the output filtered array to contain.<##input##> |
|
||||
| <span className="ndl-data">Skip</span> | <##input:skip##>The number of records in the beginning of the output filtered array to skip.<##input##> |
|
||||
| <span className="ndl-data">Items</span> | <##input:items##>The input array of records that should be filtered by this node.<##input##> |
|
||||
| <span className="ndl-data">Filter Parameter Inputs</span> | <##input:fp-\*##>Each filter parameter get an input where a connection can be made to provide the value for the paramter.<##input##> |
|
||||
| <span className="ndl-data">Use Limit</span> | {/*##input:use limit##*/}Enabled or disable limiting of the input array to a specific number of maximum records.{/*##input##*/} |
|
||||
| <span className="ndl-data">Limit</span> | {/*##input:limit##*/}The number of maximum records to limit the output filtered array to contain.{/*##input##*/} |
|
||||
| <span className="ndl-data">Skip</span> | {/*##input:skip##*/}The number of records in the beginning of the output filtered array to skip.{/*##input##*/} |
|
||||
| <span className="ndl-data">Items</span> | {/*##input:items##*/}The input array of records that should be filtered by this node.{/*##input##*/} |
|
||||
| <span className="ndl-data">Filter Parameter Inputs</span> | {/*##input:fp-\*##*/}Each filter parameter get an input where a connection can be made to provide the value for the paramter.{/*##input##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Filter</span> | <##input:filter##>Send a signal on this input to perform the filtering, this will produce a new filtered array on the **Items** output. If this input does not have a connection, the input array will be filtered every time it is updated.<##input##> |
|
||||
| <span className="ndl-signal">Filter</span> | {/*##input:filter##*/}Send a signal on this input to perform the filtering, this will produce a new filtered array on the **Items** output. If this input does not have a connection, the input array will be filtered every time it is updated.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Items</span> | <##output:items##>This output will contain the filtered array of records.<##output##> |
|
||||
| <span className="ndl-data">Count</span> | <##output:count##>The number of records in the filtered output array.<##output##> |
|
||||
| <span className="ndl-data">First Record Id</span> | <##output:first record id##>The **Id** of the first record in the filtered output array.<##output##> |
|
||||
| <span className="ndl-data">Items</span> | {/*##output:items##*/}This output will contain the filtered array of records.{/*##output##*/} |
|
||||
| <span className="ndl-data">Count</span> | {/*##output:count##*/}The number of records in the filtered output array.{/*##output##*/} |
|
||||
| <span className="ndl-data">First Record Id</span> | {/*##output:first record id##*/}The **Id** of the first record in the filtered output array.{/*##output##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Filtered</span> | <##output:filtered##>A signal will be sent on this output when the input array have been successfully filtered.<##output##> |
|
||||
| <span className="ndl-signal">Filtered</span> | {/*##output:filtered##*/}A signal will be sent on this output when the input array have been successfully filtered.{/*##output##*/} |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Query Records node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Query Records
|
||||
|
||||
@@ -24,7 +24,7 @@ You can specify the query using filter, sorting and limit in the Property Panel.
|
||||
|
||||
</div>
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Filters
|
||||
|
||||
@@ -320,27 +320,27 @@ sort(["-Age", "createdAt"]);
|
||||
| --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Class</span> | Select the **Class** for the types of records this node should query. When the **Class** is selected you can create filters and sorting based on the properties of the **Class**. |
|
||||
| <span className="ndl-data">Filter</span> | This specifies the type of filter, you can choose from:<br/><br/>`Visual`: Specify your filter using the visual filter editor.<br/>`JavaScript`: Specify your filter using JavaScript (this is more flexible and you can create more dynamic queyries but it's also more complex) |
|
||||
| <span className="ndl-data">Use Limit</span> | <##input:use limit##>Enable or disable the use of limit, i.e. that you can specify how many records are returned as a maximum and if a number of record should be skipped.<##input##> |
|
||||
| <span className="ndl-data">Limit</span> | <##input:limit##>The maximum number of records to be returned by the backend.<##input##> |
|
||||
| <span className="ndl-data">Skip</span> | <##input:skip##>This property allows you to skip a number of records from being returned by the backend. Using **Skip** and **Limit** allows you to do paging, e.g. return records from 10-20.<##input##> |
|
||||
| <span className="ndl-data">Fetch Total Count</span> | <##input:storageEnableCount##>Enable this to also query for the total count of records matching the filters. Even if you limit the returned result. <##input##> |
|
||||
| <span className="ndl-data">Query Parameters</span> | <##input:qp-\*##>The input for specifying the value of a query parameter.<##input##> Each paramteter used in your query will get an input where you can provide a value through a connection.<##input##> |
|
||||
| <span className="ndl-data">Use Limit</span> | {/*##input:use limit##*/}Enable or disable the use of limit, i.e. that you can specify how many records are returned as a maximum and if a number of record should be skipped.{/*##input##*/} |
|
||||
| <span className="ndl-data">Limit</span> | {/*##input:limit##*/}The maximum number of records to be returned by the backend.{/*##input##*/} |
|
||||
| <span className="ndl-data">Skip</span> | {/*##input:skip##*/}This property allows you to skip a number of records from being returned by the backend. Using **Skip** and **Limit** allows you to do paging, e.g. return records from 10-20.{/*##input##*/} |
|
||||
| <span className="ndl-data">Fetch Total Count</span> | {/*##input:storageEnableCount##*/}Enable this to also query for the total count of records matching the filters. Even if you limit the returned result. {/*##input##*/} |
|
||||
| <span className="ndl-data">Query Parameters</span> | {/*##input:qp-\*##*/}The input for specifying the value of a query parameter.{/*##input##*/} Each paramteter used in your query will get an input where you can provide a value through a connection.{/*##input##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal here to perform the query and fetch matching records from the backend.<##input##> |
|
||||
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal here to perform the query and fetch matching records from the backend.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Items</span> | <##output:items##>The result of the query as an array of **Records**.<##output##> |
|
||||
| <span className="ndl-data">Count</span> | <##output:count##>The number of records in the result.<##output##> |
|
||||
| <span className="ndl-data">First Record Id</span> | <##output:first record id##>The Id of the first Record in the result array.<##output##> |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>This output contains the error message incase something when wrong when executing the query.<##output##> |
|
||||
| <span className="ndl-data">Total Count</span> | <##output:storageTotalCount##>If **Fetch Total Count** is enabled then this output will contain the total number of records that match the query. Even if you limit the returned result.<##output##> |
|
||||
| <span className="ndl-data">Items</span> | {/*##output:items##*/}The result of the query as an array of **Records**.{/*##output##*/} |
|
||||
| <span className="ndl-data">Count</span> | {/*##output:count##*/}The number of records in the result.{/*##output##*/} |
|
||||
| <span className="ndl-data">First Record Id</span> | {/*##output:first record id##*/}The Id of the first Record in the result array.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output contains the error message incase something when wrong when executing the query.{/*##output##*/} |
|
||||
| <span className="ndl-data">Total Count</span> | {/*##output:storageTotalCount##*/}If **Fetch Total Count** is enabled then this output will contain the total number of records that match the query. Even if you limit the returned result.{/*##output##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent here if the query was successful and the result is ready.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent here if something went wrong with the query. You can find the error message via the **Error** output.<##output##> |
|
||||
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent here if the query was successful and the result is ready.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent here if something went wrong with the query. You can find the error message via the **Error** output.{/*##output##*/} |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Record node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Record
|
||||
|
||||
@@ -19,32 +19,32 @@ This node is used to read data from a **Record**. A **Record** is an **Object**
|
||||
You have to choose the class for the **Record** node in the property panel and you must make sure that the node has the Id of the record it should access (there are multiple ways to do this, see full docs for details).
|
||||
|
||||
Then you can access the properties of the specific **Record** through the property outputs.
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Class</span> | Select the **Class** for this Records that this node will get data from. Choosing the **Class** will make the node get all properties of the class as outputs. |
|
||||
| <span className="ndl-data">Id</span> | <##input:id##>The Id of the **Record** that this node should read data from.<##input##> |
|
||||
| <span className="ndl-data">Id</span> | {/*##input:id##*/}The Id of the **Record** that this node should read data from.{/*##input##*/} |
|
||||
|
||||
@include "../_id-source.md"
|
||||
|
||||
| Signal | Description |
|
||||
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Fetch</span> | <##input:fetch##>Send a signal on this input to fetch the data for this **Record** from the backend. All **Record** nodes that share the **Id** with this node (i.e. are reading data from the same record) will be updated.<##input##> |
|
||||
| <span className="ndl-signal">Fetch</span> | {/*##input:fetch##*/}Send a signal on this input to fetch the data for this **Record** from the backend. All **Record** nodes that share the **Id** with this node (i.e. are reading data from the same record) will be updated.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Id</span> | <##output:id##>The Id of the **Record** this node is accessing the properties for.<##output##> |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>This will contain the error message if a fetch action failed and the **Failure** signal was emitted.<##output##> |
|
||||
| <span className="ndl-data">Class Properties</span> | <##output:prop-\*##>The value of this property in the record that the node reads from.<##output##> This node will have an output for each property in the **Class** that have been selected on the node. |
|
||||
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The Id of the **Record** this node is accessing the properties for.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This will contain the error message if a fetch action failed and the **Failure** signal was emitted.{/*##output##*/} |
|
||||
| <span className="ndl-data">Class Properties</span> | {/*##output:prop-\*##*/}The value of this property in the record that the node reads from.{/*##output##*/} This node will have an output for each property in the **Class** that have been selected on the node. |
|
||||
|
||||
| Signal | Description |
|
||||
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Fetched</span> | <##output:fetched##>A signal is sent on this output when a **Fetch** has been completed successfully. This is as a result of triggering a fetch by sending a signal to the **Fetch** input.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if a fetch action has failed. This is a potential result of triggering a fetch by sending a signal to the **Fetch** input.<##output##> |
|
||||
| <span className="ndl-signal">Changed</span> | <##output:changed##>A signal is sent on this output if the record that this node is reading data from has changed locally.<##output##> |
|
||||
| <span className="ndl-signal">Property Changed Signal</span> | <##output:changed-\*##>A signal is sent here if the value of the property on the record this node is reading data from has changed locally.<##output##> |
|
||||
| <span className="ndl-signal">Fetched</span> | {/*##output:fetched##*/}A signal is sent on this output when a **Fetch** has been completed successfully. This is as a result of triggering a fetch by sending a signal to the **Fetch** input.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if a fetch action has failed. This is a potential result of triggering a fetch by sending a signal to the **Fetch** input.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Changed</span> | {/*##output:changed##*/}A signal is sent on this output if the record that this node is reading data from has changed locally.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Property Changed Signal</span> | {/*##output:changed-\*##*/}A signal is sent here if the value of the property on the record this node is reading data from has changed locally.{/*##output##*/} |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Remove Record Relation node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Remove Record Relation
|
||||
|
||||
@@ -22,31 +22,31 @@ You need to provide the <span className="ndl-data">Id</span> of the owning recor
|
||||
|
||||
Finally, send a <span className="ndl-signal">signal</span> to <span className="ndl-signal">Do</span> to perform the action.
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Class</span> | The **Class** of the owning record where you want to remove the relation from. |
|
||||
| <span className="ndl-data">Id</span> | <##input:id##>Specify the **Id** of the record that you want to use as the owning record to remove an existing relation from.<##input##> This input is only valid if **Id Source** is set to **Specify explicitly**. |
|
||||
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Specify the **Id** of the record that you want to use as the owning record to remove an existing relation from.{/*##input##*/} This input is only valid if **Id Source** is set to **Specify explicitly**. |
|
||||
| <span className="ndl-data">Relation</span> | You need to choose the **Relation** property of the owning class to use when removing the relation. |
|
||||
| <span className="ndl-data">Target Record Id</span> | <##input:target record id##>This input should be connected to the **Id** of the target record that have an existing relation to the owning record via the **Relation** property that should be removed.<##input##> |
|
||||
| <span className="ndl-data">Target Record Id</span> | {/*##input:target record id##*/}This input should be connected to the **Id** of the target record that have an existing relation to the owning record via the **Relation** property that should be removed.{/*##input##*/} |
|
||||
|
||||
@include "../_id-source.md"
|
||||
|
||||
| Signal | Description |
|
||||
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Do</span> | <##input:do##>When a signal is received on this input the relation will be removed in the backend, if it exists.<##input##> |
|
||||
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}When a signal is received on this input the relation will be removed in the backend, if it exists.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Id</span> | <##output:id##>This is the **Id** of the owning record. It is simply a mirror of the **Id** input.<##output##> |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>The error message in case something went wrong when attempting to remove the relation in the backend.<##output##> |
|
||||
| <span className="ndl-data">Id</span> | {/*##output:id##*/}This is the **Id** of the owning record. It is simply a mirror of the **Id** input.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The error message in case something went wrong when attempting to remove the relation in the backend.{/*##output##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent on this output when the relation has been removed successfully in the backend.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when removing the relation in the backend. The error message will be outputed on the **Error** output.<##output##> |
|
||||
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent on this output when the relation has been removed successfully in the backend.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when removing the relation in the backend. The error message will be outputed on the **Error** output.{/*##output##*/} |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Set Record Properties node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Set Record Properties
|
||||
|
||||
@@ -19,23 +19,23 @@ This action node will set property values of a record.
|
||||
You need specify the class of the record in the property panel. Then you can either specify the values of the properties to set in the property panel or by providing them as an input connection.
|
||||
|
||||
Send a <span className="ndl-signal">signal</span> to <span className="ndl-signal">Do</span> to perform the action.
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Class</span> | The class of record for this node. Choosing the class will determine which property inputs that become available on the node. |
|
||||
| <span className="ndl-data">Store to</span> | <##input:store to##>Specifies if this node should store both to the cloud and locally, or only locally.<##input##> |
|
||||
| <span className="ndl-data">Properties to store</span> | <##input:properties to store##>Specifies if only the explicitly specified properties should be save, **only specified**, this means that only the properties that have a value either in the property panel or via an input connection will be written to the cloud record. If **All** is selected that means that all properties will always be written, if there is no explicit value provided on this node the value of the object with the corresponding **Id** will be used.<##input##> |
|
||||
| <span className="ndl-data">Id</span> | <##input:id##>Specify the **Id** of the record that you want to set the properties on.<##input##> This input is only valid if **Id Source** is set to **Specify explicitly**. |
|
||||
| <span className="ndl-data">Property Inputs</span> | <##input:prop-\*##>The value to set this property to when the action is triggered.<##input##> For each property in the specified class there will be an input of the correct type. You can provide the values for the inputs either through connections or by specifying them in the property panel. |
|
||||
| <span className="ndl-data">Store to</span> | {/*##input:store to##*/}Specifies if this node should store both to the cloud and locally, or only locally.{/*##input##*/} |
|
||||
| <span className="ndl-data">Properties to store</span> | {/*##input:properties to store##*/}Specifies if only the explicitly specified properties should be save, **only specified**, this means that only the properties that have a value either in the property panel or via an input connection will be written to the cloud record. If **All** is selected that means that all properties will always be written, if there is no explicit value provided on this node the value of the object with the corresponding **Id** will be used.{/*##input##*/} |
|
||||
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Specify the **Id** of the record that you want to set the properties on.{/*##input##*/} This input is only valid if **Id Source** is set to **Specify explicitly**. |
|
||||
| <span className="ndl-data">Property Inputs</span> | {/*##input:prop-\*##*/}The value to set this property to when the action is triggered.{/*##input##*/} For each property in the specified class there will be an input of the correct type. You can provide the values for the inputs either through connections or by specifying them in the property panel. |
|
||||
|
||||
@include "../_id-source.md"
|
||||
|
||||
| Signal | Description |
|
||||
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Do</span> | <##input:do##>When a signal is received on this input the properties will be set on the record.<##input##> |
|
||||
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}When a signal is received on this input the properties will be set on the record.{/*##input##*/} |
|
||||
|
||||
@include "../_acl.md"
|
||||
|
||||
@@ -43,10 +43,10 @@ Send a <span className="ndl-signal">signal</span> to <span className="ndl-signal
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the record where the properties will be updated by this node.<##output##> |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>The specific error message in case something went wrong when updating the record.<##output##> |
|
||||
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the record where the properties will be updated by this node.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The specific error message in case something went wrong when updating the record.{/*##output##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent here when the record have been updated successfully.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when updating the record.<##output##> You can find the specific error in the **Error** output. |
|
||||
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent here when the record have been updated successfully.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when updating the record.{/*##output##*/} You can find the specific error in the **Error** output. |
|
||||
|
||||
@@ -4,7 +4,7 @@ hide_table_of_contents: true
|
||||
title: Upload File node
|
||||
---
|
||||
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
# Upload File
|
||||
|
||||
@@ -15,31 +15,31 @@ This node uploads a file to the Noodl Cloud Services. Can be used in combination
|
||||
|
||||
|
||||
</div>
|
||||
<##head##>
|
||||
{/*##head##*/}
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">File</span> | <##input:file##>An HTML5 [File](https://developer.mozilla.org/en-US/docs/Web/API/File). The [File Picker](/nodes/utilities/open-file-picker) can be used to open a file dialog picker and generate the **File** from a local file. It's also possible to retrieve the File from external sources, or generate it by code. <##input##> |
|
||||
| <span className="ndl-data">File</span> | {/*##input:file##*/}An HTML5 [File](https://developer.mozilla.org/en-US/docs/Web/API/File). The [File Picker](/nodes/utilities/open-file-picker) can be used to open a file dialog picker and generate the **File** from a local file. It's also possible to retrieve the File from external sources, or generate it by code. {/*##input##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ------------------------------------------ | ---------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Upload</span> | <##input:upload##>Triggers the upload to start.<##input##> |
|
||||
| <span className="ndl-signal">Upload</span> | {/*##input:upload##*/}Triggers the upload to start.{/*##input##*/} |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Cloud File</span> | <##output:cloudFile##>A [Cloud File](/nodes/data/cloud-data/cloud-file), which consists of an URL and a file name. Can be connected to a property of a [Record](/nodes/data/cloud-data/record) if the property type is specified as 'File'.<##output##> |
|
||||
| <span className="ndl-data">Total Bytes</span> | <##output:progressTotalBytes##>The total size of the file in bytes that is being uploaded.<##output##> |
|
||||
| <span className="ndl-data">Uploaded Bytes</span> | <##output:progressLoadedBytes##>Contains the number of bytes have been uploaded so far. Starts at 0, and moves towards **Total Bytes** after the **Upload** input signal has been triggered. The value is updated each time the **Progress Changed** event is sent.<##output##> |
|
||||
| <span className="ndl-data">Uploaded Percent</span> | <##output:progressLoadedPercent##>The current percentage of the file that have been uploaded. Starts at 0, and moves towards 100 after the **Upload** input signal has been triggered. The value is updated each time the **Progress Changed** event is sent.<##output##> |
|
||||
| <span className="ndl-data">Error</span> | <##output:error##>The error message as a string, if the upload fails.<##output##> |
|
||||
| <span className="ndl-data">Error Status Code</span> | <##output:errorStatus##>An [HTTP error code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). For example, `413` if the file is too large.<##output##> |
|
||||
| <span className="ndl-data">Cloud File</span> | {/*##output:cloudFile##*/}A [Cloud File](/nodes/data/cloud-data/cloud-file), which consists of an URL and a file name. Can be connected to a property of a [Record](/nodes/data/cloud-data/record) if the property type is specified as 'File'.{/*##output##*/} |
|
||||
| <span className="ndl-data">Total Bytes</span> | {/*##output:progressTotalBytes##*/}The total size of the file in bytes that is being uploaded.{/*##output##*/} |
|
||||
| <span className="ndl-data">Uploaded Bytes</span> | {/*##output:progressLoadedBytes##*/}Contains the number of bytes have been uploaded so far. Starts at 0, and moves towards **Total Bytes** after the **Upload** input signal has been triggered. The value is updated each time the **Progress Changed** event is sent.{/*##output##*/} |
|
||||
| <span className="ndl-data">Uploaded Percent</span> | {/*##output:progressLoadedPercent##*/}The current percentage of the file that have been uploaded. Starts at 0, and moves towards 100 after the **Upload** input signal has been triggered. The value is updated each time the **Progress Changed** event is sent.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The error message as a string, if the upload fails.{/*##output##*/} |
|
||||
| <span className="ndl-data">Error Status Code</span> | {/*##output:errorStatus##*/}An [HTTP error code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). For example, `413` if the file is too large.{/*##output##*/} |
|
||||
|
||||
| Signal | Description |
|
||||
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-signal">Progress Changed</span> | <##output:progressChanged##>This event is used to track the upload progress. It is triggered multiple times during an upload when **Uploaded Bytes** and **Uploaded Percent** are updated.<##output##> |
|
||||
| <span className="ndl-signal">Success</span> | <##output:success##>This event triggers when the file was uploaded successfully.<##output##> |
|
||||
| <span className="ndl-signal">Failure</span> | <##output:failure##>This event triggers if there was en error uploading the file.<##output##> |
|
||||
| <span className="ndl-signal">Progress Changed</span> | {/*##output:progressChanged##*/}This event is used to track the upload progress. It is triggered multiple times during an upload when **Uploaded Bytes** and **Uploaded Percent** are updated.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event triggers when the file was uploaded successfully.{/*##output##*/} |
|
||||
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event triggers if there was en error uploading the file.{/*##output##*/} |
|
||||
|
||||
Reference in New Issue
Block a user