FTP

Non-Visible component
Category Requires Version
Connectivity API 19, Android 4.4 - 4.4.4 KitKat 2

Overview

A non-visible component that allows for uploading and downloading of files via File Transfer Protocol.

Permissions

Events

Connect Error

This event returns the reason if a try to connect was not successful.

Params
error Text

Connection Status

This event returns the status of the connection. If it is connect it will return true, else false.

Params
is Connected Boolean

Disconnect Error

This event returns the reason if a try to disconnect was not successful.

Params
error Text

Download Done

This event is invoked when the download is finished.

Download error

This event returns the reason if a download was not successful.

Params
error Text

Upload Done

This event is invoked when the upload is finished.

Upload error

This event returns the reason if a upload was not successful.

Params
error Text

Methods

Connect

Start the connection to the ftp server.

Delete Dir

Delete a directory on the ftp server.

Params
dir Text

Disconnect

Disconnect the current connection.

Download File

Start downloading a file.

Params
remote Filepath Text
destination Text

Get List Of Files

Returns: List

Get a list of files in a directory. Returns a empty list if a error occurs.

Params
dir Text

make Dir

Make/create a directory on the ftp server.

Params
dir Text

Upload File

Start uploading a file.

Params
file Path Text
new Name Text

Properties

FTP-Server (Host)

Text Default: ftp.example.org ➖ Read Write - Designer Blocks

Set the ftp server url.

Password

Text ➖ Read Write - Designer Blocks

Set the password to login into the ftp server.

Port

Number Default: 21 ➖ Read Write - Designer Blocks

Set the ftp port number.

Username

Text Default: Your Username ➖ Read Write - Designer Blocks

Set the username to login into the ftp server.

Working Directory

Text Default: / ➖ Read Write - Designer Blocks

Set the ftp working dir.


Last update: January 27, 2020