org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-54013A2F-7503-4DA3-85C7-904BCD98B011.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Tue, 20 Apr 2010 17:11:57 -0700
changeset 313 25282116ebcf
parent 229 716254ccbcc0
permissions -rw-r--r--
Eclipse 3.6 M6 support


<!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 adding and updating calendar information"/><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-4718B87C-0FFF-48EC-A47F-5C9F8C2E2A51"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-54013A2F-7503-4DA3-85C7-904BCD98B011"/><title>Criteria for
adding and updating calendar information </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-54013A2F-7503-4DA3-85C7-904BCD98B011"><span>Criteria</span> for
adding and updating calendar information</h1><div>
<p>The <code>criteria</code> object specifies the calendar
to create or the calendar entry to add or update:</p>
<ul>
<li><p>To create a new calendar, specify the properties listed in <a href="#GUID-F4D8D6BB-A6E4-4AB7-B33C-D89C226F12A4">Table:
Creating a new calendar</a>.</p></li>
<li><p>To add a new calendar entry, specify the properties listed
in <a href="#GUID-43FD3F7F-ED96-4F10-8E3B-CDEDF5F75FA0">Table:
Adding a new calendar entry</a>.</p></li>
<li><p>To update an existing calendar entry, first use <a href="GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4.html#GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4"><code>GetList</code></a> to retrieve the <code>LocalId</code> of that entry, and then
specify the properties listed in <a href="#GUID-29B3B9CA-14F6-441E-8175-DA3B75A5BA48">Table:
Updating a calendar entry</a>. Use the <code>LocalId</code> returned
by <code>GetList</code> as the value for <code>Item.LocalId</code>.</p>
</li>
</ul>
<p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Item</code>.</p>
<div class="tablenoborder"><a name="GUID-F4D8D6BB-A6E4-4AB7-B33C-D89C226F12A4"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-F4D8D6BB-A6E4-4AB7-B33C-D89C226F12A4" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties (creating
a new calendar)</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e21532">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21537">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21542">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21547">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21532 ">
<p><code>criteria.Type</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21537 ">
<p>Specifies the type of calendar information to add or update.</p>
<p>For creating a new calendar, this is always <code>"Calendar"</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21542 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21547 ">
<p>Possible values:</p>
<ul>
<li><p><code>"Calendar"</code></p></li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21532 ">
<p><code>criteria.Item</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21537 ">
<p>Specifies the calendar to create.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21542 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21547 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21532 ">
<p><code>criteria.Item.CalendarName</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21537 ">
<p>Specifies the drive letter and file name of the new calendar file.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21542 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21547 ">
<p><code>&lt;DriveLetter&gt;:&lt;FileName&gt;</code></p>
<p>For example: <code>"C:Calendar"</code></p>
</td>
</tr>
</tbody>
</table></div><div class="tablenoborder"><a name="GUID-43FD3F7F-ED96-4F10-8E3B-CDEDF5F75FA0"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-43FD3F7F-ED96-4F10-8E3B-CDEDF5F75FA0" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object
properties (adding a new calendar entry)</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e21678">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21683">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21688">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21693">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21678 ">
<p><code>criteria.Type</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21683 ">
<p>Specifies the type of calendar information to add or update.</p>
<p>For adding a new calendar entry, this is always <code>"CalendarEntry"</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21688 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21693 ">
<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="d0e21678 ">
<p><code>criteria.Item</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21683 ">
<p>Specifies the calendar entry to add.</p>
<p>The exact set of properties that need to be specified depends on the
type of the entry. For more information about which properties are valid for
a given type, see section <a href="GUID-2B27591B-F58B-4C6B-8C35-6F65FCF599C6.html#GUID-2B27591B-F58B-4C6B-8C35-6F65FCF599C6">Properties and calendar entry types</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21688 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21693 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21678 ">
<p><code>[criteria.Item.CalendarName]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21683 ">
<p>Specifies the calendar file to which the entry is added.</p>
<p>If this property is not specified, the entry is added to the default
calendar. If the default calendar does not exist, it is created.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21688 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21693 ">
<p><code>&lt;DriveLetter&gt;:&lt;FileName&gt;</code></p>
<p>For example: <code>"C:Calendar"</code></p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21678 ">
<p><code>criteria.Item.&lt;property&gt;</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21683 ">
<p>For detailed information about the properties and their values, see
section <a href="GUID-5D53649F-FDE2-4421-A362-25C91EE76EF4.html#GUID-5D53649F-FDE2-4421-A362-25C91EE76EF4">Calendar entry properties</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21688 ">
<p>(depends on the property)</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21693 ">
<p>For example, to add a new meeting:</p>
<p><code>criteria</code><code>.Item.Type
= "Meeting";</code></p>
</td>
</tr>
</tbody>
</table></div><div class="tablenoborder"><a name="GUID-29B3B9CA-14F6-441E-8175-DA3B75A5BA48"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-29B3B9CA-14F6-441E-8175-DA3B75A5BA48" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object
properties (updating a calendar entry)</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e21868">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21873">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21878">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e21883">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21868 ">
<p><code>criteria.Type</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21873 ">
<p>Specifies the type of calendar information to add or update.</p>
<p>For updating an existing calendar entry, this is always <code>"CalendarEntry"</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21878 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21883 ">
<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="d0e21868 ">
<p><code>criteria.Item</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21873 ">
<p>Specifies the new information and the calendar entry to update.</p>
<p>The exact set of properties that need to be specified depends on the
type of the entry. For more information about which properties are valid for
a given type, see section <a href="GUID-2B27591B-F58B-4C6B-8C35-6F65FCF599C6.html#GUID-2B27591B-F58B-4C6B-8C35-6F65FCF599C6">Properties and calendar entry types</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21878 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21883 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21868 ">
<p><code>[criteria.Item.CalendarName]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21873 ">
<p>Specifies the calendar file on which the update is performed.</p>
<p>If this property is not specified, the update is performed on the default
calendar.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21878 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21883 ">
<p><code>&lt;DriveLetter&gt;:&lt;FileName&gt;</code></p>
<p>For example: <code>"C:Calendar"</code></p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21868 ">
<p><code>criteria.Item.LocalId</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21873 ">
<p>Identifies the calendar entry to update. This can be either a parent
or child entry.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21878 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21883 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21868 ">
<p><code>[criteria.Item.InstanceStartTime]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21873 ">
<p>In case of a recurring entry, specify <code>InstanceStartTime</code> to
identify the instance to modify. The specified instance is stored as a new
child entry.</p>
<p>If this property is not specified, the whole entry is updated.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21878 ">
<p>date object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21883 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e21868 ">
<p><code>criteria.Item.&lt;property&gt;</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21873 ">
<p>For detailed information about the properties and their values, see
section <a href="GUID-5D53649F-FDE2-4421-A362-25C91EE76EF4.html#GUID-5D53649F-FDE2-4421-A362-25C91EE76EF4">Calendar entry properties</a>.</p>
<p>Properties that are not specified remain unchanged.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21878 ">
<p>(depends on the property)</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e21883 ">&nbsp;</td>
</tr>
</tbody>
</table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>