Whatsmeow

https://pkg.go.dev/go.mau.fi/whatsmeow
Admin
Whatsmeow is a Go package that provides a WhatsApp client library, allowing developers to interact...
Tokens:373,055
Snippets:2,962
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Download attachment example

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Illustrates downloading an attachment from a protobuf message using the Download method. The example shows retrieving image data from a message's image field.

```go
var msg *waE2E.Message
...
imageData, err := cli.Download(msg.GetImageMessage())
```

--------------------------------

### BuildReaction usage example

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Example of using BuildReaction to send a reaction. Note: for newsletter messages, use NewsletterSendReaction instead.

```go
resp, err := cli.SendMessage(context.Background(), chat, cli.BuildReaction(chat, senderJID, targetMessageID, "🐈️")

```

--------------------------------

### Upload image example

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Uploads an image and sends it as an image message. The response fields are copied to the ImageMessage protobuf.

```go
resp, err := cli.Upload(context.Background(), yourImageBytes, whatsmeow.MediaImage)
// handle error

imageMsg := &waE2E.ImageMessage{
	Caption:  proto.String("Hello, world!"),
	Mimetype: proto.String("image/png"), // replace this with the actual mime type
	// you can also optionally add other fields like ContextInfo and JpegThumbnail here

	URL:           &resp.URL,
	DirectPath:    &resp.DirectPath,
	MediaKey:      resp.MediaKey,
	FileEncSHA256: resp.FileEncSHA256,
	FileSHA256:    resp.FileSHA256,
	FileLength:    &resp.FileLength,
}
_, err = cli.SendMessage(context.Background(), targetJID, &waE2E.Message{
	ImageMessage: imageMsg,
})
// handle error again
```

--------------------------------

### DownloadThumbnail usage example

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Shows how to download a thumbnail from a message, primarily for link preview thumbnails in ExtendedTextMessage. The example declares a message variable and calls DownloadThumbnail with the extended text message.

```go
var msg *waE2E.Message
...
thumbnailImageBytes, err := cli.DownloadThumbnail(msg.GetExtendedTextMessage())
```

--------------------------------

### GetFirstDevice

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Gets the first device, creating a new one if none exist.

```APIDOC
## GetFirstDevice

### Description
Gets the first device in the store. If there are no devices, then a new device will be created. You should only use this if you don't want to have multiple sessions simultaneously.

### Function Signature
`func (c *Container) GetFirstDevice(ctx context.Context) (*store.Device, error)`

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Returns
- **device** (*store.Device) - The first device, or a new device if none exist.
- **error** (error) - An error if retrieval fails.
```

--------------------------------

### GenerateMessageID usage example

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Shows how to generate a message ID and use it when sending a message with SendMessage.

```go
msgID := cli.GenerateMessageID()
cli.SendMessage(context.Background(), targetJID, &waE2E.Message{...}, whatsmeow.SendRequestExtra{ID: msgID})
```

--------------------------------

### Initialize WhatsApp client with SQL store

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Creates a new WhatsApp client using a SQL-backed device store. The device store must be set; a default SQL-backed implementation is available in the store/sqlstore package. The logger can be nil, defaulting to a no-op logger.

```go
container, err := sqlstore.New(context.Background(), "sqlite3", "file:yoursqlitefile.db?_foreign_keys=on", nil)
if err != nil {
	panic(err)
}
// If you want multiple sessions, remember their JIDs and use .GetDevice(jid) or .GetAllDevices() instead.
deviceStore, err := container.GetFirstDevice()
if err != nil {
	panic(err)
}
client := whatsmeow.NewClient(deviceStore, nil)
```

--------------------------------

### DecryptComment usage example

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Example of using DecryptComment to decrypt a comment message from an event.

```go
if evt.Message.GetEncCommentMessage() != nil {
	comment, err := cli.DecryptComment(evt)
	if err != nil {
		fmt.Println(":(", err)
		return
	}
	fmt.Printf("Comment message: %+v\n", comment)
}

```

--------------------------------

### DecryptPollVote usage example

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Example of using DecryptPollVote to decrypt a poll update message and print the selected option hashes.

```go
if evt.Message.GetPollUpdateMessage() != nil {
	pollVote, err := cli.DecryptPollVote(evt)
	if err != nil {
		fmt.Println(":(", err)
		return
	}
	fmt.Println("Selected hashes:")
	for _, hash := range pollVote.GetSelectedOptions() {
		fmt.Printf("- %X\n", hash)
	}
}

```

--------------------------------

### New

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Creates a new Container by connecting to a SQL database.

