- 18 May 2022
- 3 Minutes to read
- DarkLight
- PDF
Firebase storage get download url
- Updated on 18 May 2022
- 3 Minutes to read
- DarkLight
- PDF
Generate download URLs for files stored in Firebase Storage. An array of files with a 'uploadPath' or 'path' property should be provided as the input.
If the download URL is successful, the first output is triggered and the files with download URLs are returned.
If download URL generation fails for at least one but not all of them, the second output is triggered.
If the download URL generation fails for all files, the third output is triggered.
Note: Firebase needs to be initialized before this flow function can be used. Also, if access to the Firebase Storage resource is restricted make sure user is authenticated and has the required permissions to access it.
Input arguments
Label | Key | Type | Required? | Default | Description |
---|---|---|---|---|---|
Files to get download URLs for | files | Array | Yes | Object describing the file to get the download URL for. | |
Custom path | uploadPath | String | No | – | Custom path for uploaded files - this determines the folder structure in Firestore. |
Output arguments
Number of outputs: 2
Label | Key | Type | Description |
---|---|---|---|
Uploaded files | files | Array | Object describing the file with a download URL. |
| files.path | String | Absolute local filesystem path representing the file location on the device, including the filename and extension. On web, this is created via the [`createObjectURL`](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL) method. |
| files.mimeType | String | MIME type of the file, if it could be determined. |
| files.name | String | Name of the file in the local filesystem, if applicable. Note that the filename and extension are included in the **Local path** property already. |
| files.size | Number | Size of the file, in bytes. |
| files.createdAt | String | Creation datetime of the file, if it can be determined. |
| files.modifiedAt | String | Datetime when the file was last modified, if it can be determined. |
| files.uploadPath | String | Firebase Storage path where the file is uploaded |
| files.uploadStatus | Object | Upload status for the file |
| files.downloadUrl | String | URL to download the uploaded image. Depending on the Firebase configuration the URL is valid only temporarily and should be re-fetched using the Get Firebase Storage download URL flow function for later access. |
Uploaded files | erroredFiles | Array | Object describing the file for which the download URL generation failed. |
| erroredFiles.path | String | Absolute local filesystem path representing the file location on the device, including the filename and extension. On web, this is created via the [`createObjectURL`](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL) method. |
| erroredFiles.mimeType | String | MIME type of the file, if it could be determined. |
| erroredFiles.name | String | Name of the file in the local filesystem, if applicable. Note that the filename and extension are included in the **Local path** property already. |
| erroredFiles.size | Number | Size of the file, in bytes. |
| erroredFiles.createdAt | String | Creation datetime of the file, if it can be determined. |
| erroredFiles.modifiedAt | String | Datetime when the file was last modified, if it can be determined. |
| erroredFiles.uploadPath | String | Firebase Storage path where the file is uploaded |
| erroredFiles.uploadStatus | Object | Upload status for the file |
| erroredFiles.downloadUrl | String | URL to download the uploaded image. Depending on the Firebase configuration the URL is valid only temporarily and should be re-fetched using the Get Firebase Storage download URL flow function for later access. |
Uploaded files | successfulFiles | Array | Object describing the file with a download URL. |
| successfulFiles.path | String | Absolute local filesystem path representing the file location on the device, including the filename and extension. On web, this is created via the [`createObjectURL`](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL) method. |
| successfulFiles.mimeType | String | MIME type of the file, if it could be determined. |
| successfulFiles.name | String | Name of the file in the local filesystem, if applicable. Note that the filename and extension are included in the **Local path** property already. |
| successfulFiles.size | Number | Size of the file, in bytes. |
| successfulFiles.createdAt | String | Creation datetime of the file, if it can be determined. |
| successfulFiles.modifiedAt | String | Datetime when the file was last modified, if it can be determined. |
| successfulFiles.uploadPath | String | Firebase Storage path where the file is uploaded |
| successfulFiles.uploadStatus | Object | Upload status for the file |
| successfulFiles.downloadUrl | String | URL to download the uploaded image. Depending on the Firebase configuration the URL is valid only temporarily and should be re-fetched using the Get Firebase Storage download URL flow function for later access. |
Events
No events.
Errors
Label | Code | Description |
---|---|---|
Unknown error | unknown | Thrown when trying to generate download URLs for files resulted in an unknown error. |
All files failed | allFilesFailed | Thrown if download URL generation fails for all files |
No files to download | noFilesToDownload | Thrown if there are no files to generate a download URL for |