ExWapp.JID (ExWapp v0.1.2)

Copy Markdown View Source

Minimal representation of a WhatsApp JID.

The implementation mirrors the pieces used by the binary encoder/decoder.

Summary

Types

t()

@type t() :: %ExWapp.JID{
  device: non_neg_integer(),
  integrator: non_neg_integer(),
  raw_agent: non_neg_integer(),
  server: String.t(),
  user: String.t()
}

Functions

actual_agent(jid)

broadcast?(jid)

@spec broadcast?(term()) :: boolean()

Checks if a JID string represents a broadcast list.

broadcast_server()

default_user_server()

empty?()

group?(jid)

@spec group?(term()) :: boolean()

Checks if a JID string represents a group.

group_server()

hidden_user_server()

hosted_server()

interop_server()

is_broadcast?(jid)

This function is deprecated. Use broadcast?/1 instead..

is_group?(jid)

This function is deprecated. Use group?/1 instead..

is_user?(jid)

This function is deprecated. Use user?/1 instead..

messenger_server()

new(user, server)

new_ad(user, agent, device)

parse(jid)

@spec parse(term()) :: {:ok, t()} | {:error, :invalid_jid}

Parses a JID string into a struct.

to_string(jid)

user?(jid)

@spec user?(term()) :: boolean()

Checks if a JID string represents a regular user.

with_device(jid, device)

with_integrator(jid, integrator)