|
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="IDataSource.RequestNotification()"/><meta name="DC.Relation" scheme="URI" content="GUID-043C7578-485F-4186-830F-013223A156D1"/><meta name="DC.Relation" scheme="URI" content="GUID-0022AED9-7B79-4C96-B82E-8B1EDF455E1D"/><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.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-894E87F7-7146-44DD-8CAF-60F7C446B0D8"/><title>IDataSource.RequestNotification() </title><script type="text/javascript"> |
|
5 function initPage() {} |
|
6 </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-894E87F7-7146-44DD-8CAF-60F7C446B0D8"><span>IDataSource.</span>RequestNotification()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>RequestNotification</code> method registers the <span>widget</span> to receive notifications of changes to the event |
|
9 log.</p> |
|
10 <p>This is an asynchronous method.</p> |
|
11 <p><strong>Syntax:</strong></p> |
|
12 <pre class="codeblock" id="GUID-AC8635A2-D9EC-4A09-A3A3-B7B767C99DEF">result = so.IDataSource.RequestNotification(criteria, callback);</pre> |
|
13 |
|
14 <p><strong>Arguments:</strong></p> |
|
15 <ul> |
|
16 <li><p><code>criteria</code>:</p> |
|
17 |
|
18 <p>This is an object that specifies the request for notification of changes |
|
19 to the event log. For more information about the object properties and how |
|
20 to define them, see section <a href="GUID-4F84676A-16EE-4A66-A6DC-67A57001A565.html#GUID-4F84676A-16EE-4A66-A6DC-67A57001A565">Criteria for requesting notification</a>.</p> |
|
21 |
|
22 </li> |
|
23 <li><p><code>callback</code>:</p> |
|
24 |
|
25 <p>The <code>callback</code> argument is the name of the method |
|
26 that is executed when an asynchronous <code>RequestNotification</code> call |
|
27 has results or status information to return. You must define this method separately. |
|
28 Follow the instructions in section <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608">Defining the callback handler for an asynchronous method</a> to |
|
29 define the <code>callback</code> method.</p> |
|
30 |
|
31 </li> |
|
32 </ul> |
|
33 <p><strong>Return value:</strong></p> |
|
34 <p>The <code>RequestNotification</code> method returns an object |
|
35 that contains a transaction ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance, |
|
36 an error code, and an error message (see the following table). When the asynchronous |
|
37 call has completed, <code>callback</code> returns an object that contains |
|
38 an error code and an error message (see <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-E43BC9EA-3EBE-4C7F-A57E-A1C33BB01CF4">Table: |
|
39 Callback return value</a>).</p> |
|
40 <div class="tablenoborder"><a name="GUID-1903FF1D-3AEE-466C-863A-9556D5B17225"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-1903FF1D-3AEE-466C-863A-9556D5B17225" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
41 properties for an asynchronous RequestNotification</caption> |
|
42 |
|
43 <thead align="left"> |
|
44 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53881"> |
|
45 <p>Property</p> |
|
46 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53886"> |
|
47 <p>Description</p> |
|
48 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53891"> |
|
49 <p>Value</p> |
|
50 </th></tr> |
|
51 </thead> |
|
52 <tbody> |
|
53 <tr class=""> |
|
54 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53881 "> |
|
55 <p><code>result.TransactionID</code></p> |
|
56 </td> |
|
57 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53886 "> |
|
58 <p>This is a number used as an identification to match transactions started |
|
59 with the asynchronous <code>GetList</code> call to one or more calls |
|
60 it generates to <code>callback</code>.</p> |
|
61 <p>This property is only valid for asynchronous calls.</p> |
|
62 </td> |
|
63 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53891 "> </td> |
|
64 </tr> |
|
65 <tr class="bg "> |
|
66 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53881 "> |
|
67 <p><code>result.ErrorCode</code></p> |
|
68 </td> |
|
69 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53886 "> |
|
70 <p>This is a number that specifies a predefined error code.</p> |
|
71 </td> |
|
72 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53891 "> |
|
73 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
74 </td> |
|
75 </tr> |
|
76 <tr class=""> |
|
77 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53881 "> |
|
78 <p><code>result.ErrorMessage</code></p> |
|
79 </td> |
|
80 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53886 "> |
|
81 <p>This is a text string that describes the error.</p> |
|
82 </td> |
|
83 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53891 "> |
|
84 <p>See <a href="GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6.html#GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6">Logging Service API error messages</a>.</p> |
|
85 </td> |
|
86 </tr> |
|
87 </tbody> |
|
88 </table></div> |
|
89 <p><strong>Example code:</strong></p> |
|
90 <p/> |
|
91 <p>For the complete source of a sample widget |
|
92 that demonstrates how to use this Service API, see <a href="GUID-9C85B403-6CFC-4E17-A2B2-AD1AD2F7794D.html#GUID-9C85B403-6CFC-4E17-A2B2-AD1AD2F7794D">the |
|
93 full example</a>.</p> |
|
94 |
|
95 |
|
96 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |