deleteLocalImage

Deletes a locally saved image with the specified name from the app's image folder on the device.

note

If no image is found with the provided name, nothing happens.

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
"name" (required)	String	The name of the image that is to be deleted.	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: Delete a locally saved image

Show ExampleHide Example

Delete the locally saved image with the specified name.

{
  "type": "deleteLocalImage",
  "params": {
    "name": "{{imageId}}"
  }
}