Skip to main content

Module messages_api

Module messages_api 

Source

Enums§

DeleteMessageError
struct for typed errors of method delete_message
GetMessageError
struct for typed errors of method get_message
GetMessageVersionsError
struct for typed errors of method get_message_versions
GetMessagesError
struct for typed errors of method get_messages
SendMessageError
struct for typed errors of method send_message
UpdateMessageError
struct for typed errors of method update_message

Functions§

delete_message
Soft-deletes a message. This is a POST to a /delete sub-resource (not an HTTP DELETE). Produces a new message version with action message.delete; the deleted message remains retrievable with its delete action applied.
get_message
Returns the latest version of a single message by its serial.
get_message_versions
Returns a paginated list of all versions (create, updates, deletes) of a message. The response body is a JSON array; pagination is conveyed via RFC 5988 Link response headers.
get_messages
Returns a paginated list of messages for a room, ordered per the direction parameter. The response body is a JSON array of messages; pagination is conveyed via RFC 5988 Link response headers (rel=\"first\", rel=\"current\", rel=\"next\").
send_message
Publishes a new message to the room.
update_message
Updates a message. All fields under message are replaced; any omitted message field is reset to empty. Produces a new message version with action message.update.