org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Fri, 11 Jun 2010 13:33:03 -0700
changeset 372 1e408ee32d8a
parent 229 716254ccbcc0
permissions -rw-r--r--
Added templates for WRT 1.1 platform services


<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="Returned log event information"/><meta name="DC.Relation" scheme="URI" content="GUID-258A8E34-56F4-4BF2-8C94-F7BB7FAE71F8"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-F003B7DD-E450-49AD-B447-C5132FE47D3C"/><meta name="DC.Relation" scheme="URI" content="GUID-7E53CD9F-E213-42E7-8569-02AEA1198E52"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C"/><title>Returned
log event information </title><script type="text/javascript">
      function initPage() {}
    </script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C">Returned
log event information</h1><div>
<p>The <code>ReturnValue</code> property returned by a synchronous <a href="GUID-7E53CD9F-E213-42E7-8569-02AEA1198E52.html#GUID-7E53CD9F-E213-42E7-8569-02AEA1198E52"><code>GetList</code></a> call
and by <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> for
an asynchronous <code>GelList</code> call is an iterator containing
information about the requested entries in the event log. Each item (object)
in the iterator corresponds to one entry in the event log.</p>
<div class="tablenoborder"><a name="GUID-81878C1A-78BD-441B-968B-DB93A7A84372"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-81878C1A-78BD-441B-968B-DB93A7A84372" frame="border" border="1" rules="all"><caption><strong>Table: </strong>ReturnValue properties
for entries in the event log</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="24.561403508771928%" id="d0e52780">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="24.561403508771928%" id="d0e52785">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="24.561403508771928%" id="d0e52790">
<p>Value type</p>
</th><th class="cellrowborder" valign="top" width="26.31578947368421%" id="d0e52795">
<p>Type</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.EventType</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains a unique identifier for the type of entry.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
<p><strong>Possible values:</strong></p>
<p><code>0</code> - EKLogCallEventType</p>
<p><code>1</code> - EKLogDataEventType</p>
<p><code>2</code> - EKLogFaxEventType</p>
<p><code>3</code> - EKLogShortMessageEventType</p>
<p><code>4</code> - EKLogPacketDataEventType</p>
</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>number</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.RemoteParty</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains the destination of the outgoing event or the source of incoming
event.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
<p>Up to 64 characters. If the length of the specified string is greater
than 64 characters, the data is truncated.</p>
</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>string</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.Direction</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains whether the event is incoming, outgoing, or missed and if it
came in on an alternate line.</p>
<p>Alternate line refers to the second phone call on the mobile device.
Alternate line values, such as <code>2</code> - EIncomingEventAlternateline,
are valid for call events only.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
<p><strong>Possible values:</strong></p>
<p><code>0</code> - EIncomingEvent</p>
<p><code>1</code> - EOutgoingEvent</p>
<p><code>2</code> - EIncomingEventAlternateline</p>
<p><code>3</code> - EOutgoingEventAlternateline</p>
<p><code>4</code> - EFetchedEvent</p>
<p><code>5</code> - EMissedEvent</p>
<p><code>6</code> - EMissedEventAlternateline</p>
</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>number</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.EventTime</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains the time at which the event was created. The mobile device
automatically sets this time.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>string</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.EventDuration</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains the duration of the event, in seconds.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>number</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.DeliveryStatus</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains whether the event was delivered, is pending, failed to be delivered,
etc.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
<p><strong>Possible Values:</strong></p>
<p><code>0</code> - EStatusPending</p>
<p><code>1</code> - EStatusSent</p>
<p><code>2</code> - EStatusFailed</p>
<p><code>3</code> - EStatusNone</p>
<p><code>4</code> - EStatusDone</p>
<p><code>5</code> - EStatusSent</p>
<p><code>6</code> - EStatusScheduled</p>
</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>number</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.Subject</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains the subject for the event.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>string</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.PhoneNumber</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains the phone number associated with the event. </p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>string</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.Description</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains information about the type of event, such as voice call or
short message. The mobile device automatically defines this description.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>string</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.Link</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains an ID that links the log event to an entity in another application.
For example, the log event can be associated with a call ID or message ID
for emails and faxes.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>number</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.id</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains a unique identifier of the event in the log database.</p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>string</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
<p><code>&lt;item&gt;.LogFlags</code></p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
<p>Contains the flags for this event. </p>
</td>
<td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
<p>Possible values:</p>
<p><code>0</code> - EKLogEventContactSearched</p>
<div class="note"><p><strong class="note_title">Note: </strong>The EKLogEventContactSearched flag is set when the user searches the
contact database for any operation such as a voice call or SMS.</p>
</div>
<p><code>1</code> - EKLogEventRead</p>
<div class="note"><p><strong class="note_title">Note: </strong>The EKLogEventRead flag is set when the user "reads" the event in the
log database.</p>
</div>
</td>
<td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
<p>number</p>
</td>
</tr>
</tbody>
</table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>