|
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.Organise()"/><meta name="DC.Relation" scheme="URI" content="GUID-231C11D4-82B3-4202-8E86-DE8A3556C9DE"/><meta name="DC.Relation" scheme="URI" content="GUID-CA7C3A7B-6733-47E0-9C6F-FBFB0993F034"/><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.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-F2CE0F94-324C-4D45-BD37-DA55F9DAC077"/><title>IDataSource.Organise() </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-F2CE0F94-324C-4D45-BD37-DA55F9DAC077"><span>IDataSource.</span>Organise()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Organise</code> method adds contacts to a contact |
|
9 group (association) or removes contacts from a contact group (disassociation). |
|
10 The operation is performed on the specified database or, if no database is |
|
11 specified, on the default one.</p> |
|
12 <p>This method can be called both synchronously and asynchronously.</p> |
|
13 <p><strong>Syntax:</strong></p> |
|
14 <p>For synchronous calls:</p> |
|
15 <pre class="codeblock" id="GUID-BBCC8B63-A910-4DB4-B5E9-ECFF2FF1BA4C">result = so.IDataSource.Organise(criteria);</pre> |
|
16 |
|
17 <p>For asynchronous calls:</p> |
|
18 <pre class="codeblock" id="GUID-DFA2C4C2-4E3E-4796-ACF8-41748A8485FE">result = so.IDataSource.Organise(criteria, callback);</pre> |
|
19 |
|
20 <p><strong>Arguments:</strong></p> |
|
21 <ul> |
|
22 <li><p><code>criteria</code>:</p> |
|
23 |
|
24 <p>This is an object that specifies which contact group to organize and |
|
25 how. For more information about the object properties and how to define them, |
|
26 see section <a href="GUID-72B5BFF3-DA09-4475-AA88-865852AAB2F0.html#GUID-72B5BFF3-DA09-4475-AA88-865852AAB2F0">Criteria for organizing contacts in a contact group</a>.</p> |
|
27 |
|
28 </li> |
|
29 <li><p><code>callback</code>:</p> |
|
30 |
|
31 <p>The <code>callback</code> argument is the name of the method |
|
32 that is executed when an asynchronous <code>Organise</code> call has |
|
33 results or status information to return. You must define this method separately. |
|
34 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 |
|
35 define the <code>callback</code> method.</p> |
|
36 <p>This argument is used only with an asynchronous <code>Organise</code> call.</p> |
|
37 |
|
38 </li> |
|
39 </ul> |
|
40 <p><strong>Return value:</strong></p> |
|
41 <p>If synchronous, the <code>Organise</code> method returns an |
|
42 object that contains an error code and an error message.</p> |
|
43 <p>If asynchronous, the method returns an object that contains a transaction |
|
44 ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance, |
|
45 an error code, and an error message. When the asynchronous call has completed, <code>callback</code> returns |
|
46 an object that contains an error code and an error message (see <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-E43BC9EA-3EBE-4C7F-A57E-A1C33BB01CF4">Table: Callback return value</a>).</p> |
|
47 <div class="tablenoborder"><a name="GUID-43F51A8E-AAA0-4140-9357-670A4A605D8C"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-43F51A8E-AAA0-4140-9357-670A4A605D8C" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
48 properties for Organise</caption> |
|
49 |
|
50 <thead align="left"> |
|
51 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e34250"> |
|
52 <p>Property</p> |
|
53 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e34255"> |
|
54 <p>Description</p> |
|
55 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e34260"> |
|
56 <p>Value</p> |
|
57 </th></tr> |
|
58 </thead> |
|
59 <tbody> |
|
60 <tr class=""> |
|
61 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34250 "> |
|
62 <p><code>result.TransactionID</code></p> |
|
63 </td> |
|
64 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34255 "> |
|
65 <p>This is a number used as an identification to match transactions started |
|
66 with an asynchronous <code>Organise</code> call to one or more calls |
|
67 it generates to <code>callback</code>.</p> |
|
68 <p>This property is only valid for asynchronous calls.</p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34260 "> </td> |
|
71 </tr> |
|
72 <tr class="bg "> |
|
73 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34250 "> |
|
74 <p><code>result.ErrorCode</code></p> |
|
75 </td> |
|
76 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34255 "> |
|
77 <p>This is a number that specifies a predefined error code.</p> |
|
78 </td> |
|
79 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34260 "> |
|
80 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
81 </td> |
|
82 </tr> |
|
83 <tr class=""> |
|
84 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34250 "> |
|
85 <p><code>result.ErrorMessage</code></p> |
|
86 </td> |
|
87 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34255 "> |
|
88 <p>This is a text string that describes the error.</p> |
|
89 </td> |
|
90 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e34260 "> |
|
91 <p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p> |
|
92 </td> |
|
93 </tr> |
|
94 </tbody> |
|
95 </table></div> |
|
96 <p><strong>Remarks:</strong></p> |
|
97 <ul> |
|
98 <li><p>The default contacts database is <code>cntdb://c:contacts.cdb</code>.</p> |
|
99 </li> |
|
100 <li><p><code>Organise</code> is not supported for SIM card |
|
101 databases, since contact groups cannot be created in a SIM card database.</p> |
|
102 </li> |
|
103 </ul> |
|
104 <p><strong>Example code:</strong></p> |
|
105 <p/> |
|
106 <p>For the complete source of a sample widget |
|
107 that demonstrates how to use this Service API, see <a href="GUID-B2BCD2C0-DA4D-4830-9BF3-5DA50879A3A1.html#GUID-B2BCD2C0-DA4D-4830-9BF3-5DA50879A3A1">the |
|
108 full example</a>.</p> |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |