C# Class Miracle.FileZilla.Api.FileZillaApi

FileZilla server API
Inheritance: FileZillaServerProtocol, IFileZillaApi
Mostrar archivo Open project: PolarbearDK/Miracle.FileZilla.Api

Public Methods

Method Description
BanIp ( int connectionId ) : bool

Kick a connection by id, and also ban IP address.
FileZillaApi ( ) : System.Collections.Generic

Construct FileZillaApi using default IP/port
FileZillaApi ( IPAddress address, int port ) : System.Collections.Generic

Construct FileZillaApi using specific IP/port
GetAccountSettings ( ) : AccountSettings

Get account settings including all users and groups
GetConnections ( ) : List

Get list af current connections to FileZilla server
GetServerState ( ) : ServerState

Get state of FileZilla server
GetSettings ( ) : Settings

Get state of FileZilla server
Kick ( int connectionId ) : bool

Kick a connection by id.
SetAccountSettings ( AccountSettings accountSettings ) : bool

Set account settings. Note! This replaces ALL users and groups on FileZilla server.
SetServerState ( ServerState serverState ) : ServerState

Set state of FileZilla server
SetSettings ( Settings settings ) : bool

Get state of FileZilla server

Method Details

BanIp() public method

Kick a connection by id, and also ban IP address.
public BanIp ( int connectionId ) : bool
connectionId int Connection Id (Use GetConnections to find ConnectionId)
return bool

FileZillaApi() public method

Construct FileZillaApi using default IP/port
public FileZillaApi ( ) : System.Collections.Generic
return System.Collections.Generic

FileZillaApi() public method

Construct FileZillaApi using specific IP/port
public FileZillaApi ( IPAddress address, int port ) : System.Collections.Generic
address System.Net.IPAddress IP address of filezilla server.
port int Admin port as specified when FileZilla server were installed
return System.Collections.Generic

GetAccountSettings() public method

Get account settings including all users and groups
public GetAccountSettings ( ) : AccountSettings
return AccountSettings

GetConnections() public method

Get list af current connections to FileZilla server
public GetConnections ( ) : List
return List

GetServerState() public method

Get state of FileZilla server
public GetServerState ( ) : ServerState
return ServerState

GetSettings() public method

Get state of FileZilla server
public GetSettings ( ) : Settings
return Settings

Kick() public method

Kick a connection by id.
public Kick ( int connectionId ) : bool
connectionId int Connection Id (Use GetConnections to find ConnectionId)
return bool

SetAccountSettings() public method

Set account settings. Note! This replaces ALL users and groups on FileZilla server.
public SetAccountSettings ( AccountSettings accountSettings ) : bool
accountSettings AccountSettings
return bool

SetServerState() public method

Set state of FileZilla server
public SetServerState ( ServerState serverState ) : ServerState
serverState ServerState The new state
return ServerState

SetSettings() public method

Get state of FileZilla server
public SetSettings ( Settings settings ) : bool
settings Settings
return bool