Interface IAsyncFtpClient

Namespace

FluentFTP

Assembly

FluentFTP.dll

Interface for the AsyncFtpClient class. For detailed documentation of the methods, please see the FtpClient class or check the Wiki on the FluentFTP Github project.

public interface IAsyncFtpClient : IDisposable, IAsyncDisposable, IBaseFtpClient

Inherited Members

IBaseFtpClient.Config

IBaseFtpClient.Logger

IBaseFtpClient.IsDisposed

IBaseFtpClient.IsConnected

IBaseFtpClient.Host

IBaseFtpClient.Port

IBaseFtpClient.Credentials

IBaseFtpClient.Capabilities

IBaseFtpClient.HashAlgorithms

IBaseFtpClient.SystemType

IBaseFtpClient.ServerType

IBaseFtpClient.ServerHandler

IBaseFtpClient.ServerOS

IBaseFtpClient.ConnectionType

IBaseFtpClient.LastReply

IBaseFtpClient.LastReplies

IBaseFtpClient.Encoding

IBaseFtpClient.LegacyLogger

IBaseFtpClient.Status

IBaseFtpClient.InternetProtocol

IBaseFtpClient.IsAuthenticated

IBaseFtpClient.SslProtocolActive

IBaseFtpClient.IsEncrypted

IBaseFtpClient.ValidateCertificateHandlerExists

IBaseFtpClient.RecursiveList

IBaseFtpClient.SocketLocalEndPoint

IBaseFtpClient.SocketRemoteEndPoint

IBaseFtpClient.ValidateCertificate

Extension Methods

ValuePrinter.ObjectToString(object)

Methods

AutoConnect(CancellationToken)

