# ListFiles Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: {% tabs %} {% tab title="Parameter: Input" %} | Name | Description | | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- | | Directory : `String` |

Path to file(s).


Default: /
Example: / , /SubDir

| | | FileMask : `String` |

FileMask.

The file mask uses regular expressions and for convenience it handles \* and ? like wildcards (regex .\* and .+).

Parameter can begin with . For example: ^(?!prof).\_test.txt is same as ^(?!prof).\_test.txt).

Use \* or leave empty to list all files.


Default: -
Example: test.txt, test\*.txt, test?.txt, test.(txt | xml), test.\[^t]\[^x]\[^t], ^(?!prof).\*\_test.txt

| | IncludeType : `IncludeType` |

Types to include in the directory listing.

Possible values:

Types to include in the directory listing.

Types to include in the directory listing.

Types to include in the directory listing.


Default: 0
Example: IncludeType.File

| | | IncludeSubdirectories : `Boolean` |

Include subdirectories?


Default: -
Example: true

| | | {% endtab %} | | | {% tab title="Parameter: Connection" %} | Name | Description | | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Address : `String` |

FTP(S) host address


Default: -
Example: my.ftp.server.com

| | Port : `Int32` |

Port number to use in the connection to the server.


Default: 21
Example: 21

| | UserName : `String` |

Username to use for authentication to the server. Note that the file endpoint only supports

username for remote shares and the username must be in the format DOMAIN\Username.


Default: -
Example: myUsername

| | 🗝Password : `String` |

Password to use in the authentication to the server.


Default: -
Example: myPassword

| | Mode : `FtpMode` |

Connection mode to use to connect to the FTP server

Possible values:

Connection mode to use to connect to the FTP server

Connection mode to use to connect to the FTP server


Default: 0
Example: FtpMode.Passive

| | KeepConnectionAliveInterval : `Int32` |

Sends NOOP command to keep connection alive at specified time-interval in seconds. If set to 0 the connection is not kept alive. Default value is 0


Default: 0
Example: 60

| | ConnectionTimeout : `Int32` |

The length of time, in seconds, until the connection times out. You can use value 0 to indicate that the connection does not time out. Default value is 60 seconds


Default: 60
Example: 60

| | UseFTPS : `Boolean` |

Whether to use FTPS or not.


Default: false
Example: false

| | SecureDataChannel : `Boolean` |

Whether the data channel is secured or not.


Default: true
Example: false

| | SslMode : `FtpsSslMode` |

Specifies whether to use Explicit or Implicit SSL.

Possible values:

Specifies whether to use Explicit or Implicit SSL.

Specifies whether to use Explicit or Implicit SSL.

Specifies whether to use Explicit or Implicit SSL.

Specifies whether to use Explicit or Implicit SSL.


Default: 0
Example: FtpsSslMode.None

| | EnableClientAuth : `Boolean` |

If enabled the client certificate is searched from user's certificate store.


Default: false
Example: false

| | ClientCertificateName : `String` |

Optional. Enables certification search by name from the certification store of current user.


Default: -
Example: mycert.crt

| | ClientCertificateThumbprint : `String` |

Optional. Enables certification search by thumbprint from the certification store of current user.


Default: -
Example: a909502dd82ae41433e6f83886b00d4277a32a7b

| | ValidateAnyCertificate : `Boolean` |

If enabled the any certificate will be considered valid.


Default: false
Example: false

| | ClientCertificatePath : `String` |

Path to client certificate (X509).


Default: -
Example: c:\example.cer

| | CertificateHashStringSHA1 : `String` |

Certificate SHA1 hash string to validate against.


Default: -
Example: BA7816BF8F01CFEA414140DE5DAE2223B00361A3

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Files : `List` |

List of files.
Example: \[ { "test.txt", "/ListFiles/test.txt", "2022-05-20T13:21:42Z", 1048576 }, { "test2.txt", "/ListFiles/test2.txt", "2022-05-20T13:21:42Z", 1048576 } ]

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[2.1.0] - 2024-08-23 #### Changed * Updated the Newtonsoft.Json package to version 13.0.3. ### \[2.0.0] - 2022-12-20 #### Fixed * Fixed documentation * Fixed Tests and change the Tests to use docker container. * Fixed error handling to throw specific errors from the library and not custom. #### Added * Created Connection class for connection parameters. * Added FTPS options. * Added FtpMode and FtpsSslMode * Added feature which enables the Task to get files, directories or both. * Added feature which enables the Task to get files from subdirectories. * Added possibility to use certificates. #### Changed * Changed return object to a List of FileItems. * Renamed most of the parameters. * Changed the target framework to .net6. * Changed the Task to async method. ### \[1.0.0] - 2022-05-18 #### Added * Initial implementation {% endtab %} {% endtabs %}