Home Download News FAQ / Knowledge Base Screenshots Documentation Support
philosophical imaginary

Differences

This shows you the differences between two versions of the page.

documentation:appproto:users [2013/11/14 15:10]
dothebart [Table]
documentation:appproto:users [2016/04/13 16:39] (current)
ajc
Line 9: Line 9:
 ====  PASS   (send PASSword)  ==== ====  PASS   (send PASSword)  ====
 The second step in logging in a user.  This command takes one argument: the password for the user we are attempting to log in.  If the password doesn't match the correct password for the user we specified for the USER command, [[documentation:appproto:statuscodes|ERROR + PASSWORD_REQUIRED]] is returned.  If a USER command has not been executed yet, [[documentation:appproto:statuscodes|ERROR + USERNAME_REQUIRED]] is returned.  If a user is already logged in, [[documentation:appproto:statuscodes|ERROR + ALREADY_LOGGED_IN]] is returned.  If the password is correct, [[documentation:appproto:statuscodes|OK]] is returned and the user is now logged in... and most of the other server commands can now be executed.  Along with [[documentation:appproto:statuscodes|OK]], the following parameters are returned: The second step in logging in a user.  This command takes one argument: the password for the user we are attempting to log in.  If the password doesn't match the correct password for the user we specified for the USER command, [[documentation:appproto:statuscodes|ERROR + PASSWORD_REQUIRED]] is returned.  If a USER command has not been executed yet, [[documentation:appproto:statuscodes|ERROR + USERNAME_REQUIRED]] is returned.  If a user is already logged in, [[documentation:appproto:statuscodes|ERROR + ALREADY_LOGGED_IN]] is returned.  If the password is correct, [[documentation:appproto:statuscodes|OK]] is returned and the user is now logged in... and most of the other server commands can now be executed.  Along with [[documentation:appproto:statuscodes|OK]], the following parameters are returned:
-^No.^Value^ +^ No.  ^ Value                                                                    
-|0 | The user's name (in case the client wants the right upper/lower casing)| +| 0    | The user's name (in case the client wants the right upper/lower casing)  
-|1 | The user's current access level| +| 1    | The user's current access level                                          
-|2 | Times called| +| 2    | Times called                                                             
-|3 | Messages posted| +| 3    | Messages posted                                                          
-|4 | Various flags (see citadel.h)| +| 4    | Various flags  (see libcitadel.h; US_*                                 
-|5 | User number| +| 5    | User number                                                              
-|6 | Time of last call (UNIX timestamp)|+| 6    | Time of last call (UNIX timestamp)                                       | 
  
  
Line 113: Line 114:
  
  
 +
 +====  DLUI   (DownLoad User Image)  ====
 +Download the image (photo, icon, avatar, etc.) associated with a user account.  This command should be passed a single argument - the name of the user whose photo is requested.   If successful, DLUI returns data in the same format as the DLAT (DownLoad ATtachment) command: a BINARY_FOLLOWS code followed by three parameters - the number of bytes in the data, a filename (always empty), the Content-Type (such as image/gif), and the character set (always empty).
  
  
 +====  ULUI   (UpLoad User Image)  ====
 +Upload the image (photo, icon, avatar, etc.) associated with a user account.  This command may be passed either two or three parameters:
  
-====  LBIO   (List users who have BIOs on file ==== +^ No.  ^ Value                                                            ^ 
-This command is self-explanatory.  Any user who has used [[documentation:appproto:users#ebio.enter.biography|EBIO]] to place a bio on file is listed.  LBIO almost always returns [[documentation:appproto:statuscodes|LISTING_FOLLOWS]] followed by this listingunless it experiences an internal error in which case [[documentation:appproto:statuscodes|ERROR]] is returned.+| 0    | Data length to be transmitted (in bytes                        | 
 +1    | MIME Content-Type of the data to be transmitted                  | 
 +| 2    | (Optional) name of the user whose image is being uploaded.  If emptyassumes the currently logged in user|
  
 +An error will occur if a user without administrative privileges attempts to change another user's photo, or if a nonexistent user is specified.
  
 +If successful, a SEND_BINARY response will be delivered, along with the number of bytes expected.  The client MUST then transmit a binary blob containing that number of bytes.
  
  
Copyright © 1987-2016 Uncensored Communications Group. All rights reserved.     Login (site admin)