Blur v0.2.1-beta1 Blur.IRC View Source
Shortcuts for IRC options to auto join channels
client is a process of ExIRC.Client.start_link
Link to this section Summary
Functions
Request the CAP (capability) on the server
Connect to the default IRC server.
Connect to the IRC server.
Join an IRC channel.
Join many channels.
Login to the server.
Parse oauth token
Part from IRC channel.
Quit the IRC server with no message.
Quit the IRC server.
Request twitch for capabilities
Send a message to the channel
Stop the IRC client process
Link to this section Functions
Specs
Request the CAP (capability) on the server
Example
iex> Blur.IRC.cap_request client, ':twitch.tv/membership'
:ok
Specs
connect!(client :: pid()) :: :ok
Connect to the default IRC server.
Example
iex> Blur.IRC.connect client
:ok
Specs
connect!(client :: pid(), host :: binary(), port :: non_neg_integer()) :: :ok
Connect to the IRC server.
Example
iex> Blur.IRC.connect client, "irc.twitch.tv", 6667
:ok
Specs
Join an IRC channel.
Example
iex> Blur.IRC.join client, "#rockerboo"
:ok
Specs
Join many channels.
Example
iex> Blur.IRC.join_many client, ["#rockerboo", "#adattape"]
:ok
Specs
Login to the server.
Example
iex> Blur.IRC.login client, "rockerBOO", "oauth:oauthhashherewithlettersandnumbers"
:ok
Parse oauth token
Example
iex> Blur.IRC.parse_token "oauthhashherewithlettersandnumbers"
"oauth:oauthhashherewithlettersandnumbers"
Specs
Part from IRC channel.
Example
iex> Blur.IRC.part client, "#rockerboo"
:ok
Specs
Quit the IRC server with no message.
Example
iex> Blur.IRC.quit client
:ok
Specs
Quit the IRC server.
Example
iex> Blur.IRC.quit client, "Goodbye!"
:ok
Specs
Request twitch for capabilities
Example
iex> Blur.IRC.request_twitch_capabilities client
:ok
Specs
Send a message to the channel
Example
iex> Blur.IRC.say client, "#rockerboo", "Hello"
:ok
Stop the IRC client process
Example
iex> Blur.IRC.stop! client
{:stop, :normal, :ok, %ExIRC.Client{}}