All Classes and Interfaces
Class
Description
A model interface that represents an action
A model class that holds the information related to an companion reply.
The constants of this enumerated type describe the various types of companion that a
AdReplyInfo can link toA model clas that represents an agent
A model clas that represents unsupported actions for android
A model clas that represents an archived chat
An interface to represent a supplier that returns a code wrapped in a CompletableFuture
The constants of this enumerated type describe the various types of attachments supported by Whatsapp
A utility class that wraps a map and provides easy methods to interact with its content
A model class that holds a payload about a business link info.
The constants of this enumerated type describe the various types of business accounts
A model class that holds a payload about a business account.
A record class that represents a business catalog entry.
A model class that represents a business category
Record class representing a business collection entry.
A business hours representation that contains the business' time zone and a list of business hour
entries.
A business hours entry that represents the hours of operation for a single day of the week.
A model class that holds the information related to the identity of a business account.
The constants of this enumerated type describe the various types of actors of a business account
The constants of this enumerated type describe the various types of verification that a business
account can have
An enumeration of possible Availabilities.
A model class that represents a time a localizable name
The constants of this enumerated type describe the various types of business privacy
This model class represents the metadata of a business profile
An enumeration of possible ReviewStatuses.
A model class that represents a business certificate
A model class that represents a verified name
A model class that represents a button
An action link for a button
A model that represents the body of a button
A model interface that represents a button message
A model class that represents data about a button
A model interface that represents a reply to a button message
A model class that represents a row of buttons
A model class that represents data about a row
A model class that represents a section of buttons
A model class that represents a message that contains buttons inside
A model that represents the header of a
ButtonsMessageThe constants of this enumerated type describe the various types of headers that a
ButtonsMessage can haveA model class that represents a message that contains a newsletters to a previous
ButtonsMessageA model class that represents the text of a button
A message that contains information related to a call
A model class that represents a message that cancels a
RequestPaymentMessage.A model class that represents a Chat.
The constants of this enumerated type describe the various types of transfers that can regard a
chat history sync
A model clas that represents the assignment of a chat
A model clas that represents the assignment of a chat as opened
A model that represents a chat disappear mode
The constants of this enumerated type describe the various actors that can initialize
disappearing messages in a chat
Enum representing the ChatEphemeralTimer period.
A model class that holds the information related to a
Message.The constants of this enumerated type describe the various types of server message that a
ChatMessageInfo can describeA container for unique identifiers and metadata linked to a
Message and contained in
ChatMessageInfo.An immutable model class that represents a mute
The constants of this enumerated type describe the various types of mute a
ChatMute can
describeThe constants of this enumerated type describe the various policies that can be enforced for a
GroupSetting or CommunitySetting in a ChatA model class that represents the wallpaper of a chat.
A model clas that represents a cleared chat
The constants of this enumerated type describe the various types of API that can be used to make
Whatsapp workThe constants of this enumerated type describe the various settings that can be toggled for a community
A model for a mobile companion
The constants of this enumeration describe the various types of recommendedChannels that can be yielded by a new device's registration through the mobile api
A model that represents an immutable property associated with the linked device
A builder to specify the type of connection to use
The constants of this enumerated type describe the various types of connections that can be initialized
A model class that represents a Contact.
A model clas that represents a new contact push name
A model class to represent and build the vcard of a contact
A parsed representation of the vcard
A raw representation of the vcard
A model class that represents a message holding a contact inside
A model class that represents a message holding a list of contacts inside
The constants of this enumerated type describe the various status that a
Contact can be
inA model class that holds the information related to a
ContextualMessage.A model interface that represents a message sent by a contact that provides a context.
This interface represents is implemented by all WhatsappWeb4J's controllers.
This interface provides a standardized way to serialize a session
A model class that represents a message to decline a
RequestPaymentMessage.A model clas that represents a deleted chat
A model clas that represents a message deleted for this client
A model class that represents a message that refers to a message sent by the device paired with
the active WhatsappWeb session.
A model class that represents a message that refers to a message sent by the device paired with
the active WhatsappWeb session to dataSync.
The constants of this enumerated type describe the various reasons for which a session can be
terminated
A model class that represents a message holding a document inside
A list of all emojis supported by Whatsapp
Source
A model class that represents an empty message.
This interface allows to handle a socket error and provides a default way to do so
The constants of this enumerated type describe the various locations where an error can occur
in the socket
The constants of this enumerated type describe the various types of actions that can be
performed by an error handler in newsletters to a throwable
A model class that holds the information related to an advertisement.
The constants of this enumerated type describe the various types of media that an ad can wrap
A container for a future message
A model interface that represents a gdpr account report.
An erroneous gdpr request
A pending gdpr request
A successful gdpr request
The constants of this enumerated type describe the status of a gdpr request
A model class that represents a message holding a whatsapp group invite inside
This model class represents the metadata of a group
A model class that represents a participant of a group.
Class representing a past participant in a chat
Enum representing the errorReason for a past participant leaving the chat.
Class representing a list of past participants in a chat group
The constants of this enumerated type describe the various roles that a
GroupParticipant
can have in a group.The constants of this enumerated type describe the various settings that can be toggled for a
group.
A model that represents all types of hydrated buttons
The constants of this enumerated type describe the various types of buttons that a template can
wrap
A model class that represents a template for a button
A model class that represents a button that can start a phone call
A model class that represents a currency
A model class that represents a time
A model class that represents a time component
The constants of this enumerated type describe the supported calendar types
The constants of this enumerated type describe the days of the week
A model class that represents a time as a unix epoch
A model class that represents the value of a localizable parameter
The constants of this enumerated type describe the various type of date types that a date time can wrap
A model class that represents a four row template
A model that represents the title of a
HighlyStructuredFourRowTemplateThe constants of this enumerated type describe the various types of title that a template can
have
A model class that represents a time a localizable parameter
A model class that represents the value of a localizable parameter
A model class that represents a message that contains a highly structured message inside.
A model class that represents a quick reply button
A model class that represents an url button
An unchecked exception that is thrown when a hmac signature cannot be validated
A model that represents all types of hydrated buttons
The constants of this enumerated type describe the various types of buttons that a template can
wrap
A model class that represents a hydrated button that can start a phone call
A model class that represents a hydrated four row template
A model class that represents a hydrated four row template
A model that represents the title of a
HydratedFourRowTemplateThe constants of this enumerated type describe the various types of title that a template can
wrap
A model class that represents a hydrated quick reply button
A model class that represents a hydrated template for a button
A model class that represents a hydrated url button
A model class that represents a message holding an image inside
A model class that represents the body of a product
A model class that represents a native flow button
A model class that represents a business collection
A model class that represents the footer of a product
A model class that represents the header of a product
A sealed class that describes the various types of headers
The constants of this enumerated type describe the various types of attachment that a product
header can have
A model that represents the jpeg thumbnail of a
InteractiveHeaderA model class that describes an interactive annotation linked to a message
The constants of this enumerated type describe the various types of sync that an interactive
annotation can provide
A model class that represents a message holding an interactive message inside.
A model class that represents a message that can be used as the content of a
InteractiveMessageThe constants of this enumerated type describe the various types of content that an interactive
message can wrap
A model class that represents a native flow
Here> is an explanation on how to use this kind of message
This model class describes a Point in space
A model class that represents the body of a product
A model class that represents a shop
The constants of this enumerated type describe the various types of surfaces that a
InteractiveShop can haveThis model class describes a Location
A model class that represents a jid.
Utility interface to make providing a jid easier
The constants of this enumerated type describe the various servers that a jid might be linked
to
The constants of this enumerated type describe the various types of jids currently supported
A model class that represents an ephemeral message that was saved manually by the user in a chat
This controller holds the cryptographic-related data regarding a WhatsappWeb session
A model clas that represents a label association
A model clas that represents an edit to a label
This interface can be used to listen for events fired when new information is sent by
WhatsappWeb's socket.
A model class that represents a message that contains a list of buttons or a list of products
The constants of this enumerated type describe the various types of
ListMessageA model class that represents a message that contains a newsletters to a previous
ListMessageThe constants of this enumerated type describe the various types of
ListMessageA model class that represents a message holding a live location inside
A model class that represents a message holding a location inside
A model clas that represents a new read status for a chat
A media message
Read its content using
Whatsapp.downloadMedia(ChatMessageInfo)The constants of this enumerated type describe the various types of media type that a
MediaMessage can holdThe constants of this enumerated type describe the various types of media visibility that can be
set for a chat
A model interface that represents a message sent by a contact or by Whatsapp.
The constants of this enumerated type describe the various categories of messages that a
MessageContainer can wrapA container for all types of messages known currently to WhatsappWeb.
An index that contains data about a setting change or an action
A model that represents the receipt for a message
The constants of this enumerated type describe the various types of status of a
MessageThe constants of this enumerated type describe the various types of messages that a
MessageContainer can wrapA builder to specify the options for the mobile api
A sealed interface that represents a class that can provide data about a media
A model clas that represents a new mute status for a chat
A model class that holds the information related to a native flow.
An immutable model class that represents the primary unit used by WhatsappWeb's WebSocket to communicate with the client
Unknown
This interface allows to consume a pairing code sent by WhatsappWeb
A model class that holds the information related to a payment.
The constants of this enumerated type describe the currencies supported for a transaction
described by a
PaymentInfoThe constants of this enumerated type describe the status of a payment described by a
PaymentInfoA model class that represents a message to decline a
RequestPaymentMessage.A model class that represents a message to notify the invoice about a successful payment.
The constants of this enumerated type describe the various types of attachment that an invoice
can wrap
A model interface that represents a message regarding a payment
A model class that represents a message to pay an order.
A model clas that represents a new pin status for a chat
A model class that represents additional metadata about a
PollCreationMessageA model class that represents a message holding a poll inside
A model class that represents an option in a
PollCreationMessageA model class that represents metadata about a
PollUpdateMessage Not currently used, so it's
package privateA model class that represents the cypher data to decode a
PollUpdateMessageA model class that represents the cypher data to decode the votes of a user inside
PollUpdateMessageA model class that represents a message holding a vote for a poll inside
A model class that represents additional metadata about a
PollUpdateMessage Currently emptyA model class that contains the main Whatsapp version being used
A model that represents a privacy setting entry
The constants of this enumerated type describe the various types of settings that a user can
toggle in his account's preferences
The constants of this enumerated type describe the various types of preferences that can be
toggled for a corresponding setting
A model class that represents a product
A model class that represents a product catalog
A model class that represents the header of a product list
A model class that holds the information related to a list of products.
A model class that represents a message holding a product inside
A model class that represents a section inside a list of products
A model class that represents a product
A model class that represents a message sent by a WhatsappWeb.
The constants of this enumerated type describe the various type of data that a
ProtocolMessage can wrapThis interface allows to consume a qr code and provides default common implementations to do so
This interface allows to consume a file created by
QrHandler.toFile(Path, ToFileConsumer) easilyA model clas that represents the addition or deletion of a quick reply
An immutable model class that represents a quoted message
A model class that represents a message holding an emoji reaction inside
A model clas that represents a change in the weight of recent emojis
This exception is thrown when a phone number cannot be registered by the Whatsapp API
A model class that represents the deletion of a sticker from the recent list
This exception is thrown when a request cannot be sent to Whatsapp's socket
A model class that represents a message to try to place a
PaymentMessage.A model class that represents a message holding a request for a phone number inside
Still needs to be implemented by Whatsapp
A model class that represents a message sent by WhatsappWeb for security purposes.
A model class that represents a message to confirm a
RequestPaymentMessage.A model interface that represents a message sent by a WhatsappWeb's server
A model class that represents the selection of a row
The constants of this enumerated type describe the various types of events regarding a socket
A model clas that represents a new star status for a message
A model clas that represents a sticker
A model class that represents a message holding a sticker inside
This controller holds the user-related data regarding a WhatsappWeb session
A pair of Store and Keys with the same uuid
A model clas that represents a subscription
A formatter used to structure a button message
The constant of this enumerated type define the various of types of visual formats for a
TemplateMessageA model class that represents a message sent in a WhatsappBusiness chat that provides a list of
buttons to choose from.
A model class that represents a message that contains a newsletters to a previous
HighlyStructuredMessageA model class that represents a message holding text inside
The constants of this enumerated type describe the various types of fonts that a
TextMessage supports.The constants of this enumerated type describe the various types of previuew that a
TextMessage can provide.The constants of this enumerated type describe the various types of text preview that can be
used
A model clas that represents the time format used by the companion
A model clas that represents whether a user was muted
The constants of this enumerated type describe the various types of verification that can be used to receive the OTP required for an
ClientType.MOBILEA model that represents a newsletters from Whatsapp regarding the registration of a phone number
A model class that represents a message holding a video inside
The constants of this enumerated type describe the various sources from where a gif can come
from
The constants of this enumerated type describe the various chat history's codeLength that Whatsapp
can send on the first login attempt
A utility sealed interface to represent methods that can be used to verify a WhatsappWeb Client
A class used to interface a user to WhatsappWeb's WebSocket