ExWapp.Contact (ExWapp v0.1.2)

@type t() :: %ExWapp.Contact{
  first_name: String.t() | nil,
  full_name: String.t() | nil,
  jid: String.t(),
  lid: String.t() | nil,
  phone_number: String.t() | nil,
  push_name: String.t() | nil,
  username: String.t() | nil
}

Functions

delete(store, jid)

@spec delete(
  struct(),
  String.t()
) :: :ok

Delete a contact by JID.

get(store, jid)

@spec get(
  struct(),
  String.t()
) :: t() | nil

Get a contact by JID.

list(store)

@spec list(struct()) :: [t()]

List all contacts from the store.

merge_from_sync(store, jid, contact_action)

@spec merge_from_sync(struct(), String.t(), map()) :: :ok

Merge contact data from an app state sync ContactAction.

put(store, jid, contact)

@spec put(struct(), String.t(), t()) :: :ok

Put (create or update) a contact.

update_push_name(store, jid, name)

@spec update_push_name(struct(), String.t(), String.t()) :: :ok

Update push name for a contact (from incoming message notify attr).

vcard(display_name, phone_number)

@spec vcard(String.t(), String.t()) :: String.t()

Builds a WhatsApp-compatible vCard 3.0 payload for send_contact/5.

The waid parameter is normalized to digits while the displayed telephone number keeps its leading + when one was supplied.