View Source Mobilizon.Todos (Mobilizon v4.1.0-alpha.1)

The Todos context.

Summary

Functions

Creates a todo.

Creates a todo list.

Deletes a todo

Deletes a todo list

Get a todo by it's ID

Get a todo by it's URL

Get a todo list by it's ID

Get a todo list by it's URL

Returns the list of todo lists for a group.

Returns the list of todos for a group.

Updates a todo.

Updates a todo list.

Functions

Link to this function

create_todo(attrs \\ %{})

View Source
@spec create_todo(map()) ::
  {:ok, Mobilizon.Todos.Todo.t()} | {:error, Ecto.Changeset.t()}

Creates a todo.

Link to this function

create_todo_list(attrs \\ %{})

View Source
@spec create_todo_list(map()) ::
  {:ok, Mobilizon.Todos.TodoList.t()} | {:error, Ecto.Changeset.t()}

Creates a todo list.

@spec delete_todo(Mobilizon.Todos.Todo.t()) ::
  {:ok, Mobilizon.Todos.Todo.t()} | {:error, Ecto.Changeset.t()}

Deletes a todo

Link to this function

delete_todo_list(todo_list)

View Source
@spec delete_todo_list(Mobilizon.Todos.TodoList.t()) ::
  {:ok, Mobilizon.Todos.TodoList.t()} | {:error, Ecto.Changeset.t()}

Deletes a todo list

@spec get_todo(integer() | String.t()) :: Mobilizon.Todos.Todo.t() | nil

Get a todo by it's ID

@spec get_todo_by_url(String.t()) :: Mobilizon.Todos.Todo.t() | nil

Get a todo by it's URL

@spec get_todo_list(integer() | String.t()) :: Mobilizon.Todos.TodoList.t() | nil

Get a todo list by it's ID

Link to this function

get_todo_list_by_url(url)

View Source
@spec get_todo_list_by_url(String.t()) :: Mobilizon.Todos.TodoList.t() | nil

Get a todo list by it's URL

Link to this function

get_todo_lists_for_group(actor, page \\ nil, limit \\ nil)

View Source
@spec get_todo_lists_for_group(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Todos.TodoList.t())

Returns the list of todo lists for a group.

Link to this function

get_todos_for_todo_list(todo_list, page \\ nil, limit \\ nil)

View Source
@spec get_todos_for_todo_list(
  Mobilizon.Todos.TodoList.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Todos.Todo.t())

Returns the list of todos for a group.

Link to this function

update_todo(todo, attrs)

View Source
@spec update_todo(Mobilizon.Todos.Todo.t(), map()) ::
  {:ok, Mobilizon.Todos.Todo.t()} | {:error, Ecto.Changeset.t()}

Updates a todo.

Link to this function

update_todo_list(todo_list, attrs)

View Source
@spec update_todo_list(Mobilizon.Todos.TodoList.t(), map()) ::
  {:ok, Mobilizon.Todos.TodoList.t()} | {:error, Ecto.Changeset.t()}

Updates a todo list.