|
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="Criteria for retrieving log events"/><meta name="DC.Relation" scheme="URI" content="GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C"/><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-258A8E34-56F4-4BF2-8C94-F7BB7FAE71F8"/><title>Criteria for |
|
5 retrieving log events </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-258A8E34-56F4-4BF2-8C94-F7BB7FAE71F8"><span>Criteria</span> for |
|
8 retrieving log events</h1><div> |
|
9 <p>The <code>criteria</code> object specifies what log event |
|
10 information is returned.</p> |
|
11 <p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Filter</code>. |
|
12 These are described in the following table. Properties enclosed in brackets |
|
13 are optional.</p> |
|
14 <div class="tablenoborder"><a name="GUID-6AD9C1FD-A522-4FD8-8521-A1940AA67167"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-6AD9C1FD-A522-4FD8-8521-A1940AA67167" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption> |
|
15 <thead align="left"> |
|
16 <tr class="title "><th class="cellrowborder" valign="top" id="d0e52189"> |
|
17 <p>Property</p> |
|
18 </th><th class="cellrowborder" valign="top" id="d0e52194"> |
|
19 <p>Description</p> |
|
20 </th><th class="cellrowborder" valign="top" id="d0e52199"> |
|
21 <p>Type</p> |
|
22 </th><th class="cellrowborder" valign="top" id="d0e52204"> |
|
23 <p>Value</p> |
|
24 </th></tr> |
|
25 </thead> |
|
26 <tbody> |
|
27 <tr class=""> |
|
28 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
29 <p><code>criteria.Type</code></p> |
|
30 </td> |
|
31 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
32 <p>Specifies the type of content.</p> |
|
33 </td> |
|
34 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
35 <p>string</p> |
|
36 </td> |
|
37 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
38 <p>Possible values:</p> |
|
39 <ul> |
|
40 <li><p><code>"Log"</code></p></li> |
|
41 </ul> |
|
42 </td> |
|
43 </tr> |
|
44 <tr class="bg "> |
|
45 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
46 <p><code>[criteria.Filter]</code></p> |
|
47 </td> |
|
48 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
49 <p>Specifies the criteria to search for specific events in the log database.</p> |
|
50 <p>If <code>Filter</code> is not specified, all of the events from |
|
51 the log database are retrieved.</p> |
|
52 </td> |
|
53 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
54 <p>object</p> |
|
55 </td> |
|
56 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
57 <p>Object with the properties specified below</p> |
|
58 </td> |
|
59 </tr> |
|
60 <tr class=""> |
|
61 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
62 <p><code>[criteria.Filter.id]</code></p> |
|
63 </td> |
|
64 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
65 <p>Specifies a unique identifier of an event in the log database.</p> |
|
66 <div class="note"><p><strong class="note_title">Note: </strong>When <code>[id]</code> is specified, all other keys are ignored.</p> |
|
67 </div> |
|
68 </td> |
|
69 <td class="cellrowborder" valign="top" headers="d0e52199 "> </td> |
|
70 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
71 <p>string</p> |
|
72 </td> |
|
73 </tr> |
|
74 <tr class="bg "> |
|
75 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
76 <p><code>[criteria.Filter.RecentList]</code></p> |
|
77 </td> |
|
78 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
79 <p>Creates a view of the most recent 20 events in the specified recent |
|
80 call list. The recent call list derives from recent log entries (a subset |
|
81 of all log entries). </p> |
|
82 <p>On successful completion, the view is positioned at the first (most |
|
83 recent) event in the recent call list.</p> |
|
84 <p>Recent lists do not contain individual entries for duplicate events, |
|
85 such as two outgoing calls to the same number. </p> |
|
86 <div class="note"><p><strong class="note_title">Note: </strong>When <code>[RecentList]</code> is specified, all other keys |
|
87 are ignored. If <code>[id]</code> is specified, it takes precedence |
|
88 and <code>[RecentList]</code> is ignored.</p> |
|
89 </div> |
|
90 </td> |
|
91 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
92 <p><strong>Value - Description:</strong></p> |
|
93 <p><code>-1</code> - EKLogNullRecentList</p> |
|
94 <p><code>1</code> - EKLogRecentIncomingCalls</p> |
|
95 <p><code>2</code> - EKLogRecentOutgoingCalls</p> |
|
96 <p><code>3</code> - EKLogRecentMissedCalls</p> |
|
97 <p>A value of <code>-1</code> - EKLogNullRecentList results in |
|
98 a view that includes events from all of the recent event lists.</p> |
|
99 </td> |
|
100 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
101 <p>number</p> |
|
102 </td> |
|
103 </tr> |
|
104 <tr class=""> |
|
105 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
106 <p><code>[criteria.Filter.EventType]</code></p> |
|
107 </td> |
|
108 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
109 <p>Specifies a unique identifier for the type of event; such as call, fax, |
|
110 etc.</p> |
|
111 </td> |
|
112 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
113 <p><strong>Value - Description:</strong></p> |
|
114 <p><code>0</code> - EKLogCallEventType</p> |
|
115 <p><code>1</code> - EKLogDataEventType</p> |
|
116 <p><code>2</code> - EKLogFaxEventType</p> |
|
117 <p><code>3</code> - EKLogShortMessageEventType</p> |
|
118 <p><code>4</code> - EKLogPacketDataEventType</p> |
|
119 </td> |
|
120 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
121 <p>number</p> |
|
122 </td> |
|
123 </tr> |
|
124 <tr class="bg "> |
|
125 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
126 <p><code>[criteria.Filter.PhoneNumber]</code></p> |
|
127 </td> |
|
128 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
129 <p>Specifies the phone number associated with the event. </p> |
|
130 <div class="note"><p><strong class="note_title">Note: </strong>This is used when the number cannot be stored in any other key. For |
|
131 example, if there is an entry in the contacts database for a person named |
|
132 Prakash, then <code>RemoteParty</code> is specified as "Prakash" and <code>PhoneNumber</code> is |
|
133 needed to specify the phone number. If there is no entry for Prakash, <code>RemoteParty</code> is |
|
134 specified as the phone number.</p> |
|
135 </div> |
|
136 </td> |
|
137 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
138 <p>Up to 100 characters. If the length of the specified string is greater |
|
139 than 100 characters, the number is truncated.</p> |
|
140 </td> |
|
141 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
142 <p>string</p> |
|
143 </td> |
|
144 </tr> |
|
145 <tr class=""> |
|
146 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
147 <p><code>[criteria.Filter.RemoteParty]</code></p> |
|
148 </td> |
|
149 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
150 <p>Specifies the destination of the outgoing event or the source of incoming |
|
151 event.</p> |
|
152 </td> |
|
153 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
154 <p>Up to 64 characters. If the length of the specified string is greater |
|
155 than 64 characters, the data is truncated.</p> |
|
156 </td> |
|
157 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
158 <p>string</p> |
|
159 </td> |
|
160 </tr> |
|
161 <tr class="bg "> |
|
162 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
163 <p><code>[criteria.Filter.Direction]</code></p> |
|
164 </td> |
|
165 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
166 <p>Specifies whether the event is incoming, outgoing, or missed and if |
|
167 it came in on an alternate line.</p> |
|
168 <p>Alternate line refers to the second phone call on the mobile device. |
|
169 Alternate line values, such as <code>2</code> - EIncomingEventAlternateline, |
|
170 are valid for call events only.</p> |
|
171 </td> |
|
172 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
173 <p><strong>Value - Description:</strong></p> |
|
174 <p><code>0</code> - EIncomingEvent</p> |
|
175 <p><code>1</code> - EOutgoingEvent</p> |
|
176 <p><code>2</code> - EIncomingEventAlternateline</p> |
|
177 <p><code>3</code> - EOutgoingEventAlternateline</p> |
|
178 <p><code>4</code> - EFetchedEvent</p> |
|
179 <p><code>5</code> - EMissedEvent</p> |
|
180 <p><code>6</code> - EMissedEventAlternateline</p> |
|
181 </td> |
|
182 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
183 <p>number</p> |
|
184 </td> |
|
185 </tr> |
|
186 <tr class=""> |
|
187 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
188 <p><code>[criteria.Filter.DeliveryStatus]</code></p> |
|
189 </td> |
|
190 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
191 <p>Specifies whether the event was delivered, is pending, failed to be |
|
192 delivered, etc.</p> |
|
193 </td> |
|
194 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
195 <p><strong>Value - Description:</strong></p> |
|
196 <p><code>0</code> - EStatusPending</p> |
|
197 <p><code>1</code> - EStatusSent</p> |
|
198 <p><code>2</code> - EStatusFailed</p> |
|
199 <p><code>3</code> - EStatusNone</p> |
|
200 <p><code>4</code> - EStatusDone</p> |
|
201 <p><code>5</code> - EStatusSent</p> |
|
202 <p><code>6</code> - EStatusScheduled</p> |
|
203 </td> |
|
204 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
205 <p>number</p> |
|
206 </td> |
|
207 </tr> |
|
208 <tr class="bg "> |
|
209 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
210 <p><code>[criteria.Filter.EndTime]</code></p> |
|
211 </td> |
|
212 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
213 <p>Events added to the log after this time will not be retrieved.</p> |
|
214 </td> |
|
215 <td class="cellrowborder" valign="top" headers="d0e52199 "> </td> |
|
216 <td class="cellrowborder" valign="top" headers="d0e52204 "> |
|
217 <p>date object</p> |
|
218 </td> |
|
219 </tr> |
|
220 <tr class=""> |
|
221 <td class="cellrowborder" valign="top" headers="d0e52189 "> |
|
222 <p><code>[criteria.Filter.LogFlags]</code></p> |
|
223 </td> |
|
224 <td class="cellrowborder" valign="top" headers="d0e52194 "> |
|
225 <p>Specifies the flags for this event. This method does not change any |
|
226 other flag bit settings.</p> |
|
227 </td> |
|
228 <td class="cellrowborder" valign="top" headers="d0e52199 "> |
|
229 <p><strong>Value - Description:</strong></p> |
|
230 <p><code>0</code> - EKLogEventContactSearched</p> |
|
231 <div class="note"><p><strong class="note_title">Note: </strong>The EKLogEventContactSearched flag is set when the user searches the |
|
232 contact database for any operation such as a voice call or SMS.</p> |
|
233 </div> |
|
234 <p><code>1</code> - EKLogEventRead</p> |
|
235 <div class="note"><p><strong class="note_title">Note: </strong>The EKLogEventRead flag is set when the user "reads" the event in the |
|
236 log database.</p> |
|
237 </div> |
|
238 </td> |
|
239 <td class="cellrowborder" valign="top" headers="d0e52204 "> </td> |
|
240 </tr> |
|
241 </tbody> |
|
242 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |