Kaguya v0.6.6 Kaguya.Module.Core

Core builtin functions necessary for the bot to be function. This module is always loaded into the bot.

Link to this section Summary

Functions

Adds a user to a channel

Changes a user’s mode internally in a channel

Changes a user’s nick internally in a channel

Returns a specification to start this module under a supervisor

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Joins all channels initially specified in the configuration

Logs a PRIVMSG to a channel, or ignores it if it’s a PM

Sends a PONG response to the PING command

Remove a user from all channels

Removes a user from a channel

Resends the nick command with an appended “_” if the NICK command fails

Adds users to a channel

Link to this section Functions

Link to this function addNickToChan(arg1, arg2)

Adds a user to a channel

Link to this function changeUserMode(arg1, arg2)

Changes a user’s mode internally in a channel.

Link to this function changeUserNick(arg1, arg2)

Changes a user’s nick internally in a channel.

Link to this function child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

init_arg is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state}, except that it also sets a timeout. See the “Timeouts” section in the module documentation for more information.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function joinInitChans(arg1, arg2)

Joins all channels initially specified in the configuration

Link to this function logMessage(arg1, arg2)

Logs a PRIVMSG to a channel, or ignores it if it’s a PM.

Link to this function module_unload()
Link to this function on_message(msg)
Link to this function pingHandler(arg1, arg2)

Sends a PONG response to the PING command.

Link to this function removeNickFromAllChans(arg1, arg2)

Remove a user from all channels.

Link to this function removeNickFromChan(arg1, arg2)

Removes a user from a channel

Link to this function retryNick(arg1, arg2)

Resends the nick command with an appended “_” if the NICK command fails.

Link to this function setChanNicks(arg1, arg2)

Adds users to a channel

Link to this function start_link(opts \\ [])