Mishka Installer v0.0.4-beta.1

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

This event is triggered whenever a user accesses form an authorisation. if there is any active module in this section on state, this module sends a request as a Task tool to the developer call function that includes user_id(), entries(), ip(), endpoint(). It should be noted; This process does not interfere with the main operation of the system. It is just a sender and is active for both side endpoints.

Link to this section Summary

Types

conn()
endpoint()
entries()
extra()
ip()
module_name()
operation()
optional_callbacks()
reason()
ref()
registerd_info()
state()
t()
user_id()

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

conn()

View Source 
@type conn() :: Plug.Conn.t() | Phoenix.LiveView.Socket.t()
Link to this type

endpoint()

View Source 
@type endpoint() :: :html | :api
Link to this type

entries()

View Source 
@type entries() :: map() | struct() | tuple()
Link to this type

extra()

View Source 
@type extra() :: map() | struct() | list()
Link to this type

ip()

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

module_name()

View Source 
@type module_name() :: String.t()
Link to this type

operation()

View Source 
@type operation() :: atom()
Link to this type

optional_callbacks()

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

reason()

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

ref()

View Source 
@type ref() :: :on_user_authorisation
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.OnUserAuthorisation{
  conn: conn(),
  endpoint: endpoint(),
  extra: extra(),
  ip: ip(),
  module: module(),
  operation: operation(),
  user_id: user_id()
}
Link to this type

t()

View Source 
@type t() :: state()
Link to this type

user_id()

View Source 
@type user_id() :: <<_::288>>

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