Commit 94fdf455 authored by David Byers's avatar David Byers

Documented two elisp-client-specific aux-items

parent 9ca283b4
......@@ -8689,6 +8689,57 @@ Only the author of the text can set this item. The data must be the
empty string. The hide-creator, secret, dont-garb and inherit bits
are automatically cleared.
@item elisp-client-read-faq [10000] (letterbox)
This item indicates FAQs that the user has read. Data is a decimal
number indicating the conference for which a FAQ has been read,
followed by a space character and a second decimal number indicating
the text number of the FAQ. In the future, additional data may be
defined; clients should be prepared to accept and ignore a space and
any trailing data that may follow the second number.
Note that aux-items of this type should always be secret since they
may contain information about texts of conferences that are not
publicly visible.
A few examples might clarify what the data may look like:
@table @code
@item 459 11215
FAQ in text 11215 for conference 459 has been read.
@item 459 11215 garbage
FAQ in text 11215 has been read. Clients must ignore the trailing
garbage. Note that clients are not allowed to create aux-items of this
format, but they should be prepared to handle them correctly.
@end table
This aux-item is specific to the elisp client. Other clients are not
required to use or understand this item type.
@item elisp-client-rejected-recommendation [10001] (letterbox)
This item indicates a rejected membership recommendation. Data is a
decimal number indicating the conference for which the recommendation
was rejected. In the future, additional data may be defined; clients
should be prepared to accept and ignore a space and any trailing data
that may follow the second number.
Note that aux-items of this type should always be secret since future
extensions may contain sensitive data.
A few examples might clarify what the data may look like:
@table @code
@item 459
A recommendation for conference 459 has been rejected.
@item 459 garbage
A recommendation for conference 459 has been rejected. Clients must
ignore the trailing garbage. Note that clients are not allowed to
create aux-items of this format, but they should be prepared to handle
them correctly.
@end table
This aux-item is specific to the elisp client. Other clients are not
required to use or understand this item type.
@item mx-mime-belongs-to [10100] (text)
Data is a decimal text number that this text is an attachment to. Most
......
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