|
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.Import()"/><meta name="DC.Relation" scheme="URI" content="GUID-890D2F5C-D43F-44B2-97A0-5F5B9230C85F"/><meta name="DC.Relation" scheme="URI" content="GUID-270C6C2A-5EBB-4ACC-A231-064F17E85F4A"/><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-CABB28B8-D2B1-496B-BD7E-34FF496E60B4"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-D19BB894-371A-4D55-A047-3B2F97673F5F"/><title>IDataSource.Import() </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-D19BB894-371A-4D55-A047-3B2F97673F5F"><span>IDataSource.</span>Import()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Import</code> method imports entries into a calendar. |
|
9 The information must be imported from an iCal or vCal file. For more information |
|
10 about these two formats, see the <a href="GUID-AE9A928B-F938-49B5-BC9E-72CB42046571.html#GUID-AE9A928B-F938-49B5-BC9E-72CB42046571">Calendar |
|
11 Service overview page</a>.</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-173FE57C-5F1D-45F7-A3A3-83CA5A05D0A5">result = so.IDataSource.Import(criteria);</pre> |
|
16 |
|
17 <p>For asynchronous calls:</p> |
|
18 <pre class="codeblock" id="GUID-141D4B72-7957-49FD-AC57-C785FC5E7A55">result = so.IDataSource.Import(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 the calendar entries to import and |
|
25 optionally the target calendar. For more information about the object properties |
|
26 and how to define them, see section <a href="GUID-B86F1686-F2AC-438F-8306-4B9D70F879EC.html#GUID-B86F1686-F2AC-438F-8306-4B9D70F879EC">Criteria for importing calendar entries</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>Import</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>Import</code> call.</p> |
|
37 |
|
38 </li> |
|
39 </ul> |
|
40 <p><strong>Return value:</strong></p> |
|
41 <p>If synchronous, the <code>Import</code> method returns an object |
|
42 that contains a list of the imported calendar entries, an error code, and |
|
43 an error message.</p> |
|
44 <div class="tablenoborder"><a name="GUID-42E868DB-E737-4102-A248-1B2ECCBE639F"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-42E868DB-E737-4102-A248-1B2ECCBE639F" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
45 properties for a synchronous Import</caption> |
|
46 |
|
47 <thead align="left"> |
|
48 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e22949"> |
|
49 <p>Property</p> |
|
50 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e22954"> |
|
51 <p>Description</p> |
|
52 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e22959"> |
|
53 <p>Value</p> |
|
54 </th></tr> |
|
55 </thead> |
|
56 <tbody> |
|
57 <tr class=""> |
|
58 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22949 "> |
|
59 <p><code>result.ReturnValue</code></p> |
|
60 </td> |
|
61 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22954 "> |
|
62 <p>This is an iterator that contains an ordered list of objects. The objects |
|
63 contain the <code>id</code>s (strings) of the entries that were successfully |
|
64 imported to the calendar. The same <code>id</code> may be repeated |
|
65 multiple times in case of child entries.</p> |
|
66 </td> |
|
67 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22959 "> </td> |
|
68 </tr> |
|
69 <tr class="bg "> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22949 "> |
|
71 <p><code>result.ErrorCode</code></p> |
|
72 </td> |
|
73 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22954 "> |
|
74 <p>This is a number that specifies a predefined error code.</p> |
|
75 </td> |
|
76 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22959 "> |
|
77 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
78 </td> |
|
79 </tr> |
|
80 <tr class=""> |
|
81 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22949 "> |
|
82 <p><code>result.ErrorMessage</code></p> |
|
83 </td> |
|
84 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22954 "> |
|
85 <p>This is a text string that describes the error.</p> |
|
86 </td> |
|
87 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22959 "> |
|
88 <p>See <a href="GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35.html#GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35">Calendar Service API error messages</a>.</p> |
|
89 </td> |
|
90 </tr> |
|
91 </tbody> |
|
92 </table></div> |
|
93 <p>If asynchronous, the <code>Import</code> method returns an object |
|
94 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, |
|
95 an error code, and an error message (see the following table). When the asynchronous |
|
96 call has completed, <code>callback</code> returns an object that contains |
|
97 a list of the imported calendar entries, an error code, and an error message |
|
98 (see the preceding table).</p> |
|
99 <div class="tablenoborder"><a name="GUID-11253E50-8BE1-4C85-A6C2-A07E3DD1F542"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-11253E50-8BE1-4C85-A6C2-A07E3DD1F542" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
100 properties for an asynchronous Import</caption> |
|
101 |
|
102 <thead align="left"> |
|
103 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e23069"> |
|
104 <p>Property</p> |
|
105 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e23074"> |
|
106 <p>Description</p> |
|
107 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e23079"> |
|
108 <p>Value</p> |
|
109 </th></tr> |
|
110 </thead> |
|
111 <tbody> |
|
112 <tr class=""> |
|
113 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23069 "> |
|
114 <p><code>result.TransactionID</code></p> |
|
115 </td> |
|
116 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23074 "> |
|
117 <p>This is a number used as an identification to match transactions started |
|
118 with an asynchronous <code>Import</code> call to one or more calls |
|
119 it generates to <code>callback</code>.</p> |
|
120 </td> |
|
121 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23079 "> </td> |
|
122 </tr> |
|
123 <tr class="bg "> |
|
124 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23069 "> |
|
125 <p><code>result.ErrorCode</code></p> |
|
126 </td> |
|
127 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23074 "> |
|
128 <p>This is a number that specifies a predefined error code.</p> |
|
129 </td> |
|
130 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23079 "> |
|
131 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
132 </td> |
|
133 </tr> |
|
134 <tr class=""> |
|
135 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23069 "> |
|
136 <p><code>result.ErrorMessage</code></p> |
|
137 </td> |
|
138 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23074 "> |
|
139 <p>This is a text string that describes the error.</p> |
|
140 </td> |
|
141 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e23079 "> |
|
142 <p>See <a href="GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35.html#GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35">Calendar Service API error messages</a>.</p> |
|
143 </td> |
|
144 </tr> |
|
145 </tbody> |
|
146 </table></div> |
|
147 <p><strong>Remarks:</strong></p> |
|
148 <ul> |
|
149 <li><p>If entries are imported to a calendar other than the default |
|
150 one, the corresponding calendar file must exist on the device.</p></li> |
|
151 <li><p>For detailed information about calendar entries, see section <a href="GUID-798E9CA0-2A46-4D10-B567-04C9567500F4.html#GUID-798E9CA0-2A46-4D10-B567-04C9567500F4">Calendar entries</a>.</p></li> |
|
152 </ul> |
|
153 <p><strong>Example code:</strong></p> |
|
154 <p/> |
|
155 <p>For the complete source of a sample widget |
|
156 that demonstrates how to use this Service API, see <a href="GUID-7C0890BC-7931-417B-B4AC-6E77E65A10F3.html#GUID-7C0890BC-7931-417B-B4AC-6E77E65A10F3">the full example</a>.</p> |
|
157 |
|
158 |
|
159 |
|
160 |
|
161 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |