Commit 72a0cc4f authored by Per Cederqvist's avatar Per Cederqvist

(get-membership-old): Use a "want-read-texts : BOOL" argument instead

	of "mask : BITSTRING(want-read-texts)".  The result is the
	same, but using BOOL makes the prototype easier to read.
	Document the argument more verbosely.
(get-membership): Do likewise.
(login): Do likewise for the "invisible" argument.
(create-anonymous-text-old): Added @misc{} markup.
parent 9c78d7a0
......@@ -2,7 +2,7 @@
@c
@c FIXME: Explain how the garb works with nice and keep-commented
@c
@c $Id: Protocol-A.texi,v 1.110 2001/04/18 08:22:11 ceder Exp $
@c $Id: Protocol-A.texi,v 1.111 2001/04/18 21:08:32 ceder Exp $
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
......@@ -5437,10 +5437,7 @@ Messages have been disabled.
get-membership-old [46] (( person : Pers-No;
first : INT16;
no-of-confs : INT16;
mask : BITSTRING
(
want-read-texts
); ))
want-read-texts : BOOL ))
-> ( ARRAY Membership-Old );
@end example
......@@ -5448,9 +5445,10 @@ This call retrieves the membership record for a list of conferences for
a single person. @rarg{person} is the person whose memberships are to be
retrieved. @rarg{first} is the first position in the membership list to
retrieve, numbered from 0 and up. @rarg{no-of-confs} is the number of
membership records to retrieve. @rarg{mask} is a set of flags. Currently
the only flag is @rarg{want-read-texts}, which instructs the server not
to send the @field{read-texts} array of the memberships.
membership records to retrieve. If @rarg{want-read-texts} is @samp{0}
the server will not send the contents of the @field{read-texts} array
of the memberships. (The size will be transmitted, but a single
asterisk (@samp{*}) will be sent instead of the array itself.)
The server will return a membership list that is shorter than
@rarg{no-of-confs} if @rarg{no-of-confs} + @rarg{first} is larger than
......@@ -5471,12 +5469,14 @@ zero.)
@t{=1 1 @{ 20 14 22 17 6 97 4 197 1 6 100 2 0 * @}}
@end example
In this example we retrieve the memberships of person 5. The first call
asks for three memberships, starting with number 0. Since this person is
only a member of two conferences, the list returned only contains two
memberships. The next two calls retrieve a single membership each. The
first by asking for only one, and the second by asking for four
memberships, starting with number 1.
In this example we retrieve the memberships of person 5. The first
call asks for three memberships, starting with number 0. Since this
person is only a member of two conferences, the list returned only
contains two memberships. (An extra newline has been inserted in the
result of the first call to make the result more readable.) The next
two calls retrieve a single membership each, the first by asking for
only one, and the second by asking for four memberships, starting with
number 1.
@subheading Error codes
......@@ -6014,8 +6014,9 @@ explicit support for sending anonymous texts to a server.
It is only possible to send anonymous texts to a conference with the
right flag bit set.
The only Misc-Info items valid for this call are recpt, cc-recpt,
bcc-recpt (protocol version 10) comm-to and footn-to.
The only Misc-Info items valid for this call in the @rarg{misc-info}
array are @misc{recpt}, @misc{cc-recpt}, @misc{bcc-recpt} (introducted
in protocol version 10), @misc{comm-to} and @misc{footn-to}.
@example
1 28 20HExample\nMessage body 3 @{ 0 5 1 112 2 33467 @}
......@@ -6141,18 +6142,15 @@ There is no text preceding text @rarg{start}.
@example
login [62] (( person : Pers-No;
passwd : HOLLERITH;
visibility : BITSTRING
(
is-invisible;
); ))
invisible : BOOL ))
-> ( );
@end example
This call is used to log in. The session is logged in as person number
@rarg{person} if @rarg{passwd} is the correct password for that person.
If @rarg{is-invisible} is true, the session is invisible. It will not be
If @rarg{invisible} is true, the session is invisible. It will not be
returned by @req{who-is-on} and @req{who-is-on-ident} and the
invisible flag of the dynamic session info (@pxref{LysKOM Data Types}
dynamic session info (@pxref{LysKOM Data Types}
will have the invisible flag set.
Invisible sessions are primarily used by software agents that do not act
......@@ -7515,20 +7513,19 @@ privileges to find out if @rarg{person} is a member.
get-membership [99] (( person : Pers-No;
first : INT16;
no-of-confs : INT16;
mask : BITSTRING
(
want-read-texts
); ))
want-read-texts : BOOL ))
-> ( ARRAY Membership );
@end example
This call retrieves the membership record for a list of conferences for
a single person. @rarg{person} is the person whose memberships are to be
retrieved. @rarg{first} is the first position in the membership list to
retrieve, numbered from 0 and up. @rarg{no-of-confs} is the number of
membership records to retrieve. @rarg{mask} is a set of flags. Currently
the only flag is @rarg{want-read-texts}, which instructs the server not
to send the @field{read-texts} array of the memberships.
This call retrieves the membership record for a list of conferences
for a single person. @rarg{person} is the person whose memberships are
to be retrieved. @rarg{first} is the first position in the membership
list to retrieve, numbered from 0 and up. @rarg{no-of-confs} is the
number of membership records to retrieve. If @rarg{want-read-texts} is
@samp{0}, the server will not send the contents of the
@field{read-texts} array of the memberships. (The size will be
transmitted, but a single asterisk (@samp{*}) will be sent instead of
the array itself.)
The server will return a membership list that is shorter than
@rarg{no-of-confs} if @rarg{no-of-confs} + @rarg{first} is larger than
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment