Lean  $LEAN_TAG$
QuantConnect.Orders.UpdateOrderRequest Class Reference

Defines a request to update an order's values More...

Inheritance diagram for QuantConnect.Orders.UpdateOrderRequest:
[legend]

Public Member Functions

 UpdateOrderRequest (DateTime time, int orderId, UpdateOrderFields fields)
 Initializes a new instance of the UpdateOrderRequest class More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 
bool IsAllowedForClosedOrder ()
 Checks whether the update request is allowed for a closed order. Only tag updates are allowed on closed orders. More...
 
- Public Member Functions inherited from QuantConnect.Orders.OrderRequest
void SetResponse (OrderResponse response, OrderRequestStatus status=OrderRequestStatus.Error)
 Sets the Response for this request More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Properties

override OrderRequestType OrderRequestType [get]
 Gets Orders.OrderRequestType.Update More...
 
decimal? Quantity [get]
 Gets the new quantity of the order, null to not change the quantity More...
 
decimal? LimitPrice [get]
 Gets the new limit price of the order, null to not change the limit price More...
 
decimal? StopPrice [get]
 Gets the new stop price of the order, null to not change the stop price More...
 
decimal? TriggerPrice [get]
 Gets the new trigger price of the order, null to not change the trigger price More...
 
decimal? TrailingAmount [get]
 The trailing stop order trailing amount More...
 
- Properties inherited from QuantConnect.Orders.OrderRequest
abstract OrderRequestType OrderRequestType [get]
 Gets the type of this order request More...
 
OrderRequestStatus Status [get]
 Gets the status of this request More...
 
DateTime Time [get]
 Gets the UTC time the request was created More...
 
int OrderId [get, protected set]
 Gets the order id the request acts on More...
 
string Tag [get]
 Gets a tag for this request More...
 
OrderResponse Response [get]
 Gets the response for this request. If this request was never processed then this will equal OrderResponse.Unprocessed. This value is never equal to null. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Orders.OrderRequest
 OrderRequest (DateTime time, int orderId, string tag)
 Initializes a new instance of the OrderRequest class More...
 

Detailed Description

Defines a request to update an order's values

Definition at line 23 of file UpdateOrderRequest.cs.

Constructor & Destructor Documentation

◆ UpdateOrderRequest()

QuantConnect.Orders.UpdateOrderRequest.UpdateOrderRequest ( DateTime  time,
int  orderId,
UpdateOrderFields  fields 
)

Initializes a new instance of the UpdateOrderRequest class

Parameters
timeThe time the request was submitted
orderIdThe order id to be updated
fieldsThe fields defining what should be updated

Definition at line 64 of file UpdateOrderRequest.cs.

Member Function Documentation

◆ ToString()

override string QuantConnect.Orders.UpdateOrderRequest.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

<filterpriority>2</filterpriority>

Definition at line 81 of file UpdateOrderRequest.cs.

◆ IsAllowedForClosedOrder()

bool QuantConnect.Orders.UpdateOrderRequest.IsAllowedForClosedOrder ( )

Checks whether the update request is allowed for a closed order. Only tag updates are allowed on closed orders.

Returns
True if the update request is allowed for a closed order

Definition at line 91 of file UpdateOrderRequest.cs.

Here is the caller graph for this function:

Property Documentation

◆ OrderRequestType

override OrderRequestType QuantConnect.Orders.UpdateOrderRequest.OrderRequestType
get

Gets Orders.OrderRequestType.Update

Definition at line 29 of file UpdateOrderRequest.cs.

◆ Quantity

decimal? QuantConnect.Orders.UpdateOrderRequest.Quantity
get

Gets the new quantity of the order, null to not change the quantity

Definition at line 36 of file UpdateOrderRequest.cs.

◆ LimitPrice

decimal? QuantConnect.Orders.UpdateOrderRequest.LimitPrice
get

Gets the new limit price of the order, null to not change the limit price

Definition at line 41 of file UpdateOrderRequest.cs.

◆ StopPrice

decimal? QuantConnect.Orders.UpdateOrderRequest.StopPrice
get

Gets the new stop price of the order, null to not change the stop price

Definition at line 46 of file UpdateOrderRequest.cs.

◆ TriggerPrice

decimal? QuantConnect.Orders.UpdateOrderRequest.TriggerPrice
get

Gets the new trigger price of the order, null to not change the trigger price

Definition at line 51 of file UpdateOrderRequest.cs.

◆ TrailingAmount

decimal? QuantConnect.Orders.UpdateOrderRequest.TrailingAmount
get

The trailing stop order trailing amount

Definition at line 56 of file UpdateOrderRequest.cs.


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