Blur v0.2.1-rc1 Blur View Source

Access your bot through Blur

Client

Handlers

  • Login on_logon -> join_channels
  • Connection %ConnState{} on_connection -> login on_disconnection -> logoff
  • Message pool
  • Channels on_join -> add_channel [Channel, Channel]
  • Users on_names -> add_users on_user_join -> add_user on_part -> remove_user [User, User]

Link to this section Summary

Functions

List channels we have joined.

Check if we are logged on.

Join a channel on the client IRC connection.

Leave a channel on the client IRC connection.

Say a message to the channel.

Get token from the environmental variables.

List who is in the channel. This is not completely accurate.

Link to this section Functions

Specs

channels() :: list() | {:error, atom()}

List channels we have joined.

Examples

Blur.channels 

Specs

is_logged_on?() :: boolean()

Check if we are logged on.

Examples

Blur.is_logged_on? 

Specs

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

Join a channel on the client IRC connection.

Examples

Blur.join "#channel" :ok

Specs

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

Leave a channel on the client IRC connection.

Examples

Blur.leave "#channel"

Specs

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

Say a message to the channel.

Examples

Blur.say "#rockerboo", "yo"

Specs

token() :: nil | binary()

Get token from the environmental variables.

Specs

users(channel :: binary()) :: list() | {:error, atom()}

List who is in the channel. This is not completely accurate.

Examples

Blur.users "#rockerboo"