ExUssd v0.1.1

ExUssd.Ussd behaviour (ExUssd v0.1.1) View Source

Link to this section Summary

Types

api_parameters()

A map value carrying api parameters, e.g %{ sessionId: "session_01", phoneNumber: "254722000000", networkCode: "Safaricom", serviceCode: "*544#", text: "1" }

internal_routing()

An internal routing map that takes text value, session id and service code, e.g. %{text: "1", session_id: "session_01", service_code: "*544#"}

menu()

Menu Struct

Callbacks

end_session(list)
get_menu(list)
goto(list)

Link to this section Types

Link to this type

api_parameters()

View Source

Specs

api_parameters() :: map()

A map value carrying api parameters, e.g %{ sessionId: "session_01", phoneNumber: "254722000000", networkCode: "Safaricom", serviceCode: "*544#", text: "1" }

Link to this type

internal_routing()

View Source

Specs

internal_routing() :: %{
  text: String.t(),
  session_id: String.t(),
  service_code: String.t()
}

An internal routing map that takes text value, session id and service code, e.g. %{text: "1", session_id: "session_01", service_code: "*544#"}

Link to this type

menu()

View Source

Specs

menu() :: ExUssd.Menu

Menu Struct

Link to this section Callbacks

Link to this callback

end_session(list)

View Source

Specs

end_session([{:session_id, String.t()}]) :: any()
Link to this callback

get_menu(list)

View Source

Specs

get_menu([{:session_id, String.t()}]) :: any()
Link to this callback

goto(list)

View Source

Specs

goto(
  internal_routing: internal_routing(),
  menu: menu(),
  api_parameters: api_parameters()
) :: any()