The class provides access to a message that is intended for the user.
Method/Use |
Prerequisites |
O2GMessagesTableResponseReader.getRow
This method is used to get an initial message after a session with the trading server is established.
This method provides access to a single message. To get multiple messages, call this method in a loop. |
The Messages table is always loaded by the server automatically during the login process.
You can get the message information by using the O2GLoginRules.getTableRefreshResponse method.
The returned O2GResponse object is of the O2GResponseType.GetMessages type.
You must parse this object by using the O2GMessagesTableResponseReader object.
For details, see the example below. |
O2GTablesUpdatesReader.getMessageRow
This method is used to get information about a message received during a session lifetime.
This method provides access to a single message. To track multiple messages, call this method in a loop. |
To receive the message information, you must implement the IO2GResponseListener.onTablesUpdates method.
The received O2GResponse object is of the O2GResponseType.TablesUpdates type.
You must parse this object by using the O2GTablesUpdatesReader object.
For details, see the example below. |
Get Messages information [hide]
// Get messages information
public static void getMessages(O2GSession session, ResponseListener responseListener)
{
try
{
O2GLoginRules loginRules = session.getLoginRules();
if (loginRules != null && loginRules.isTableLoadedByDefault(O2GTableType.Messages))
{
O2GResponse messagesResponse = loginRules.getTableRefreshResponse(O2GTableType.Messages);
O2GResponseReaderFactory responseFactory = session.getResponseReaderFactory();
if (responseFactory != null)
{
O2GMessagesTableResponseReader messagesReader = responseFactory.createMessagesTableReader(messagesResponse);
for (int i = 0; i < messagesReader.Count; i++)
{
O2GMessageRow message = messagesReader.getRow(i);
Console.WriteLine(" This is a received message: \nFrom = " + message.From +
" Subject = " + message.Subject +
" Text = " + message.Text);
}
}
}
}
catch (Exception e)
{
Console.WriteLine("Exception in getMessages().\n\t " + e.Message);
}
}
// Implementation of IO2GResponseListener interface public method onTablesUpdates
public void onTablesUpdates(O2GResponse response)
{
O2GResponseReaderFactory factory = mSession.getResponseReaderFactory();
if (factory != null)
{
O2GTablesUpdatesReader updatesReader = factory.createTablesUpdatesReader(response);
for (int i = 0; i < updatesReader.Count; i++)
{
O2GTableType tableType = updatesReader.getUpdateTable(i);
if (tableType == O2GTableType.Messages)
{
O2GMessageRow message = updatesReader.getMessageRow(i);
Console.WriteLine(" This is a live message: \nFrom = " + message.From +
" Subject = " + message.Subject +
" Text = " + message.Text);
}
}
}
}
| Public Properties |
|
Columns
|
The columns of the table.
|
|
Feature
|
Gets the type of the message content.
|
|
From
|
Gets the login of the message sender.
|
|
HTMLFragmentFlag
|
Gets the flag indicating whether the message is in the HTML format or not.
|
|
MsgID
|
Gets the unique identification number of the message.
|
|
Subject
|
Gets the subject of the message.
|
|
TableType
|
The type of the table.
|
|
Text
|
Gets the text body of the message.
|
|
Time
|
Gets the date and time when the recipient receives the message.
|
|
Type
|
Gets the message container.
|
| Public Methods |
|
getCell
|
Gets a cell of the table.
|
|
isCellChanged
|
Gets a flag indicating whether the value of the cell is changed.
|