org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C.html
changeset 229 716254ccbcc0
equal deleted inserted replaced
228:913c9751c067 229:716254ccbcc0
       
     1 
       
     2 <!DOCTYPE html
       
     3   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 <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
       
     5 log event information </title><script type="text/javascript">
       
     6       function initPage() {}
       
     7     </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
       
     8 log event information</h1><div>
       
     9 <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
       
    10 and by <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> for
       
    11 an asynchronous <code>GelList</code> call is an iterator containing
       
    12 information about the requested entries in the event log. Each item (object)
       
    13 in the iterator corresponds to one entry in the event log.</p>
       
    14 <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
       
    15 for entries in the event log</caption>
       
    16 <thead align="left">
       
    17 <tr class="title "><th class="cellrowborder" valign="top" width="24.561403508771928%" id="d0e52780">
       
    18 <p>Property</p>
       
    19 </th><th class="cellrowborder" valign="top" width="24.561403508771928%" id="d0e52785">
       
    20 <p>Description</p>
       
    21 </th><th class="cellrowborder" valign="top" width="24.561403508771928%" id="d0e52790">
       
    22 <p>Value type</p>
       
    23 </th><th class="cellrowborder" valign="top" width="26.31578947368421%" id="d0e52795">
       
    24 <p>Type</p>
       
    25 </th></tr>
       
    26 </thead>
       
    27 <tbody>
       
    28 <tr class="">
       
    29 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
    30 <p><code>&lt;item&gt;.EventType</code></p>
       
    31 </td>
       
    32 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
    33 <p>Contains a unique identifier for the type of entry.</p>
       
    34 </td>
       
    35 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
       
    36 <p><strong>Possible values:</strong></p>
       
    37 <p><code>0</code> - EKLogCallEventType</p>
       
    38 <p><code>1</code> - EKLogDataEventType</p>
       
    39 <p><code>2</code> - EKLogFaxEventType</p>
       
    40 <p><code>3</code> - EKLogShortMessageEventType</p>
       
    41 <p><code>4</code> - EKLogPacketDataEventType</p>
       
    42 </td>
       
    43 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
    44 <p>number</p>
       
    45 </td>
       
    46 </tr>
       
    47 <tr class="bg ">
       
    48 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
    49 <p><code>&lt;item&gt;.RemoteParty</code></p>
       
    50 </td>
       
    51 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
    52 <p>Contains the destination of the outgoing event or the source of incoming
       
    53 event.</p>
       
    54 </td>
       
    55 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
       
    56 <p>Up to 64 characters. If the length of the specified string is greater
       
    57 than 64 characters, the data is truncated.</p>
       
    58 </td>
       
    59 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
    60 <p>string</p>
       
    61 </td>
       
    62 </tr>
       
    63 <tr class="">
       
    64 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
    65 <p><code>&lt;item&gt;.Direction</code></p>
       
    66 </td>
       
    67 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
    68 <p>Contains whether the event is incoming, outgoing, or missed and if it
       
    69 came in on an alternate line.</p>
       
    70 <p>Alternate line refers to the second phone call on the mobile device.
       
    71 Alternate line values, such as <code>2</code> - EIncomingEventAlternateline,
       
    72 are valid for call events only.</p>
       
    73 </td>
       
    74 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
       
    75 <p><strong>Possible values:</strong></p>
       
    76 <p><code>0</code> - EIncomingEvent</p>
       
    77 <p><code>1</code> - EOutgoingEvent</p>
       
    78 <p><code>2</code> - EIncomingEventAlternateline</p>
       
    79 <p><code>3</code> - EOutgoingEventAlternateline</p>
       
    80 <p><code>4</code> - EFetchedEvent</p>
       
    81 <p><code>5</code> - EMissedEvent</p>
       
    82 <p><code>6</code> - EMissedEventAlternateline</p>
       
    83 </td>
       
    84 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
    85 <p>number</p>
       
    86 </td>
       
    87 </tr>
       
    88 <tr class="bg ">
       
    89 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
    90 <p><code>&lt;item&gt;.EventTime</code></p>
       
    91 </td>
       
    92 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
    93 <p>Contains the time at which the event was created. The mobile device
       
    94 automatically sets this time.</p>
       
    95 </td>
       
    96 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
       
    97 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
    98 <p>string</p>
       
    99 </td>
       
   100 </tr>
       
   101 <tr class="">
       
   102 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
   103 <p><code>&lt;item&gt;.EventDuration</code></p>
       
   104 </td>
       
   105 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
   106 <p>Contains the duration of the event, in seconds.</p>
       
   107 </td>
       
   108 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
       
   109 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
   110 <p>number</p>
       
   111 </td>
       
   112 </tr>
       
   113 <tr class="bg ">
       
   114 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
   115 <p><code>&lt;item&gt;.DeliveryStatus</code></p>
       
   116 </td>
       
   117 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
   118 <p>Contains whether the event was delivered, is pending, failed to be delivered,
       
   119 etc.</p>
       
   120 </td>
       
   121 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
       
   122 <p><strong>Possible Values:</strong></p>
       
   123 <p><code>0</code> - EStatusPending</p>
       
   124 <p><code>1</code> - EStatusSent</p>
       
   125 <p><code>2</code> - EStatusFailed</p>
       
   126 <p><code>3</code> - EStatusNone</p>
       
   127 <p><code>4</code> - EStatusDone</p>
       
   128 <p><code>5</code> - EStatusSent</p>
       
   129 <p><code>6</code> - EStatusScheduled</p>
       
   130 </td>
       
   131 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
   132 <p>number</p>
       
   133 </td>
       
   134 </tr>
       
   135 <tr class="">
       
   136 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
   137 <p><code>&lt;item&gt;.Subject</code></p>
       
   138 </td>
       
   139 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
   140 <p>Contains the subject for the event.</p>
       
   141 </td>
       
   142 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
       
   143 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
   144 <p>string</p>
       
   145 </td>
       
   146 </tr>
       
   147 <tr class="bg ">
       
   148 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
   149 <p><code>&lt;item&gt;.PhoneNumber</code></p>
       
   150 </td>
       
   151 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
   152 <p>Contains the phone number associated with the event. </p>
       
   153 </td>
       
   154 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
       
   155 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
   156 <p>string</p>
       
   157 </td>
       
   158 </tr>
       
   159 <tr class="">
       
   160 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
   161 <p><code>&lt;item&gt;.Description</code></p>
       
   162 </td>
       
   163 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
   164 <p>Contains information about the type of event, such as voice call or
       
   165 short message. The mobile device automatically defines this description.</p>
       
   166 </td>
       
   167 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
       
   168 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
   169 <p>string</p>
       
   170 </td>
       
   171 </tr>
       
   172 <tr class="bg ">
       
   173 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
   174 <p><code>&lt;item&gt;.Link</code></p>
       
   175 </td>
       
   176 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
   177 <p>Contains an ID that links the log event to an entity in another application.
       
   178 For example, the log event can be associated with a call ID or message ID
       
   179 for emails and faxes.</p>
       
   180 </td>
       
   181 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
       
   182 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
   183 <p>number</p>
       
   184 </td>
       
   185 </tr>
       
   186 <tr class="">
       
   187 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
   188 <p><code>&lt;item&gt;.id</code></p>
       
   189 </td>
       
   190 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
   191 <p>Contains a unique identifier of the event in the log database.</p>
       
   192 </td>
       
   193 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">&nbsp;</td>
       
   194 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
   195 <p>string</p>
       
   196 </td>
       
   197 </tr>
       
   198 <tr class="bg ">
       
   199 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52780 ">
       
   200 <p><code>&lt;item&gt;.LogFlags</code></p>
       
   201 </td>
       
   202 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52785 ">
       
   203 <p>Contains the flags for this event. </p>
       
   204 </td>
       
   205 <td class="cellrowborder" valign="top" width="24.561403508771928%" headers="d0e52790 ">
       
   206 <p>Possible values:</p>
       
   207 <p><code>0</code> - EKLogEventContactSearched</p>
       
   208 <div class="note"><p><strong class="note_title">Note: </strong>The EKLogEventContactSearched flag is set when the user searches the
       
   209 contact database for any operation such as a voice call or SMS.</p>
       
   210 </div>
       
   211 <p><code>1</code> - EKLogEventRead</p>
       
   212 <div class="note"><p><strong class="note_title">Note: </strong>The EKLogEventRead flag is set when the user "reads" the event in the
       
   213 log database.</p>
       
   214 </div>
       
   215 </td>
       
   216 <td class="cellrowborder" valign="top" width="26.31578947368421%" headers="d0e52795 ">
       
   217 <p>number</p>
       
   218 </td>
       
   219 </tr>
       
   220 </tbody>
       
   221 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>