Task<FtpProfile> AutoConnect(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Task<FtpProfile>

AutoDetect(FtpAutoDetectConfig, CancellationToken)

Task<List<FtpProfile>> AutoDetect(FtpAutoDetectConfig config, CancellationToken token = default)

Parameters

config FtpAutoDetectConfig

token CancellationToken

Returns

Task<List<FtpProfile>>

AutoDetect(bool, bool, CancellationToken)

Task<List<FtpProfile>> AutoDetect(bool firstOnly, bool cloneConnection = true, CancellationToken token = default)

Parameters

firstOnly bool

cloneConnection bool

token CancellationToken

Returns

Task<List<FtpProfile>>

Chmod(string, FtpPermission, FtpPermission, FtpPermission, CancellationToken)

Task Chmod(string path, FtpPermission owner, FtpPermission group, FtpPermission other, CancellationToken token = default)

Parameters

path string

owner FtpPermission

group FtpPermission

other FtpPermission

token CancellationToken

Returns

Task

Chmod(string, int, CancellationToken)

Task Chmod(string path, int permissions, CancellationToken token = default)

Parameters

path string

permissions int

token CancellationToken

Returns

Task

CompareFile(string, string, FtpCompareOption, CancellationToken)

Task<FtpCompareResult> CompareFile(string localPath, string remotePath, FtpCompareOption options = FtpCompareOption.Auto, CancellationToken token = default)

Parameters

localPath string

remotePath string

options FtpCompareOption

token CancellationToken

Returns

Task<FtpCompareResult>

Connect(FtpProfile, CancellationToken)

Task Connect(FtpProfile profile, CancellationToken token = default)

Parameters

profile FtpProfile

token CancellationToken

Returns

Task

Connect(bool, CancellationToken)

Task Connect(bool reConnect, CancellationToken token = default)

Parameters

reConnect bool

token CancellationToken

Returns

Task

Connect(CancellationToken)

Task Connect(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Task

CreateDirectory(string, bool, CancellationToken)

Task<bool> CreateDirectory(string path, bool force, CancellationToken token = default)

Parameters

path string

force bool

token CancellationToken

Returns

Task<bool>

CreateDirectory(string, CancellationToken)

Task<bool> CreateDirectory(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task<bool>

DeleteDirectory(string, FtpListOption, CancellationToken)

Task DeleteDirectory(string path, FtpListOption options, CancellationToken token = default)

Parameters

path string

options FtpListOption

token CancellationToken

Returns

Task

DeleteDirectory(string, CancellationToken)

Task DeleteDirectory(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task

DeleteFile(string, CancellationToken)

Task DeleteFile(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task

DirectoryExists(string, CancellationToken)

Task<bool> DirectoryExists(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task<bool>

DisableUTF8(CancellationToken)

Task DisableUTF8(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Task

Disconnect(CancellationToken)

Task Disconnect(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Task

Dispose()

void Dispose()

DisposeAsync()

ValueTask DisposeAsync()

Returns

ValueTask

DownloadBytes(string, long, IProgress<FtpProgress>, CancellationToken, long)

Task<byte[]> DownloadBytes(string remotePath, long restartPosition = 0, IProgress<FtpProgress> progress = null, CancellationToken token = default, long stopPosition = 0)

Parameters

remotePath string

restartPosition long

progress IProgress<FtpProgress>

token CancellationToken

stopPosition long

Returns

Task<byte[]>

DownloadBytes(string, CancellationToken)

Task<byte[]> DownloadBytes(string remotePath, CancellationToken token = default)

Parameters

remotePath string

token CancellationToken

Returns

Task<byte[]>

DownloadDirectory(string, string, FtpFolderSyncMode, FtpLocalExists, FtpVerify, List<FtpRule>, IProgress<FtpProgress>, CancellationToken)

Task<List<FtpResult>> DownloadDirectory(string localFolder, string remoteFolder, FtpFolderSyncMode mode = FtpFolderSyncMode.Update, FtpLocalExists existsMode = FtpLocalExists.Skip, FtpVerify verifyOptions = FtpVerify.None, List<FtpRule> rules = null, IProgress<FtpProgress> progress = null, CancellationToken token = default)

Parameters

localFolder string

remoteFolder string

mode FtpFolderSyncMode

existsMode FtpLocalExists

verifyOptions FtpVerify

rules List<FtpRule>

progress IProgress<FtpProgress>

token CancellationToken

Returns

Task<List<FtpResult>>

DownloadFile(string, string, FtpLocalExists, FtpVerify, IProgress<FtpProgress>, CancellationToken)

Task<FtpStatus> DownloadFile(string localPath, string remotePath, FtpLocalExists existsMode = FtpLocalExists.Overwrite, FtpVerify verifyOptions = FtpVerify.None, IProgress<FtpProgress> progress = null, CancellationToken token = default)

Parameters

localPath string

remotePath string

existsMode FtpLocalExists

verifyOptions FtpVerify

progress IProgress<FtpProgress>

token CancellationToken

Returns

Task<FtpStatus>

DownloadFiles(string, IEnumerable<string>, FtpLocalExists, FtpVerify, FtpError, CancellationToken, IProgress<FtpProgress>, List<FtpRule>)

Task<List<FtpResult>> DownloadFiles(string localDir, IEnumerable<string> remotePaths, FtpLocalExists existsMode = FtpLocalExists.Overwrite, FtpVerify verifyOptions = FtpVerify.None, FtpError errorHandling = FtpError.None, CancellationToken token = default, IProgress<FtpProgress> progress = null, List<FtpRule> rules = null)

Parameters

localDir string

remotePaths IEnumerable<string>

existsMode FtpLocalExists

verifyOptions FtpVerify

errorHandling FtpError

token CancellationToken

progress IProgress<FtpProgress>

rules List<FtpRule>

Returns

Task<List<FtpResult>>

DownloadStream(Stream, string, long, IProgress<FtpProgress>, CancellationToken, long)

Task<bool> DownloadStream(Stream outStream, string remotePath, long restartPosition = 0, IProgress<FtpProgress> progress = null, CancellationToken token = default, long stopPosition = 0)

Parameters

outStream Stream

remotePath string

restartPosition long

progress IProgress<FtpProgress>

token CancellationToken

stopPosition long

Returns

Task<bool>

DownloadUriBytes(string, IProgress<FtpProgress>, CancellationToken)

Task<byte[]> DownloadUriBytes(string uri, IProgress<FtpProgress> progress = null, CancellationToken token = default)

Parameters

uri string

progress IProgress<FtpProgress>

token CancellationToken

Returns

Task<byte[]>

EmptyDirectory(string, FtpListOption, CancellationToken)

Task EmptyDirectory(string path, FtpListOption options, CancellationToken token = default)

Parameters

path string

options FtpListOption

token CancellationToken

Returns

Task

EmptyDirectory(string, CancellationToken)

Task EmptyDirectory(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task

Execute(string, CancellationToken)

Task<FtpReply> Execute(string command, CancellationToken token = default)

Parameters

command string

token CancellationToken

Returns

Task<FtpReply>

ExecuteDownloadText(string, CancellationToken)

Task<List<string>> ExecuteDownloadText(string command, CancellationToken token = default)

Parameters

command string

token CancellationToken

Returns

Task<List<string>>

FileExists(string, CancellationToken)

Task<bool> FileExists(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task<bool>

GetChecksum(string, FtpHashAlgorithm, CancellationToken)

Task<FtpHash> GetChecksum(string path, FtpHashAlgorithm algorithm = FtpHashAlgorithm.NONE, CancellationToken token = default)

Parameters

path string

algorithm FtpHashAlgorithm

token CancellationToken

Returns

Task<FtpHash>

GetChmod(string, CancellationToken)

Task<int> GetChmod(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task<int>

GetFilePermissions(string, CancellationToken)

Task<FtpListItem> GetFilePermissions(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task<FtpListItem>

GetFileSize(string, long, CancellationToken)

Task<long> GetFileSize(string path, long defaultValue = -1, CancellationToken token = default)

Parameters

path string

defaultValue long

token CancellationToken

Returns

Task<long>

GetListing(string, FtpListOption, CancellationToken)

Task<FtpListItem[]> GetListing(string path, FtpListOption options, CancellationToken token = default)

Parameters

path string

options FtpListOption

token CancellationToken

Returns

Task<FtpListItem[]>

GetListing(string, CancellationToken)

Task<FtpListItem[]> GetListing(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task<FtpListItem[]>

GetListing(CancellationToken)

Task<FtpListItem[]> GetListing(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Task<FtpListItem[]>

GetListingEnumerable(string, FtpListOption, CancellationToken, CancellationToken)

IAsyncEnumerable<FtpListItem> GetListingEnumerable(string path, FtpListOption options, CancellationToken token = default, CancellationToken enumToken = default)

Parameters

path string

options FtpListOption

token CancellationToken

enumToken CancellationToken

Returns

IAsyncEnumerable<FtpListItem>

GetListingEnumerable(string, CancellationToken, CancellationToken)

IAsyncEnumerable<FtpListItem> GetListingEnumerable(string path, CancellationToken token = default, CancellationToken enumToken = default)

Parameters

path string

token CancellationToken

enumToken CancellationToken

Returns

IAsyncEnumerable<FtpListItem>

GetListingEnumerable(CancellationToken, CancellationToken)

IAsyncEnumerable<FtpListItem> GetListingEnumerable(CancellationToken token = default, CancellationToken enumToken = default)

Parameters

token CancellationToken

enumToken CancellationToken

Returns

IAsyncEnumerable<FtpListItem>

GetModifiedTime(string, CancellationToken)

Task<DateTime> GetModifiedTime(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task<DateTime>

GetNameListing(string, CancellationToken)

Task<string[]> GetNameListing(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task<string[]>

GetNameListing(CancellationToken)

Task<string[]> GetNameListing(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Task<string[]>

GetObjectInfo(string, bool, CancellationToken)

Task<FtpListItem> GetObjectInfo(string path, bool dateModified = false, CancellationToken token = default)

Parameters

path string

dateModified bool

token CancellationToken

Returns

Task<FtpListItem>

GetReply(CancellationToken)

Task<FtpReply> GetReply(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Task<FtpReply>

GetWorkingDirectory(CancellationToken)

Task<string> GetWorkingDirectory(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Task<string>

HasFeature(FtpCapability)

bool HasFeature(FtpCapability cap)

Parameters

cap FtpCapability

Returns

bool

MoveDirectory(string, string, FtpRemoteExists, CancellationToken)

Task<bool> MoveDirectory(string path, string dest, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, CancellationToken token = default)

Parameters

path string

dest string

existsMode FtpRemoteExists

token CancellationToken

Returns

Task<bool>

MoveFile(string, string, FtpRemoteExists, CancellationToken)

Task<bool> MoveFile(string path, string dest, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, CancellationToken token = default)

Parameters

path string

dest string

existsMode FtpRemoteExists

token CancellationToken

Returns

Task<bool>

OpenAppend(string, FtpDataType, bool, CancellationToken)

Task<Stream> OpenAppend(string path, FtpDataType type = FtpDataType.Binary, bool checkIfFileExists = true, CancellationToken token = default)

Parameters

path string

type FtpDataType

checkIfFileExists bool

token CancellationToken

Returns

Task<Stream>

OpenAppend(string, FtpDataType, long, CancellationToken)

Task<Stream> OpenAppend(string path, FtpDataType type, long fileLen, CancellationToken token = default)

Parameters

path string

type FtpDataType

fileLen long

token CancellationToken

Returns

Task<Stream>

OpenRead(string, FtpDataType, long, bool, CancellationToken)

Task<Stream> OpenRead(string path, FtpDataType type = FtpDataType.Binary, long restart = 0, bool checkIfFileExists = true, CancellationToken token = default)

Parameters

path string

type FtpDataType

restart long

checkIfFileExists bool

token CancellationToken

Returns

Task<Stream>

OpenRead(string, FtpDataType, long, long, CancellationToken)

Task<Stream> OpenRead(string path, FtpDataType type, long restart, long fileLen, CancellationToken token = default)

Parameters

path string

type FtpDataType

restart long

fileLen long

token CancellationToken

Returns

Task<Stream>

OpenWrite(string, FtpDataType, bool, CancellationToken)

Task<Stream> OpenWrite(string path, FtpDataType type = FtpDataType.Binary, bool checkIfFileExists = true, CancellationToken token = default)

Parameters

path string

type FtpDataType

checkIfFileExists bool

token CancellationToken

Returns

Task<Stream>

OpenWrite(string, FtpDataType, long, CancellationToken)

Task<Stream> OpenWrite(string path, FtpDataType type, long fileLen, CancellationToken token = default)

Parameters

path string

type FtpDataType

fileLen long

token CancellationToken

Returns

Task<Stream>

Rename(string, string, CancellationToken)

Task Rename(string path, string dest, CancellationToken token = default)

Parameters

path string

dest string

token CancellationToken

Returns

Task

SetFilePermissions(string, FtpPermission, FtpPermission, FtpPermission, CancellationToken)

Task SetFilePermissions(string path, FtpPermission owner, FtpPermission group, FtpPermission other, CancellationToken token = default)

Parameters

path string

owner FtpPermission

group FtpPermission

other FtpPermission

token CancellationToken

Returns

Task

SetFilePermissions(string, int, CancellationToken)

Task SetFilePermissions(string path, int permissions, CancellationToken token = default)

Parameters

path string

permissions int

token CancellationToken

Returns

Task

SetModifiedTime(string, DateTime, CancellationToken)

Task SetModifiedTime(string path, DateTime date, CancellationToken token = default)

Parameters

path string

date DateTime

token CancellationToken

Returns

Task

SetWorkingDirectory(string, CancellationToken)

Task SetWorkingDirectory(string path, CancellationToken token = default)

Parameters

path string

token CancellationToken

Returns

Task

UploadBytes(byte[], string, FtpRemoteExists, bool, IProgress<FtpProgress>, CancellationToken)

Task<FtpStatus> UploadBytes(byte[] fileData, string remotePath, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, bool createRemoteDir = false, IProgress<FtpProgress> progress = null, CancellationToken token = default)

Parameters

fileData byte[]

remotePath string

existsMode FtpRemoteExists

createRemoteDir bool

progress IProgress<FtpProgress>

token CancellationToken

Returns

Task<FtpStatus>

UploadDirectory(string, string, FtpFolderSyncMode, FtpRemoteExists, FtpVerify, List<FtpRule>, IProgress<FtpProgress>, CancellationToken)

Task<List<FtpResult>> UploadDirectory(string localFolder, string remoteFolder, FtpFolderSyncMode mode = FtpFolderSyncMode.Update, FtpRemoteExists existsMode = FtpRemoteExists.Skip, FtpVerify verifyOptions = FtpVerify.None, List<FtpRule> rules = null, IProgress<FtpProgress> progress = null, CancellationToken token = default)

Parameters

localFolder string

remoteFolder string

mode FtpFolderSyncMode

existsMode FtpRemoteExists

verifyOptions FtpVerify

rules List<FtpRule>

progress IProgress<FtpProgress>

token CancellationToken

Returns

Task<List<FtpResult>>

UploadFile(string, string, FtpRemoteExists, bool, FtpVerify, IProgress<FtpProgress>, CancellationToken)

Task<FtpStatus> UploadFile(string localPath, string remotePath, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, bool createRemoteDir = false, FtpVerify verifyOptions = FtpVerify.None, IProgress<FtpProgress> progress = null, CancellationToken token = default)

Parameters

localPath string

remotePath string

existsMode FtpRemoteExists

createRemoteDir bool

verifyOptions FtpVerify

progress IProgress<FtpProgress>

token CancellationToken

Returns

Task<FtpStatus>

UploadFiles(IEnumerable<FileInfo>, string, FtpRemoteExists, bool, FtpVerify, FtpError, CancellationToken, IProgress<FtpProgress>, List<FtpRule>)

Task<List<FtpResult>> UploadFiles(IEnumerable<FileInfo> localFiles, string remoteDir, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, bool createRemoteDir = true, FtpVerify verifyOptions = FtpVerify.None, FtpError errorHandling = FtpError.None, CancellationToken token = default, IProgress<FtpProgress> progress = null, List<FtpRule> rules = null)

Parameters

localFiles IEnumerable<FileInfo>

remoteDir string

existsMode FtpRemoteExists

createRemoteDir bool

verifyOptions FtpVerify

errorHandling FtpError

token CancellationToken

progress IProgress<FtpProgress>

rules List<FtpRule>

Returns

Task<List<FtpResult>>

UploadFiles(IEnumerable<string>, string, FtpRemoteExists, bool, FtpVerify, FtpError, CancellationToken, IProgress<FtpProgress>, List<FtpRule>)

Task<List<FtpResult>> UploadFiles(IEnumerable<string> localPaths, string remoteDir, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, bool createRemoteDir = true, FtpVerify verifyOptions = FtpVerify.None, FtpError errorHandling = FtpError.None, CancellationToken token = default, IProgress<FtpProgress> progress = null, List<FtpRule> rules = null)

Parameters

localPaths IEnumerable<string>

remoteDir string

existsMode FtpRemoteExists

createRemoteDir bool

verifyOptions FtpVerify

errorHandling FtpError

token CancellationToken

progress IProgress<FtpProgress>

rules List<FtpRule>

Returns

Task<List<FtpResult>>

UploadStream(Stream, string, FtpRemoteExists, bool, IProgress<FtpProgress>, CancellationToken)

Task<FtpStatus> UploadStream(Stream fileStream, string remotePath, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, bool createRemoteDir = false, IProgress<FtpProgress> progress = null, CancellationToken token = default)

Parameters

fileStream Stream

remotePath string

existsMode FtpRemoteExists

createRemoteDir bool

progress IProgress<FtpProgress>

token CancellationToken

Returns

Task<FtpStatus>