|
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 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 |
|
5 adding a log entry </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-DDF5BDA7-E0DA-40EB-94E7-30824B0F4365"><span>Criteria</span> for |
|
8 adding a log entry</h1><div> |
|
9 <p>The <code>criteria</code> object specifies what type |
|
10 of device log entries are added to the event database and details about the |
|
11 entry.</p> |
|
12 <p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Item</code>. |
|
13 These are described in the following table. Properties enclosed in brackets |
|
14 are optional.</p> |
|
15 <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> |
|
16 |
|
17 <thead align="left"> |
|
18 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e51247"> |
|
19 <p>Property</p> |
|
20 </th><th class="cellrowborder" valign="top" width="25%" id="d0e51252"> |
|
21 <p>Description</p> |
|
22 </th><th class="cellrowborder" valign="top" width="25%" id="d0e51257"> |
|
23 <p>Type</p> |
|
24 </th><th class="cellrowborder" valign="top" width="25%" id="d0e51262"> |
|
25 <p>Value</p> |
|
26 </th></tr> |
|
27 </thead> |
|
28 <tbody> |
|
29 <tr class=""> |
|
30 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
31 <p><code>criteria.Type</code></p> |
|
32 </td> |
|
33 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
34 <p>Specifies the type of content.</p> |
|
35 </td> |
|
36 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
37 <p>string</p> |
|
38 </td> |
|
39 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
40 <p>Possible values:</p> |
|
41 <ul> |
|
42 <li><p><code>"Log"</code></p></li> |
|
43 </ul> |
|
44 </td> |
|
45 </tr> |
|
46 <tr class="bg "> |
|
47 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
48 <p><code>criteria.Item</code></p> |
|
49 </td> |
|
50 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
51 <p>Specifies the content of the entry to add to the event log.</p> |
|
52 </td> |
|
53 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
54 <p>object</p> |
|
55 </td> |
|
56 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
57 <p>Object with the properties specified below</p> |
|
58 </td> |
|
59 </tr> |
|
60 <tr class=""> |
|
61 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
62 <p><code>criteria.Item.EventType</code></p> |
|
63 </td> |
|
64 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
65 <p>Specifies a unique identifier for the type of event.</p> |
|
66 </td> |
|
67 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
68 <p>number</p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
71 <p><strong>Value - Description:</strong></p> |
|
72 <ul> |
|
73 <li><p><code>0</code> - EKLogCallEventType</p></li> |
|
74 <li><p><code>1</code> - EKLogDataEventType</p></li> |
|
75 <li><p><code>2</code> - EKLogFaxEventType</p></li> |
|
76 <li><p><code>3</code> - EKLogShortMessageEventType</p> |
|
77 </li> |
|
78 <li><p><code>4</code> - EKLogPacketDataEventType</p> |
|
79 </li> |
|
80 </ul> |
|
81 </td> |
|
82 </tr> |
|
83 <tr class="bg "> |
|
84 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
85 <p><code>[criteria.Item.RemoteParty]</code></p> |
|
86 </td> |
|
87 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
88 <p>Specifies the destination of the outgoing event or the source of incoming |
|
89 event.</p> |
|
90 </td> |
|
91 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
92 <p>string</p> |
|
93 </td> |
|
94 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
95 <p>Up to 64 characters. If the length of the specified string is greater |
|
96 than 64 characters, the data is truncated.</p> |
|
97 </td> |
|
98 </tr> |
|
99 <tr class=""> |
|
100 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
101 <p><code>[criteria.Item.Direction]</code></p> |
|
102 </td> |
|
103 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
104 <p>Specifies whether the event is incoming, outgoing, or missed and if |
|
105 it came in on an alternate line.</p> |
|
106 <p>Alternate line refers to the second phone call on the mobile device. |
|
107 Alternate line values, such as <code>2</code> - EIncomingEventAlternateline, |
|
108 are valid for call events only.</p> |
|
109 </td> |
|
110 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
111 <p>number</p> |
|
112 </td> |
|
113 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
114 <p><strong>Value - Description:</strong></p> |
|
115 <ul> |
|
116 <li><p><code>0</code> - EIncomingEvent</p></li> |
|
117 <li><p><code>1</code> - EOutgoingEvent</p></li> |
|
118 <li><p><code>2</code> - EIncomingEventAlternateline</p> |
|
119 </li> |
|
120 <li><p><code>3</code> - EOutgoingEventAlternateline</p> |
|
121 </li> |
|
122 <li><p><code>4</code> - EFetchedEvent</p></li> |
|
123 <li><p><code>5</code> - EMissedEvent</p></li> |
|
124 <li><p><code>6</code> - EMissedEventAlternateline</p> |
|
125 </li> |
|
126 </ul> |
|
127 </td> |
|
128 </tr> |
|
129 <tr class="bg "> |
|
130 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
131 <p><code>[criteria.Item.EventDuration]</code></p> |
|
132 </td> |
|
133 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
134 <p>Specifies the duration of the event, in seconds.</p> |
|
135 </td> |
|
136 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
137 <p>number</p> |
|
138 </td> |
|
139 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> </td> |
|
140 </tr> |
|
141 <tr class=""> |
|
142 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
143 <p><code>[criteria.Item.DeliveryStatus]</code></p> |
|
144 </td> |
|
145 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
146 <p>Specifies whether the event was delivered, is pending, failed to be |
|
147 delivered, etc.</p> |
|
148 </td> |
|
149 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
150 <p>number</p> |
|
151 </td> |
|
152 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
153 <p><strong>Value - Description:</strong></p> |
|
154 <ul> |
|
155 <li><p><code>0</code> - EStatusPending</p></li> |
|
156 <li><p><code>1</code> - EStatusSent</p></li> |
|
157 <li><p><code>2</code> - EStatusFailed</p></li> |
|
158 <li><p><code>3</code> - EStatusNone</p></li> |
|
159 <li><p><code>4</code> - EStatusDone</p></li> |
|
160 <li><p><code>5</code> - EStatusSent</p></li> |
|
161 <li><p><code>6</code> - EStatusScheduled</p></li> |
|
162 </ul> |
|
163 </td> |
|
164 </tr> |
|
165 <tr class="bg "> |
|
166 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
167 <p><code>[criteria.Item.Subject]</code></p> |
|
168 </td> |
|
169 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
170 <p>Specifies the subject for the event.</p> |
|
171 </td> |
|
172 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
173 <p>string</p> |
|
174 </td> |
|
175 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
176 <p>Up to 64 characters. If the length of the specified string is greater |
|
177 than 64 characters, the data is truncated.</p> |
|
178 </td> |
|
179 </tr> |
|
180 <tr class=""> |
|
181 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
182 <p><code>[criteria.Item.PhoneNumber]</code></p> |
|
183 </td> |
|
184 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
185 <p>Specifies the phone number associated with the event. </p> |
|
186 <p>This key is specified when the number cannot be stored in any other |
|
187 key. For example, if there is an entry in the contacts database for a person |
|
188 named Prakash, then <code>RemoteParty</code> is specified as "Prakash" |
|
189 and <code>PhoneNumber</code> is needed to specify the phone number. |
|
190 If there is no entry for Prakash, <code>RemoteParty</code> is specified |
|
191 as the phone number. </p> |
|
192 </td> |
|
193 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
194 <p>string</p> |
|
195 </td> |
|
196 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
197 <p>Up to 100 characters. If the length of the specified string is greater |
|
198 than 100 characters, the number is truncated.</p> |
|
199 </td> |
|
200 </tr> |
|
201 <tr class="bg "> |
|
202 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
203 <p><code>[criteria.Item.Link]</code></p> |
|
204 </td> |
|
205 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
206 <p>Specifies an ID (messageID, callID, etc) that links the event being |
|
207 added to an entity in another application. </p> |
|
208 <p>For example, it might be useful to link the event to an SMS messageID |
|
209 so that details of the message can be displayed to the mobile device user.</p> |
|
210 </td> |
|
211 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
212 <p>number</p> |
|
213 </td> |
|
214 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> </td> |
|
215 </tr> |
|
216 <tr class=""> |
|
217 <td class="cellrowborder" valign="top" width="25%" headers="d0e51247 "> |
|
218 <p><code>[criteria.Item.LogFlags]</code></p> |
|
219 </td> |
|
220 <td class="cellrowborder" valign="top" width="25%" headers="d0e51252 "> |
|
221 <p>Specifies the flags for this event. This method does not change any |
|
222 of the other flag bit settings.</p> |
|
223 </td> |
|
224 <td class="cellrowborder" valign="top" width="25%" headers="d0e51257 "> |
|
225 <p>number</p> |
|
226 </td> |
|
227 <td class="cellrowborder" valign="top" width="25%" headers="d0e51262 "> |
|
228 <p>Possible values:</p> |
|
229 <p><code>0</code> - EKLogEventContactSearched</p> |
|
230 <div class="note"><p><strong class="note_title">Note: </strong>The EKLogEventContactSearched flag is set when the user searches the |
|
231 contact database for any operation such as a voice call or SMS.</p> |
|
232 </div> |
|
233 <p><code>1</code> - EKLogEventRead</p> |
|
234 <div class="note"><p><strong class="note_title">Note: </strong>The EKLogEventRead flag is set when the user "reads" the event in the |
|
235 log database.</p> |
|
236 </div> |
|
237 </td> |
|
238 </tr> |
|
239 </tbody> |
|
240 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |