[Tcladdressbook-commits] Help TclAddressBookHelp,1.14,1.15

[Bernard D. <bde...@us...>]

Update of /cvsroot/tcladdressbook/Help
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5692/Help

Modified Files:
	TclAddressBookHelp 
Log Message:
Documents new 1.1b1 commands

Index: TclAddressBookHelp
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- TclAddressBookHelp	28 Jul 2004 23:11:06 -0000	1.14
+++ TclAddressBookHelp	29 Jul 2004 13:32:18 -0000	1.15
@@ -18,8 +18,9 @@
           addressbook create (group | person) name ?-ingroup groupID?
           addressbook delete recordID
           addressbook export personID
-          addressbook getme
+          addressbook getme ?-id?
           addressbook groups ?-ids? ?-ingroup groupID?
+          addressbook identifier personID groupID propName ?label?
           addressbook image personID ?imageData?
           addressbook import vCardData
           addressbook parents ?-ids? recordID
@@ -27,7 +28,7 @@
           addressbook property names (-groups | -persons)
           addressbook property type (-groups | -persons) propName
           addressbook property add (-groups | -persons) propName propType
-          addressbook property remove (-groups | -persons) propName
+          addressbook property remove (-groups | -persons | recordID) propName
           addressbook record recordID
           addressbook remove recordID groupID
           addressbook save
@@ -101,12 +102,13 @@
 a VCard. The result should be considered as binary data since it can
 contain an image associated to the record.
 
- addressbook getme
-This command returns all the data available in the database concerning
-the logged-in user ("Me"). The returned value takes the form of 
-a keyed list: see the addressbook record command for a description 
-of this format. Keyed lists can be easily manipulated with the 
-keylget and keylset commands defined in the TclX extension.
+ addressbook getme ?-id?
+This command returns the ID or the data corresponding to the logged-in user
+("Me"). If the -id option is specified, it returns the unique ID of
+the logged-in user. Otherwise the returned value takes the form of a keyed
+list: see the addressbook record command for a description of this
+format. Keyed lists can be easily manipulated with the keylget and
+keylset commands defined in the TclX extension.
 
  addressbook groups ?-ids? ?-ingroup groupID?
 This command returns a list of all the existing group records: if no option
@@ -117,6 +119,23 @@
 -ingroup option is specified, only the subgroups contained in the group
 with ID groupID will be returned.
 
+ addressbook identifier personID groupID propName ?label?
+This command lets you get or set the distribution identifier for a
+multi-value list property of a person in a group. 
+ Used without a label argument, this will return the
+distribution identifier for the person personID belonging to the
+group groupID concerning property propName if it was set,
+otherwise the property¹s primary identifier. Property propName must
+be a multi-value list property
+ If the label argument is specified, this will assign a
+specific distribution identifier for the person¹s multi-value list property
+so that the group can be used as a distribution list (a mailing list for
+instance, in the case of an email property). This value must be a label
+used by the multi-value list (such as home for an address
+property). If label is an empty string, this command resets the
+distribution identifier to its default, i-e the multi-value list¹s primary
+identifier.
+
  addressbook image personID ?imageData?
 If no imageData argument is specified, this command returns the
 custom image associated with the record corresponding to the unique ID 
@@ -168,10 +187,17 @@
 Dictionary, Integer, Real, String, MultiArray, MultiData, MultiDate,
 MultiDictionary, MultiInteger, MultiReal, MultiString.
 
- addressbook property remove (-groups | -persons) propName
+ addressbook property remove (-groups | -persons | recordID) propName
 This command lets you remove a property from the database, either for
 person or for group records. The name of the property is specified in the
-propName argument. One can get the list of all the existing
+propName argument. If the third argument is either -groups or
+-persons, the command should remove the given property from all
+the records of this type in the Address Book database and return the
+number of properties successfully removed. Otherwise the third 
+argument should be the record ID of a particular person or group: the 
+property is removed for this record only and the command returns an 
+empty string.
+ One can get the list of all the existing
 properties with the addressbook property names command.
 
  addressbook record recordID
@@ -365,7 +391,7 @@
 
 
 ----------------------------------------------------------------------
- Last updated 2004-07-29 01:09:25
+ Last updated 2004-07-29 15:28:58