Blur v0.2.1-beta1 Blur View Source

Access your bot through Blur

Link to this section Summary

Functions

Join a channel.

Join a channel on the client IRC connection.

Leave a channel.

Leave a channel on the client IRC connection.

Say a message to the channel.

Get token from the environmental variables.

Link to this section Functions

Specs

join(channel :: binary()) :: :ok | {:error, atom()}

Join a channel.

Examples

iex> Blur.join "#channel"
:ok

Specs

join(pid() | atom(), binary()) :: :ok | {:error, atom()}

Join a channel on the client IRC connection.

Examples

iex> Blur.join client, "#channel"
:ok

Specs

leave(channel :: binary()) :: :ok | {:error, atom()}

Leave a channel.

Examples

iex> Blur.leave "#channel"
:ok

Specs

leave(client :: pid(), channel :: binary()) :: :ok | {:error, atom()}

Leave a channel on the client IRC connection.

Examples

iex> Blur.leave client, "#channel"
:ok

Specs

say(channel :: charlist(), msg :: charlist()) :: :ok | {:error, atom()}

Say a message to the channel.

Examples

iex> Blur.say "#channel", "a message to the channel"
:ok

Specs

token() :: nil | binary()

Get token from the environmental variables.