module

Crirc::Controller::Command::Chan

Inherits Crirc::Controller::Command

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

Instance methods

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

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

Source

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.

Source

join(chan : Crirc::Protocol::Chan, password : String = "")

Overloads the join function for 1 chan.

Source

kick(chans : Enumerable(Crirc::Protocol::Chan), users : Enumerable(Crirc::Protocol::User), msg : String | Nil = nil)

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

Source

kick(chans : Enumerable(Crirc::Protocol::Chan), user : Crirc::Protocol::User, msg : String | Nil = nil)

Overloads the kick function for several chans, one user.

Source

kick(chan : Crirc::Protocol::Chan, users : Enumerable(Crirc::Protocol::User), msg : String | Nil = nil)

Overloads the kick function for one chan, several users.

Source

kick(chan : Crirc::Protocol::Chan, user : Crirc::Protocol::User, msg : String | Nil = nil)

Overloads the kick function for one chan, one user.

Source

list(chans : Enumerable(Crirc::Protocol::Chan | Nil) | Nil)

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

Source

list(chan : Crirc::Protocol::Chan)

Overloads the list function for 1 chan.

Source

mode(chan : Crirc::Protocol::Chan, flags : String, user : Crirc::Protocol::User | Nil = nil)

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

Source

names(chans : Enumerable(Crirc::Protocol::Chan) | Nil)

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.

Source

names(chan : Crirc::Protocol::Chan)

Overloads the names function for 1 chan.

Source

part(chans : Enumerable(Crirc::Protocol::Chan), msg : String | Nil = nil)

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

Source

part(chan : Crirc::Protocol::Chan, msg : String | Nil = nil)

Overloads the part function for 1 chan.

Source

topic(chan : Crirc::Protocol::Chan, msg : String | Nil = nil)

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

Source