Public facade for the BaileysEx connection runtime and major feature surfaces.
Quick Start
alias BaileysEx.Auth.NativeFilePersistence
alias BaileysEx.Connection.Transport.MintWebSocket
{:ok, persisted_auth} =
NativeFilePersistence.use_native_file_auth_state("tmp/baileys_auth")
parent = self()
{:ok, connection} =
BaileysEx.connect(
persisted_auth.state,
Keyword.merge(persisted_auth.connect_opts, [
transport: {MintWebSocket, []},
on_qr: fn qr -> IO.puts("Scan QR: #{qr}") end,
on_connection: fn update ->
IO.inspect({:connection, update})
send(parent, {:connection_update, update})
end
])
)
_creds_unsubscribe =
BaileysEx.subscribe_raw(connection, fn events ->
if Map.has_key?(events, :creds_update) do
{:ok, latest_auth_state} = BaileysEx.auth_state(connection)
:ok = persisted_auth.save_creds.(latest_auth_state)
end
end)
receive do
{:connection_update, %{connection: :open}} -> :ok
after
30_000 -> raise "connection did not open"
end
unsubscribe =
BaileysEx.subscribe(connection, fn
{:message, message} -> IO.inspect(message, label: "incoming")
{:connection, update} -> IO.inspect(update, label: "connection")
_other -> :ok
end)
unsubscribe.()
:ok = BaileysEx.disconnect(connection)Persistence Backends
Use BaileysEx.Auth.NativeFilePersistence.use_native_file_auth_state/1 for the
recommended durable file-backed setup in Elixir-first apps.
Use BaileysEx.Auth.FilePersistence.use_multi_file_auth_state/1 when you need
the Baileys-compatible JSON multi-file auth layout and helper semantics.
Custom SQL/NoSQL backends remain supported through
BaileysEx.Auth.Persistence, BaileysEx.Auth.KeyStore, and a matching
signal_store_module. Advanced custom store modules must implement the
explicit transaction-handle contract in BaileysEx.Signal.Store; the
built-in helpers already wire the correct store for you.
Advanced callers can obtain the raw socket transport tuple via queryable/1
and pass it directly to the lower-level feature modules.
Outbound send_message/4 and send_status/3 use the built-in production Signal
adapter by default when the auth state includes signed_identity_key,
signed_pre_key, and registration_id. Use :signal_repository or
:signal_repository_adapter only when you need to override that default.
Summary
Types
Opaque WAProto WebMessageInfo struct accepted by media download and retry helpers.
Functions
Archive or unarchive a chat via the app-state patch path.
Return the current auth state snapshot from the connection store.
Fetch a business catalog.
Fetch business catalog collections.
Fetch business order details.
Create a business product.
Delete one or more business products.
Update a business product.
Fetch the business profile for a WhatsApp JID.
Clear a chat history via app-state sync.
Accept a legacy community invite code.
Accept a v4 community invite.
Create a community.
Create a linked subgroup inside a community.
Fetch all participating communities.
Fetch linked groups for a community or subgroup.
Fetch community invite metadata without joining.
Fetch the current community invite code.
Toggle join-approval mode for a community.
Leave a community.
Link an existing subgroup into a community.
Switch whether only admins or all members can add participants to a community.
Fetch community metadata.
Add, remove, promote, or demote community participants.
Fetch the pending membership-approval request list for a community.
Approve or reject pending community membership requests.
Revoke the current community invite code and return the new one.
Revoke a v4 community invite for a specific invited user.
Update a community announcement or locked setting.
Enable or disable disappearing messages for a community.
Unlink a subgroup from a community.
Update or clear a community description.
Update a community subject.
Start a connection runtime and optionally attach convenience callbacks.
Create an audio or video call link.
Delete a chat via app-state sync.
Delete a specific message for the current device.
Stop a running connection runtime.
Download media into memory.
Download media directly to a file path.
Return the connection event emitter pid.
Fetch the account blocklist.
Fetch the latest version published by Baileys' current Defaults/index.ts.
Fetch the latest WhatsApp Web client revision from web.whatsapp.com/sw.js.
Fetch profile status text for one or more JIDs.
Accept a legacy group invite code.
Accept a v4 group invite.
Create a group.
Fetch all participating groups.
Fetch group invite metadata without joining.
Fetch the current group invite code.
Toggle join-approval mode for a group.
Leave a group.
Switch whether only admins or all members can add participants.
Fetch group metadata.
Add, remove, promote, or demote group participants.
Fetch the pending join-request list for a group.
Approve or reject pending group join requests.
Revoke the current group invite code and return the new one.
Revoke a v4 group invite for a specific invited user.
Update a group announcement or locked setting.
Enable or disable disappearing messages for a group.
Update or clear a group description.
Update a group subject.
Mark a chat read or unread.
Mute a chat until the given Unix timestamp, or pass nil to unmute.
Fetch newsletter admin count.
Change the newsletter owner.
Create a newsletter.
Delete a newsletter.
Demote a newsletter admin.
Fetch newsletter message history.
Follow a newsletter.
Fetch newsletter metadata by :jid or :invite key.
Mute a newsletter.
React to a newsletter message or remove an existing reaction.
Remove the newsletter picture.
Subscribe to live newsletter updates.
Fetch newsletter subscriber counts.
Unfollow a newsletter.
Unmute a newsletter.
Update newsletter metadata.
Update the newsletter description.
Update the newsletter name.
Update the newsletter picture.
Check which phone numbers are registered on WhatsApp.
Pin or unpin a chat.
Subscribe to a contact or group presence feed.
Fetch privacy settings.
Fetch a profile picture URL.
Return the underlying socket transport tuple used by feature modules.
Send read receipts for the provided message keys using current privacy settings.
Reject an inbound call.
Remove the business cover photo.
Remove the profile picture for yourself or a group.
Request a phone-number pairing code from the active socket.
Send a message to a WhatsApp JID through the coordinator-managed runtime.
Send an availability or chatstate update.
Send a status update through the status@broadcast fanout path.
Send a WAM analytics buffer or BaileysEx.WAM.BinaryInfo through the active socket.
Return the wrapped Signal store for the connection when present.
Star or unstar one or more messages in a chat.
Subscribe to friendly high-level events.
Subscribe to raw buffered event maps.
Block or unblock a user.
Upload and set the business cover photo.
Update the business profile payload.
Update call-add privacy.
Set the default disappearing-message duration in seconds.
Update group-add privacy.
Update last-seen privacy.
Update the app-state privacy toggle that disables server-side link previews.
Request media re-upload and return the updated message with refreshed URLs.
Update who can message you.
Update online-visibility privacy.
Update the current account push name via app-state sync.
Update the profile picture for yourself or a group.
Update profile-picture privacy.
Update the account status text.
Update read-receipt privacy.
Update status/story privacy.
Types
@type connection() :: GenServer.server()
@type unsubscribe_fun() :: (-> :ok)
@type web_message_info() :: struct()
Opaque WAProto WebMessageInfo struct accepted by media download and retry helpers.
Functions
@spec archive_chat(connection(), String.t(), boolean(), list(), keyword()) :: :ok | {:error, term()}
Archive or unarchive a chat via the app-state patch path.
@spec auth_state(connection()) :: {:ok, map()} | {:error, :store_not_available}
Return the current auth state snapshot from the connection store.
creds_update events are mirrored into the store before public subscribers run,
so callers can safely read auth_state/1 from inside those callbacks.
@spec business_catalog( connection(), keyword() ) :: {:ok, map()} | {:error, term()}
Fetch a business catalog.
@spec business_collections(connection(), String.t() | nil, pos_integer(), keyword()) :: {:ok, map()} | {:error, term()}
Fetch business catalog collections.
@spec business_order_details(connection(), String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Fetch business order details.
@spec business_product_create(connection(), map(), keyword()) :: {:ok, map()} | {:error, term()}
Create a business product.
@spec business_product_delete(connection(), [String.t()], keyword()) :: {:ok, %{deleted: non_neg_integer()}} | {:error, term()}
Delete one or more business products.
@spec business_product_update(connection(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, term()}
Update a business product.
@spec business_profile(connection(), String.t(), keyword()) :: {:ok, map() | nil} | {:error, term()}
Fetch the business profile for a WhatsApp JID.
@spec clear_chat(connection(), String.t(), list(), keyword()) :: :ok | {:error, term()}
Clear a chat history via app-state sync.
@spec community_accept_invite(connection(), String.t(), keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Accept a legacy community invite code.
@spec community_accept_invite_v4(connection(), String.t() | map(), map(), keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Accept a v4 community invite.
@spec community_create(connection(), String.t(), String.t() | nil, keyword()) :: {:ok, map()} | {:error, term()}
Create a community.
@spec community_create_group( connection(), String.t(), [String.t()], String.t(), keyword() ) :: {:ok, map() | nil} | {:error, term()}
Create a linked subgroup inside a community.
@spec community_fetch_all_participating( connection(), keyword() ) :: {:ok, %{required(String.t()) => map()}} | {:error, term()}
Fetch all participating communities.
@spec community_fetch_linked_groups(connection(), String.t(), keyword()) :: {:ok, %{community_jid: String.t(), is_community: boolean(), linked_groups: [map()]}} | {:error, term()}
Fetch linked groups for a community or subgroup.
@spec community_get_invite_info(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Fetch community invite metadata without joining.
@spec community_invite_code(connection(), String.t(), keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Fetch the current community invite code.
@spec community_join_approval_mode(connection(), String.t(), :on | :off, keyword()) :: :ok | {:error, term()}
Toggle join-approval mode for a community.
@spec community_leave(connection(), String.t(), keyword()) :: :ok | {:error, term()}
Leave a community.
@spec community_link_group(connection(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}
Link an existing subgroup into a community.
@spec community_member_add_mode( connection(), String.t(), :admin_add | :all_member_add, keyword() ) :: :ok | {:error, term()}
Switch whether only admins or all members can add participants to a community.
@spec community_metadata(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Fetch community metadata.
@spec community_participants_update( connection(), String.t(), [String.t()], :add | :remove | :promote | :demote, keyword() ) :: {:ok, [map()]} | {:error, term()}
Add, remove, promote, or demote community participants.
@spec community_request_participants_list(connection(), String.t(), keyword()) :: {:ok, [map()]} | {:error, term()}
Fetch the pending membership-approval request list for a community.
@spec community_request_participants_update( connection(), String.t(), [String.t()], :approve | :reject, keyword() ) :: {:ok, [map()]} | {:error, term()}
Approve or reject pending community membership requests.
@spec community_revoke_invite(connection(), String.t(), keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Revoke the current community invite code and return the new one.
@spec community_revoke_invite_v4(connection(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}
Revoke a v4 community invite for a specific invited user.
@spec community_setting_update( connection(), String.t(), :announcement | :not_announcement | :locked | :unlocked, keyword() ) :: :ok | {:error, term()}
Update a community announcement or locked setting.
@spec community_toggle_ephemeral( connection(), String.t(), non_neg_integer(), keyword() ) :: :ok | {:error, term()}
Enable or disable disappearing messages for a community.
@spec community_unlink_group(connection(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}
Unlink a subgroup from a community.
@spec community_update_description( connection(), String.t(), String.t() | nil, keyword() ) :: :ok | {:error, term()}
Update or clear a community description.
@spec community_update_subject(connection(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}
Update a community subject.
Start a connection runtime and optionally attach convenience callbacks.
Pass a real :transport such as {BaileysEx.Connection.Transport.MintWebSocket, []}
when you want an actual WhatsApp connection. Without it, the default transport
returns {:error, :transport_not_configured}.
Use BaileysEx.Auth.NativeFilePersistence.use_native_file_auth_state/1 for the
recommended durable built-in file setup.
Use BaileysEx.Auth.FilePersistence.use_multi_file_auth_state/1 when you want the
Baileys-compatible JSON multi-file helper instead.
Custom persistence backends remain supported through BaileysEx.Auth.Persistence
plus a compatible signal_store_module. Advanced custom store modules must
follow the explicit transaction-handle contract in BaileysEx.Signal.Store.
Supported callback options:
:on_connectionreceives eachconnection_updatepayload:on_qrreceives QR strings extracted fromconnection_update:on_messagereceives each message frommessages_upsert:on_eventreceives the raw buffered event map
These convenience callbacks stay attached for the lifetime of the connection runtime.
Use subscribe/2 or subscribe_raw/2 when you need an explicit unsubscribe handle.
@spec create_call_link(connection(), :audio | :video, map() | nil, keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Create an audio or video call link.
@spec delete_chat(connection(), String.t(), list(), keyword()) :: :ok | {:error, term()}
Delete a chat via app-state sync.
@spec delete_message_for_me( connection(), String.t(), map(), integer(), boolean(), keyword() ) :: :ok | {:error, term()}
Delete a specific message for the current device.
@spec disconnect(connection()) :: :ok | {:error, term()}
Stop a running connection runtime.
Download media into memory.
Download media directly to a file path.
@spec event_emitter(connection()) :: {:ok, pid()} | {:error, :event_emitter_not_available}
Return the connection event emitter pid.
@spec fetch_blocklist( connection(), keyword() ) :: {:ok, [String.t()]} | {:error, term()}
Fetch the account blocklist.
Fetch the latest version published by Baileys' current Defaults/index.ts.
Fetch the latest WhatsApp Web client revision from web.whatsapp.com/sw.js.
@spec fetch_status(connection(), [String.t()], keyword()) :: {:ok, [map()]} | {:error, term()}
Fetch profile status text for one or more JIDs.
@spec group_accept_invite(connection(), String.t(), keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Accept a legacy group invite code.
@spec group_accept_invite_v4(connection(), String.t() | map(), map(), keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Accept a v4 group invite.
@spec group_create(connection(), String.t(), [String.t()], keyword()) :: {:ok, map()} | {:error, term()}
Create a group.
@spec group_fetch_all_participating( connection(), keyword() ) :: {:ok, %{required(String.t()) => map()}} | {:error, term()}
Fetch all participating groups.
@spec group_get_invite_info(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Fetch group invite metadata without joining.
@spec group_invite_code(connection(), String.t(), keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Fetch the current group invite code.
@spec group_join_approval_mode(connection(), String.t(), :on | :off, keyword()) :: :ok | {:error, term()}
Toggle join-approval mode for a group.
@spec group_leave(connection(), String.t()) :: :ok | {:error, term()}
Leave a group.
@spec group_member_add_mode( connection(), String.t(), :admin_add | :all_member_add, keyword() ) :: :ok | {:error, term()}
Switch whether only admins or all members can add participants.
@spec group_metadata(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Fetch group metadata.
@spec group_participants_update( connection(), String.t(), [String.t()], :add | :remove | :promote | :demote, keyword() ) :: {:ok, [map()]} | {:error, term()}
Add, remove, promote, or demote group participants.
@spec group_request_participants_list(connection(), String.t(), keyword()) :: {:ok, [map()]} | {:error, term()}
Fetch the pending join-request list for a group.
@spec group_request_participants_update( connection(), String.t(), [String.t()], :approve | :reject, keyword() ) :: {:ok, [map()]} | {:error, term()}
Approve or reject pending group join requests.
@spec group_revoke_invite(connection(), String.t(), keyword()) :: {:ok, String.t() | nil} | {:error, term()}
Revoke the current group invite code and return the new one.
@spec group_revoke_invite_v4(connection(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}
Revoke a v4 group invite for a specific invited user.
@spec group_setting_update( connection(), String.t(), :announcement | :not_announcement | :locked | :unlocked, keyword() ) :: :ok | {:error, term()}
Update a group announcement or locked setting.
@spec group_toggle_ephemeral(connection(), String.t(), non_neg_integer(), keyword()) :: :ok | {:error, term()}
Enable or disable disappearing messages for a group.
@spec group_update_description(connection(), String.t(), String.t() | nil, keyword()) :: :ok | {:error, term()}
Update or clear a group description.
@spec group_update_subject(connection(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}
Update a group subject.
@spec mark_chat_read(connection(), String.t(), boolean(), list(), keyword()) :: :ok | {:error, term()}
Mark a chat read or unread.
@spec mute_chat(connection(), String.t(), integer() | nil, keyword()) :: :ok | {:error, term()}
Mute a chat until the given Unix timestamp, or pass nil to unmute.
@spec newsletter_admin_count(connection(), String.t(), keyword()) :: {:ok, non_neg_integer()} | {:error, term()}
Fetch newsletter admin count.
@spec newsletter_change_owner(connection(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}
Change the newsletter owner.
@spec newsletter_create(connection(), String.t(), String.t() | nil, keyword()) :: {:ok, map()} | {:error, term()}
Create a newsletter.
@spec newsletter_delete(connection(), String.t(), keyword()) :: :ok | {:error, term()}
Delete a newsletter.
@spec newsletter_demote(connection(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}
Demote a newsletter admin.
@spec newsletter_fetch_messages(connection(), String.t(), pos_integer(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Fetch newsletter message history.
@spec newsletter_follow(connection(), String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Follow a newsletter.
@spec newsletter_metadata(connection(), :invite | :jid, String.t(), keyword()) :: {:ok, map() | nil} | {:error, term()}
Fetch newsletter metadata by :jid or :invite key.
@spec newsletter_mute(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Mute a newsletter.
@spec newsletter_react_message( connection(), String.t(), String.t(), String.t() | nil, keyword() ) :: :ok | {:error, term()}
React to a newsletter message or remove an existing reaction.
@spec newsletter_remove_picture(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Remove the newsletter picture.
@spec newsletter_subscribe_updates(connection(), String.t(), keyword()) :: {:ok, %{duration: String.t()} | nil} | {:error, term()}
Subscribe to live newsletter updates.
@spec newsletter_subscribers(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Fetch newsletter subscriber counts.
@spec newsletter_unfollow(connection(), String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Unfollow a newsletter.
@spec newsletter_unmute(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Unmute a newsletter.
@spec newsletter_update(connection(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, term()}
Update newsletter metadata.
@spec newsletter_update_description(connection(), String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Update the newsletter description.
@spec newsletter_update_name(connection(), String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
Update the newsletter name.
@spec newsletter_update_picture(connection(), String.t(), term(), keyword()) :: {:ok, map()} | {:error, term()}
Update the newsletter picture.
@spec on_whatsapp(connection(), [String.t()], keyword()) :: {:ok, [%{exists: boolean(), jid: String.t()}]} | {:error, term()}
Check which phone numbers are registered on WhatsApp.
@spec pin_chat(connection(), String.t(), boolean(), keyword()) :: :ok | {:error, term()}
Pin or unpin a chat.
@spec presence_subscribe(connection(), String.t(), keyword()) :: :ok | {:error, term()}
Subscribe to a contact or group presence feed.
@spec privacy_settings( connection(), keyword() ) :: {:ok, map()} | {:error, term()}
Fetch privacy settings.
@spec profile_picture_url( connection(), String.t(), BaileysEx.Feature.Profile.picture_type(), keyword() ) :: {:ok, String.t() | nil} | {:error, term()}
Fetch a profile picture URL.
@spec queryable(connection()) :: {:ok, {module(), pid()}} | {:error, :socket_not_available}
Return the underlying socket transport tuple used by feature modules.
@spec read_messages(connection(), [map()], keyword()) :: :ok | {:error, term()}
Send read receipts for the provided message keys using current privacy settings.
@spec reject_call(connection(), String.t(), String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Reject an inbound call.
@spec remove_business_cover_photo(connection(), String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Remove the business cover photo.
@spec remove_profile_picture(connection(), String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Remove the profile picture for yourself or a group.
@spec request_pairing_code(connection(), binary(), keyword()) :: {:ok, binary()} | {:error, term()}
Request a phone-number pairing code from the active socket.
@spec send_message( connection(), String.t() | BaileysEx.JID.t(), map() | struct(), keyword() ) :: {:ok, map()} | {:error, term()}
Send a message to a WhatsApp JID through the coordinator-managed runtime.
By default, connect/2 builds the production Signal adapter when the auth state
includes signed_identity_key, signed_pre_key, and registration_id. Use
:signal_repository or :signal_repository_adapter only to override it.
@spec send_presence_update( connection(), BaileysEx.Feature.Presence.presence(), String.t() | nil, keyword() ) :: :ok | {:error, term()}
Send an availability or chatstate update.
@spec send_status(connection(), map(), keyword()) :: {:ok, map()} | {:error, term()}
Send a status update through the status@broadcast fanout path.
By default, connect/2 builds the production Signal adapter when the auth state
includes signed_identity_key, signed_pre_key, and registration_id. Use
:signal_repository or :signal_repository_adapter only to override it.
@spec send_wam_buffer(connection(), binary() | BaileysEx.WAM.BinaryInfo.t()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Send a WAM analytics buffer or BaileysEx.WAM.BinaryInfo through the active socket.
@spec signal_store(connection()) :: {:ok, BaileysEx.Signal.Store.t()} | {:error, :signal_store_not_available}
Return the wrapped Signal store for the connection when present.
@spec star_messages(connection(), String.t(), [map()], boolean(), keyword()) :: :ok | {:error, term()}
Star or unstar one or more messages in a chat.
@spec subscribe(connection(), (tuple() -> term())) :: unsubscribe_fun() | {:error, :event_emitter_not_available}
Subscribe to friendly high-level events.
The handler receives:
{:connection, update}for connection lifecycle updates{:message, message}for each incoming message{:presence, update}for presence updates{:call, payload}for call events{:event, name, payload}for all other event payloads
@spec subscribe_raw(connection(), (map() -> term())) :: unsubscribe_fun() | {:error, :event_emitter_not_available}
Subscribe to raw buffered event maps.
@spec update_block_status(connection(), String.t(), :block | :unblock, keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Block or unblock a user.
@spec update_business_cover_photo(connection(), term(), keyword()) :: {:ok, String.t()} | {:error, term()}
Upload and set the business cover photo.
@spec update_business_profile(connection(), map(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update the business profile payload.
@spec update_call_privacy(connection(), atom() | String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update call-add privacy.
@spec update_default_disappearing_mode(connection(), non_neg_integer(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Set the default disappearing-message duration in seconds.
@spec update_groups_add_privacy(connection(), atom() | String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update group-add privacy.
@spec update_last_seen_privacy(connection(), atom() | String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update last-seen privacy.
@spec update_link_previews_privacy(connection(), boolean(), keyword()) :: :ok | {:error, term()}
Update the app-state privacy toggle that disables server-side link previews.
@spec update_media_message(connection(), web_message_info(), keyword()) :: {:ok, web_message_info()} | {:error, term()}
Request media re-upload and return the updated message with refreshed URLs.
Sends a retry request, waits for the matching messages_media_update event,
decrypts the response, and applies the refreshed directPath/url.
Options
:timeout— milliseconds to wait for the media update event (default 10_000)
@spec update_messages_privacy(connection(), atom() | String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update who can message you.
@spec update_online_privacy(connection(), atom() | String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update online-visibility privacy.
@spec update_profile_name(connection(), String.t(), keyword()) :: :ok | {:error, term()}
Update the current account push name via app-state sync.
@spec update_profile_picture(connection(), String.t(), term(), map() | nil, keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update the profile picture for yourself or a group.
@spec update_profile_picture_privacy(connection(), atom() | String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update profile-picture privacy.
@spec update_profile_status(connection(), String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update the account status text.
@spec update_read_receipts_privacy(connection(), atom() | String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update read-receipt privacy.
@spec update_status_privacy(connection(), atom() | String.t(), keyword()) :: {:ok, BaileysEx.BinaryNode.t()} | {:error, term()}
Update status/story privacy.