downloadFile

Downloads a file to the device's local storage. To skip the completion, async has to be used.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"additionalHeaders"	AdditionalHeaders	Additional HTTP headers which will be appended to the request.	null
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"extensionFromRequest"	String,Boolean	Indicates whether or not the file extension should be inferred from the mime type of downloaded file.	false
"field"	String	The name of the field.	null
"fileExtension"	String	The type of the file to be downloaded.	null
"name"	String	Optional name to use as the file name for the downloaded file.	null
"progressBarBackground"	Color	The background color of the progress bar when a file is loaded.	null
"progressBarColor"	Color	The color of the progress bar when a file is loaded.	null
"query"	String	The name of the query.	null
"queryParams"	Array	The list of the appended query parameters.	null
"table"	String	The name of the database table.	null
"url"	String	The URL of the file to be downloaded.	null
"urls"	Array	The list of file URL's to be downloaded.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Download a PDF file

Show ExampleHide Example

Download a PDF file from the specified url.

{
  "type": "downloadFile",
  "params": {
    "url": "https://example.mobilitysuite.com/pdf",
    "field": "file",
    "fileExtension": "pdf"
  }
}