FTP notification data More...

Inheritance diagram for QuantConnect.Notifications.NotificationFtp:

Public Member Functions
	NotificationFtp (string hostname, string username, string password, string filePath, byte[] fileContent, bool secure=true, int? port=null)
	Constructor for a notification to sent as a file to an FTP server using password authentication. More...

	NotificationFtp (string hostname, string username, string privateKey, string privateKeyPassphrase, string filePath, byte[] fileContent, int? port=null)
	Constructor for a notification to sent as a file to an FTP server over SFTP using SSH keys. More...

	NotificationFtp (string hostname, string username, string password, string filePath, string fileContent, bool secure=true, int? port=null)
	Constructor for a notification to sent as a file to an FTP server using password authentication. More...

	NotificationFtp (string hostname, string username, string privateKey, string privateKeyPassphrase, string filePath, string fileContent, int? port=null)
	Constructor for a notification to sent as a file to an FTP server over SFTP using SSH keys. More...

Public Member Functions inherited from QuantConnect.Notifications.Notification
virtual void	Send ()
	Method for sending implementations of notification object types. More...

Properties
bool	Secure `[get]`
	Whether to use SFTP or FTP. More...

string	Hostname `[get]`
	The FTP server hostname. More...

int	Port `[get]`
	The FTP server port. More...

string	Username `[get]`
	The FTP server username. More...

string	Password `[get]`
	The FTP server password. More...

string	FilePath `[get]`
	The path to file on the FTP server. More...

string	FileContent `[get]`
	The contents of the file to send. More...

string	PrivateKey `[get]`
	The private key to use for authentication (optional). More...

string	PrivateKeyPassphrase `[get]`
	The passphrase for the private key (optional). More...

Detailed Description

FTP notification data

Definition at line 205 of file Notification.cs.

Constructor & Destructor Documentation

◆ NotificationFtp() [1/4]

QuantConnect.Notifications.NotificationFtp.NotificationFtp	(	string	hostname,
		string	username,
		string	password,
		string	filePath,
		byte[]	fileContent,
		bool	secure = `true`,
		int?	port = `null`
	)

Constructor for a notification to sent as a file to an FTP server using password authentication.

Parameters

hostname	FTP server hostname
username	The FTP server username
password	The FTP server password
filePath	The path to file on the FTP server
fileContent	The contents of the file
secure	Whether to use SFTP or FTP. Defaults to true
port	The FTP server port. Defaults to 21

Definition at line 285 of file Notification.cs.

◆ NotificationFtp() [2/4]

QuantConnect.Notifications.NotificationFtp.NotificationFtp	(	string	hostname,
		string	username,
		string	privateKey,
		string	privateKeyPassphrase,
		string	filePath,
		byte[]	fileContent,
		int?	port = `null`
	)

Constructor for a notification to sent as a file to an FTP server over SFTP using SSH keys.

Parameters

hostname	FTP server hostname
username	The FTP server username
privateKey	The private SSH key to use for authentication
privateKeyPassphrase	The optional passphrase to decrypt the private key. This can be empty or null if the private key is not encrypted
filePath	The path to file on the FTP server
fileContent	The contents of the file
port	The FTP server port. Defaults to 21

Definition at line 308 of file Notification.cs.

◆ NotificationFtp() [3/4]

QuantConnect.Notifications.NotificationFtp.NotificationFtp	(	string	hostname,
		string	username,
		string	password,
		string	filePath,
		string	fileContent,
		bool	secure = `true`,
		int?	port = `null`
	)

Constructor for a notification to sent as a file to an FTP server using password authentication.

Parameters

hostname	FTP server hostname
username	The FTP server username
password	The FTP server password
filePath	The path to file on the FTP server
fileContent	The contents of the file
secure	Whether to use SFTP or FTP. Defaults to true
port	The FTP server port. Defaults to 21

Definition at line 331 of file Notification.cs.

◆ NotificationFtp() [4/4]

QuantConnect.Notifications.NotificationFtp.NotificationFtp	(	string	hostname,
		string	username,
		string	privateKey,
		string	privateKeyPassphrase,
		string	filePath,
		string	fileContent,
		int?	port = `null`
	)

Constructor for a notification to sent as a file to an FTP server over SFTP using SSH keys.

Parameters

hostname	FTP server hostname
username	The FTP server username
privateKey	The private SSH key to use for authentication
privateKeyPassphrase	The optional passphrase to decrypt the private key. This can be empty or null if the private key is not encrypted
filePath	The path to file on the FTP server
fileContent	The contents of the file
port	The FTP server port. Defaults to 21

Definition at line 348 of file Notification.cs.

Property Documentation

◆ Secure

bool QuantConnect.Notifications.NotificationFtp.Secure

get

Whether to use SFTP or FTP.

Definition at line 215 of file Notification.cs.

◆ Hostname

string QuantConnect.Notifications.NotificationFtp.Hostname

get

The FTP server hostname.

Definition at line 221 of file Notification.cs.

◆ Port

int QuantConnect.Notifications.NotificationFtp.Port

get

The FTP server port.

Definition at line 227 of file Notification.cs.

◆ Username

string QuantConnect.Notifications.NotificationFtp.Username

get

The FTP server username.

Definition at line 233 of file Notification.cs.

◆ Password

string QuantConnect.Notifications.NotificationFtp.Password

get

The FTP server password.

Definition at line 239 of file Notification.cs.

◆ FilePath

string QuantConnect.Notifications.NotificationFtp.FilePath

get

The path to file on the FTP server.

Definition at line 245 of file Notification.cs.

◆ FileContent

string QuantConnect.Notifications.NotificationFtp.FileContent

get

The contents of the file to send.

Definition at line 251 of file Notification.cs.

◆ PrivateKey

string QuantConnect.Notifications.NotificationFtp.PrivateKey

get

The private key to use for authentication (optional).

Definition at line 257 of file Notification.cs.

◆ PrivateKeyPassphrase

string QuantConnect.Notifications.NotificationFtp.PrivateKeyPassphrase

get

The passphrase for the private key (optional).

Definition at line 263 of file Notification.cs.

The documentation for this class was generated from the following file:

Common/Notifications/Notification.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ NotificationFtp() [1/4]

◆ NotificationFtp() [2/4]

◆ NotificationFtp() [3/4]

◆ NotificationFtp() [4/4]

Property Documentation

◆ Secure

◆ Hostname

◆ Port

◆ Username

◆ Password

◆ FilePath

◆ FileContent

◆ PrivateKey

◆ PrivateKeyPassphrase