Lean  $LEAN_TAG$
QuantConnect.Algorithm.Framework.Portfolio.SignalExports.BaseSignalExport Class Reference

Base class to send signals to different 3rd party API's More...

Inheritance diagram for QuantConnect.Algorithm.Framework.Portfolio.SignalExports.BaseSignalExport:
[legend]

Public Member Functions

virtual bool Send (SignalExportTargetParameters parameters)
 Sends positions to different 3rd party API's More...
 
void Dispose ()
 If created, dispose of HttpClient we used for the requests to the different 3rd party API's More...
 

Protected Attributes

HttpClient HttpClient => _lazyClient.Value
 Property to access a HttpClient More...
 

Properties

abstract string Name [get]
 The name of this signal export More...
 
virtual HashSet< SecurityTypeAllowedSecurityTypes [get]
 Default hashset of allowed Security types More...
 

Detailed Description

Base class to send signals to different 3rd party API's

Definition at line 27 of file BaseSignalExport.cs.

Member Function Documentation

◆ Send()

virtual bool QuantConnect.Algorithm.Framework.Portfolio.SignalExports.BaseSignalExport.Send ( SignalExportTargetParameters  parameters)
virtual

Sends positions to different 3rd party API's

Parameters
parametersHoldings the user have defined to be sent to certain 3rd party API and the algorithm being ran
Returns
True if the positions were sent correctly and the 3rd party API sent no errors. False, otherwise

Implements QuantConnect.Interfaces.ISignalExportTarget.

Reimplemented in QuantConnect.Algorithm.Framework.Portfolio.SignalExports.NumeraiSignalExport, QuantConnect.Algorithm.Framework.Portfolio.SignalExports.CrunchDAOSignalExport, and QuantConnect.Algorithm.Framework.Portfolio.SignalExports.Collective2SignalExport.

Definition at line 74 of file BaseSignalExport.cs.

Here is the call graph for this function:

◆ Dispose()

void QuantConnect.Algorithm.Framework.Portfolio.SignalExports.BaseSignalExport.Dispose ( )

If created, dispose of HttpClient we used for the requests to the different 3rd party API's

Definition at line 107 of file BaseSignalExport.cs.

Member Data Documentation

◆ HttpClient

HttpClient QuantConnect.Algorithm.Framework.Portfolio.SignalExports.BaseSignalExport.HttpClient => _lazyClient.Value
protected

Property to access a HttpClient

Definition at line 59 of file BaseSignalExport.cs.

Property Documentation

◆ Name

abstract string QuantConnect.Algorithm.Framework.Portfolio.SignalExports.BaseSignalExport.Name
getprotected

The name of this signal export

Definition at line 53 of file BaseSignalExport.cs.

◆ AllowedSecurityTypes

virtual HashSet<SecurityType> QuantConnect.Algorithm.Framework.Portfolio.SignalExports.BaseSignalExport.AllowedSecurityTypes
getprotected

Default hashset of allowed Security types

Definition at line 65 of file BaseSignalExport.cs.


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