```APIDOC
## New

### Description
Connects to the given SQL database and wraps it in a Container. Only SQLite and Postgres are currently fully supported. The logger can be nil and will default to a no-op logger. When using SQLite, it's strongly recommended to enable foreign keys by adding `?_foreign_keys=true`.

### Function Signature
`func New(ctx context.Context, dialect, address string, log waLog.Logger) (*Container, error)`

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **dialect** (string) - Required - The SQL dialect (e.g., "sqlite3", "postgres").
- **address** (string) - Required - The database connection string.
- **log** (waLog.Logger) - Required - The logger; can be nil.

### Returns
- **container** (*Container) - The created container.
- **error** (error) - An error if the connection fails.

### Example
```go
container, err := sqlstore.New(context.Background(), "sqlite3", "file:yoursqlitefile.db?_foreign_keys=on", nil)
```
```

--------------------------------

### ConsumerApplication String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplication

Returns a string representation of the ConsumerApplication.

```go
func (x *ConsumerApplication) String() string
```

--------------------------------

### BuildRevoke usage example for own messages

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Example of using BuildRevoke to revoke your own messages. Pass your JID or an empty JID as the sender parameter.

```go
resp, err := cli.SendMessage(context.Background(), chat, cli.BuildRevoke(chat, types.EmptyJID, originalMessageID)

```

--------------------------------

### NewWithWrappedDB

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Wraps an existing dbutil.Database in a Container.

```APIDOC
## NewWithWrappedDB

### Description
Wraps an existing dbutil.Database in a Container.

### Function Signature
`func NewWithWrappedDB(wrapped *dbutil.Database, log waLog.Logger) *Container`

### Parameters
- **wrapped** (*dbutil.Database) - Required - The existing database wrapper.
- **log** (waLog.Logger) - Required - The logger; can be nil.

### Returns
- **container** (*Container) - The created container.
```

--------------------------------

### BuildPollVote usage example

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Example of using BuildPollVote to vote for the first option after receiving a message event. Sends the built message with SendMessage.

```go
if evt.Message.GetPollCreationMessage() != nil {
	pollVoteMsg, err := cli.BuildPollVote(&evt.Info, []string{evt.Message.GetPollCreationMessage().GetOptions()[0].GetOptionName()})
	if err != nil {
		fmt.Println(":(", err)
		return
	}
	resp, err := cli.SendMessage(context.Background(), evt.Info.Chat, pollVoteMsg)
}

```

--------------------------------

### func Init() error

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/argo

Initializes the package, preparing internal state.

```APIDOC
## [FUNCTION] Init

### Description
Initializes the package.

### Method
FUNCTION

### Endpoint
Init

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **error** - Error if any

#### Response Example
```go
nil
```
```

--------------------------------

### ConsumerApplication ProtoReflect method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplication

Returns the protoreflect.Message for the ConsumerApplication.

```go
func (x *ConsumerApplication) ProtoReflect() protoreflect.Message
```

--------------------------------

### GetUserInfo

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets information about a user.

```APIDOC
## GetUserInfo

### Description
Gets information about a user.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetUserInfo(ctx context.Context, jids []types.JID) (*types.UserInfo, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **jids** ([]types.JID) - Required - The list of user JIDs.

### Return Values
- **\*types.UserInfo** - The user information.
- **error** - An error if the operation fails.
```

--------------------------------

### String method for AppVersion

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Returns a string representation of AppVersion.

```go
func (x *ClientPayload_UserAgent_AppVersion) String() string
```

--------------------------------

### GetBotListV2

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets a list of bots.

```APIDOC
## GetBotListV2

### Description
Gets a list of bots.

### Method
func (cli *Client) GetBotListV2(ctx context.Context) ([]types.BotListInfo, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Returns
- **[]types.BotListInfo** - A list of bot information.
- **error** - An error if the operation fails.
```

--------------------------------

### New: Connect to SQL database with foreign keys

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Connects to a SQL database using the New function. Only SQLite and Postgres are fully supported. For SQLite, it's strongly recommended to enable foreign keys by adding `?_foreign_keys=true` to the connection string.

```go
container, err := sqlstore.New(context.Background(), "sqlite3", "file:yoursqlitefile.db?_foreign_keys=on", nil)
```

--------------------------------

### BuildRevoke usage example for admin revoking others' messages

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Example of using BuildRevoke to revoke someone else's messages when you are group admin. Pass the message sender's JID as the sender parameter.

```go
resp, err := cli.SendMessage(context.Background(), chat, cli.BuildRevoke(chat, senderJID, originalMessageID)

```

--------------------------------

### NewDevice

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Creates a new device in the database.

