|
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="Returned contact information"/><meta name="DC.Relation" scheme="URI" content="GUID-06C803FE-DD16-44B5-B9C7-2EC9D497D425"/><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-A5853293-7B83-4CCE-9C29-B2B8F0CD8A18"/><meta name="DC.Relation" scheme="URI" content="GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-CD495D49-E492-4E88-833D-29EF222B097F"/><title>Returned |
|
5 contact information </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-CD495D49-E492-4E88-833D-29EF222B097F">Returned |
|
8 contact information</h1><div> |
|
9 <p>The <code>ReturnValue</code> property returned by a synchronous <a href="GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007.html#GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"><code>GetList</code></a> call |
|
10 and by <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> for |
|
11 an asynchronous <code>GetList</code> call is an iterator containing |
|
12 the requested contact information. Each item (object) in the iterator corresponds |
|
13 to one contact, contact group, or contacts database, depending on <a href="GUID-06C803FE-DD16-44B5-B9C7-2EC9D497D425.html#GUID-06C803FE-DD16-44B5-B9C7-2EC9D497D425">what |
|
14 type of contact information was requested</a>:</p> |
|
15 <ul> |
|
16 <li><p><a href="#GUID-416686B8-301C-4D47-89B7-E22813FBF9AB">Table: |
|
17 ReturnValue properties for a contact</a> describes the information returned |
|
18 per <strong>contact</strong>. The contact details are contained in one or more keys, |
|
19 with each key representing a specific piece of information.</p></li> |
|
20 <li><p><a href="#GUID-692CB508-902B-4DF3-B31E-D4E45C901AE0">Table: |
|
21 ReturnValue properties for a contact group</a> describes the information |
|
22 returned per <strong>contact group</strong>.</p></li> |
|
23 <li><p><a href="#GUID-316C6D3D-718D-4738-9643-7AD9D585AFBF">Table: |
|
24 ReturnValue properties for a contacts database</a> describes the information |
|
25 returned per <strong>contacts database</strong>.</p></li> |
|
26 </ul> |
|
27 <div class="tablenoborder"><a name="GUID-416686B8-301C-4D47-89B7-E22813FBF9AB"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-416686B8-301C-4D47-89B7-E22813FBF9AB" frame="border" border="1" rules="all"><caption><strong>Table: </strong>ReturnValue properties |
|
28 for a contact</caption> |
|
29 |
|
30 <thead align="left"> |
|
31 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31329"> |
|
32 <p>Property</p> |
|
33 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31334"> |
|
34 <p>Description</p> |
|
35 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31339"> |
|
36 <p>Type</p> |
|
37 </th></tr> |
|
38 </thead> |
|
39 <tbody> |
|
40 <tr class=""> |
|
41 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31329 "> |
|
42 <p><code><item>.id</code></p> |
|
43 </td> |
|
44 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31334 "> |
|
45 <p>Unique identifier of the contact.</p> |
|
46 </td> |
|
47 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31339 "> |
|
48 <p>string</p> |
|
49 </td> |
|
50 </tr> |
|
51 <tr class="bg "> |
|
52 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31329 "> |
|
53 <p><code><item>.<key></code></p> |
|
54 </td> |
|
55 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31334 "> |
|
56 <p>Each key represents one piece of contact information, such as first |
|
57 name, last name, home phone number, or email address. For each contact, <code>GetList</code> returns |
|
58 as many keys as has been defined for that contact.</p> |
|
59 <p>For example:</p> |
|
60 <ul> |
|
61 <li><p><code><item>.FirstName</code></p></li> |
|
62 <li><p><code><item>.LastName</code></p></li> |
|
63 <li><p><code><item>.LandPhoneHome</code></p></li> |
|
64 <li><p><code><item>.EmailHome</code></p></li> |
|
65 </ul> |
|
66 <p>For a list of supported keys, see section <a href="GUID-686FDCE2-4487-4402-8347-875350D30163.html#GUID-686FDCE2-4487-4402-8347-875350D30163">Supported contact keys</a>.</p> |
|
67 </td> |
|
68 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31339 "> |
|
69 <p>object</p> |
|
70 </td> |
|
71 </tr> |
|
72 <tr class=""> |
|
73 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31329 "> |
|
74 <p><code><item>.<key>.Label</code></p> |
|
75 </td> |
|
76 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31334 "> |
|
77 <p>Label that describes the key value.</p> |
|
78 </td> |
|
79 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31339 "> |
|
80 <p>string</p> |
|
81 </td> |
|
82 </tr> |
|
83 <tr class="bg "> |
|
84 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31329 "> |
|
85 <p><code><item>.<key>.Value</code></p> |
|
86 </td> |
|
87 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31334 "> |
|
88 <p>Value defined for the key.</p> |
|
89 </td> |
|
90 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31339 "> |
|
91 <p>string</p> |
|
92 </td> |
|
93 </tr> |
|
94 <tr class=""> |
|
95 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31329 "> |
|
96 <p><code>[<item>.<key>.Next]</code></p> |
|
97 </td> |
|
98 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31334 "> |
|
99 <p>This is an object that represents an additional value defined for the |
|
100 key. This object contains the same properties as a key: <code>Label</code>, <code>Value</code>, |
|
101 and optionally <code>Next</code>, where <code>Next</code> is |
|
102 an object identical to this one, representing yet another value defined for |
|
103 the same key.</p> |
|
104 <p>There is no limit to how many nested values a key can contain.</p> |
|
105 <p>For example, an <code>EmailHome</code> key with two values (two |
|
106 email addresses) has the following property structure:</p> |
|
107 <ul> |
|
108 <li><p><code><item>.EmailHome</code></p></li> |
|
109 <li><p><code><item>.EmailHome.Label</code></p></li> |
|
110 <li><p><code><item>.EmailHome.Value</code></p></li> |
|
111 <li><p><code><item>.EmailHome.Next</code></p></li> |
|
112 <li><p><code><item>.EmailHome.Next.Label</code></p> |
|
113 </li> |
|
114 <li><p><code><item>.EmailHome.Next.Value</code></p> |
|
115 </li> |
|
116 </ul> |
|
117 <p>The first email address is contained in <code><item>.EmailHome.Value</code> and |
|
118 the second one in <code><item>.EmailHome.Next.Value</code>.</p> |
|
119 </td> |
|
120 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31339 "> |
|
121 <p>object</p> |
|
122 </td> |
|
123 </tr> |
|
124 </tbody> |
|
125 </table></div><div class="tablenoborder"><a name="GUID-692CB508-902B-4DF3-B31E-D4E45C901AE0"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-692CB508-902B-4DF3-B31E-D4E45C901AE0" frame="border" border="1" rules="all"><caption><strong>Table: </strong>ReturnValue |
|
126 properties for a contact group</caption> |
|
127 |
|
128 <thead align="left"> |
|
129 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31572"> |
|
130 <p>Property</p> |
|
131 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31577"> |
|
132 <p>Description</p> |
|
133 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31582"> |
|
134 <p>Type</p> |
|
135 </th></tr> |
|
136 </thead> |
|
137 <tbody> |
|
138 <tr class=""> |
|
139 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31572 "> |
|
140 <p><code><item>.id</code></p> |
|
141 </td> |
|
142 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31577 "> |
|
143 <p>Unique identifier of the contact group.</p> |
|
144 </td> |
|
145 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31582 "> |
|
146 <p>string</p> |
|
147 </td> |
|
148 </tr> |
|
149 <tr class="bg "> |
|
150 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31572 "> |
|
151 <p><code><item>.GroupLabel</code></p> |
|
152 </td> |
|
153 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31577 "> |
|
154 <p>Name of the group.</p> |
|
155 </td> |
|
156 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31582 "> |
|
157 <p>string</p> |
|
158 </td> |
|
159 </tr> |
|
160 <tr class=""> |
|
161 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31572 "> |
|
162 <p><code><item>.Contents</code></p> |
|
163 </td> |
|
164 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31577 "> |
|
165 <p>Contains the IDs of the contacts that belong to the group.</p> |
|
166 <p><code>Contents[0]</code> contains the ID of the first listed |
|
167 contact.</p> |
|
168 </td> |
|
169 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31582 "> |
|
170 <p>array of strings</p> |
|
171 </td> |
|
172 </tr> |
|
173 </tbody> |
|
174 </table></div><div class="tablenoborder"><a name="GUID-316C6D3D-718D-4738-9643-7AD9D585AFBF"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-316C6D3D-718D-4738-9643-7AD9D585AFBF" frame="border" border="1" rules="all"><caption><strong>Table: </strong>ReturnValue |
|
175 properties for a contacts database</caption> |
|
176 |
|
177 <thead align="left"> |
|
178 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31677"> |
|
179 <p>Property</p> |
|
180 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31682"> |
|
181 <p>Description</p> |
|
182 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31687"> |
|
183 <p>Type</p> |
|
184 </th></tr> |
|
185 </thead> |
|
186 <tbody> |
|
187 <tr class=""> |
|
188 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31677 "> |
|
189 <p><code><item>.DBUri</code></p> |
|
190 </td> |
|
191 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31682 "> |
|
192 <p>URI of the contacts database.</p> |
|
193 </td> |
|
194 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31687 "> |
|
195 <p>string</p> |
|
196 </td> |
|
197 </tr> |
|
198 </tbody> |
|
199 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |