class PrivateParlorXT::HelpCommand

Overview

A command used to view the commands that one can use

Defined in:

private-parlor-xt/handlers/command_handlers/help_command.cr

Instance Method Summary

Instance methods inherited from class PrivateParlorXT::CommandHandler

authorized?(user : User, message : Tourmaline::Message, permission : CommandPermissions, services : Services) : Bool
authorized?(user : User, message : Tourmaline::Message, services : Services, *permissions : CommandPermissions) : CommandPermissions | Nil authorized?, delete_messages(message : MessageID, user : UserID, debug_enabled : Bool | Nil, services : Services) : MessageID | Nil delete_messages, deny_user(user : User, services : Services) : Nil deny_user, remove_command_entity(text : String, entities : Array(Tourmaline::MessageEntity), arg : String) : Array(Tourmaline::MessageEntity) remove_command_entity, user_from_message(message : Tourmaline::Message, services : Services) : User | Nil user_from_message

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 #

Returns a message containing commands that the sender of the message can use


[View source]
def help(user : User, ranks : Hash(Int32, Rank), services : Services) : String #

Returns a generated message containing the commands the user can use based on his rank.


[View source]