|
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="Criteria for exporting calendar entries"/><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.Relation" scheme="URI" content="GUID-890D2F5C-D43F-44B2-97A0-5F5B9230C85F"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-36434377-FA7E-45F2-AEB3-BA0B7A378422"/><title>Criteria for |
|
5 exporting calendar entries </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-36434377-FA7E-45F2-AEB3-BA0B7A378422"><span>Criteria</span> for |
|
8 exporting calendar entries</h1><div> |
|
9 <p>The <code>criteria</code> object specifies the entries |
|
10 to export and optionally the source calendar.</p> |
|
11 <p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Data</code>. |
|
12 These are described in the following table. Properties enclosed in brackets |
|
13 are optional.</p> |
|
14 <div class="tablenoborder"><a name="GUID-C77CB70C-3551-4A8C-8273-0C470FD8975C"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-C77CB70C-3551-4A8C-8273-0C470FD8975C" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption> |
|
15 |
|
16 <thead align="left"> |
|
17 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e23926"> |
|
18 <p>Property</p> |
|
19 </th><th class="cellrowborder" valign="top" width="25%" id="d0e23931"> |
|
20 <p>Description</p> |
|
21 </th><th class="cellrowborder" valign="top" width="25%" id="d0e23936"> |
|
22 <p>Type</p> |
|
23 </th><th class="cellrowborder" valign="top" width="25%" id="d0e23941"> |
|
24 <p>Value</p> |
|
25 </th></tr> |
|
26 </thead> |
|
27 <tbody> |
|
28 <tr class=""> |
|
29 <td class="cellrowborder" valign="top" width="25%" headers="d0e23926 "> |
|
30 <p><code>criteria.Type</code></p> |
|
31 </td> |
|
32 <td class="cellrowborder" valign="top" width="25%" headers="d0e23931 "> |
|
33 <p>Specifies the type of calendar information to export. This is always <code>"CalendarEntry"</code>.</p> |
|
34 </td> |
|
35 <td class="cellrowborder" valign="top" width="25%" headers="d0e23936 "> |
|
36 <p>string</p> |
|
37 </td> |
|
38 <td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> |
|
39 <p>Possible values:</p> |
|
40 <ul> |
|
41 <li><p><code>"CalendarEntry"</code></p></li> |
|
42 </ul> |
|
43 </td> |
|
44 </tr> |
|
45 <tr class="bg "> |
|
46 <td class="cellrowborder" valign="top" width="25%" headers="d0e23926 "> |
|
47 <p><code>criteria.Data</code></p> |
|
48 </td> |
|
49 <td class="cellrowborder" valign="top" width="25%" headers="d0e23931 "> |
|
50 <p>Specifies the entries to export.</p> |
|
51 </td> |
|
52 <td class="cellrowborder" valign="top" width="25%" headers="d0e23936 "> |
|
53 <p>object</p> |
|
54 </td> |
|
55 <td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> |
|
56 <p>Object with the properties specified below</p> |
|
57 </td> |
|
58 </tr> |
|
59 <tr class=""> |
|
60 <td class="cellrowborder" valign="top" width="25%" headers="d0e23926 "> |
|
61 <p><code>[criteria.Data.CalendarName]</code></p> |
|
62 </td> |
|
63 <td class="cellrowborder" valign="top" width="25%" headers="d0e23931 "> |
|
64 <p>Specifies the calendar from which the entries are exported.</p> |
|
65 <p>If this property is not specified, the entries are exported from the |
|
66 default calendar.</p> |
|
67 </td> |
|
68 <td class="cellrowborder" valign="top" width="25%" headers="d0e23936 "> |
|
69 <p>string</p> |
|
70 </td> |
|
71 <td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> |
|
72 <p><code><DriveLetter>:<FileName></code></p> |
|
73 <p>For example: <code>"C:Calendar"</code></p> |
|
74 </td> |
|
75 </tr> |
|
76 <tr class="bg "> |
|
77 <td class="cellrowborder" valign="top" width="25%" headers="d0e23926 "> |
|
78 <p><code>[criteria.Data.IdList]</code></p> |
|
79 </td> |
|
80 <td class="cellrowborder" valign="top" width="25%" headers="d0e23931 "> |
|
81 <p>Specifies the <code>id</code>s of the entries to export. If |
|
82 an entry has child entries, the parent entry and all child entries are exported. |
|
83 Invalid values are ignored.</p> |
|
84 <p>Specify either <code>Data.IdList</code> or <code>Data.LocalIdList</code> or |
|
85 neither, but not both. If neither is specified, all entries in the calendar |
|
86 are exported.</p> |
|
87 <p>The first <code>id</code> is specified in <code>Data.IdList[0]</code>.</p> |
|
88 </td> |
|
89 <td class="cellrowborder" valign="top" width="25%" headers="d0e23936 "> |
|
90 <p>array of strings</p> |
|
91 </td> |
|
92 <td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> </td> |
|
93 </tr> |
|
94 <tr class=""> |
|
95 <td class="cellrowborder" valign="top" width="25%" headers="d0e23926 "> |
|
96 <p><code>[criteria.Data.LocalIdList]</code></p> |
|
97 </td> |
|
98 <td class="cellrowborder" valign="top" width="25%" headers="d0e23931 "> |
|
99 <p>Specifies the <code>LocalId</code>s of the entries to export. |
|
100 In case of parent and child entries, only the specific entry matching the <code>LocalId</code> is |
|
101 exported. Invalid values are ignored.</p> |
|
102 <p>Specify either <code>Data.IdList</code> or <code>Data.LocalIdList</code> or |
|
103 neither, but not both. If neither is specified, all entries in the calendar |
|
104 are exported.</p> |
|
105 <p>The first <code>LocalId</code> is specified in <code>Data.LocalIdList[0]</code>.</p> |
|
106 </td> |
|
107 <td class="cellrowborder" valign="top" width="25%" headers="d0e23936 "> |
|
108 <p>array of strings</p> |
|
109 </td> |
|
110 <td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> </td> |
|
111 </tr> |
|
112 <tr class="bg "> |
|
113 <td class="cellrowborder" valign="top" width="25%" headers="d0e23926 "> |
|
114 <p><code>[criteria.Data.FileName]</code></p> |
|
115 </td> |
|
116 <td class="cellrowborder" valign="top" width="25%" headers="d0e23931 "> |
|
117 <p>Specifies the full path and file name of the target file to which the |
|
118 entries are exported.</p> |
|
119 <p>If this property is not specified, the entries are stored in the <code>ReturnValue</code> property |
|
120 of the result object.</p> |
|
121 </td> |
|
122 <td class="cellrowborder" valign="top" width="25%" headers="d0e23936 "> |
|
123 <p>string</p> |
|
124 </td> |
|
125 <td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> |
|
126 <p>The string cannot exceed 239 characters</p> |
|
127 <p>For example: <code>C:\\Data\\exportfile.txt</code></p> |
|
128 </td> |
|
129 </tr> |
|
130 <tr class=""> |
|
131 <td class="cellrowborder" valign="top" width="25%" headers="d0e23926 "> |
|
132 <p><code>criteria.Data.Format</code></p> |
|
133 </td> |
|
134 <td class="cellrowborder" valign="top" width="25%" headers="d0e23931 "> |
|
135 <p>Specifies the data format in which the entries are exported. The supported |
|
136 formats are:</p> |
|
137 <ul> |
|
138 <li><p>iCal</p></li> |
|
139 <li><p>vCal</p></li> |
|
140 </ul> |
|
141 <p>For more information about these two formats, see the <a href="GUID-AE9A928B-F938-49B5-BC9E-72CB42046571.html#GUID-AE9A928B-F938-49B5-BC9E-72CB42046571">Calendar |
|
142 Service overview page</a>.</p> |
|
143 </td> |
|
144 <td class="cellrowborder" valign="top" width="25%" headers="d0e23936 "> |
|
145 <p>string</p> |
|
146 </td> |
|
147 <td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> |
|
148 <p>Possible values:</p> |
|
149 <ul> |
|
150 <li><p><code>"ICal"</code></p></li> |
|
151 <li><p><code>"VCal"</code></p></li> |
|
152 </ul> |
|
153 </td> |
|
154 </tr> |
|
155 </tbody> |
|
156 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |