ExSNI v0.2.9

View Source ExSni (ExSNI v0.2.9)

Link to this section Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

close(sni_pid)
get_icon(sni_pid)
get_menu(sni_pid)
get_supported(sni_pid)

Returns {:ok, sni_pid} if there is a StatusNotifierWatcher available on the Session Bus. Returns {:error, reason} otherwise.

is_supported?()

Returns true if there is a StatusNotifierWatcher available on the Session Bus.

is_supported?(sni_pid)

Returns true if there is a StatusNotifierWatcher available on the Session Bus.

register_icon(sni_pid)
set_icon(sni_pid, icon, opts \\ [])
set_menu(sni_pid, menu)
start_link(init_opts \\ [], start_opts \\ [])
update_icon(sni_pid, icon)
update_menu(sni_pid, atom, menu)

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

close(sni_pid)

View Source

Specs

close(GenServer.server()) :: :ok
Link to this function

get_icon(sni_pid)

View Source

Specs

get_icon(GenServer.server()) :: {:ok, nil | ExSni.Icon.t()} | {:error, any()}
Link to this function

get_menu(sni_pid)

View Source

Specs

get_menu(
  GenServer.server()
  | {:router, ExSni.Router.t()}
  | {:server, GenServer.server() | atom() | tuple()}
) :: {:ok, nil | ExSni.Menu.t()} | {:error, any()}
Link to this function

get_supported(sni_pid)

View Source

Specs

get_supported(GenServer.server()) ::
  {:ok, bus_pid :: GenServer.server()} | {:error, reason :: binary()}

Returns {:ok, sni_pid} if there is a StatusNotifierWatcher available on the Session Bus. Returns {:error, reason} otherwise.

  • sni_pid - The pid of the ExSni Supervisor
Link to this function

is_supported?()

View Source

Specs

is_supported?() :: boolean()

Returns true if there is a StatusNotifierWatcher available on the Session Bus.

Link to this function

is_supported?(sni_pid)

View Source

Specs

is_supported?(GenServer.server()) :: boolean()

Returns true if there is a StatusNotifierWatcher available on the Session Bus.

  • sni_pid - The pid of the ExSni Supervisor
Link to this function

register_icon(sni_pid)

View Source

Specs

register_icon(pid()) :: :ok | {:error, any()}
Link to this function

set_icon(sni_pid, icon, opts \\ [])

View Source

Specs

set_icon(pid(), ExSni.Icon.t() | nil, keyword()) ::
  {:ok, ExSni.Icon.t() | nil} | {:error, any()}
Link to this function

set_menu(sni_pid, menu)

View Source

Specs

set_menu(GenServer.server(), ExSni.Menu.t() | nil) ::
  {:ok, ExSni.Menu.t() | nil} | {:error, any()}
Link to this function

start_link(init_opts \\ [], start_opts \\ [])

View Source
Link to this function

update_icon(sni_pid, icon)

View Source

Specs

update_icon(sni_pid :: GenServer.server(), icon :: nil | ExSni.Icon.t()) ::
  any()
Link to this function

update_menu(sni_pid, atom, menu)

View Source

Specs

update_menu(
  sni_pid :: GenServer.server(),
  parentId :: nil | integer(),
  menu :: nil | ExSni.Menu.t()
) :: any()