Lean  $LEAN_TAG$
QuantConnect.Orders.CancelOrderRequest Class Reference

Defines a request to cancel an order More...

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

Public Member Functions

 CancelOrderRequest (DateTime time, int orderId, string tag)
 Initializes a new instance of the CancelOrderRequest class More...
 
override string ToString ()
 Returns a string that represents the current object. 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.Cancel 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 cancel an order

Definition at line 23 of file CancelOrderRequest.cs.

Constructor & Destructor Documentation

◆ CancelOrderRequest()

QuantConnect.Orders.CancelOrderRequest.CancelOrderRequest ( DateTime  time,
int  orderId,
string  tag 
)

Initializes a new instance of the CancelOrderRequest class

Parameters
timeThe time this cancelation was requested
orderIdThe order id to be canceled
tagA new tag for the order

Definition at line 39 of file CancelOrderRequest.cs.

Member Function Documentation

◆ ToString()

override string QuantConnect.Orders.CancelOrderRequest.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 CancelOrderRequest.cs.

Property Documentation

◆ OrderRequestType

override OrderRequestType QuantConnect.Orders.CancelOrderRequest.OrderRequestType
get

Gets Orders.OrderRequestType.Cancel

Definition at line 29 of file CancelOrderRequest.cs.


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