abstract class PrivateParlorXT::User

• PrivateParlorXT::User
• Reference
• Object

Overview

A reprentation of a Telegram user.

All users require an ID, which is obtained from the Telegram user (Tourmaline::User). This ID should be unique and stored as a UserID.

Database implementations should have their own User type that inherits from this class and is modified to work with the given implementation.

Direct Known Subclasses

• PrivateParlorXT::SQLiteUser

Defined in:

private-parlor-xt/user.cr

Constructors

• .new(id : UserID, username : String | Nil = nil, realname : String = "", rank : Int32 = 0, joined : Time = Time.utc, left : Time | Nil = nil, last_active : Time = Time.utc, cooldown_until : Time | Nil = nil, blacklist_reason : String | Nil = nil, warnings : Int32 = 0, warn_expiry : Time | Nil = nil, karma : Int32 = 0, hide_karma : Bool | Nil = false, debug_enabled : Bool | Nil = false, tripcode : String | Nil = nil)

  Creates an instance of User.

Instance Method Summary

• #blacklist(reason : String | Nil) : Nil

  Set the user's #rank to -10 (blacklisted), sets the #left value, and updates the #blacklist_reason

• #blacklist_reason : String | Nil

  Returns the reason why the user was blacklisted, or nil if a reason does not exist

• #blacklisted? : Bool

  Returns true if rank is -10; user is blacklisted.

• #can_chat?(limit : Time::Span) : Bool

  Returns true if user is joined, not in cooldown, not blacklisted, and not limited; user can chat

• #can_chat? : Bool

  Returns true if user is joined, not in cooldown, and not blacklisted; user can chat

• #can_use_command? : Bool

  Returns true if user is joined and not blacklisted; user can use commands

• #cooldown(base : Int32) : Time::Span

  Gives the user an exponentially increasing cooldown from the given base value and current number of #warnings

• #cooldown(time : Time::Span) : Time::Span

  Gives the user a cooldown based on the given Time::Span

• #cooldown_until : Time | Nil

  Returns the Time until which the user is in cooldown, or nil if the user is not cooldowned

• #debug_enabled : Bool | Nil

  Returns true if the suer has debug mode enabled, false otherwise

• #decrement_karma(amount : Int32 = 1) : Nil

  Decrement the user's #karma by a given amount (1 by default) On arithmetic overflow, sets user's #karma to the minimum Int32 value

• #formatted_name : String

  Get the formatted name of the user.

• #hide_karma : Bool | Nil

  Returns true if the user has karma notifications disabled, false otherwise

• #id : UserID

  Returns the user's ID

• #increment_karma(amount : Int32 = 1) : Nil

  Increment the user's #karma by a given amount (1 by default) On arithmetic overflow, sets user's #karma to the maximum Int32 value

• #joined : Time

  Returns the Time the user joined the chat

• #karma : Int32

  Returns the user's current amount of karma

• #last_active : Time

  Returns the Time the user was last active (i.e., the last time a message was sent or a command was used)

• #left : Time | Nil

  Returns the Time the user left the chat, or nil if the user has not left

• #left? : Bool

  Returns true if left is not nil; user has left the chat.

• #obfuscated_id : String

  Generate an obfuscated ID for the user, used for log messages and commands like InfoCommand

• #obfuscated_karma : Int32

  Get the user's obfuscated #karma

• #rank : Int32

  Returns the user's current rank value

• #realname : String

  Returns the user's full name

• #rejoin : Nil

  Set #left to nil, meaning that the User has joined the chat.

• #remove_cooldown(override : Bool = false) : Bool

  Removes a cooldown from a user if it has expired.

• #remove_warning(amount : Int32, warn_lifespan : Time::Span) : Nil

  Removes the given amount of #warnings from a user

• #set_active : Nil

  Set #last_active to the current time

• #set_left : Nil

  Set #left to the current time

• #set_rank(rank : Int32) : Nil

  Set #rank to the given value

• #set_tripcode(tripcode : String) : Nil

  Set #tripcode to the given value

• #to_a : Array(UserID | String | Int32 | Time | Bool | Nil)

  Returns an array with all the values in User.

• #toggle_debug : Nil

  Switches user's #debug_enabled toggle

• #toggle_karma : Nil

  Switches user's #hide_karma notifications toggle

• #tripcode : String | Nil

  Returns a String containing the user's tripcode name and password for generating tripcodes, or nil if the user has no tripcode set

• #update_names(username : String | Nil, fullname : String) : Nil

  Sets user's #username and #realname to the given values

• #username : String | Nil

  Returns the user's unformatted username, or nil if it does not exist

• #warn(lifespan : Int32) : Nil

  Increments the user's #warnings and sets the #warn_expiry to the current time plus the lifespan of a warning

• #warn_expiry : Time | Nil

  Returns the Time when one of the #warnings will expire, or nil if such a time does not exit

• #warnings : Int32

  Returns the number of warnings the user has

Constructor Detail

Instance Method Detail