View Source Mobilizon.Activities (Mobilizon v5.0.0-beta.1)

The Activities context.

Summary

Functions

activity_types()

create_activity(attrs \\ %{})

Creates a activity.

get_activity!(id)

Gets a single activity.

list_activities()

Returns the list of activities.

list_group_activities(group_id, filters \\ [], page \\ nil, limit \\ nil)

list_group_activities_for_member(group_id, actor_asking_id, filters \\ [], page \\ nil, limit \\ nil)

list_group_activities_for_recap(group_id, actor_asking_id, last_sent_at \\ nil)

preload_activity(activity)

Functions

activity_types()

@spec activity_types() :: [String.t()]

create_activity(attrs \\ %{})

@spec create_activity(map()) ::
  {:ok, Mobilizon.Activities.Activity.t()} | {:error, Ecto.Changeset.t()}

Creates a activity.

Examples

iex> create_activity(%{field: value})
{:ok, %Activity{}}

iex> create_activity(%{field: bad_value})
{:error, %Ecto.Changeset{}}

get_activity!(id)

@spec get_activity!(integer()) :: Mobilizon.Activities.Activity.t()

Gets a single activity.

Raises Ecto.NoResultsError if the Activity does not exist.

Examples

iex> get_activity!(123)
%Activity{}

iex> get_activity!(456)
** (Ecto.NoResultsError)

list_activities()

@spec list_activities() :: [Mobilizon.Activities.Activity.t()]

Returns the list of activities.

Examples

iex> list_activities()
[%Activity{}, ...]

list_group_activities(group_id, filters \\ [], page \\ nil, limit \\ nil)

@spec list_group_activities(
  integer() | String.t(),
  Keyword.t(),
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Activities.Activity.t())

list_group_activities_for_member(group_id, actor_asking_id, filters \\ [], page \\ nil, limit \\ nil)

@spec list_group_activities_for_member(
  integer() | String.t(),
  integer() | String.t(),
  Keyword.t(),
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Activities.Activity.t())

list_group_activities_for_recap(group_id, actor_asking_id, last_sent_at \\ nil)

@spec list_group_activities_for_recap(
  integer() | String.t(),
  integer() | String.t(),
  DateTime.t() | nil
) :: [Mobilizon.Activities.Activity.t()]

preload_activity(activity)

@spec preload_activity(Mobilizon.Activities.Activity.t()) ::
  Mobilizon.Activities.Activity.t()