# remove

## Description

Removes an existing file in the cache directory of the mobile phone.

## Input / Parameter

| Name     | Description                                                                                      | Input Type | Default | Options | Required |
| -------- | ------------------------------------------------------------------------------------------------ | ---------- | ------- | ------- | -------- |
| fileName | The name of the file to be removed.                                                              | Text       | -       | -       | Yes      |
| folder   | The folder path of the file. If this input is provided, it will be appended to the storage path. | Text       | -       | -       | No       |
| extra    | The stored value that is passed to all the callbacks.                                            | Any        | -       | -       | No       |

## Output

| Description                        | Output Type |
| ---------------------------------- | ----------- |
| Returns the formatted information. | Object      |

### Object

| Key     | Description                                                             | Output Type |
| ------- | ----------------------------------------------------------------------- | ----------- |
| success | Boolean value to denote whether the function was executed successfully. | Text        |
| message | The message to print.                                                   | Text        |
| data    | Any additional message or data to print.                                | Text        |

## Callback

### callback

The action performed if this function runs successfully.

| Description                                           | Output Type |
| ----------------------------------------------------- | ----------- |
| Returns an object that contains the file information. | Object      |

### errorCallback

The action performed if this function does not run successfully.

| Description               | Output Type |
| ------------------------- | ----------- |
| Returns an error message. | Text        |

## Example

In this example, we will remove a file from the device.

```js
Note: This example will only work after the user has created a file using `File.write` function. 
```

### Steps

1. Drag a button component to a page in the mobile designer.

   ![](https://399701567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwmJ1RKjM2uNFaL6fO3Xu%2Fuploads%2Fgit-blob-840c58ada244abe5882e191193581afd170f480b%2Fremove-step-1.png?alt=media)
2. Select the event `press` and drag the `File.remove` function to the event flow and fill in the parameter.

   ![](https://399701567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwmJ1RKjM2uNFaL6fO3Xu%2Fuploads%2Fgit-blob-8384e8cecca8675b81f5f020ae53e2c630b92aac%2Fremove-step-2.png?alt=media)

### Result

1. Open the installed app on a device and try to press the button.
2. The selected file should be deleted.

   ![](https://399701567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwmJ1RKjM2uNFaL6fO3Xu%2Fuploads%2Fgit-blob-c2f51dba7088e1877e84973e774a58e9b9d69e73%2Fremove-result-1.png?alt=media)