Mishka Installer v0.0.4-beta.1

View Source MishkaInstaller.Reference.OnUserBeforeLogin behaviour (Mishka Installer v0.0.4-beta.1)

Link to this section Summary

Types

assigns()
input()
ip()
optional_callbacks()
output()
reason()
ref()
registerd_info()
state()
t()

Callbacks

call(state)

This Callback can be used when you want to call a plugin

delete(registerd_info)

This Callback can be used when you want to delete a plugin

initial(list)

This Callback can be used when you want to register a plugin

restart(registerd_info)

This Callback can be used when you want to restart a plugin

start(registerd_info)

This Callback can be used when you want to start a plugin

stop(registerd_info)

This Callback can be used when you want to stop a plugin

unregister(registerd_info)

This Callback can be used when you want to unregister a plugin

Link to this section Types

Link to this type

assigns()

View Source 
@type assigns() :: Phoenix.LiveView.Socket.assigns()
Link to this type

input()

View Source 
@type input() :: map()
Link to this type

ip()

View Source 
@type ip() :: String.t() | tuple()
Link to this type

optional_callbacks()

View Source 
@type optional_callbacks() ::
  {:ok, ref(), registerd_info()} | {:error, ref(), reason()}
Link to this type

output()

View Source 
@type output() :: Phoenix.LiveView.Rendered.t() | nil
Link to this type

reason()

View Source 
@type reason() :: map() | String.t()
Link to this type

ref()

View Source 
@type ref() :: :on_user_before_login
Link to this type

registerd_info()

View Source 
@type registerd_info() :: MishkaInstaller.PluginState.t()
Link to this type

state()

View Source 
@type state() :: %MishkaInstaller.Reference.OnUserBeforeLogin{
  assigns: assigns(),
  input: input(),
  ip: ip(),
  output: output()
}
Link to this type

t()

View Source 
@type t() :: state()

Link to this section Callbacks

Link to this callback

call(state)

View Source 
@callback call(state()) :: {:reply, state()} | {:reply, :halt, state()}

This Callback can be used when you want to call a plugin

Link to this callback

delete(registerd_info)

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

This Callback can be used when you want to delete a plugin

Link to this callback

initial(list)

View Source 
@callback initial(list()) :: {:ok, ref(), list()} | {:error, ref(), reason()}

This Callback can be used when you want to register a plugin

Link to this callback

restart(registerd_info)

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

This Callback can be used when you want to restart a plugin

Link to this callback

start(registerd_info)

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

This Callback can be used when you want to start a plugin

Link to this callback

stop(registerd_info)

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

This Callback can be used when you want to stop a plugin

Link to this callback

unregister(registerd_info)

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

This Callback can be used when you want to unregister a plugin