Commit 8582d53c authored by Per Cederqvist's avatar Per Cederqvist
Browse files

(Person Status Types): Added a reference to Security, for an

	explanation of the privileges.  Document the bits in Personal-Flags.
(Membership Information): Document how unread-is-secret affects some
	parts of Membership and Membership-Old. (Bug 593).
parent b221b54e
......@@ -2115,7 +2115,7 @@ Human-readable name of the server software version.
These types are used to specify information about persons. @type{Person}
contains the information about a person, @type{Personal-Flags} contains
flags set by the user and @type{Priv-Bits} contains the person's
privileges.
privileges (@pxref{Security}).
The fields of @type{Person} are
......@@ -2163,6 +2163,26 @@ The number of marked texts this person has.
The number of conferences the person is a member of.
@end table
The fields of @type{Personal-Flags} are
@table @field
@item unread-is-secret
If this is set, nobody can see how many texts you have read in a
certain conference. The server will clear the @field{read-texts},
@field{last-time-read} and @field{last-text-read} fields of
@type{Membership} and @type{Membership-Old} when other persons asks
about your information.
@item flg2
@itemx flg3
@itemx flg4
@itemx flg5
@itemx flg6
@itemx flg7
@itemx flg8
Reserved for the future. Set them to 0, and ignore the values they
have.
@end table
@node Membership Information
@section Membership Information
......@@ -2273,7 +2293,10 @@ membership in a conference. It is returned by the
@item position
The position of this membership in the membership list.
@item last-time-read
The time when the person last read anything from the conference.
The time when the person last read anything from the conference. This
will contain the start of the epoch if the @field{unread-is-secret}
bit of the @type{Personal-flags} is set and you don't have enough
privileges to get the info anyhow.
@item conference
The conference this membership data pertains to.
@item priority
......@@ -2281,10 +2304,14 @@ The priority the person has assigned to the conference. The higher the
number, the higher the priority. In the past, priority zero indicated a
passive membership. This usage is now obsolete.
@item last-text-read
The local number of last text read in the conference.
The local number of last text read in the conference. This will be
set to 0 if @field{unread-is-secret} is set, unless you have access to
the data anyhow.
@item read-texts
Additional texts beyond @field{last-text-read} that have also been read.
@item added-by
Additional texts beyond @field{last-text-read} that have also been
read. This will be empty if @field{unread-is-secret} is set, unless
you have access to the data anyhow.
@item added-byp
The person who created the membership. This field is zero if the
membership was created before protocol version 10 was introduced.
@item added-at
......
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