Selaa lähdekoodia

Updated with new methods.

pallo 25 vuotta sitten
vanhempi
commit
ab36a01a18
1 muutettua tiedostoa jossa 30 lisäystä ja 1 poistoa
  1. 30 1
      doc/addressbook.txt

+ 30 - 1
doc/addressbook.txt

@@ -78,11 +78,13 @@ methods are provided:
    fullname before it is returned.
    fullname before it is returned.
 
 
 
 
-  lookup(NICKNAME)  
+  lookup(NICKNAME, [BNUM])  
 
 
      NICKNAME - Return the user identified by NICKNAME in
      NICKNAME - Return the user identified by NICKNAME in
      the addressbook.
      the addressbook.
 
 
+     BNUM - ID of the backend to look in (optional).
+
    This method will return one result array (see below), an empty
    This method will return one result array (see below), an empty
    array if nothing was found, or false if the search failed. The
    array if nothing was found, or false if the search failed. The
    lookup is only performed in "local" type backends.
    lookup is only performed in "local" type backends.
@@ -108,6 +110,33 @@ methods are provided:
    was added, or false if it failed.
    was added, or false if it failed.
 
 
 
 
+  remove(NICKNAME, BNUM)
+
+     NICKNAME - Delete the user identified by NICKNAME in the
+     addressbook or, if NICKNAME is an array, all users indentified by
+     nthe nicknames in the array.
+
+     BNUM - ID of the backend, as returned by add_backend, to remove
+     the user(s) from.
+
+   This method will retrun true if the user(s) was removed, or false
+   if removal failed.
+
+
+  modify(NICKNAME, USERDATA, BNUM)
+
+     NICKNAME - Update the user identified by NICKNAME in the
+     addressbook.
+
+     USERDATA - Array with user data. The exisiting data for the user
+     will be replaced with this.
+
+     BNUM - ID of the backend, as returned by add_backend, to update
+     the user in.
+
+   This method will retrun true if the user was modified, or false if
+   something failed.
+
 
 
 If one of the above methods fail, an error message is available in the
 If one of the above methods fail, an error message is available in the
 AddressBook->error variable. Feel free to ignore it.
 AddressBook->error variable. Feel free to ignore it.