```APIDOC
## NewDevice

### Description
Creates a new device in this database. No data is actually stored before Save is called. However, the pairing process will automatically call Save after a successful pairing, so you most likely don't need to call it yourself.

### Function Signature
`func (c *Container) NewDevice() *store.Device`

### Parameters
- **c** (*Container) - The container instance.

### Returns
- **device** (*store.Device) - The new device.
```

--------------------------------

### GetSubGroups

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the subgroups of the given community.

```APIDOC
## GetSubGroups

### Description
Gets the subgroups of the given community.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetSubGroups(ctx context.Context, community types.JID) ([]*types.GroupLinkTarget, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **community** (types.JID) - Required - The JID of the community.

### Return Values
- **[]\*types.GroupLinkTarget** - The list of subgroup link targets.
- **error** - An error if the operation fails.
```

--------------------------------

### GetNewsletterMessages

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets messages in a WhatsApp channel.

```APIDOC
## GetNewsletterMessages

### Description
Gets messages in a WhatsApp channel.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetNewsletterMessages(ctx context.Context, jid types.JID, params *GetNewsletterMessagesParams) ([]*types.NewsletterMessage, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **jid** (types.JID) - Required - The JID of the newsletter.
- **params** (\*GetNewsletterMessagesParams) - Required - Parameters for the message request.

### Return Values
- **[]\*types.NewsletterMessage** - The list of newsletter messages.
- **error** - An error if the operation fails.
```

--------------------------------

### ConsumerApplication_VideoMessage String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplicationParameterised

Returns the string representation of the VideoMessage.

```go
func (x *ConsumerApplication_VideoMessage) String() string
```

--------------------------------

### GetNewsletterMessageUpdates

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets updates in a WhatsApp channel.

```APIDOC
## GetNewsletterMessageUpdates

### Description
Gets updates in a WhatsApp channel. These are the same kind of updates that NewsletterSubscribeLiveUpdates triggers (reaction and view counts).

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetNewsletterMessageUpdates(ctx context.Context, jid types.JID, params *GetNewsletterUpdatesParams) ([]*types.NewsletterMessage, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **jid** (types.JID) - Required - The JID of the newsletter.
- **params** (\*GetNewsletterUpdatesParams) - Required - Parameters for the update request.

### Return Values
- **[]\*types.NewsletterMessage** - The list of newsletter message updates.
- **error** - An error if the operation fails.
```

--------------------------------

### ConsumerApplication_VideoMessage ProtoReflect method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplicationParameterised

Returns the protoreflect.Message for the VideoMessage.

```go
func (x *ConsumerApplication_VideoMessage) ProtoReflect() protoreflect.Message
```

--------------------------------

### GetBotProfiles

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets profiles for the given bots.

```APIDOC
## GetBotProfiles

### Description
Gets profiles for the given bots.

### Method
func (cli *Client) GetBotProfiles(ctx context.Context, botInfo []types.BotListInfo) ([]types.BotProfileInfo, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **botInfo** ([]types.BotListInfo) - Required - The list of bot information to fetch profiles for.

### Returns
- **[]types.BotProfileInfo** - A list of bot profile information.
- **error** - An error if the operation fails.
```

--------------------------------

### ConsumerApplication_ApplicationData String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplication

Returns a string representation of the ApplicationData.

```go
func (x *ConsumerApplication_ApplicationData) String() string
```

--------------------------------

### GetProfilePictureParams struct

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Parameters for getting a profile picture.

```go
type GetProfilePictureParams struct {
	Preview     bool
	ExistingID  string
	IsCommunity bool
	// This is a common group ID that you share with the target
	CommonGID types.JID
	// use this to query the profile photo of a group you don't have joined, but you have an invite code for
	InviteCode string
	// Persona ID when getting profile of Meta AI bots
	PersonaID string
}
```

--------------------------------

### NoiseHandshake.Start

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/socket

Initializes the Noise handshake with the given pattern and header.

```APIDOC
## NoiseHandshake.Start

### Description
Initializes the Noise handshake with the given pattern and header.

### Method
`func (nh *NoiseHandshake) Start(pattern string, header []byte)`

### Parameters
- **pattern** (string) - Required - The Noise protocol pattern (e.g., Noise_XX_25519_AESGCM_SHA256).
- **header** ([]byte) - Required - The header bytes to use.
```

--------------------------------

### GetUserDevices

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the list of devices that the given user has.

```APIDOC
## GetUserDevices

### Description
Gets the list of devices that the given user has. The input should be a list of regular JIDs, and the output will be a list of AD JIDs. The local device will not be included in the output even if the user's JID is included in the input. All other devices will be included.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetUserDevices(ctx context.Context, jids []types.JID) ([]types.JID, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **jids** ([]types.JID) - Required - The list of user JIDs.

### Return Values
- **[]types.JID** - The list of device JIDs.
- **error** - An error if the operation fails.
```

