Files Element

Prev Next

The Files element allows the user to upload an array of files from their device. View more information about Form Element Types.

Important Notes

  • At the moment, there is no anti-virus scanning occurring when a file is submitted by a user using the File Element. We are currently researching potential solutions to prevent users from uploading malicious files when completing a form.

  • When building a form, you have the functionality to Restrict File Types. This will allow you to determine the types of files available for submission (such as allowing PDF, PNG, JPG, while not entering EXE, which will restrict files of this type from being uploaded).

Properties

Property

Required

Type

Default

Description

type

Yes

string

'files'

The type of Form Element

name

Yes

string

N/A

The key that will be assigned a value in the submission data when the form is submitted

label

Yes

string

N/A

Display text presented to the user above the input by default

hint

No

string

N/A

A hint triggered by an icon tooltip to be displayed when hovering beside the element label

minEntries

No

string

N/A

Minimum number of files required

storageType

No

string

N/A

How the files uploaded by a user will be stored: private, public, legacy

defaultValue

No

Array

N/A

An array of attachments, see Example Submission Data below for structure which is based on the storageType property

The Files element also inherits the properties of the following:

Example Element

{"id": "b1311ae0-6bb7-11e9-a923-1681be663d3e","type": "files","name": "supportingDocuments","label": "Please Upload your Supporting Documentation","storageType": "private","minEntries": 1,"maxEntries": 2}

Example Submission Data

Private/Public Storage

{"submission": {"[element.name]": [{"s3": {"region": "ap-southeast-2","bucket": "customer.forms.oneblink.io","key": "submissions/1/attachments/44cdee6f-edbd-4620-aaf5-df25ce976e43"},"url": "https://auth-api.blinkm.io/submissions/1/attachments/44cdee6f-edbd-4620-aaf5-df25ce976e43","contentType": "image/png","fileName": "dot.png","id": "44cdee6f-edbd-4620-aaf5-df25ce976e43","isPrivate": true}]}}

Legacy Storage (Deprecated)

{"submission": {"[element.name]": [{"fileName": "dot.png","data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAMAAAADCAYAAABWKLW/AAAAIElEQVQYV2NkYGBoYGBgqGdgYGhkZGBg+M8ABSAOXAYATFcEA8STCz8AAAAASUVORK5CYII="}]}}

Supporting Articles