saveImageLocally

Saves an image to the local storage of the app.

note

This action is intended to work with a picker layer that has its allowMultipleSelection property set to false only. Using this action with a picker layer that has the allowMultipleSelection property set to true is unsupported!

Field Configurations

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

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"form" (required)	String	Name of the form to use.	null
"formDataKey" (required)	String	Form data key in which the image was saved.	null
"imageName"	String	Name under which the image should be saved.	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: Save image locally

Goal: Saving an image after you picked it with the picker layer.

To achieve this the following code can be used:

{
  "type": "saveImageLocally",
  "params": {
    "form": "imageUpload",
    "formDataKey": "imagePicker",
    "imageName": "image"
  }
}

The example will save the image into the namedForm imageUpload:imagePicker with the name image.

Result:

A saveImageLocally action has been created.