@spec change_message(Glific.Messages.Message.t(), map()) :: Ecto.Changeset.t()

Returns an %Ecto.Changeset{} for tracking message changes.

examples

Examples

iex> change_message(message)
%Ecto.Changeset{data: %Message{}}

@spec change_message_media(Glific.Messages.MessageMedia.t(), map()) ::
  Ecto.Changeset.t()

Returns an %Ecto.Changeset{} for tracking message media changes.

examples

Examples

iex> change_message_media(message_media)
%Ecto.Changeset{data: %MessageMedia{}}

@spec clear_messages(Glific.Contacts.Contact.t()) :: :ok

Delete all messages of a contact

@spec count_messages(map()) :: integer()

Return the count of messages, using the same filter as list_messages

@spec count_messages_media(map()) :: integer()

Return the count of messages, using the same filter as list_messages

@spec create_and_send_hsm_message(map()) ::
  {:ok, Glific.Messages.Message.t()} | {:error, String.t()}

Send a hsm template message to the specific contact.

@spec create_and_send_message_to_group(map(), Glific.Groups.Group.t(), atom()) ::
  {:ok, any()} | {:error, any()}

Create and send message to all contacts of a group

@spec create_and_send_session_template(String.t(), integer()) ::
  {:ok, Glific.Messages.Message.t()}

@spec create_and_send_session_template(integer(), integer()) ::
  {:ok, Glific.Messages.Message.t()}

@spec create_and_send_session_template(
  Glific.Templates.SessionTemplate.t() | map(),
  map()
) ::
  {:ok, Glific.Messages.Message.t()}

Send a session template to the specific contact. This is typically used in automation

@spec create_group_message(map()) ::
  {:ok, Glific.Messages.Message.t()} | {:error, Ecto.Changeset.t()}

Record a message sent to a group in the message table. This message is actually not sent, but is used for display purposes in the group listings

@spec create_message(map()) ::
  {:ok, Glific.Messages.Message.t()} | {:error, Ecto.Changeset.t()}

Creates a message.

examples

Examples

iex> create_message(%{field: value})
{:ok, %Message{}}

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

@spec create_message_media(map()) ::
  {:ok, Glific.Messages.MessageMedia.t()} | {:error, Ecto.Changeset.t()}

Creates a message media.

examples

Examples

iex> create_message_media(%{field: value})
{:ok, %MessageMedia{}}

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

@spec create_temp_message(non_neg_integer(), any(), Keyword.t()) ::
  Glific.Messages.Message.t()

We need to simulate a few messages as we move to the system. This is a wrapper function to add those messages, which trigger specific actions within flows. e.g. include: Completed, Failure, Success etc

@spec delete_message(Glific.Messages.Message.t()) ::
  {:ok, Glific.Messages.Message.t()} | {:error, Ecto.Changeset.t()}

Deletes a message.

examples

Examples

iex> delete_message(message)
{:ok, %Message{}}

iex> delete_message(message)
{:error, %Ecto.Changeset{}}

@spec delete_message_media(Glific.Messages.MessageMedia.t()) ::
  {:ok, Glific.Messages.MessageMedia.t()} | {:error, Ecto.Changeset.t()}

Deletes a message media.

examples

Examples

iex> delete_message_media(message_media)
{:ok, %MessageMedia{}}

iex> delete_message_media(message_media)
{:error, %Ecto.Changeset{}}

@spec get_media_type_from_url(String.t(), Keyword.t()) :: tuple()

Get Media type from a url. We will primary use it for when we receive the url from EEX call.

@spec get_message!(integer()) :: Glific.Messages.Message.t()

Gets a single message.

Raises Ecto.NoResultsError if the Message does not exist.

examples

Examples

iex> get_message!(123)
%Message{}

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

@spec get_message_media!(integer()) :: Glific.Messages.MessageMedia.t()

Gets a single message media.

Raises Ecto.NoResultsError if the Message media does not exist.

examples

Examples

iex> get_message_media!(123)
%MessageMedia{}

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

@spec list_conversations(map(), boolean()) ::
  [Glific.Conversations.Conversation.t()] | integer()

Given a list of message ids builds a conversation list with most recent conversations at the beginning of the list

@spec list_messages(map()) :: [Glific.Messages.Message.t()]

Returns the list of filtered messages.

examples

Examples

iex> list_messages(map())
[%Message{}, ...]

@spec list_messages_media(map()) :: [Glific.Messages.MessageMedia.t()]

Returns the list of message media.

examples

Examples

iex> list_messages_media(map())
[%MessageMedia{}, ...]

@spec mark_contact_messages_as_read(non_neg_integer(), non_neg_integer()) :: nil

Mark that the user has read all messages sent by a given contact

@spec notify(map(), String.t()) :: nil

Create and insert a notification for this error when sending a message. Add as much detail, so we can reverse-engineer why the sending failed.

@spec tag_in_message?(Glific.Messages.Message.t(), integer()) :: boolean()

Check if the tag is present in message

@spec update_message(Glific.Messages.Message.t(), map()) ::
  {:ok, Glific.Messages.Message.t()} | {:error, Ecto.Changeset.t()}

Updates a message.

examples

Examples

iex> update_message(message, %{field: new_value})
{:ok, %Message{}}

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

@spec update_message_media(Glific.Messages.MessageMedia.t(), map()) ::
  {:ok, Glific.Messages.MessageMedia.t()} | {:error, Ecto.Changeset.t()}

Updates a message media.

examples

Examples

iex> update_message_media(message_media, %{field: new_value})
{:ok, %MessageMedia{}}

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