Develop Channel.Type.MessageArchive spec

[Kaffeine]

A channel type for logs retrieve. Inspired by Channel.Type.RoomList. Can be used to retrieve logs without opening channels for all possible targets.

Methods

GetMessages (a{sv} filter) -> void

Acceptable filter keys listed in FilterKeys property

Signals

MessagesReceived (aaa{sv}: array of Messages)

MessageHeader part:

• message-sender (u - Contact_Handle) The contact who sent the message. If omitted, clients MUST fall back to looking at message-sender-id.
• message-sender-id (s) The identifier of the contact who sent the message.
• scrollback (b) Must be presented and must be true.
• channel-type (u - Handle_Type) Must be presented.
• target-id (s) The identifier of the target. Must be presented.

Properties

FilterKeys — as

Possible (optional) keys:

• with-id - s (string) Identifier of the contact.
• with-type - (u - Handle_Type) Must be presented, if there is with-id key.
• start-timestamp - x (Unix timestamp)
• end-timestamp - x (Unix timestamp)
• start-message-token - s (Protocol_Message_Token)
• end-message-token - s (Protocol_Message_Token)
• limit - u (uint)
• offset - u (uint)