mirror of
https://github.com/noodlapp/noodl-docs.git
synced 2026-01-12 07:12:53 +01:00
656e5fc8d2
* chore: Upgrade Docusaurus from v2 to v3 * chore: Update "Test build" GH workflow * fix: build All markdown is processed as MDX * fix: Broken links
46 lines
5.9 KiB
Markdown
46 lines
5.9 KiB
Markdown
---
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
title: Upload File node
|
|
---
|
|
|
|
{/*##head##*/}
|
|
|
|
# Upload File
|
|
|
|
This node uploads a file to the Noodl Cloud Services. Can be used in combination with a **Record** to link the file to a property. When retrieving the file reference you can get the **URL** to the file and **Name** of file using a [Cloud File](/nodes/data/cloud-data/cloud-file) node.
|
|
|
|
<div className="ndl-image-with-background l">
|
|
|
|
|
|
|
|
</div>
|
|
{/*##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##*/} |
|
|
|
|
| Signal | Description |
|
|
| ------------------------------------------ | ---------------------------------------------------------- |
|
|
| <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##*/} |
|
|
|
|
| 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##*/} |
|