View Source Mobilizon.Service.Notifier behaviour (Mobilizon v5.0.0-beta.1)

Behaviour for notifiers

Summary

ready?()

Whether the notifier is enabled and configured

send(t, t, t)

Sends one or multiple notifications from an activity

@callback ready?() :: boolean()

Whether the notifier is enabled and configured

@callback send(Mobilizon.Users.User.t(), Mobilizon.Activities.Activity.t(), Keyword.t()) ::
  {:ok, any()} | {:error, String.t()}

@callback send(Mobilizon.Users.User.t(), [Mobilizon.Activities.Activity.t()], Keyword.t()) ::
  {:ok, any()} | {:error, String.t()}

Sends one or multiple notifications from an activity

@spec notify(Mobilizon.Users.User.t(), Mobilizon.Activities.Activity.t(), Keyword.t()) ::
  :ok