Telegex.Plug v0.0.4 Telegex.Plug behaviour View Source
Updates processing plug-in.
Link to this section Summary
Types
State data.
Stateful call result, return type and new state.
The stateless call result directly returns the type.
Functions
Get the preset type of a plug.
Get the username of the bot.
Update the username of the bot.
Link to this section Types
Specs
preset() :: :handler | :commander | :caller
Specs
state() :: any()
State data.
Specs
Stateful call result, return type and new state.
Specs
stateless() :: :ok | :error | :ignored
The stateless call result directly returns the type.
Link to this section Functions
Specs
Get the preset type of a plug.
Specs
get_usename() :: String.t()
Get the username of the bot.
Unless Telegex.Plug.update_username/1
has been called, nil
will be returned.
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
Specs
__preset__() :: preset()
Specs
call(update :: Telegex.Model.Update.t(), state :: state()) :: stateless() | stateful()
Pass update and call.