View Source MishkaInstaller.Reference.OnUserBeforeLogin behaviour (Mishka Installer v0.0.3)

Link to this section Summary

Link to this section Types

@type assigns() :: Phoenix.LiveView.Socket.assigns()
@type input() :: map()
@type ip() :: String.t() | tuple()
@type optional_callbacks() ::
  {:ok, ref(), registerd_info()} | {:error, ref(), reason()}
@type output() :: Phoenix.LiveView.Rendered.t() | nil
@type reason() :: map() | String.t()
@type ref() :: :on_user_before_login
@type registerd_info() :: MishkaInstaller.PluginState.t()
@type state() :: %MishkaInstaller.Reference.OnUserBeforeLogin{
  assigns: assigns(),
  input: input(),
  ip: ip(),
  output: output()
}
@type t() :: state()

Link to this section Callbacks

@callback call(state()) :: {:reply, state()} | {:reply, :halt, state()}
Link to this callback

delete(registerd_info)

View Source (optional)
@callback delete(registerd_info()) :: optional_callbacks()
@callback initial(list()) :: {:ok, ref(), list()} | {:error, ref(), reason()}
Link to this callback

start(registerd_info)

View Source (optional)
@callback start(registerd_info()) :: optional_callbacks()
Link to this callback

stop(registerd_info)

View Source (optional)
@callback stop(registerd_info()) :: optional_callbacks()
Link to this callback

unregister(registerd_info)

View Source (optional)
@callback unregister(registerd_info()) :: optional_callbacks()