--------------------------------

### GetSubscribedNewsletters

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the info of all newsletters that you're joined to.

```APIDOC
## GetSubscribedNewsletters

### Description
Gets the info of all newsletters that you're joined to.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetSubscribedNewsletters(ctx context.Context) ([]*types.NewsletterMetadata, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.

### Return Values
- **[]\*types.NewsletterMetadata** - The list of newsletter metadata.
- **error** - An error if the operation fails.
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Initializes a new WhatsApp web client. The logger can be nil, it will default to a no-op logger. The device store must be set.

```APIDOC
## NewClient

### Description
Initializes a new WhatsApp web client. The logger can be nil, it will default to a no-op logger. The device store must be set.

### Signature
```go
func NewClient(deviceStore *store.Device, log waLog.Logger) *Client
```

### Parameters
- **deviceStore** (*store.Device) - Required - The device store. A default SQL-backed implementation is available in the store/sqlstore package.
- **log** (waLog.Logger) - Optional - The logger. Can be nil.

### Example
```go
container, err := sqlstore.New(context.Background(), "sqlite3", "file:yoursqlitefile.db?_foreign_keys=on", nil)
if err != nil {
    panic(err)
}
// If you want multiple sessions, remember their JIDs and use .GetDevice(jid) or .GetAllDevices() instead.
deviceStore, err := container.GetFirstDevice()
if err != nil {
    panic(err)
}
client := whatsmeow.NewClient(deviceStore, nil)
```
```

--------------------------------

### Method String for AddDeviceEpochOutput

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWebLabyrinthWaWasm

Returns a string representation of the message.

```go
func (x *AddDeviceEpochOutput) String() string
```

--------------------------------

### GetServerPushNotificationConfig

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the server push notification configuration.

```APIDOC
## GetServerPushNotificationConfig

