module Crirc::Controller::Command::Chan

Overview

Defines the IRC commands that are related to chans (join, part, ...).

Included Modules

Direct including types

Defined in:

crirc/controller/command/chan.cr

Instance Method Summary

Instance methods inherited from module Crirc::Controller::Command

puts(data) puts

Instance Method Detail

def invite(chan : Crirc::Protocol::Chan, user : Crirc::Protocol::User) #

Invite the user "user" to the channel "chan".


[View source]
def join(chans : Enumerable(Crirc::Protocol::Chan), passwords : Enumerable(String) = [""]) #

Request to join the chan(s) "chans", with password(s) "passwords". The passwords may be ignored if not needed.


[View source]
def join(chan : Crirc::Protocol::Chan, password : String = "") #

Overloads the join function for 1 chan.


[View source]
def kick(chans : Enumerable(Crirc::Protocol::Chan), users : Enumerable(Crirc::Protocol::User), msg : String? = nil) #

Kick the users users from the channels chans. The reason of the kick will be displayed if given as a parameter.


[View source]
def kick(chans : Enumerable(Crirc::Protocol::Chan), user : Crirc::Protocol::User, msg : String? = nil) #

Overloads the kick function for several chans, one user.


[View source]
def kick(chan : Crirc::Protocol::Chan, users : Enumerable(Crirc::Protocol::User), msg : String? = nil) #

Overloads the kick function for one chan, several users.


[View source]
def kick(chan : Crirc::Protocol::Chan, user : Crirc::Protocol::User, msg : String? = nil) #

Overloads the kick function for one chan, one user.


[View source]
def list(chans : Enumerable(Crirc::Protocol::Chan?)?) #

List the channels and their topics. If the chans parameter is given, lists the status of the given chans.


[View source]
def list(chan : Crirc::Protocol::Chan) #

Overloads the list function for 1 chan.


[View source]
def mode(chan : Crirc::Protocol::Chan, flags : String, user : Crirc::Protocol::User? = nil) #

Request to change the mode of the given channel. If the mode is to be applied to an user, precise it.


[View source]
def names(chans : Enumerable(Crirc::Protocol::Chan)?) #

Request the names of the users in the given channel(s). If no channel is given, requests the names of the users in every known channel.


[View source]
def names(chan : Crirc::Protocol::Chan) #

Overloads the names function for 1 chan.


[View source]
def part(chans : Enumerable(Crirc::Protocol::Chan), msg : String? = nil) #

Request to leave the channel(s) "chans", with an optional part message "msg".


[View source]
def part(chan : Crirc::Protocol::Chan, msg : String? = nil) #

Overloads the part function for 1 chan.


[View source]
def topic(chan : Crirc::Protocol::Chan, msg : String? = nil) #

Request to change the topic of the given channel. If no topic is given, requests the topic of the given channel.


[View source]