Telegex.Plug behaviour (Telegex.Plug v0.3.0) View Source

Updates processing plug-in.

Link to this section Summary

Types

preset()

The preset category.

state()

State data.

stateful()

Stateful call result, return type and new state.

stateless()

The stateless call result directly returns the type.

Functions

__preset__(module)

Get the preset type of a plug.

get_usename()

Get the username of the bot.

update_username(username)

Update the username of the bot.

Callbacks

__preset__()

call(update, state)

Pass update and call.

Link to this section Types

preset()

Specs

preset() :: :preheater | :message_handler | :commander | :caller | :custom

The preset category.

state()

Specs

state() :: any()

State data.

stateful()

Specs

stateful() :: {stateless(), state()}

Stateful call result, return type and new state.

stateless()

Specs

stateless() :: :ok | :error | :ignored

The stateless call result directly returns the type.

Link to this section Functions

preset(module)

Specs

__preset__(atom()) :: preset()

Get the preset type of a plug.

get_usename()

Specs

get_usename() :: String.t()

Get the username of the bot.

Unless Telegex.Plug.update_username/1 has been called, nil will be returned.

update_username(username)

Specs

update_username(String.t()) :: :ok

Update the username of the bot.

This function will improve the accuracy of command matching.

Link to this section Callbacks

preset()

Specs

__preset__() :: preset()

call(update, state)

Specs

call(update :: Telegex.Model.Update.t(), state :: state()) ::
  stateless() | stateful()

Pass update and call.