diff -r 4d198a32ac7d -r d4809db37847 plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-06C803FE-DD16-44B5-B9C7-2EC9D497D425.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-06C803FE-DD16-44B5-B9C7-2EC9D497D425.html Thu Aug 19 17:48:04 2010 -0700 @@ -0,0 +1,170 @@ + + +
The criteria
object specifies what contact
+information is returned and how the returned information is sorted.
Each GetList
call
+targets one type of contact information:
Contacts are individual contact entries in a contacts +database. You can retrieve a specific contact or a list of contacts depending +on the filtering criteria.
Contact groups are associations that group individual +contacts together by ID. You can retrieve a specific group or a list of groups +depending on the filtering criteria.
Contacts databases are databases that store information +about contacts and contact groups. You can retrieve a list of all the open +databases.
The criteria
object has three main properties: Type
, Filter
,
+and Sort
. These are described in the following table.
+Properties enclosed in brackets are optional.
Note: All string values in the object are Unicode.
+
+ Property + |
+ Description + |
+ Type + |
+ Value + |
---|---|---|---|
+
|
+
+ Specifies the type of contact information to retrieve. +Note: If this property is set to |
+
+ string + |
+
+ Possible values: +
|
+
+
|
+
+ Specifies how the information to be retrieved is filtered. +This property is valid only if If this property is not specified and If this property is not specified and |
+
+ object + |
+
+ Object with the properties specified below + |
+
+
|
+
+ Specifies the contacts database from which to retrieve the information. +If this property is not specified, the default database is used. + |
+
+ string + |
++ |
+
|
+
+ Specifies the unique identifier of the contact or contact group to retrieve. +If this property is specified, |
+
+ string + |
++ |
+
|
+
+ Specifies a text string by which to search for contacts. The search +is based on first name and last name. Any contact whose first name or last +name contains this string is retrieved. +If this property is not specified, all contacts are retrieved from the +database. +Note: This property is valid only if |
+
+ string + |
+
+ The string cannot exceed 255 characters. + |
+
+
|
+
+ Specifies how the returned list of information is sorted. +Sorting is based on last name and first name, in that order of priority. +By default, sorting is done in ascending order. +Note: Sorting is done only if |
+
+ object + |
+
+ Object with the properties specified below + |
+
+
|
+
+ Specifies the sort order. + |
+
+ string + |
+
+ Possible values: +
|
+