org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-DDF5BDA7-E0DA-40EB-94E7-30824B0F4365.html
<!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="Criteria for adding a log entry"/><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-F146B956-77AE-41B5-BA17-20F48AF8DBA7"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-DDF5BDA7-E0DA-40EB-94E7-30824B0F4365"/><title>Criteria for
adding a log entry </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-DDF5BDA7-E0DA-40EB-94E7-30824B0F4365"><span>Criteria</span> for
adding a log entry</h1><div>
<p>The <code>criteria</code> object specifies what type
of device log entries are added to the event database and details about the
entry.</p>
<p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Item</code>.
These are described in the following table. Properties enclosed in brackets
are optional.</p>
<div class="tablenoborder"><a name="GUID-566F432B-5350-4223-A5C4-E6FF26CC17F0"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-566F432B-5350-4223-A5C4-E6FF26CC17F0" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e51247">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e51252">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e51257">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e51262">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>criteria.Type</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies the type of content.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<p>Possible values:</p>
<ul>
<li><p><code>"Log"</code></p></li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>criteria.Item</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies the content of the entry to add to the event log.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>criteria.Item.EventType</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies a unique identifier for the type of event.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<p><strong>Value - Description:</strong></p>
<ul>
<li><p><code>0</code> - EKLogCallEventType</p></li>
<li><p><code>1</code> - EKLogDataEventType</p></li>
<li><p><code>2</code> - EKLogFaxEventType</p></li>
<li><p><code>3</code> - EKLogShortMessageEventType</p>
</li>
<li><p><code>4</code> - EKLogPacketDataEventType</p>
</li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>[criteria.Item.RemoteParty]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies the destination of the outgoing event or the source of incoming
event.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<p>Up to 64 characters. If the length of the specified string is greater
than 64 characters, the data is truncated.</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>[criteria.Item.Direction]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies 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="25%" headers="d0e51257 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<p><strong>Value - Description:</strong></p>
<ul>
<li><p><code>0</code> - EIncomingEvent</p></li>
<li><p><code>1</code> - EOutgoingEvent</p></li>
<li><p><code>2</code> - EIncomingEventAlternateline</p>
</li>
<li><p><code>3</code> - EOutgoingEventAlternateline</p>
</li>
<li><p><code>4</code> - EFetchedEvent</p></li>
<li><p><code>5</code> - EMissedEvent</p></li>
<li><p><code>6</code> - EMissedEventAlternateline</p>
</li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>[criteria.Item.EventDuration]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies the duration of the event, in seconds.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> </td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>[criteria.Item.DeliveryStatus]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies whether the event was delivered, is pending, failed to be
delivered, etc.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<p><strong>Value - Description:</strong></p>
<ul>
<li><p><code>0</code> - EStatusPending</p></li>
<li><p><code>1</code> - EStatusSent</p></li>
<li><p><code>2</code> - EStatusFailed</p></li>
<li><p><code>3</code> - EStatusNone</p></li>
<li><p><code>4</code> - EStatusDone</p></li>
<li><p><code>5</code> - EStatusSent</p></li>
<li><p><code>6</code> - EStatusScheduled</p></li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>[criteria.Item.Subject]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies the subject for the event.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<p>Up to 64 characters. If the length of the specified string is greater
than 64 characters, the data is truncated.</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>[criteria.Item.PhoneNumber]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies the phone number associated with the event. </p>
<p>This key is specified when the number cannot be stored in any other
key. For example, if there is an entry in the contacts database for a person
named Prakash, then <code>RemoteParty</code> is specified as "Prakash"
and <code>PhoneNumber</code> is needed to specify the phone number.
If there is no entry for Prakash, <code>RemoteParty</code> is specified
as the phone number. </p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<p>Up to 100 characters. If the length of the specified string is greater
than 100 characters, the number is truncated.</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>[criteria.Item.Link]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies an ID (messageID, callID, etc) that links the event being
added to an entity in another application. </p>
<p>For example, it might be useful to link the event to an SMS messageID
so that details of the message can be displayed to the mobile device user.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> </td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e51247 ">
<p><code>[criteria.Item.LogFlags]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51252 ">
<p>Specifies the flags for this event. This method does not change any
of the other flag bit settings.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51257 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e51262 ">
<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>
</tr>
</tbody>
</table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>