|
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="ISysInfo.GetNotification()"/><meta name="DC.Relation" scheme="URI" content="GUID-BF044B8D-C16A-47DC-84F3-9103D9DCE09B"/><meta name="DC.Relation" scheme="URI" content="GUID-4347A7F1-1560-4B28-B4A8-DC570864F505"/><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-AEB26A58-1DE2-46CB-81EC-6DB3A477B7A3"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-7978FAFD-5BAC-45FD-9C44-5CF7BC484A1E"/><title>ISysInfo.GetNotification() </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-7978FAFD-5BAC-45FD-9C44-5CF7BC484A1E"><span>ISysInfo.</span>GetNotification()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetNotification</code> method notifies the client |
|
9 when the value of a <a href="GUID-B796D072-4E51-4BC7-9259-84530DB3539D.html#GUID-B796D072-4E51-4BC7-9259-84530DB3539D">system |
|
10 attribute</a> is changed.</p> |
|
11 <p>This is an asynchronous method.</p> |
|
12 <p><strong>Syntax:</strong></p> |
|
13 |
|
14 <pre class="codeblock" id="GUID-058A4EA2-A311-495C-AFEB-BA23E482DE22">result = so.ISysInfo.GetNotification(criteria, callback);</pre> |
|
15 <p><strong>Arguments:</strong></p> |
|
16 <ul> |
|
17 <li><p><code>criteria</code>:</p> |
|
18 |
|
19 <p>This is an object that specifies the system attribute to monitor for |
|
20 changes. For more information about the object properties and how to define |
|
21 them, see section <a href="GUID-ABF4EC7E-557F-4C6D-8B2C-F734A0BBC082.html#GUID-ABF4EC7E-557F-4C6D-8B2C-F734A0BBC082">Criteria for change notifications</a>.</p> |
|
22 |
|
23 </li> |
|
24 <li><p><code>callback</code>:</p> |
|
25 |
|
26 <p>The <code>callback</code> argument is the name of the method |
|
27 that is executed when a <code>GetNotification</code> call has results |
|
28 or status information to return. You must define this method separately. Follow |
|
29 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 |
|
30 define the <code>callback</code> method.</p> |
|
31 |
|
32 </li> |
|
33 </ul> |
|
34 <p><strong>Return value:</strong></p> |
|
35 <p>The <code>GetNotification</code> method returns an object that |
|
36 contains the initial return value for the asynchronous call it started (see |
|
37 the following table). The actual notification information is returned by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method |
|
38 in the <code>ReturnValue</code> property of its <a href="#GUID-C4D4A6CE-04BE-48FF-B22A-75987DDF5839">result object</a>.</p> |
|
39 <div class="tablenoborder"><a name="GUID-4E591038-D3E9-4149-865A-7237C8106C9D"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-4E591038-D3E9-4149-865A-7237C8106C9D" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
40 properties for GetNotification</caption> |
|
41 |
|
42 <thead align="left"> |
|
43 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e68618"> |
|
44 <p>Property</p> |
|
45 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e68623"> |
|
46 <p>Description</p> |
|
47 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e68628"> |
|
48 <p>Value</p> |
|
49 </th></tr> |
|
50 </thead> |
|
51 <tbody> |
|
52 <tr class=""> |
|
53 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68618 "> |
|
54 <p><code>result.TransactionID</code></p> |
|
55 </td> |
|
56 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68623 "> |
|
57 <p>This is a number used as an identification to match transactions started |
|
58 with the asynchronous <code>GetNotification</code> call to one or |
|
59 more calls it generates to <code>callback</code>.</p> |
|
60 </td> |
|
61 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68628 "> </td> |
|
62 </tr> |
|
63 <tr class="bg "> |
|
64 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68618 "> |
|
65 <p><code>result.ErrorCode</code></p> |
|
66 </td> |
|
67 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68623 "> |
|
68 <p>This is a number that specifies a predefined error code.</p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68628 "> |
|
71 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
72 </td> |
|
73 </tr> |
|
74 <tr class=""> |
|
75 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68618 "> |
|
76 <p><code>result.ErrorMessage</code></p> |
|
77 </td> |
|
78 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68623 "> |
|
79 <p>This is a text string that describes the error.</p> |
|
80 </td> |
|
81 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68628 "> |
|
82 <p>See <a href="GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1.html#GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1">SystemInfo Service API error messages</a>.</p> |
|
83 </td> |
|
84 </tr> |
|
85 </tbody> |
|
86 </table></div><div class="tablenoborder"><a name="GUID-C4D4A6CE-04BE-48FF-B22A-75987DDF5839"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-C4D4A6CE-04BE-48FF-B22A-75987DDF5839" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return |
|
87 value properties for GetNotification callback</caption> |
|
88 <thead align="left"> |
|
89 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e68723"> |
|
90 <p>Property</p> |
|
91 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e68728"> |
|
92 <p>Description</p> |
|
93 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e68733"> |
|
94 <p>Value</p> |
|
95 </th></tr> |
|
96 </thead> |
|
97 <tbody> |
|
98 <tr class=""> |
|
99 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68723 "> |
|
100 <p><code>result.ReturnValue</code></p> |
|
101 </td> |
|
102 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68728 "> |
|
103 <p>This is an object (a system attribute object) that contains the information |
|
104 for the changed system attribute.</p> |
|
105 <p>This object contains the properties <code>Entity</code> and <code>Key</code> as |
|
106 well as one or more additional properties representing the system attribute |
|
107 value. The name and type of these properties depend on the <a href="GUID-DBB90F32-C1FA-4B0C-9BCA-89177140A60D.html#GUID-DBB90F32-C1FA-4B0C-9BCA-89177140A60D">specific |
|
108 system attribute</a> and its <a href="GUID-4C79E511-1C1A-475D-BBBB-4F1F6D406340.html#GUID-4C79E511-1C1A-475D-BBBB-4F1F6D406340">system |
|
109 data type</a>.</p> |
|
110 <p>For example, if you request notification for the <code>Connectivity |
|
111 - ConnectionStatus</code> system attribute, whose system data type is <a href="GUID-4C79E511-1C1A-475D-BBBB-4F1F6D406340.html#GUID-02CAF5CE-6BCB-43E3-8981-39FA12DAB0AE"><code>ConnectionInfo</code></a>, |
|
112 callback returns the following properties:</p> |
|
113 <ul> |
|
114 <li><p><code>ReturnValue.Entity</code></p></li> |
|
115 <li><p><code>ReturnValue.Key</code></p></li> |
|
116 <li><p><code>ReturnValue.ConnectionStatus</code></p> |
|
117 </li> |
|
118 <li><p><code>ReturnValue.IAPID</code></p></li> |
|
119 <li><p><code>ReturnValue.ConnectionType</code></p></li> |
|
120 <li><p><code>ReturnValue.IAPName</code></p></li> |
|
121 <li><p><code>ReturnValue.NetworkName</code></p></li> |
|
122 <li><p><code>ReturnValue.IAPConnectionName</code></p> |
|
123 </li> |
|
124 </ul> |
|
125 </td> |
|
126 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68733 "> |
|
127 <p>See <a href="GUID-B796D072-4E51-4BC7-9259-84530DB3539D.html#GUID-B796D072-4E51-4BC7-9259-84530DB3539D">System attributes</a>.</p> |
|
128 </td> |
|
129 </tr> |
|
130 <tr class="bg "> |
|
131 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68723 "> |
|
132 <p><code>result.ErrorCode</code></p> |
|
133 </td> |
|
134 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68728 "> |
|
135 <p>This is a number that specifies a predefined error code.</p> |
|
136 </td> |
|
137 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68733 "> |
|
138 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
139 </td> |
|
140 </tr> |
|
141 <tr class=""> |
|
142 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68723 "> |
|
143 <p><code>result.ErrorMessage</code></p> |
|
144 </td> |
|
145 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68728 "> |
|
146 <p>This is a text string that describes the error.</p> |
|
147 </td> |
|
148 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e68733 "> |
|
149 <p>See <a href="GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1.html#GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1">SystemInfo Service API error messages</a>.</p> |
|
150 </td> |
|
151 </tr> |
|
152 </tbody> |
|
153 </table></div> |
|
154 <p><strong>Remarks:</strong></p> |
|
155 <ul> |
|
156 <li><p><code>GetNotification</code> returns notifications |
|
157 until cancelled with <a href="GUID-BF044B8D-C16A-47DC-84F3-9103D9DCE09B.html#GUID-BF044B8D-C16A-47DC-84F3-9103D9DCE09B"><code>Cancel</code></a>.</p></li> |
|
158 <li><p>Only some system attributes can be monitored for changes. |
|
159 To find out which system attributes support <code>GetNotification</code>, |
|
160 see section <a href="GUID-DBB90F32-C1FA-4B0C-9BCA-89177140A60D.html#GUID-DBB90F32-C1FA-4B0C-9BCA-89177140A60D">Supported system attributes (entities and keys)</a>.</p> |
|
161 </li> |
|
162 </ul> |
|
163 <p><strong>Example code:</strong></p> |
|
164 <p/> |
|
165 <p>For the complete source of a sample widget |
|
166 that demonstrates how to use this Service API, see <a href="GUID-7C9CCFF3-A6E0-4593-8315-1A0EAAFD05AF.html#GUID-7C9CCFF3-A6E0-4593-8315-1A0EAAFD05AF">the |
|
167 full example</a>.</p> |
|
168 |
|
169 |
|
170 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |