class IO2GOfferTableRow
Parents | |
IO2GOfferRow |
Brief
The class provides access to the offer information and calculated fields.
Details
The class represents a single row of the Offers table. In addition to the methods of its parent class,
the O2GOfferTableRow
class provides methods to access calculated fields, such as cost of one pip per lot.
Prerequisites
The class is available only through the use of the IO2GTableManager
. The IO2GTableManager
object must have the O2GTableManagerStatus.TablesLoaded status.
For complete instructions on the table manager usage, see the
How to use table manager in ForexConnect API section.
After tables are loaded, you must obtain an instance of the IO2GOffersTable
class. For example,
O2GOffersTable offersTable = (O2GOffersTable)tableManager.getTable(O2GTable.Offers);
Instantiating the class
If you need access to the current offer information, get an instance of the class by calling any of the following methods of the IO2GOffersTable
class:
|
Syntax example |
|
|
|
|
|
|
|
|
|
|
|
If you want to track the Offers table updates, your application must have a listener class that implements the
IO2GTableListener
interface.
An instance of the listener class must be subscribed to the table updates. Subscription to each update type is done individually.
Before the logout, you must unsubscribe the listener from each update type separately. The examples of subscription/unsubscription syntax are listed below.
|
Subscribe syntax |
Unsubscribe syntax |
|
|
|
|
|
To instantiate the O2GOfferTableRow
class, you must cast the rowData
parameter of the above methods to the
O2GOfferTableRow
type. For example,
O2GOfferTableRow row = (O2GOfferTableRow)(rowData);
Example
Get Instrument, Bid/Ask prices and Pip cost [show]
Public Methods | |
Gets the columns of the table. |
|
Gets the current market price an instrument can be bought at. |
|
Gets the usage of an ask price. |
|
Gets the current market price an instrument can be sold at. |
|
Gets the usage of a bid price. |
|
Gets the interest amount applied to the account balance for holding a one lot long (buy) position opened overnight. |
|
Gets value of a table cell. |
|
Gets the instrument base currency. |
|
Gets the contract multiplier for some CFD instruments only. |
|
Gets the instrument price precision. |
|
Gets the highest ask price (buy price) of an instrument for the current trading day. |
|
Gets the symbol of an instrument. |
|
Gets the type of an instrument. |
|
Gets the lowest bid price (sell price) of an instrument for the current trading day. |
|
Gets the unique identification number of an instrument. |
|
Gets the cost of one pip per lot. |
|
Gets the size of one pip. |
|
Gets the unique identifier of the pair of prices (bid and ask) an instrument can be traded at. |
|
Gets the interest amount applied to the account balance for holding a one lot short (sell) position opened overnight. |
|
Gets the subscription status. |
|
Gets the type of the table. |
|
Gets the date and time of the last update of the instrument. |
|
Gets the trading status. |
|
Gets the simulated delivery date. |
|
Gets a tick volume of the current minute. |
|
Gets the flag indicating whether the AskTradable field is valid or not. |
|
Gets the flag indicating whether the Ask field is valid or not. |
|
Gets the flag indicating whether the BidTradable field is valid or not. |
|
Gets the flag indicating whether the Bid field is valid or not. |
|
Gets the flag indicating whether the BuyInterest field is valid or not. |
|
Gets a flag indicating whether the value of the cell is changed. |
|
Gets the flag indicating whether the ContractCurrency field is valid or not. |
|
Gets the flag indicating whether the ContractMultiplier field is valid or not. |
|
Gets the flag indicating whether the Digits field is valid or not. |
|
Gets the flag indicating whether the High field is valid or not. |
|
Gets the flag indicating whether the InstrumentType field is valid or not. |
|
Gets the flag indicating whether the Instrument field is valid. |
|
Gets the flag indicating whether the Low field is valid. |
|
Gets the flag indicating whether the OfferID field is valid. |
|
Gets the flag indicating whether the PointSize field is valid or not. |
|
Gets the flag indicating whether the QuoteID field is valid. |
|
Gets the flag indicating whether the SellInterest field is valid or not. |
|
Gets the flag indicating whether the SubscriptionStatus field is valid or not. |
|
Gets the flag indicating whether the date and time of the last instument update is valid or not. |
|
Gets the flag indicating whether the TradingStatus field is valid or not. |
|
Gets the flag indicating whether the ValueDate field is valid or not. |
|
Gets the flag indicating whether the Volume field is valid or not. |