org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-72B5BFF3-DA09-4475-AA88-865852AAB2F0.html
changeset 229 716254ccbcc0
equal deleted inserted replaced
228:913c9751c067 229:716254ccbcc0
       
     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 organizing contacts in a contact group"/><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-A5853293-7B83-4CCE-9C29-B2B8F0CD8A18"/><meta name="DC.Relation" scheme="URI" content="GUID-F2CE0F94-324C-4D45-BD37-DA55F9DAC077"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-72B5BFF3-DA09-4475-AA88-865852AAB2F0"/><title>Criteria for
       
     5 organizing contacts in a contact group </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-72B5BFF3-DA09-4475-AA88-865852AAB2F0"><span>Criteria</span> for
       
     8 organizing contacts in a contact group</h1><div>
       
     9 <p>The <code>criteria</code> object specifies which contact
       
    10 group to organize and how. This involves:</p>
       
    11 <ul>
       
    12 <li><p>Defining the target group</p></li>
       
    13 <li><p>Defining the target contact or contacts</p></li>
       
    14 <li><p>Defining whether to add the contacts to the group (associate)
       
    15 or remove the contacts from the group (disassociate)</p></li>
       
    16 <li><p>Optionally defining on which contacts database to perform
       
    17 the operation</p></li>
       
    18 </ul>
       
    19 <p>The <code>criteria</code> object has three main properties: <code>Type</code>, <code>Data</code>,
       
    20 and <code>OperationType</code>. These are described in the following
       
    21 table. Properties enclosed in brackets are optional.</p>
       
    22 <div class="note"><p><strong class="note_title">Note: </strong>All string values in the object are Unicode.</p>
       
    23 </div>
       
    24 <div class="tablenoborder"><a name="GUID-C13B472E-3CA4-4337-8281-74B4CC5AD173"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-C13B472E-3CA4-4337-8281-74B4CC5AD173" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption>
       
    25 
       
    26 <thead align="left">
       
    27 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e34473">
       
    28 <p>Property</p>
       
    29 </th><th class="cellrowborder" valign="top" width="25%" id="d0e34478">
       
    30 <p>Description</p>
       
    31 </th><th class="cellrowborder" valign="top" width="25%" id="d0e34483">
       
    32 <p>Type</p>
       
    33 </th><th class="cellrowborder" valign="top" width="25%" id="d0e34488">
       
    34 <p>Value</p>
       
    35 </th></tr>
       
    36 </thead>
       
    37 <tbody>
       
    38 <tr class="">
       
    39 <td class="cellrowborder" valign="top" width="25%" headers="d0e34473 ">
       
    40 <p><code>criteria.Type</code></p>
       
    41 </td>
       
    42 <td class="cellrowborder" valign="top" width="25%" headers="d0e34478 ">
       
    43 <p>Specifies the type of contact information to organize. This is always <code>"Group"</code>.</p>
       
    44 </td>
       
    45 <td class="cellrowborder" valign="top" width="25%" headers="d0e34483 ">
       
    46 <p>string</p>
       
    47 </td>
       
    48 <td class="cellrowborder" valign="top" width="25%" headers="d0e34488 ">
       
    49 <p>Possible values:</p>
       
    50 <ul>
       
    51 <li><p><code>"Group"</code></p></li>
       
    52 </ul>
       
    53 </td>
       
    54 </tr>
       
    55 <tr class="bg ">
       
    56 <td class="cellrowborder" valign="top" width="25%" headers="d0e34473 ">
       
    57 <p><code>criteria.Data</code></p>
       
    58 </td>
       
    59 <td class="cellrowborder" valign="top" width="25%" headers="d0e34478 ">
       
    60 <p>Specifies the contact group to organize.</p>
       
    61 </td>
       
    62 <td class="cellrowborder" valign="top" width="25%" headers="d0e34483 ">
       
    63 <p>object</p>
       
    64 </td>
       
    65 <td class="cellrowborder" valign="top" width="25%" headers="d0e34488 ">
       
    66 <p>Object with the properties specified below</p>
       
    67 </td>
       
    68 </tr>
       
    69 <tr class="">
       
    70 <td class="cellrowborder" valign="top" width="25%" headers="d0e34473 ">
       
    71 <p><code>[criteria.Data.DBUri]</code></p>
       
    72 </td>
       
    73 <td class="cellrowborder" valign="top" width="25%" headers="d0e34478 ">
       
    74 <p>Specifies the contacts database on which to perform the operation.</p>
       
    75 <p>If this property is not specified, the default database is used.</p>
       
    76 </td>
       
    77 <td class="cellrowborder" valign="top" width="25%" headers="d0e34483 ">
       
    78 <p>string</p>
       
    79 </td>
       
    80 <td class="cellrowborder" valign="top" width="25%" headers="d0e34488 ">&nbsp;</td>
       
    81 </tr>
       
    82 <tr class="bg ">
       
    83 <td class="cellrowborder" valign="top" width="25%" headers="d0e34473 ">
       
    84 <p><code>criteria.Data.id</code></p>
       
    85 </td>
       
    86 <td class="cellrowborder" valign="top" width="25%" headers="d0e34478 ">
       
    87 <p>Specifies the unique identifier of the contact group to organize.</p>
       
    88 <p>Use <a href="GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007.html#GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"><code>GetList</code></a> to
       
    89 retrieve this ID.</p>
       
    90 </td>
       
    91 <td class="cellrowborder" valign="top" width="25%" headers="d0e34483 ">
       
    92 <p>string</p>
       
    93 </td>
       
    94 <td class="cellrowborder" valign="top" width="25%" headers="d0e34488 ">&nbsp;</td>
       
    95 </tr>
       
    96 <tr class="">
       
    97 <td class="cellrowborder" valign="top" width="25%" headers="d0e34473 ">
       
    98 <p><code>criteria.Data.IdList</code></p>
       
    99 </td>
       
   100 <td class="cellrowborder" valign="top" width="25%" headers="d0e34478 ">
       
   101 <p>Specifies the unique identifiers of the contacts to add or remove.</p>
       
   102 <p><code>Data.IdList[0]</code> contains the ID of the first contact.</p>
       
   103 <p>Use <a href="GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007.html#GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"><code>GetList</code></a> to
       
   104 retrieve these IDs.</p>
       
   105 </td>
       
   106 <td class="cellrowborder" valign="top" width="25%" headers="d0e34483 ">
       
   107 <p>array of strings</p>
       
   108 </td>
       
   109 <td class="cellrowborder" valign="top" width="25%" headers="d0e34488 ">&nbsp;</td>
       
   110 </tr>
       
   111 <tr class="bg ">
       
   112 <td class="cellrowborder" valign="top" width="25%" headers="d0e34473 ">
       
   113 <p><code>criteria.OperationType</code></p>
       
   114 </td>
       
   115 <td class="cellrowborder" valign="top" width="25%" headers="d0e34478 ">
       
   116 <p>Specifies whether to add the contacts to the group (associate) or remove
       
   117 the contacts from the group (disassociate).</p>
       
   118 </td>
       
   119 <td class="cellrowborder" valign="top" width="25%" headers="d0e34483 ">
       
   120 <p>string</p>
       
   121 </td>
       
   122 <td class="cellrowborder" valign="top" width="25%" headers="d0e34488 ">
       
   123 <p>Possible values:</p>
       
   124 <ul>
       
   125 <li><p><code>"Associate"</code></p></li>
       
   126 <li><p><code>"Disassociate"</code></p></li>
       
   127 </ul>
       
   128 </td>
       
   129 </tr>
       
   130 </tbody>
       
   131 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>