ExUssd.Handler behaviour (ExUssd v0.1.2) View Source

This module provides callbacks to implement ExUssd menu handler.

Link to this section Summary

Callbacks

Callback for event handling.

Link to this section Types

Specs

api_parameters() :: map()

Specs

menu() :: map()

Link to this section Callbacks

Link to this callback

handle_menu(menu, api_parameters)

View Source

Specs

handle_menu(menu :: menu(), api_parameters :: api_parameters()) ::
  menu :: menu()

Callback for event handling.

This callback takes an menu struct, and api_parameters data as the input.

Examples

defmodule MyHomeHandler do
  @behaviour ExUssd.Handler
  def handle_menu(menu, api_parameters) do
    menu |> Map.put(:title, "Welcome")
  end
end