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

The conversations context

Summary

Functions

count_unread_conversation_participants_for_person(actor_id)

create_conversation(attrs)

Creates a conversation.

delete_conversation(conversation)

Delete a conversation.

find_all_conversations_for_event(event_id)

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

Get a paginated list of conversations for an actor

find_conversations_for_event(event_id, actor_id, page \\ nil, limit \\ nil)

get_conversation(conversation_id)

Get a conversation by it's ID

get_conversation_participant(conversation_participant_id)

Get a conversation by it's ID

get_participant_by_conversation_and_actor(conversation_id, actor_id)

list_conversation_participants_for_actor(actor_id, page \\ nil, limit \\ nil)

list_conversation_participants_for_conversation(conversation_id)

list_conversation_participants_for_user(user_id, page \\ nil, limit \\ nil)

reply_to_conversation(conversation, attrs \\ %{})

Create a response to a conversation

update_conversation(conversation, attrs \\ %{})

Update a conversation.

update_conversation_participant(conversation_participant, attrs \\ %{})

Update a conversation participant. Only their read status for now

Functions

count_unread_conversation_participants_for_person(actor_id)

@spec count_unread_conversation_participants_for_person(integer() | String.t()) ::
  non_neg_integer()

create_conversation(attrs)

@spec create_conversation(map()) ::
  {:ok, Mobilizon.Conversations.Conversation.t()}
  | {:error, atom(), Ecto.Changeset.t(), map()}

Creates a conversation.

delete_conversation(conversation)

@spec delete_conversation(Mobilizon.Conversations.Conversation.t()) ::
  {:ok, %{comments: {integer() | nil, any()}}}
  | {:error, :comments, Ecto.Changeset.t(), map()}

Delete a conversation.

find_all_conversations_for_event(event_id)

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

@spec find_conversations_for_actor(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Conversations.Conversation.t())

Get a paginated list of conversations for an actor

find_conversations_for_event(event_id, actor_id, page \\ nil, limit \\ nil)

@spec find_conversations_for_event(
  String.t() | integer(),
  String.t() | integer(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Conversations.ConversationParticipant.t())

get_conversation(conversation_id)

@spec get_conversation(String.t() | integer()) ::
  Mobilizon.Conversations.Conversation.t() | nil

Get a conversation by it's ID

get_conversation_participant(conversation_participant_id)

@spec get_conversation_participant(String.t() | integer()) ::
  Mobilizon.Conversations.Conversation.t() | nil

Get a conversation by it's ID

get_participant_by_conversation_and_actor(conversation_id, actor_id)

list_conversation_participants_for_actor(actor_id, page \\ nil, limit \\ nil)

@spec list_conversation_participants_for_actor(
  integer() | String.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Conversations.ConversationParticipant.t())

list_conversation_participants_for_conversation(conversation_id)

@spec list_conversation_participants_for_conversation(integer() | String.t()) :: [
  Mobilizon.Conversations.ConversationParticipant.t()
]

list_conversation_participants_for_user(user_id, page \\ nil, limit \\ nil)

@spec list_conversation_participants_for_user(
  integer() | String.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Conversations.ConversationParticipant.t())

reply_to_conversation(conversation, attrs \\ %{})

@spec reply_to_conversation(Mobilizon.Conversations.Conversation.t(), map()) ::
  {:ok, Mobilizon.Conversations.Conversation.t()}
  | {:error, atom(), Ecto.Changeset.t(), map()}

Create a response to a conversation

update_conversation(conversation, attrs \\ %{})

@spec update_conversation(Mobilizon.Conversations.Conversation.t(), map()) ::
  {:ok, Mobilizon.Conversations.Conversation.t()} | {:error, Ecto.Changeset.t()}

Update a conversation.

update_conversation_participant(conversation_participant, attrs \\ %{})

@spec update_conversation_participant(
  Mobilizon.Conversations.ConversationParticipant.t(),
  map()
) ::
  {:ok, Mobilizon.Conversations.ConversationParticipant.t()}
  | {:error, Ecto.Changeset.t()}

Update a conversation participant. Only their read status for now