module PrivateParlorXT

Defined in:

Constant Summary

VERSION = "1.2.3"

Class Method Summary

.command_disabled(message : Tourmaline::Message, services : Services) : Nil
Queues a command_disabled system reply when the CommandHandler was disabled
.generate_callback_query_handlers(config : Config, services : Services) : Array(Tourmaline::CallbackQueryHandler)
Initializes all CallbackHandler
.generate_command_handlers(config : Config, client : Tourmaline::Client, services : Services) : Array(Tourmaline::CommandHandler)
Intialize all command handlers that inherit from CommandHandler and are annotated with RespondsTo
.generate_hears_handlers(config : Config, services : Services) : Array(Tourmaline::HearsHandler)
Intialize all "hears" handlers that inherit from HearsHandler and are annotated with Hears
.generate_update_handlers(config : Config, client : Client, services : Services) : Nil
Intialize all update handlers that inherit from UpdateHandler and are annotated with On
.initialize_bot(client : Client | Nil = nil) : Services
Reads from the config file and initialize Services, recurring tasks, and bot handlers
.initialize_handlers(client : Tourmaline::Client, config : Config, services : Services) : Nil
Initialize bot handlers, such as CommandHandler, HearsHandler, CallbackHandler, and UpdateHandler
.kick_inactive_users(limit : Time::Span, services : Services) : Nil
Force-leave users whose last active time is creater than the given Time::Span limit
.media_disabled(message : Tourmaline::Message, type : Tourmaline::UpdateAction, services : Services) : Nil
Queues a media_disabled system reply when the UpdateHandler was disabled
.start_tasks(config : Config, services : Services) : Nil
Initializes recurring tasks, such as: - Warning expiration - Message expiration (if toggled) - Spam cooldown expiration (if toggled) - Inactive user kicking (if toggled)
.terminate_program(routine : Tasker::Task, services : Services) : Nil
Stop the message sending routine, send remaining messages in the queue and terminate the program

Macro Summary

append_command_handler(command, call)
Appends given CommandHandler to Tourmaline::CommandHandler array
append_hears_handler(hears_handler, hears)
Appends given HearsHandler to Tourmaline::HearsHandler array
create_command_handlers
Iterate through all CommandHandler subclasses and initialize Tourmaline::CommandHandler procs for these commands.
create_hears_handlers
Iterate through all HearsHandler subclasses and initialize Tourmaline::HearsHandler procs for these handlers.
create_update_handlers
Iterate through all UpdateHandler subclasses and initialize Tourmaline::UpdateHandler procs for these handlers.
register_update_handler(update, on)
Registers the given UpdateHandler with the bot

Class Method Detail

def self.command_disabled(message : Tourmaline::Message, services : Services) : Nil #

Queues a command_disabled system reply when the CommandHandler was disabled

[View source]

def self.generate_callback_query_handlers(config : Config, services : Services) : Array(Tourmaline::CallbackQueryHandler) #

Initializes all CallbackHandler

[View source]

def self.generate_command_handlers(config : Config, client : Tourmaline::Client, services : Services) : Array(Tourmaline::CommandHandler) #

Intialize all command handlers that inherit from CommandHandler and are annotated with RespondsTo

[View source]

def self.generate_hears_handlers(config : Config, services : Services) : Array(Tourmaline::HearsHandler) #

Intialize all "hears" handlers that inherit from HearsHandler and are annotated with Hears

[View source]

def self.generate_update_handlers(config : Config, client : Client, services : Services) : Nil #

Intialize all update handlers that inherit from UpdateHandler and are annotated with On

[View source]

def self.initialize_bot(client : Client | Nil = nil) : Services #

Reads from the config file and initialize Services, recurring tasks, and bot handlers

Returns the initialized Services object

[View source]

def self.initialize_handlers(client : Tourmaline::Client, config : Config, services : Services) : Nil #

Initialize bot handlers, such as CommandHandler, HearsHandler, CallbackHandler, and UpdateHandler

[View source]

def self.kick_inactive_users(limit : Time::Span, services : Services) : Nil #

Force-leave users whose last active time is creater than the given Time::Span limit

[View source]

def self.media_disabled(message : Tourmaline::Message, type : Tourmaline::UpdateAction, services : Services) : Nil #

Queues a media_disabled system reply when the UpdateHandler was disabled

[View source]

def self.start_tasks(config : Config, services : Services) : Nil #

Initializes recurring tasks, such as:

Warning expiration
Message expiration (if toggled)
Spam cooldown expiration (if toggled)
Inactive user kicking (if toggled)

[View source]

def self.terminate_program(routine : Tasker::Task, services : Services) : Nil #

Stop the message sending routine, send remaining messages in the queue and terminate the program

[View source]

Macro Detail

macro append_command_handler(command, call) #

Appends given CommandHandler to Tourmaline::CommandHandler array

The given CommandHandler will respond to command value(s) of RespondsTo

[View source]

macro append_hears_handler(hears_handler, hears) #

Appends given HearsHandler to Tourmaline::HearsHandler array

The given HearsHandler will respond to the pattern value of Hears

[View source]

macro create_command_handlers #

Iterate through all CommandHandler subclasses and initialize Tourmaline::CommandHandler procs for these commands.

CommandDescriptions for each CommandHandler will be registered by the bot if the the command is configurable.

[View source]

macro create_hears_handlers #

Iterate through all HearsHandler subclasses and initialize Tourmaline::HearsHandler procs for these handlers.

[View source]

macro create_update_handlers #

Iterate through all UpdateHandler subclasses and initialize Tourmaline::UpdateHandler procs for these handlers.

[View source]

macro register_update_handler(update, on) #

Registers the given UpdateHandler with the bot

The given UpdateHandler will respond to messages of type update value of On

[View source]

CrystalDoc.info

private-parlor-xt

module PrivateParlorXT

Defined in:

Constant Summary

Class Method Summary

Macro Summary

Class Method Detail

Macro Detail