[Tcladdressbook-commits] Help TclAddressBookHelp.aida,1.13,1.14

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

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

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

Index: TclAddressBookHelp.aida
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.aida,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- TclAddressBookHelp.aida	28 Jul 2004 23:11:30 -0000	1.13
+++ TclAddressBookHelp.aida	29 Jul 2004 13:32:27 -0000	1.14
@@ -83,12 +83,13 @@
 a VCard. The result should be considered as binary data since it can
 contain an image associated to the record.
 
-((s3 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 ((b addressbook record b)) command for a description 
-of this format. Keyed lists can be easily manipulated with the 
-((b keylget b)) and ((b keylset b)) commands defined in the TclX extension.
+((s3 addressbook getme ?((i -id i))?
+This command returns the ID or the data corresponding to the logged-in user
+("Me"). If the ((i -id i)) 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 ((b addressbook record b)) command for a description of this
+format. Keyed lists can be easily manipulated with the ((b keylget b)) and
+((b keylset b)) commands defined in the TclX extension.
 
 ((s3 addressbook groups ?-ids? ?-ingroup ((i groupID i))?
 This command returns a list of all the existing group records: if no option
@@ -99,6 +100,23 @@
 ((i -ingroup i)) option is specified, only the subgroups contained in the group
 with ID ((i groupID i)) will be returned.
 
+((s3 addressbook identifier ((i personID i)) ((i groupID i)) ((i propName i)) ?((i label i))?
+This command lets you get or set the distribution identifier for a
+multi-value list property of a person in a group. 
+((nl Used without a ((i label i)) argument, this will return the
+distribution identifier for the person ((i personID i)) belonging to the
+group ((i groupID i)) concerning property ((i propName i)) if it was set,
+otherwise the property¹s primary identifier. Property ((i propName i)) must
+be a multi-value list property
+((nl If the ((i label i)) 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 ((i home i)) for an ((i address i))
+property). If ((i label i)) is an empty string, this command resets the
+distribution identifier to its default, i-e the multi-value list¹s primary
+identifier.
+
 ((s3 addressbook image ((i personID i)) ?((i imageData i))?
 If no ((i imageData i)) argument is specified, this command returns the
 custom image associated with the record corresponding to the unique ID 
@@ -150,10 +168,17 @@
 Dictionary, Integer, Real, String, MultiArray, MultiData, MultiDate,
 MultiDictionary, MultiInteger, MultiReal, MultiString. i))
 
-((s3 addressbook property remove (-groups | -persons) ((i propName i))
+((s3 addressbook property remove (-groups | -persons | recordID) ((i propName i))
 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
-((i propName i)) argument. One can get the list of all the existing
+((i propName i)) argument. If the third argument is either ((b -groups b)) or
+((b -persons b)), 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.
+((nl One can get the list of all the existing
 properties with the ((b addressbook property names b)) command.
 
 ((s3 addressbook record ((i recordID i))