doc/TRANE-PASSENGERS.html

   1 <html><head><title>TRANE-PASSENGERS</title></head><body><h3>API for package TRANE-PASSENGERS</h3>
   2 <blockquote>UNDOCUMENTED</blockquote>
   3 <p>(<b>activate-passenger</b> class ticket)&nbsp;&nbsp;&nbsp;<i>function</i></p>
   4 <blockquote>Activate passenger of CLASS, using TICKET.
   5
   6 Thin wrapper on CONFIRM-ACTIVATION-TICKET, returns passenger DAO
   7 instead of numerical ID, and signals UNAUTHORIZED-ERROR on invalid
   8 TICKET.</blockquote><p>(<b>confirm-activation-ticket</b> class ticket &key activation-info ticket-timeout)&nbsp;&nbsp;&nbsp;<i>function</i></p>
   9 <blockquote>Confirm activation ticket TICKET for passenger class CLASS.
  10
  11 ACTIVATION-INFO is additional information stored in the database.
  12 TICKET-TIMEOUT is number of days, after which activation ticket becomes invalid.
  13
  14 Returns valiated user ID (integer), or NIL if ticket is
  15 invalid (i.e. nonexistent, already used, or more than 5 days old).</blockquote><p>(<b>cookie-passenger</b> cookie class)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  16 <blockquote>Authorize passenger of CLASS, based on authentication cookie COOKIE.</blockquote><p>(<b>create-activation-ticket</b> passenger &optional count)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  17 <blockquote>Create new activation ticket for PASSENGER.
  18
  19 Used in new user registration and in password recovery process.
  20 Returns activation ticket as string.</blockquote><p>(<b>id</b> x)&nbsp;&nbsp;&nbsp;<i>generic-function</i></p>
  21 <blockquote>Numeric ID or :NULL for DAOs and, if it makes sense, other objects.
  22
  23 Usually it will be a reader method automatically defined for ID column of a DAO.</blockquote><p>(<b>invite-passenger</b> parent email &rest initargs)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  24 <blockquote>Let passenger PARENT invite new passenger at EMAIL.</blockquote><p><b>passenger</b>&nbsp;&nbsp;&nbsp;<i>class</i></p>
  25 <blockquote>A basic, user-like object.</blockquote><blockquote>Class precedence list: <tt> passenger dirtiness-mixin standard-object t</tt></blockquote>
  26 <blockquote>Class init args: <tt> :name :active-p :parent :email :password-base64 :confirmed-p :invitations</tt></blockquote>
  27 <p><b>PASSENGER-ACTIVE-P</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  28 <p><b>PASSENGER-CONFIRMED-P</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  29 <p>(<b>passenger-cookie</b> passenger)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  30 <blockquote>Return authentication cookie for PASSENGER.</blockquote><p><b>PASSENGER-EMAIL</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  31 <p><b>PASSENGER-INVITATIONS</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  32 <p><b>PASSENGER-NAME</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  33 <p><b>PASSENGER-PARENT</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  34 <p><b>PASSENGER-PASSWORD</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  35 <p><b>passenger-unauthorized-error</b>&nbsp;&nbsp;&nbsp;<i>condition</i></p>
  36 <blockquote>Error raised on authorization failure.</blockquote><blockquote>Class precedence list: <tt> passenger-unauthorized-error error serious-condition condition standard-object t</tt></blockquote>
  37 <p>(<b>register-passenger</b> class &rest initargs)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  38 <blockquote>Register new passenger of CLASS.
  39
  40 Thin wrapper arount MAKE-INSTANCE+INSERT-DAO.  INITARGS are
  41 MAKE-INSTANCE keyword arguments; if :PARENT initarg is given, parent's
  42 ID is automatically calculated, so user DAO can be directly provided.
  43 Returns new passenger's activation ticket and created DAO (already
  44 inserted into database).</blockquote><p>(<b>setup-passenger-class-sql</b> class)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  45 <blockquote>SQL statement list to initialize passenger class CLASS.</blockquote><p>(<b>try-activation-ticket</b> class ticket)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  46 <blockquote>Try (but do not mark as already used) an activation ticket.
  47
  48 Returns ticket's passenger ID (integer), or NIL.</blockquote><font size=-1><p>Documentation generated by <a href="http://homepage.mac.com/svc/lispdoc/">lispdoc</a> running on Clozure Common Lisp</p></font></body></html>