Blur v0.2.1-beta3 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 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
Blur.IRC.cap_request client, ':twitch.tv/membership'
:ok
Specs
connect!(client :: pid() | atom(), host :: binary(), port :: non_neg_integer()) :: :ok
Connect to the IRC server.
Example
Blur.IRC.connect client, "irc.twitch.tv", 6667
:ok
Specs
Join an IRC channel.
Example
Blur.IRC.join client, "#rockerboo"
:ok
Specs
Join many channels.
Example
Blur.IRC.join_many client, ["#rockerboo", "#adattape"]
:ok
Specs
login(client :: pid() | atom(), nick :: binary(), pass :: binary()) :: :ok | {:error, :not_connected}
Login to the server.
Example
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
Blur.IRC.part client, "#rockerboo"
:ok
Specs
Quit the IRC server with no message.
Example
Blur.IRC.quit client
:ok
Specs
Quit the IRC server.
Example
Blur.IRC.quit client, "Goodbye!"
:ok
Specs
Request twitch for capabilities
Example
Blur.IRC.request_twitch_capabilities client
:ok
Specs
Send a message to the channel
Example
Blur.IRC.say client, "#rockerboo", "Hello"
:ok
Specs
stop!(client :: pid() | atom()) :: {:stop, :normal, :ok, %ExIRC.Client.ClientState{ autoping: term(), channel_prefixes: term(), channels: term(), connected?: term(), debug?: term(), event_handlers: term(), inet: term(), logged_on?: term(), login_time: term(), name: term(), network: term(), nick: term(), owner: term(), pass: term(), port: term(), retries: term(), server: term(), socket: term(), ssl?: term(), user: term(), user_prefixes: term(), who_buffers: term(), whois_buffers: term() }}
Stop the IRC client process
Example
Blur.IRC.stop! client
{:stop, :normal, :ok, %ExIRC.Client{}}