Mercurial Mercurial > oss > FCL > sftools > dev > eclipseenv > wrttools / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-5720512C-9198-4883-81B1-46F1B963C6B9.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Fri, 11 Jun 2010 13:33:03 -0700
changeset 372 1e408ee32d8a
parent 229 716254ccbcc0
permissions -rw-r--r--
Added templates for WRT 1.1 platform services


<!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 retrieving messaging information"/><meta name="DC.Relation" scheme="URI" content="GUID-C8571941-AD6E-4FAD-B4A1-35E7BDB99689"/><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-91579EE5-A608-401C-82B4-DCF1723EC7B5"/><meta name="DC.Relation" scheme="URI" content="GUID-C12C81D1-13A4-4B8C-81B9-694D414A4A48"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-5720512C-9198-4883-81B1-46F1B963C6B9"/><title>Criteria for
retrieving messaging 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-5720512C-9198-4883-81B1-46F1B963C6B9"><span>Criteria</span> for
retrieving messaging information</h1><div>
<p>The <code>criteria</code> object specifies what messaging
information is returned and how the returned information is sorted.</p>
<p>The <code>criteria</code> object has three main properties: <code>Type</code>, <code>Filter</code>,
and <code>Sort</code>. These are described in the following table.
Properties enclosed in brackets are optional.</p>
<div class="tablenoborder"><a name="GUID-730956F1-7540-4012-ADC6-E9C25B8E7E0A"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-730956F1-7540-4012-ADC6-E9C25B8E7E0A" 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="d0e58537">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e58542">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e58547">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e58552">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>criteria.Type</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies the type of messaging objects to retrieve.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">
<p>Possible values:</p>
<ul>
<li><p><code>"Inbox"</code></p></li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Filter]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies how the information to be retrieved is filtered.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Filter.MessageTypeList]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies the type or types of messages to retrieve.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">
<p>Possible values:</p>
<ul>
<li><p><code>"SMS"</code></p></li>
<li><p><code>"MMS"</code></p></li>
<li><p><code>"unknown"</code></p></li>
</ul>
<div class="note"><p><strong class="note_title">Note: </strong>The current implementation only recognizes SMS and MMS. Other types
of messages are <code>unknown</code>.</p>
</div>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Filter.MessageId]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies the unique ID of the message to retrieve.</p>
<p>If <code>MessageId</code> is specified, then only the message
with that ID is retrieved.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Filter.SenderList]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies the message recipients. Only messages sent to these recipients
are retrieved.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Filter.Subject]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies the message subjects. Only messages with these subjects are
retrieved.</p>
<div class="note"><p><strong class="note_title">Note: </strong>SMS does not support subject. This property is only valid for MMS.</p>
</div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Filter.StartDate]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>If only <code>StartDate</code> is specified, all messages received
on or after this date are retrieved.</p>
<p>If both <code>StartDate</code> and <code>EndDate</code> are
specified, all messages received within these dates are retrieved.</p>
<p>If <code>EndDate</code> is earlier than <code>StartDate</code>,
an error is returned.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>date object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Filter.EndDate]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>If only <code>EndDate</code> is specified, all messages received
on or before this date are retrieved.</p>
<p>If both <code>StartDate</code> and <code>EndDate</code> are
specified, all messages received within these dates are retrieved.</p>
<p>If <code>EndDate</code> is earlier than <code>StartDate</code>,
an error is returned.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>date object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Sort]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies how the returned list of information is sorted.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Sort.Key]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies the value to sort by.</p>
<div class="note"><p><strong class="note_title">Note: </strong>By default, sorting is done in ascending order based on <code>Date</code>.</p>
</div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">
<p>Possible values:</p>
<ul>
<li><p><code>"Date"</code></p></li>
<li><p><code>"Size"</code></p></li>
<li><p><code>"Sender"</code></p></li>
<li><p><code>"Subject"</code></p></li>
<li><p><code>"MessageId"</code></p></li>
</ul>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e58537 ">
<p><code>[criteria.Sort.Order]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58542 ">
<p>Specifies the sort order.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58547 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e58552 ">
<p>Possible values:</p>
<ul>
<li><p><code>"Ascending"</code></p></li>
<li><p><code>"Descending"</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>
FCL/sftools/dev/eclipseenv/wrttools