Lean  $LEAN_TAG$
QuantConnect.Packets.FileHistoryResult Class Reference

Defines requested file data for a history request More...

Inheritance diagram for QuantConnect.Packets.FileHistoryResult:
[legend]

Public Member Functions

 FileHistoryResult ()
 Default constructor for serializers More...
 
 FileHistoryResult (string filepath, byte[] file)
 Initializes a new instance of the HistoryResult class More...
 

Properties

string Filepath [get, set]
 The relative file path where the data should be written More...
 
byte[] File [get, set]
 The file's contents, this is a zipped csv file More...
 
- Properties inherited from QuantConnect.Packets.HistoryResult
HistoryResultType Type [get]
 Gets the type of history result More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Packets.HistoryResult
 HistoryResult (HistoryResultType type)
 Initializes a new instance of the HistoryResult class More...
 

Detailed Description

Defines requested file data for a history request

Definition at line 129 of file HistoryPacket.cs.

Constructor & Destructor Documentation

◆ FileHistoryResult() [1/2]

QuantConnect.Packets.FileHistoryResult.FileHistoryResult ( )

Default constructor for serializers

Definition at line 144 of file HistoryPacket.cs.

◆ FileHistoryResult() [2/2]

QuantConnect.Packets.FileHistoryResult.FileHistoryResult ( string  filepath,
byte[]  file 
)

Initializes a new instance of the HistoryResult class

Parameters
filepathThe relative file path where the file should be written, rooted in /Data, so for example ./forex/fxcm/daily/eurusd.zip
fileThe zipped csv file content in bytes

Definition at line 154 of file HistoryPacket.cs.

Property Documentation

◆ Filepath

string QuantConnect.Packets.FileHistoryResult.Filepath
getset

The relative file path where the data should be written

Definition at line 134 of file HistoryPacket.cs.

◆ File

byte [] QuantConnect.Packets.FileHistoryResult.File
getset

The file's contents, this is a zipped csv file

Definition at line 139 of file HistoryPacket.cs.


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