org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-36434377-FA7E-45F2-AEB3-BA0B7A378422.html
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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
exporting calendar entries </title><script type="text/javascript">
function initPage() {}
</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
exporting calendar entries</h1><div>
<p>The <code>criteria</code> object specifies the entries
to export and optionally the source calendar.</p>
<p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Data</code>.
These are described in the following table. Properties enclosed in brackets
are optional.</p>
<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>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e23926">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e23931">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e23936">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e23941">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e23926 ">
<p><code>criteria.Type</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23931 ">
<p>Specifies the type of calendar information to export. This is always <code>"CalendarEntry"</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23936 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23941 ">
<p>Possible values:</p>
<ul>
<li><p><code>"CalendarEntry"</code></p></li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e23926 ">
<p><code>criteria.Data</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23931 ">
<p>Specifies the entries to export.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23936 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23941 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e23926 ">
<p><code>[criteria.Data.CalendarName]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23931 ">
<p>Specifies the calendar from which the entries are exported.</p>
<p>If this property is not specified, the entries are exported from the
default calendar.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23936 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23941 ">
<p><code><DriveLetter>:<FileName></code></p>
<p>For example: <code>"C:Calendar"</code></p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e23926 ">
<p><code>[criteria.Data.IdList]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23931 ">
<p>Specifies the <code>id</code>s of the entries to export. If
an entry has child entries, the parent entry and all child entries are exported.
Invalid values are ignored.</p>
<p>Specify either <code>Data.IdList</code> or <code>Data.LocalIdList</code> or
neither, but not both. If neither is specified, all entries in the calendar
are exported.</p>
<p>The first <code>id</code> is specified in <code>Data.IdList[0]</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23936 ">
<p>array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> </td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e23926 ">
<p><code>[criteria.Data.LocalIdList]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23931 ">
<p>Specifies the <code>LocalId</code>s of the entries to export.
In case of parent and child entries, only the specific entry matching the <code>LocalId</code> is
exported. Invalid values are ignored.</p>
<p>Specify either <code>Data.IdList</code> or <code>Data.LocalIdList</code> or
neither, but not both. If neither is specified, all entries in the calendar
are exported.</p>
<p>The first <code>LocalId</code> is specified in <code>Data.LocalIdList[0]</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23936 ">
<p>array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23941 "> </td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e23926 ">
<p><code>[criteria.Data.FileName]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23931 ">
<p>Specifies the full path and file name of the target file to which the
entries are exported.</p>
<p>If this property is not specified, the entries are stored in the <code>ReturnValue</code> property
of the result object.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23936 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23941 ">
<p>The string cannot exceed 239 characters</p>
<p>For example: <code>C:\\Data\\exportfile.txt</code></p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e23926 ">
<p><code>criteria.Data.Format</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23931 ">
<p>Specifies the data format in which the entries are exported. The supported
formats are:</p>
<ul>
<li><p>iCal</p></li>
<li><p>vCal</p></li>
</ul>
<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
Service overview page</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23936 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e23941 ">
<p>Possible values:</p>
<ul>
<li><p><code>"ICal"</code></p></li>
<li><p><code>"VCal"</code></p></li>
</ul>
</td>
</tr>
</tbody>
</table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>