Lean  $LEAN_TAG$
QuantConnect.Securities.AccountEvent Class Reference

Messaging class signifying a change in a user's account More...

Public Member Functions

 AccountEvent (string currencySymbol, decimal cashBalance)
 Creates an AccountEvent More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Properties

decimal CashBalance [get]
 Gets the total cash balance of the account in units of CurrencySymbol More...
 
string CurrencySymbol [get]
 Gets the currency symbol More...
 

Detailed Description

Messaging class signifying a change in a user's account

Definition at line 21 of file AccountEvent.cs.

Constructor & Destructor Documentation

◆ AccountEvent()

QuantConnect.Securities.AccountEvent.AccountEvent ( string  currencySymbol,
decimal  cashBalance 
)

Creates an AccountEvent

Parameters
currencySymbolThe currency's symbol
cashBalanceThe total cash balance of the account

Definition at line 38 of file AccountEvent.cs.

Member Function Documentation

◆ ToString()

override string QuantConnect.Securities.AccountEvent.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

<filterpriority>2</filterpriority>

Definition at line 51 of file AccountEvent.cs.

Here is the call graph for this function:

Property Documentation

◆ CashBalance

decimal QuantConnect.Securities.AccountEvent.CashBalance
get

Gets the total cash balance of the account in units of CurrencySymbol

Definition at line 26 of file AccountEvent.cs.

◆ CurrencySymbol

string QuantConnect.Securities.AccountEvent.CurrencySymbol
get

Gets the currency symbol

Definition at line 31 of file AccountEvent.cs.


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