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:room_indexes_and_messages [2012/07/02 16:58]
ajc
documentation:appproto:room_indexes_and_messages [2017/01/06 23:12] (current)
ajc [MSGS (get pointers to MeSsaGeS in this room)]
Line 63: Line 63:
  
 The default view gives the client a hint as to what views the user should be allowed to select.  For example, it would be confusing to allow messages in a room intended for calendar items.  The server does not enforce these restrictions, though. The default view gives the client a hint as to what views the user should be allowed to select.  For example, it would be confusing to allow messages in a room intended for calendar items.  The server does not enforce these restrictions, though.
 +
 +
 +==== STAT   (retrieve name and modification time of current room) ====
 +
 +This is a lightweight command which may be used by a client to quickly determine whether there has been any activity in the current room (added or deleted messages, modification of the room's configuration, etc).  It is called with no parameters, and returns OK followed by two parameters: the name of the room, and the modification timestamp.
 +
  
 =====Commands manipulating Messageindex Lists===== =====Commands manipulating Messageindex Lists=====
Line 78: Line 84:
 [[documentation:appproto:room_indexes_and_messages#message.type.values|listed below in the writeup for the "MSG0" command]]. [[documentation:appproto:room_indexes_and_messages#message.type.values|listed below in the writeup for the "MSG0" command]].
  
-The optional fourth argument may also be either 0 or 1. If it is 1, the output of this command will include not only a list of message numbers, but a simple header summary of each message as well. This is somewhat resource intensive so you shouldn't do this unless you absolutely need all the headers immediately. The fields which are output (in the usual delimited fashion, of course) are: message number, timestamp, display name, node name, Internet email address (if present), subject (if present).+The optional fourth argument may also be either 0 or 9. If it is 9, the output of this command will include not only a list of message numbers, but a simple header summary of each message as well. This is somewhat resource intensive so you shouldn't do this unless you absolutely need all the headers immediately. The fields which are output (in the usual delimited fashion, of course) are: message number, timestamp, display name, node name, Internet email address (if present), subject (if present), hash of message-id (if present), comma-separated hashes of message thread references (if present).
  
 This command can return three possible results. ERROR + NOT_LOGGED_IN will be returned if no user is currently logged in. Otherwise, LISTING_FOLLOWS will be returned, and the listing will consist of zero or more message numbers, one per line. The listing ends, as always, with the string "000" alone on a line by itself. The listed message numbers can be used to request messages from the system. If "search mode" is being used, the server will return START_CHAT_MODE, and the client is expected to transmit the search criteria, and then read the message list. This command can return three possible results. ERROR + NOT_LOGGED_IN will be returned if no user is currently logged in. Otherwise, LISTING_FOLLOWS will be returned, and the listing will consist of zero or more message numbers, one per line. The listing ends, as always, with the string "000" alone on a line by itself. The listed message numbers can be used to request messages from the system. If "search mode" is being used, the server will return START_CHAT_MODE, and the client is expected to transmit the search criteria, and then read the message list.
Line 124: Line 130:
 Note that in "search mode" the client may specify any number of search criteria.  These criteria are applied with an AND logic. Note that in "search mode" the client may specify any number of search criteria.  These criteria are applied with an AND logic.
  
 +Another note: anyone reading through the code may observe that there are other undocumented parameters which may be supplied to this command.  These are deprecated and should not be used.
 ====  SEEN   (set or clear the SEEN flag for a message)  ==== ====  SEEN   (set or clear the SEEN flag for a message)  ====
  
Copyright © 1987-2017 Uncensored Communications Group. All rights reserved.     Login (site admin)