abstract class PrivateParlorXT::History

• PrivateParlorXT::History
• Reference
• Object

Overview

A base class for objects that store the history of sent messages so that they can be referenced later for replies, deletions, or other commands

Direct Known Subclasses

• PrivateParlorXT::CachedHistory
• PrivateParlorXT::SQLiteHistory

Defined in:

private-parlor-xt/history/history.cr

Constructors

• .new(lifespan : Time::Span)

  Initialize a message History where messages older than #lifespan are considered expired

Instance Method Summary

• #add_rating(message : MessageID, user : UserID) : Bool

  Adds a rating entry to the database with the given data

• #add_to_history(origin : MessageID, receiver : MessageID, receiver_id : UserID) : Nil

  Add a receiver message to the History

• #add_warning(message : MessageID) : Nil

  Adds a warning to the given message

• #close

  Cleanup when finished with History

• #delete_message_group(message : MessageID) : MessageID | Nil

  Delete a message group from the History

• #expire : Nil

  Deletes old messages from the History

• #lifespan : Time::Span

  Returns the Time::Span for which a message can exist before expiring

• #messages_from_user(user : UserID) : Set(MessageID)

  Get all message IDs sent by a given user for purging messages

• #new_message(sender_id : UserID, origin : MessageID) : MessageID

  Create a new message group and add it to the History

• #origin_message(message : MessageID) : MessageID | Nil

  Get the message ID of the original message associated with the given message ID

• #purge_receivers(messages : Set(MessageID)) : Hash(UserID, Array(MessageID))

  Get a hash containing an array of message IDs to delete associated with the users who received a message in the given set.

• #receiver_message(message : MessageID, receiver : UserID) : MessageID | Nil

  Get the original message ID associated with the given message ID and receiver ID

• #receivers(message : MessageID) : Hash(UserID, MessageID)

  Get a hash of all users and receiver message IDs associated with the given message ID

• #sender(message : MessageID) : UserID | Nil

  Get the sender of the original message referenced by the given message ID

• #warned?(message : MessageID) : Bool | Nil

  Returns true if the given message was already warned; false or nil otherwise

Constructor Detail

Instance Method Detail