|
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="IMessaging.RegisterNotification()"/><meta name="DC.Relation" scheme="URI" content="GUID-E2FDB3FB-2B5E-430C-81B5-9C0C22C4CC04"/><meta name="DC.Relation" scheme="URI" content="GUID-5295F092-004B-43F4-85DB-7C54ED14D6DB"/><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-91579EE5-A608-401C-82B4-DCF1723EC7B5"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-DFEDF3BF-BA73-4418-815C-83B80B888821"/><title>IMessaging.RegisterNotification() </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-DFEDF3BF-BA73-4418-815C-83B80B888821"><span>IMessaging.</span>RegisterNotification()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>RegisterNotification</code> method registers the <span>widget</span> to receive notifications of new incoming messages. |
|
9 For each new message, the method returns the header information of that message.</p> |
|
10 <p>This is an asynchronous method.</p> |
|
11 <p><strong>Syntax:</strong></p> |
|
12 <pre class="codeblock" id="GUID-F06488BB-1105-4469-9B1C-95D84AB2C6AE">result = so.IMessaging.RegisterNotification(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 new |
|
19 messages. The object must contain the <code>Type</code> property (string), |
|
20 and this property must contain the value <code>"NewMessage"</code>:</p> |
|
21 <pre class="codeblock" id="GUID-B00A008F-EB4B-4094-9FF4-A60D8BCC0CF3">criteria.Type = "NewMessage";</pre> |
|
22 |
|
23 |
|
24 </li> |
|
25 <li><p><code>callback</code>:</p> |
|
26 |
|
27 <p>The <code>callback</code> argument is the name of the method |
|
28 that is executed when <code>RegisterNotification</code> has results |
|
29 or status information to return. You must define this method separately. Follow |
|
30 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 |
|
31 define the <code>callback</code> method.</p> |
|
32 |
|
33 </li> |
|
34 </ul> |
|
35 <p><strong>Return value:</strong></p> |
|
36 <p>The <code>RegisterNotification</code> method returns an object |
|
37 that contains the initial return value for the asynchronous call it started |
|
38 (see the following table). The actual notification information is returned |
|
39 by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method |
|
40 in the <code>ReturnValue</code> property of its result object. The |
|
41 returned information is described in section <a href="GUID-F7E268AD-E112-4564-BB1D-4BD1E111A767.html#GUID-F7E268AD-E112-4564-BB1D-4BD1E111A767">Returned notification information</a>.</p> |
|
42 <div class="tablenoborder"><a name="GUID-C4E9C64A-AAC1-4CB4-A42F-40A7D4A918B9"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-C4E9C64A-AAC1-4CB4-A42F-40A7D4A918B9" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
43 properties for RegisterNotification</caption> |
|
44 |
|
45 <thead align="left"> |
|
46 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e60411"> |
|
47 <p>Property</p> |
|
48 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e60416"> |
|
49 <p>Description</p> |
|
50 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e60421"> |
|
51 <p>Value</p> |
|
52 </th></tr> |
|
53 </thead> |
|
54 <tbody> |
|
55 <tr class=""> |
|
56 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60411 "> |
|
57 <p><code>result.TransactionID</code></p> |
|
58 </td> |
|
59 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60416 "> |
|
60 <p>This is a number used as an identification to match transactions started |
|
61 with a <code>RegisterNotification</code> call to one or more calls |
|
62 it generates to <code>callback</code>.</p> |
|
63 </td> |
|
64 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60421 "> </td> |
|
65 </tr> |
|
66 <tr class="bg "> |
|
67 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60411 "> |
|
68 <p><code>result.ErrorCode</code></p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60416 "> |
|
71 <p>This is a number that specifies a predefined error code.</p> |
|
72 </td> |
|
73 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60421 "> |
|
74 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
75 </td> |
|
76 </tr> |
|
77 <tr class=""> |
|
78 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60411 "> |
|
79 <p><code>result.ErrorMessage</code></p> |
|
80 </td> |
|
81 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60416 "> |
|
82 <p>This is a text string that describes the error.</p> |
|
83 </td> |
|
84 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e60421 "> |
|
85 <p>See <a href="GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A.html#GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A">Messaging Service API error messages</a>.</p> |
|
86 </td> |
|
87 </tr> |
|
88 </tbody> |
|
89 </table></div> |
|
90 <p><strong>Remarks:</strong></p> |
|
91 <p><code>RegisterNotification</code> retrieves new message updates |
|
92 until cancelled with <a href="GUID-E2FDB3FB-2B5E-430C-81B5-9C0C22C4CC04.html#GUID-E2FDB3FB-2B5E-430C-81B5-9C0C22C4CC04"><code>CancelNotification</code></a> (or <a href="GUID-2EBDD073-499C-4A1E-A0DA-4FF8243A6479.html#GUID-2EBDD073-499C-4A1E-A0DA-4FF8243A6479"><code>Cancel</code></a>). |
|
93 You can therefore have only one <code>RegisterNotification</code> call |
|
94 (one instance) pending or in use at any given time.</p> |
|
95 <p><strong>Example code:</strong></p> |
|
96 <p/> |
|
97 <p>For the complete source of a sample widget |
|
98 that demonstrates how to use this Service API, see <a href="GUID-DBF41DB5-44D7-4822-A611-FBF7DA3A8F3B.html#GUID-DBF41DB5-44D7-4822-A611-FBF7DA3A8F3B">the full example</a>.</p> |
|
99 |
|
100 |
|
101 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |