StrawHat.Twitch

v0.0.2

StrawHat.Twitch v0.0.2 StrawHat.Twitch.IRC.ClientState View Source

A IRC client state.

Link to this section Summary

Types

t()
  • conn_pid: gun connection PID.
  • is_ready: defines if the chatbot is ready to interact with.
  • channels: list of channels currently listen to.
  • message_broker: message broker module used that gets notify the private messages.
  • host: Twitch server host

Link to this section Types

Link to this type

t() View Source 
t() :: %StrawHat.Twitch.IRC.ClientState{
  channels: [String.t()],
  conn_pid: pid() | nil,
  credentials: %StrawHat.Twitch.IRC.Credentials{
    password: term(),
    username: term()
  },
  host: binary(),
  is_ready: boolean(),
  message_broker: module()
}

  • conn_pid: gun connection PID.
  • is_ready: defines if the chatbot is ready to interact with.
  • channels: list of channels currently listen to.
  • message_broker: message broker module used that gets notify the private messages.
  • host: Twitch server host.