MishkaDocument.Dashboard.Widgets.VersionActivity (Mishka Document v0.0.1)

Copy Markdown View Source

Dashboard widget (a dashboard:widgets plugin): the most recent workspace versions — workspace name, version number, and status badge — read as the viewer through MishkaDocument.Dashboard.Scope with the version's workspace loaded: :master_workspace for a master, :workspace for a site's admin. A master sees every site's versions, a site's admin only their own site's, and a viewer without a document area none. Offered to holders of admin:dashboard:document:workspace.

How far back the timeline reaches is the viewer's own setting — the card's gear in customize mode, or Settings → Documents → Dashboard widgets, both writing the same per-user row (MishkaCmsCore.Dashboard.Widget.set_config/4); the total is always the whole history.

Summary

Types

error_return()
okey_return()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

config()
config(key)
enable()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

load(user, config \\ %{})

Loads this widget's data off the dashboard render (in a Task), read as the viewer and sized by their own "Versions to show" setting. Called as load/1 (a direct call, no dashboard) it uses the declared default.

on_dependency_error(error)

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

register()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

render(assigns)
restart()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])
stop()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.

widget()

This widget's descriptor.

Types

error_return()

@type error_return() ::
  {:error, [%{action: atom(), field: atom(), message: String.t()}]}

okey_return()

@type okey_return() :: {:ok, struct() | map() | module() | [any()]}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

config()

@spec config() :: keyword()

config(key)

@spec config(atom()) :: any()

enable()

@spec enable() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

@spec get() :: keyword()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

@spec health_check() :: :ok | {:degraded, term()} | {:error, term()}

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

load(user, config \\ %{})

Loads this widget's data off the dashboard render (in a Task), read as the viewer and sized by their own "Versions to show" setting. Called as load/1 (a direct call, no dashboard) it uses the declared default.

on_dependency_error(error)

@spec on_dependency_error(term()) :: term()

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

register()

@spec register() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

render(assigns)

restart()

@spec restart() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

@spec start() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])

stop()

@spec stop() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

@spec unregister() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.

widget()

@spec widget() :: MishkaCmsCore.Dashboard.Widget.t()

This widget's descriptor.