### Description
Gets the server push notification configuration.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetServerPushNotificationConfig(ctx context.Context) (*waBinary.Node, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.

### Return Values
- **\*waBinary.Node** - The server push notification configuration node.
- **error** - An error if the operation fails.
```

--------------------------------

### GetPrivacySettings

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the user's privacy settings.

```APIDOC
## GetPrivacySettings

### Description
Gets the user's privacy settings. If an error occurs while fetching them, the error will be logged, but the method will just return an empty struct.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetPrivacySettings(ctx context.Context) (settings types.PrivacySettings)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.

### Return Values
- **types.PrivacySettings** - The privacy settings.
```

--------------------------------

### String Method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Returns the string representation of the distribution channel.

```go
func (x ClientPayload_UserAgent_DistributionChannel) String() string
```

--------------------------------

### GetNewsletterInfoWithInvite

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the info of a newsletter with an invite link.

```APIDOC
## GetNewsletterInfoWithInvite

### Description
Gets the info of a newsletter with an invite link. You can either pass the full link (https://whatsapp.com/channel/...) or just the `...` part. Note that the ViewerMeta field of the returned NewsletterMetadata will be nil.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetNewsletterInfoWithInvite(ctx context.Context, key string) (*types.NewsletterMetadata, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **key** (string) - Required - The invite key or full link.

### Return Values
- **\*types.NewsletterMetadata** - The newsletter metadata.
- **error** - An error if the operation fails.
```

--------------------------------

### String method for ClientPayload_WebInfo_WebdPayload

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

String method for ClientPayload_WebInfo_WebdPayload.

```go
func (x *ClientPayload_WebInfo_WebdPayload) String() string
```

--------------------------------

### String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waMsgApplication

Returns a string representation of MessageApplication.

```go
func (x *MessageApplication) String() string
```

--------------------------------

### GetNewsletterInfo

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the info of a newsletter that you're joined to.

```APIDOC
## GetNewsletterInfo

### Description
Gets the info of a newsletter that you're joined to.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetNewsletterInfo(ctx context.Context, jid types.JID) (*types.NewsletterMetadata, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **jid** (types.JID) - Required - The JID of the newsletter.

### Return Values
- **\*types.NewsletterMetadata** - The newsletter metadata.
- **error** - An error if the operation fails.
```

--------------------------------

### ConsumerApplication_ApplicationData ProtoReflect method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplication

Returns the protoreflect.Message for the ApplicationData.

```go
func (x *ConsumerApplication_ApplicationData) ProtoReflect() protoreflect.Message
```

--------------------------------

### GetLinkedGroupsParticipants

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets all the participants in the groups of the given community.

```APIDOC
## GetLinkedGroupsParticipants

### Description
Gets all the participants in the groups of the given community.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetLinkedGroupsParticipants(ctx context.Context, community types.JID) ([]types.JID, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **community** (types.JID) - Required - The JID of the community.

### Return Values
- **[]types.JID** - The list of participant JIDs.
- **error** - An error if the operation fails.
```

--------------------------------

### GetJoinedGroups

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the list of groups the user has joined.

```APIDOC
## GetJoinedGroups

### Description
Gets the list of groups the user has joined.

### Method
func (cli *Client) GetJoinedGroups(ctx context.Context) ([]*types.GroupInfo, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Returns
- **[]*types.GroupInfo** - A list of group information.
- **error** - An error if the operation fails.
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Creates a new WhatsApp client with the given device store and logger.

```APIDOC
## [FUNCTION] NewClient

### Description
Creates a new WhatsApp client with the given device store and logger.

### Signature
func NewClient(deviceStore *store.Device, log waLog.Logger) *Client

### Parameters
- **deviceStore** (*store.Device) - Required - The device store.
- **log** (waLog.Logger) - Required - The logger.

### Returns
- **Client** - The new client.
```

--------------------------------

### NewWithDB

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Wraps an existing SQL connection in a Container.

```APIDOC
## NewWithDB

### Description
Wraps an existing SQL connection in a Container. Only SQLite and Postgres are currently fully supported. The logger can be nil and will default to a no-op logger. When using SQLite, it's strongly recommended to enable foreign keys by adding `?_foreign_keys=true`. This method does not call Upgrade automatically like New does, so you must call it yourself.

### Function Signature
`func NewWithDB(db *sql.DB, dialect string, log waLog.Logger) *Container`

### Parameters
- **db** (*sql.DB) - Required - The existing SQL database connection.
- **dialect** (string) - Required - The SQL dialect (e.g., "sqlite3", "postgres").
- **log** (waLog.Logger) - Required - The logger; can be nil.

### Returns
- **container** (*Container) - The created container.

### Example
```go
db, err := sql.Open("sqlite3", "file:yoursqlitefile.db?_foreign_keys=on")
if err != nil {
    panic(err)
}
container := sqlstore.NewWithDB(db, "sqlite3", nil)

err = container.Upgrade()
```
```

--------------------------------

### GetGroupInfoFromInvite

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the group info from an invite message.

```APIDOC
## GetGroupInfoFromInvite

### Description
Gets the group info from an invite message. Note that this is specifically for invite messages, not invite links. Use GetGroupInfoFromLink for resolving chat.whatsapp.com links.

### Method
func (cli *Client) GetGroupInfoFromInvite(ctx context.Context, jid, inviter types.JID, code string, expiration int64) (*types.GroupInfo, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **jid** (types.JID) - Required - The JID of the group.
- **inviter** (types.JID) - Required - The JID of the inviter.
- **code** (string) - Required - The invite code.
- **expiration** (int64) - Required - The expiration timestamp.

### Returns
- ***types.GroupInfo** - The group information.
- **error** - An error if the operation fails.
```

--------------------------------

### GetContactQRLink

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets your own contact share QR link.

```APIDOC
## GetContactQRLink

### Description
Gets your own contact share QR link that can be resolved using ResolveContactQRLink (or scanned with the official apps when encoded as a QR code). If the revoke parameter is set to true, it will ask the server to revoke the previous link and generate a new one.

### Method
func (cli *Client) GetContactQRLink(ctx context.Context, revoke bool) (string, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **revoke** (bool) - Required - Whether to revoke the previous link and generate a new one.

### Returns
- **string** - The contact share QR link.
- **error** - An error if the operation fails.
```

--------------------------------

### NewProcessor

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/appstate

Creates a new Processor instance.

```APIDOC
## NewProcessor

### Description
Creates a new Processor instance.

### Function Signature
```go
func NewProcessor(store *store.Device, log waLog.Logger) *Processor
```

### Parameters
- **store** (*store.Device) - Required - The device store.
- **log** (waLog.Logger) - Required - The logger.

### Returns
- **Processor** - A new Processor instance.
```

--------------------------------

### GetBlocklist

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the list of users that this user has blocked.

```APIDOC
## GetBlocklist

### Description
Gets the list of users that this user has blocked.

### Method
func (cli *Client) GetBlocklist(ctx context.Context) (*types.Blocklist, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Returns
- ***types.Blocklist** - The list of blocked users.
- **error** - An error if the operation fails.
```

--------------------------------

### Account Reset method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waHistorySync

Resets the Account to its zero value.

```go
func (x *Account) Reset()
```

--------------------------------

### Command String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waCommonParameterised

Returns a string representation of the Command message.

```go
func (x *Command) String() string
```

--------------------------------

### GetPNForLID

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Gets the phone number for a given LID.

```APIDOC
## GetPNForLID

### Description
Gets the phone number for a given LID.

### Function Signature
`func (s *CachedLIDMap) GetPNForLID(ctx context.Context, lid types.JID) (types.JID, error)`

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **lid** (types.JID) - Required - The LID JID.

### Returns
- **pn** (types.JID) - The phone number JID.
- **error** (error) - An error if retrieval fails.
```

--------------------------------

### Account String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waHistorySync

Returns a string representation of Account.

```go
func (x *Account) String() string
```

--------------------------------

### GetLIDForPN

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Gets the LID for a given phone number.

```APIDOC
## GetLIDForPN

### Description
Gets the LID for a given phone number.

### Function Signature
`func (s *CachedLIDMap) GetLIDForPN(ctx context.Context, pn types.JID) (types.JID, error)`

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **pn** (types.JID) - Required - The phone number JID.

### Returns
- **lid** (types.JID) - The LID JID.
- **error** (error) - An error if retrieval fails.
```

--------------------------------

### ConsumerApplication_ViewOnceMessage String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplicationParameterised

Returns the string representation of the ViewOnceMessage.

```go
func (x *ConsumerApplication_ViewOnceMessage) String() string
```

--------------------------------

### RedactedPhoneEntry.GetMassInsertValues

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store

Method on RedactedPhoneEntry to get mass insert values.

```APIDOC
## RedactedPhoneEntry.GetMassInsertValues

### Description
Returns the mass insert values for a redacted phone entry.

### Method
GET

### Endpoint
N/A (Go method)

### Parameters
- **rpe** (RedactedPhoneEntry) - Required - The receiver.

### Returns
- `[2]any` - The mass insert values.
```

--------------------------------

### HandshakeMessage_ClientFinish GetSimulateXxkemFs method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Returns the SimulateXxkemFs field value.

```go
func (x *HandshakeMessage_ClientFinish) GetSimulateXxkemFs() bool
```

--------------------------------

### GetUserDevicesContext

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the list of devices that the given user has, with context.

```APIDOC
## GetUserDevicesContext

### Description
Gets the list of devices that the given user has, with context.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetUserDevicesContext(ctx context.Context, jids []types.JID) ([]types.JID, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **jids** ([]types.JID) - Required - The list of user JIDs.

### Return Values
- **[]types.JID** - The list of device JIDs.
- **error** - An error if the operation fails.
```

--------------------------------

### GetStatusPrivacy

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the user's status privacy settings.

```APIDOC
## GetStatusPrivacy

### Description
Gets the user's status privacy settings (who to send status broadcasts to). There can be multiple different stored settings, the first one is always the default.

### Method
FUNCTION

### Signature
```go
func (cli *Client) GetStatusPrivacy(ctx context.Context) ([]types.StatusPrivacy, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.

### Return Values
- **[]types.StatusPrivacy** - The list of status privacy settings.
- **error** - An error if the operation fails.
```

--------------------------------

### Init function signature

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/argo

Function signature for Init, which initializes the package and returns an error.

```go
func Init() error
```

--------------------------------

### ProtoReflect method for AppVersion

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Returns the protoreflect.Message for AppVersion.

```go
func (x *ClientPayload_UserAgent_AppVersion) ProtoReflect() protoreflect.Message
```

--------------------------------

### GetGroupRequestParticipants

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the list of participants that have requested to join the group.

```APIDOC
## GetGroupRequestParticipants

### Description
Gets the list of participants that have requested to join the group.

### Method
func (cli *Client) GetGroupRequestParticipants(ctx context.Context, jid types.JID) ([]types.GroupParticipantRequest, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **jid** (types.JID) - Required - The JID of the group.

### Returns
- **[]types.GroupParticipantRequest** - A list of participant requests.
- **error** - An error if the operation fails.
```

--------------------------------

### Account ProtoReflect method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waHistorySync

Returns the protoreflect.Message for Account.

```go
func (x *Account) ProtoReflect() protoreflect.Message
```

--------------------------------

### GetGroupInfoFromLink

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Resolves an invite link and gets group info.

```APIDOC
## GetGroupInfoFromLink

### Description
Resolves the given invite link and asks the WhatsApp servers for info about the group. This will not cause the user to join the group.

### Method
func (cli *Client) GetGroupInfoFromLink(ctx context.Context, code string) (*types.GroupInfo, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **code** (string) - Required - The invite link code.

### Returns
- ***types.GroupInfo** - The group information.
- **error** - An error if the operation fails.
```

--------------------------------

### ProtoReflect method for ClientPayload_WebInfo_WebdPayload

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

ProtoReflect method for ClientPayload_WebInfo_WebdPayload.

```go
func (x *ClientPayload_WebInfo_WebdPayload) ProtoReflect() protoreflect.Message
```

--------------------------------

### GetBusinessProfile

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the profile info of a WhatsApp business account.

```APIDOC
## GetBusinessProfile

### Description
Gets the profile info of a WhatsApp business account.

### Method
func (cli *Client) GetBusinessProfile(ctx context.Context, jid types.JID) (*types.BusinessProfile, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **jid** (types.JID) - Required - The JID of the business account.

### Returns
- ***types.BusinessProfile** - The business profile information.
- **error** - An error if the operation fails.
```

--------------------------------

### GetLatestVersion

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets the latest WhatsApp web version from the server.

```APIDOC
## [FUNCTION] GetLatestVersion

### Description
Gets the latest WhatsApp web version from the server.

### Signature
func GetLatestVersion(ctx context.Context, httpClient *http.Client) (*store.WAVersionContainer, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **httpClient** (*http.Client) - Required - The HTTP client to use for the request.

### Returns
- **store.WAVersionContainer** - The latest version container.
- **error** - An error if the request fails.
```

--------------------------------

### ProtoReflect method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waAICommonDeprecated

Returns the protoreflect.Message for the metadata.

```go
func (x *AIRichResponseCodeMetadata) ProtoReflect() protoreflect.Message
```

--------------------------------

### ConsumerApplication ProtoMessage method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplication

Implements the proto.Message interface.

```go
func (*ConsumerApplication) ProtoMessage()
```

--------------------------------

### GetManyLIDsForPNs

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/store/sqlstore

Gets many LIDs for many phone numbers.

```APIDOC
## GetManyLIDsForPNs

### Description
Gets many LIDs for many phone numbers.

### Function Signature
`func (s *CachedLIDMap) GetManyLIDsForPNs(ctx context.Context, pns []types.JID) (map[types.JID]types.JID, error)`

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **pns** ([]types.JID) - Required - A slice of phone number JIDs.

### Returns
- **mapping** (map[types.JID]types.JID) - A map from phone number JID to LID JID.
- **error** (error) - An error if retrieval fails.
```

--------------------------------

### Processor.GetMissingKeyIDs

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/appstate

Gets the missing key IDs from a patch list.

```APIDOC
## Processor.GetMissingKeyIDs

### Description
Gets the missing key IDs from a patch list.

### Function Signature
```go
func (proc *Processor) GetMissingKeyIDs(ctx context.Context, pl *PatchList) [][]byte
```

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **pl** (*PatchList) - Required - The patch list to check.

### Returns
- **[][]byte** - A list of missing key IDs.
```

--------------------------------

### File descriptor variable for waConsumerApplication.proto

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplication

Declares the file descriptor variable for the waConsumerApplication proto file.

```go
var File_waConsumerApplication_WAConsumerApplication_proto protoreflect.FileDescriptor
```

--------------------------------

### GetPushConfigAttrs method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Method to get push config attributes as waBinary.Attrs.

```go
func (fpc *FCMPushConfig) GetPushConfigAttrs() waBinary.Attrs
```

--------------------------------

### ProtoReflect method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waMsgApplication

Returns the protoreflect.Message for MessageApplication.

```go
func (x *MessageApplication) ProtoReflect() protoreflect.Message
```

--------------------------------

### ClientPayload_DNSSource String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Returns the string representation of a ClientPayload_DNSSource value.

```go
func (x *ClientPayload_DNSSource) String() string

```

--------------------------------

### IndexOfSingleToken

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/binary/token

Gets the index of the single-byte token with the given string value.

```APIDOC
## IndexOfSingleToken

### Description
Gets the index of the single-byte token with the given string value. If there's no token with the given value, the second return value will be false.

### Method
func

### Signature
func IndexOfSingleToken(token string) (val byte, ok bool)

### Parameters
- **token** (string) - Required - The string value of the token to find.

### Returns
- **byte** - The index of the token.
- **bool** - Whether the token was found.
```

--------------------------------

### String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Returns a string representation of ClientPayload_UserAgent.

```go
func (x *ClientPayload_UserAgent) String() string
```

--------------------------------

### IndexOfDoubleByteToken

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/binary/token

Gets the index of the double-byte token with the given string value.

```APIDOC
## IndexOfDoubleByteToken

### Description
Gets the index of the double-byte token with the given string value. If there's no token with the given value, the third return value will be false.

### Method
func

### Signature
func IndexOfDoubleByteToken(token string) (byte, byte, bool)

### Parameters
- **token** (string) - Required - The string value of the token to find.

### Returns
- **byte** - The first index of the token.
- **byte** - The second index of the token.
- **bool** - Whether the token was found.
```

--------------------------------

### ConsumerApplication_ApplicationData ProtoMessage method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplication

Implements the proto.Message interface.

```go
func (*ConsumerApplication_ApplicationData) ProtoMessage()
```

--------------------------------

### GetDoubleToken

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/binary/token

Gets the string value of the double-byte token at the given index.

```APIDOC
## GetDoubleToken

### Description
Gets the string value of the double-byte token at the given index.

### Method
func

### Signature
func GetDoubleToken(index1, index2 int) (string, error)

### Parameters
- **index1** (int) - Required - The first index of the double-byte token.
- **index2** (int) - Required - The second index of the double-byte token.

### Returns
- **string** - The string value of the token.
- **error** - An error if the token is not found.
```

--------------------------------

### BuildSettingPushName function signature

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/appstate

Builds an app state patch for setting the push name.

```go
func BuildSettingPushName(pushName string) PatchInfo
```

--------------------------------

### Processor.GetMissingKeyIDs method signature

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/appstate

Gets missing key IDs from a patch list.

```go
func (proc *Processor) GetMissingKeyIDs(ctx context.Context, pl *PatchList) [][]byte
```

--------------------------------

### BuildArchive function

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/appstate

Builds an archive patch info.

```go
func BuildArchive(target types.JID, archive bool, lastMessageTimestamp time.Time, lastMessageKey *waCommon.MessageKey) PatchInfo
```

--------------------------------

### ConsumerApplication_ApplicationData GetApplicationContent method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplication

Returns the application content field.

```go
func (x *ConsumerApplication_ApplicationData) GetApplicationContent() isConsumerApplication_ApplicationData_ApplicationContent
```

--------------------------------

### AcceptTOSNotice

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Accepts a ToS notice. To accept the terms for creating newsletters, use the provided example.

```APIDOC
## AcceptTOSNotice

### Description
Accepts a ToS notice. To accept the terms for creating newsletters, use the provided example.

### Signature
```go
func (cli *Client) AcceptTOSNotice(ctx context.Context, noticeID, stage string) error
```

### Parameters
- **ctx** (context.Context) - Required - The context.
- **noticeID** (string) - Required - The notice ID.
- **stage** (string) - Required - The stage.

### Example
```go
cli.AcceptTOSNotice("20601218", "5")
```
```

--------------------------------

### String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waAICommonDeprecated

Returns a string representation of the metadata.

```go
func (x *AIRichResponseCodeMetadata) String() string
```

--------------------------------

### Method ProtoMessage for AddDeviceEpochOutput

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWebLabyrinthWaWasm

Marks the type as a protobuf message.

```go
func (*AddDeviceEpochOutput) ProtoMessage()
```

--------------------------------

### ClientPayload_UserAgent_Platform Type method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Returns the protoreflect.EnumType for the enum. Use this to get the type descriptor for reflection.

```go
func (ClientPayload_UserAgent_Platform) Type() protoreflect.EnumType
```

--------------------------------

### ConsumerApplication_SubProtocolPayload String method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waConsumerApplicationParameterised

Returns the string representation of the ConsumerApplication_SubProtocolPayload message.

```go
func (x *ConsumerApplication_SubProtocolPayload) String() string
```

--------------------------------

### SendPresence call to mark online

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Example call to mark the client as online using SendPresence with types.PresenceAvailable.

```go
cli.SendPresence(types.PresenceAvailable)
```

--------------------------------

### GetUserInfo

Source: https://pkg.go.dev/go.mau.fi/whatsmeow

Gets basic user info (avatar, status, verified business name, device list).

```APIDOC
## GetUserInfo

### Description
Gets basic user info (avatar, status, verified business name, device list).

### Method
GetUserInfo

### Signature
func (cli *Client) GetUserInfo(ctx context.Context, jids []types.JID) (map[types.JID]types.UserInfo, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **jids** ([]types.JID) - Required - List of JIDs to get info for.

### Returns
- **map[types.JID]types.UserInfo** - Map of JID to user info.
- **error** - Error if the request fails.
```

--------------------------------

### ProtoMessage method for AppVersion

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Marks AppVersion as implementing proto.Message.

```go
func (*ClientPayload_UserAgent_AppVersion) ProtoMessage()
```

--------------------------------

### ClientPayload_DNSSource ProtoReflect method

Source: https://pkg.go.dev/go.mau.fi/whatsmeow/proto/waWa6

Returns the protoreflect.Message for the type.

```go
func (x *ClientPayload_DNSSource) ProtoReflect() protoreflect.Message

```
Tokens:
Raw