Prepares a thread or reply for federation with ActivityPub.

Parameters

• object_or_thread_or_reply_to_id: The object, thread, or reply ID
• key: The key to use for preparation (:thread_id or :reply_to_id, default is :thread_id)

Examples

iex> ap_prepare("thread_123")
"https://example.com/ap/objects/thread_123"

Arranges replies.

TODOC: how is it different than arrange_replies_tree/2?

Parameters

• replies: List of replies
• opts: Arrangement options

Examples

iex> arrange_replies([%{id: "1"}, %{id: "2", path: ["1"]}])
%{"1" => %{id: "1", children: %{"2" => %{id: "2", path: ["1"]}}}}

Arranges replies into a tree structure.

Powered by https://github.com/bonfire-networks/ecto_materialized_path

Parameters

• replies: List of replies
• opts: Arrangement options

Examples

iex> arrange_replies_tree([%{id: "1"}, %{id: "2", reply_to_id: "1"}])
%{"1" => %{id: "1", direct_replies: [%{id: "2", reply_to_id: "1"}]}}

Casts a changeset with reply_to and threading info.

If it's not a reply or the user is not permitted to reply to the thing, a new thread will be created.

Parameters

• changeset: The changeset to be updated
• attrs: Attributes for the reply
• user: The user creating the reply
• _preset_or_custom_boundary: Boundary setting (currently unused)

Examples

iex> cast(changeset, %{reply_to_id: "123"}, user, nil)
%Ecto.Changeset{}

Counts participants in a thread.

Parameters

• thread_id: The ID of the thread
• opts: Additional options, should contain current_user to check for permission

Examples

iex> count_participants("thread_123")
5

Creates a parent replied record within a changeset.

Parameters

• changeset or object: The changeset to update
• replied: The replied struct
• replied_attrs: Attributes for the replied record

Examples

iex> create_parent_replied(changeset, %Replied{}, %{id: "789", thread_id: "456"})
%Ecto.Changeset{}

Group per-thread

Finds the object being replied to.

Parameters

• attrs: Attributes containing reply information
• user: The user attempting to reply

Returns

• {:ok, reply} if the reply object is found and the user has permission
• {:error, reason} otherwise, where reason may be :not_found or :not_permitted

Examples

iex> find_reply_to(%{reply_to_id: "123"}, user)
{:ok, %{id: "123", ...}}

Finds the thread for a reply.

Parameters

• attrs: Attributes containing thread information
• user: The user attempting to access the thread

Examples

iex> find_thread(%{thread_id: "456"}, user)
{:ok, %{id: "456", ...}}

Initializes a parent replied record.

Parameters

• replied_attrs: Attributes for the replied record

Examples

iex> init_parent_replied(%{id: "789", thread_id: "456"})
{:ok, %Replied{}}

Lists participants of a thread or individual object.

Parameters

• activity_or_object: The activity or object to list participants for
• thread_or_object_id: Optional thread or object ID
• opts: Additional options

Examples

iex> list_participants(activity, "thread_123", limit: 10)
[%{id: "user1", ...}, %{id: "user2", ...}]

Lists replies in a thread.

Parameters

• thread: The thread or thread ID
• opts: Additional options

Examples

iex> list_replies("thread_123", limit: 10)
%{edges: [%{id: "reply1", ...}, %{id: "reply2", ...}]}

Marks all unseen replies as seen.

Parameters

• filters: Filter criteria
• opts: Additional options

Examples

iex> mark_all_seen([thread_id: "123"], current_user: user)
{:ok, [%{id: "reply1"}, %{id: "reply2"}]}

re-order distinct threads after DISTINCT ON ordered them by thread_id - Note: does not support pagination

Builds a query for thread replies.

Parameters

• filter: Filter criteria (e.g., [thread_id: "123"])
• opts: Additional query options

Examples

iex> query([thread_id: "123"], preload: [:posts])
%Ecto.Query{}

Callback implementation for Bonfire.Common.QueryModule.query_module/0.

re-order distinct threads after DISTINCT ON ordered them by thread_id - Note: this results in (Ecto.QueryError) cannot preload associations in subquery in query

Reads a thread by its ID.

Parameters

• object_id: The ID of the object to read
• opts: should contain current_user to check for read permissions

Returns

• {:ok, object} if the object is found and readable
• {:error, reason} otherwise

Examples

iex> read("123", current_user: me)
{:ok, %{id: "123", ...}}

Callback implementation for Bonfire.Common.QueryModule.schema_module/0.

Counts unseen replies.

Parameters

• filters: Filter criteria
• opts: Additional options

Examples

iex> unseen_count([thread_id: "123"], current_user: user)
5

Builds a query for unseen replies.

Parameters

• filters: Filter criteria
• opts: Additional query options

Returns

• {:ok, query} if the query can be built
• {:error, reason} otherwise

Examples

iex> unseen_query([thread_id: "123"], current_user: user)
{:ok, %Ecto.Query{}}