class PrivateParlorXT::DocumentHandler

Overview

A handler for files and document message updates

Defined in:

private-parlor-xt/handlers/update_handlers/document_handler.cr

Instance Method Summary

Instance methods inherited from class PrivateParlorXT::UpdateHandler

authorized?(user : User, message : Tourmaline::Message, authority : MessagePermissions, services : Services) : Bool authorized?, deny_user(user : User, services : Services) : Nil deny_user, meets_requirements?(message : Tourmaline::Message) : Bool meets_requirements?, message_receivers(user : User, services : Services) : Array(UserID) message_receivers, record_message_statistics(type : Statistics::Messages, services : Services) : Nil record_message_statistics, reply_receivers(message : Tourmaline::Message, user : User, services : Services) : Hash(UserID, ReplyParameters) | Nil reply_receivers, user_from_message(message : Tourmaline::Message, services : Services) : User | Nil user_from_message

Macros inherited from class PrivateParlorXT::UpdateHandler

return_on_command(text) return_on_command

Instance methods inherited from class PrivateParlorXT::Handler

do(message : Tourmaline::Message, services : Services) : Nil do, reply_message(user : User, message : Tourmaline::Message, services : Services) : Tourmaline::Message | Nil reply_message, reply_user(user : User, reply_message : Tourmaline::Message, services : Services) : User | Nil reply_user, unique?(user : User, message : Tourmaline::Message, services : Services, text : String | Nil = nil) : Bool unique?, update_user_activity(user : User, services : Services) : Nil update_user_activity

Constructor methods inherited from class PrivateParlorXT::Handler

new(config : Config) new

Instance Method Detail

def do(message : Tourmaline::Message, services : Services) : Nil #

Checks if the document message meets requirements and relays it


[View source]
def meets_requirements?(message : Tourmaline::Message) : Bool #

Returns true if the message meets requirements

Returns `false if the message does not meet requirements, when the message is a forward, part of an album, or an animation/GIF


[View source]
def spamming?(user : User, message : Tourmaline::Message, services : Services) : Bool #

Checks if the user is spamming documents

Returns true if the user is spamming documents, false otherwise


[View source]
def spend_karma(user : User, services : Services) : User #

Returns the User with decremented karma when KarmaHandler is enabled and user has sufficient karma for a document


[View source]
def sufficient_karma?(user : User, message : Tourmaline::Message, services : Services) : Bool | Nil #

Checks if the user has sufficient karma to send a document when KarmaHandler is enabled

Returns true if:

  • KarmaHandler is not enabled
  • The price for documents is less than 0
  • The user's Rank is equal to or greater than the cutoff Rank
  • User has sufficient karma

Returns nil if the user does not have sufficient karma


[View source]