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

The Posts context.

Summary

Functions

create_post(attrs \\ %{})

Creates a post.

delete_post(post)

Deletes a post

get_post(id)

Get a post by it's ID

get_post_by_slug_with_preloads(slug)

get_post_by_url(url)

Get a post by it's URL

get_post_by_url_with_preloads(url)

get_post_with_preloads(id)

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

Returns the list of recent posts for a group

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

list_posts_for_stream()

list_public_local_posts(page \\ nil, limit \\ nil, sort \\ nil, direction \\ nil)

list_tags_for_post(post_id)

Returns the list of tags for the post.

order_posts(query, sort, direction)

update_post(post, attrs)

Updates a post.

Functions

create_post(attrs \\ %{})

@spec create_post(map()) ::
  {:ok, Mobilizon.Posts.Post.t()} | {:error, Ecto.Changeset.t()}

Creates a post.

delete_post(post)

@spec delete_post(Mobilizon.Posts.Post.t()) ::
  {:ok, Mobilizon.Posts.Post.t()} | {:error, Ecto.Changeset.t()}

Deletes a post

get_post(id)

@spec get_post(integer() | String.t()) :: Mobilizon.Posts.Post.t() | nil

Get a post by it's ID

get_post_by_slug_with_preloads(slug)

@spec get_post_by_slug_with_preloads(String.t()) :: Mobilizon.Posts.Post.t() | nil

get_post_by_url(url)

@spec get_post_by_url(String.t()) :: Mobilizon.Posts.Post.t() | nil

Get a post by it's URL

get_post_by_url_with_preloads(url)

@spec get_post_by_url_with_preloads(String.t()) :: Mobilizon.Posts.Post.t() | nil

get_post_with_preloads(id)

@spec get_post_with_preloads(integer() | String.t()) :: Mobilizon.Posts.Post.t() | nil

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

@spec get_posts_for_group(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Posts.Post.t())

Returns the list of recent posts for a group

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

@spec get_public_posts_for_group(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Posts.Post.t())

list_posts_for_stream()

@spec list_posts_for_stream() :: Enum.t()

list_public_local_posts(page \\ nil, limit \\ nil, sort \\ nil, direction \\ nil)

@spec list_public_local_posts(
  integer() | nil,
  integer() | nil,
  atom() | nil,
  atom() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Posts.Post.t())

list_tags_for_post(post_id)

@spec list_tags_for_post(integer() | String.t()) :: [Mobilizon.Events.Tag.t()]

Returns the list of tags for the post.

order_posts(query, sort, direction)

@spec order_posts(Ecto.Queryable.t(), atom() | nil, atom() | nil) ::
  Ecto.Queryable.t()

update_post(post, attrs)

@spec update_post(Mobilizon.Posts.Post.t(), map()) ::
  {:ok, Mobilizon.Posts.Post.t()} | {:error, Ecto.Changeset.t()}

Updates a post.