class O2GMessageTableRow
Parents | |
|
Brief
The class provides access to the message information.
Details
The class represents a single row of the Messages table.
Prerequisites
The class is available only through the use of the O2GTableManager
. An O2GTableManager
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 O2GMessagesTable
class. For example,
O2GMessagesTable messagesTable = (O2GMessagesTable)tableManager.getTable(O2GTableType.Messages);
Instantiating the class
If you need access to the current message information, you can get an instance of the class by calling any of the following methods of the O2GMessagesTable
class:
|
Syntax example |
|
|
|
|
|
|
|
|
|
|
|
If you want to track incoming messages, your application must have a listener class that implements the IO2GTableListener
interface.
An instance of the listener class must be subscribed to the table update with the O2GTableUpdateType.Insert type. Before the logout,
you must unsubscribe the listener from this update type. The examples of the subscription/unsubscription syntax are listed below.
|
Subscribe syntax |
Unsubscribe syntax |
|
|
To instantiate the O2MessageTableRow
class, you must cast the rowData
parameter of the above onAdded
method
to the O2GMessageTableRow
type. For example,
O2MessageTableRow row = (O2GMessageTableRow)(rowData);
Example
Get message sender and text [show]
The type defined in the fxcore2.dll
assembly.
The namespace is fxcore2
.
Public Properties | |
The columns of the table. |
|
Gets the type of the message content. |
|
Gets the login of the message sender. |
|
Gets the flag indicating whether the message is in the HTML format or not. |
|
Gets the unique identification number of the message. |
|
Gets the subject of the message. |
|
The type of the table. |
|
Gets the text body of the message. |
|
Gets the date and time when the recipient receives the message. |
|
Gets the message container. |
Public Methods | |
Gets a cell of the table. |
|
Gets a flag indicating whether the value of the cell is changed. |