Which notifications a user wants, and how: per GROUP (a row on the
settings page: "Friends and groups", a host's "Streak about to end") and
per CHANNEL (in_app, email, push), plus three switches that win over
everything: all email off, all push off, everything off.
Groups
Core declares its own; a host adds its own in config:
config :gamend_core, :notification_groups, [
%{key: "streak", label: "Streak about to end",
defaults: %{"in_app" => true, "email" => false, "push" => false},
types: ["streak_ending"], signup: true}
]A group's defaults apply until the user chooses. configurable is the
channels the user may change (default: all three); a channel they may not
change always uses its default. types are the notification types
(Gamend.Notifications.Types) that belong to the group. signup: true
offers its email on the registration form, unticked: an email nobody asked
for is spam, so the user opts in. The "account" group — sign-in links, email
changes — is email that cannot be turned off: it is how the account works.
Stored in the user's private preferences (Gamend.Accounts.Preferences)
under "notifications":
%{"off_all" => bool, "off_email" => bool, "off_push" => bool,
"groups" => %{group => %{channel => bool}}}Summary
Functions
The channels, in the order the settings page shows them.
Whether user gets group through channel. A channel the group does not
let the user change is its default; otherwise the switches win (everything
off, then all email / all push off), then the user's own choice, then the
default. An unknown group is off.
One group, or nil.
The group a notification TYPE (Gamend.Notifications.Types) belongs to, so
a friend request or a chat message follows the user's choices for its row.
nil for a type in no group (a moderator's notice), which is always sent.
Every group, core's first then the host's: %{key, label, defaults, configurable, types}, configurable a list of channels.
Whether a switch is on: "off_all", "off_email", "off_push".
Set one group's channel. A channel the group does not let users change is refused.
The groups whose email the registration form offers (signup: true).
A user's stored choices (see the moduledoc's shape).
Turn off all email, all push, or everything (:email | :push | :all).
Undo turn_off/2: each group's own choices apply again.
Functions
@spec channels() :: [String.t()]
The channels, in the order the settings page shows them.
@spec enabled?(Gamend.Accounts.User.t() | nil, String.t(), String.t()) :: boolean()
Whether user gets group through channel. A channel the group does not
let the user change is its default; otherwise the switches win (everything
off, then all email / all push off), then the user's own choice, then the
default. An unknown group is off.
One group, or nil.
The group a notification TYPE (Gamend.Notifications.Types) belongs to, so
a friend request or a chat message follows the user's choices for its row.
nil for a type in no group (a moderator's notice), which is always sent.
@spec groups() :: [map()]
Every group, core's first then the host's: %{key, label, defaults, configurable, types}, configurable a list of channels.
@spec off?(Gamend.Accounts.User.t() | nil, String.t()) :: boolean()
Whether a switch is on: "off_all", "off_email", "off_push".
@spec put(Gamend.Accounts.User.t(), String.t(), String.t(), boolean()) :: {:ok, Gamend.Accounts.User.t()} | {:error, term()}
Set one group's channel. A channel the group does not let users change is refused.
@spec signup_groups() :: [map()]
The groups whose email the registration form offers (signup: true).
@spec stored(Gamend.Accounts.User.t() | nil) :: map()
A user's stored choices (see the moduledoc's shape).
@spec turn_off(Gamend.Accounts.User.t(), :email | :push | :all) :: {:ok, Gamend.Accounts.User.t()} | {:error, term()}
Turn off all email, all push, or everything (:email | :push | :all).
@spec turn_on(Gamend.Accounts.User.t(), :email | :push | :all) :: {:ok, Gamend.Accounts.User.t()} | {:error, term()}
Undo turn_off/2: each group's own choices apply again.