Chime.Recipient (Chime v0.1.0-dev)

Copy Markdown View Source

A person who gets notifications, as the app's Chime.Resolver says:

  • :id - a string unique among the app's people: "user:42". The notifications, the preferences and the counts are kept by it.
  • :email - where the :email channel and the digests write, or nil.
  • :name - for the emails' To:.
  • :locale - the language the app speaks to them, for the notifier's words (Gettext.with_locale/3).
  • :time_zone - an IANA time zone ("Europe/Lisbon"), for the hour of the digests. UTC without one, or without a time zone database.
  • :quiet_hours - their own quiet hours, {22, 8}, over the config's; false for none; nil for the config's.
  • :data - anything else the app's notifiers and channels need: a phone number, a Telegram chat, the user itself.

Summary

Types

t()

Types

t()

@type t() :: %Chime.Recipient{
  data: term(),
  email: String.t() | nil,
  id: String.t(),
  locale: String.t() | nil,
  name: String.t() | nil,
  quiet_hours: {0..23, 0..23} | false | nil,
  time_zone: String.t() | nil
}