@spec are_jids_same_user?(binary() | nil, binary() | nil) :: boolean()

Compares two JIDs to see if they represent the same user.

@spec decode(binary() | nil) :: map() | nil

Decodes a JID string into its components.

Parameters

• jid: The JID string to decode

Returns

A map with keys: :user, :server, :device (optional), :domain_type

Examples

iex> JID.decode("1234@s.whatsapp.net")
%{user: "1234", server: "s.whatsapp.net", domain_type: 0}

iex> JID.decode("1234:0@s.whatsapp.net")
%{user: "1234", device: 0, server: "s.whatsapp.net", domain_type: 0}

@spec encode(map()) :: binary()

Encodes a JID from its components.

Parameters

• user: The user identifier (string, number, or nil)
• server: The server part of the JID (optional, defaults to "s.whatsapp.net")
• device: Optional device number
• agent: Optional agent number

Examples

iex> JID.encode(%{user: "1234", server: "s.whatsapp.net"})
"1234@s.whatsapp.net"

iex> JID.encode(%{user: "1234", device: 0, server: "s.whatsapp.net"})
"1234:0@s.whatsapp.net"

iex> JID.encode(%{user: "1234", agent: 1, server: "s.whatsapp.net"})
"1234_1@s.whatsapp.net"

@spec group?(binary() | nil) :: boolean()

Checks if a JID represents a group. This is an alias for jid_group?/1 for compatibility with the messages module.

@spec hosted_lid_user?(binary() | nil) :: boolean()

Checks if a JID represents a hosted LID user.

@spec hosted_pn_user?(binary() | nil) :: boolean()

Checks if a JID represents a hosted PN user.

@spec jid_bot?(binary() | nil) :: boolean()

Checks if a JID represents a bot.

@spec jid_broadcast?(binary() | nil) :: boolean()

Checks if a JID represents a broadcast.

@spec jid_group?(binary() | nil) :: boolean()

Checks if a JID represents a group.

@spec jid_meta_ai?(binary() | nil) :: boolean()

Checks if a JID represents Meta AI.

@spec jid_newsletter?(binary() | nil) :: boolean()

Checks if a JID represents a newsletter.

@spec jid_normalized_user(binary() | nil) :: binary()

Normalizes a JID to user format, converting c.us to s.whatsapp.net.

@spec jid_status_broadcast?(binary()) :: boolean()

Checks if a JID is the status broadcast.

@spec jid_user?(binary() | nil) :: boolean()

Checks if a JID represents a user (PN user).

@spec lid_user?(binary() | nil) :: boolean()

Checks if a JID represents a LID user.

@spec meta_ai_jid() :: binary()

Returns the META_AI_JID constant

@spec official_biz_jid() :: binary()

Returns the OFFICIAL_BIZ_JID constant

@spec psa_wid() :: binary()

Returns the PSA_WID constant

@spec s_whatsapp_net() :: binary()

Returns the S_WHATSAPP_NET constant

@spec server_jid() :: binary()

Returns the SERVER_JID constant

@spec stories_jid() :: binary()

Returns the STORIES_JID constant

@spec transfer_device(binary(), binary()) :: binary()

Transfers device from one JID to another.