Class SenderLayer

Hierarchy

RetrieverLayer
- SenderLayer
  - WebPack

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SenderLayer(page: Page, browser: Browser, options: CreateOptions, ev: any): SenderLayer

Overrides RetrieverLayer.constructor
- Defined in webpack/api/layes/sender.layes.ts:16
Parameters
- page: Page
- browser: Browser
- options: CreateOptions
- ev: any
Returns SenderLayer

Properties

autoCloseInterval

autoCloseInterval: any

autoCloseRemain

autoCloseRemain: number = 0

browser

browser: Browser

ev

ev: any

options

options: CreateOptions

page

page: Page

scanPhoneNumbersActive

scanPhoneNumbersActive: boolean = false

scanQrCodeActive

scanQrCodeActive: boolean = false

startScanQrcode

startScanQrcode: boolean

Methods

addParticipant

addParticipant(groupId: string, contacts: string | string[]): Promise<InterfaceScope>

Inherited from RetrieverLayer.addParticipant
- Defined in webpack/api/layes/group.layer.ts:61
Adds participant to Group

Parameters
- groupId: string
  
  Chat id ('0000000000-00000000@g.us' or '000000000000000000@g.us')
- contacts: string | string[]
  
  Participants id '000000000000@c.us'
Returns Promise<InterfaceScope>

asciiQr

asciiQr(code: string): Promise<string>

Inherited from RetrieverLayer.asciiQr
- Defined in webpack/api/layes/scraping.layes.ts:335
Function generate ascii qr code

Parameters
- code: string
  
  code to generate ascii qr code
Returns Promise<string>
- ascii qr code

browserClose

browserClose(): Promise<undefined | boolean>

Inherited from RetrieverLayer.browserClose
- Defined in webpack/api/layes/profile.layes.ts:26
Closes page and browser

Returns Promise<undefined | boolean>

cancelAutoClose

cancelAutoClose(): void

Inherited from RetrieverLayer.cancelAutoClose
- Defined in webpack/api/layes/scraping.layes.ts:238
Function cancel auto close session

Returns void

checkInputVisiblePhoneNumber

checkInputVisiblePhoneNumber(): Promise<boolean>

Inherited from RetrieverLayer.checkInputVisiblePhoneNumber
- Defined in webpack/api/layes/scraping.layes.ts:69
Function to check if the phone number input is visible

Returns Promise<boolean>

boolean

checkNumber

checkNumber(number: string): Promise<any>

Inherited from RetrieverLayer.checkNumber
- Defined in webpack/api/layes/retriever.layer.ts:69
Check if the number exists

Parameters
- number: string
  
  phone number
Returns Promise<any>

createGroup

createGroup(groupName: string, contacts: string | string[]): Promise<InterfaceScope>

Inherited from RetrieverLayer.createGroup
- Defined in webpack/api/layes/group.layer.ts:45
Creates a new chat group

Parameters
- groupName: string
  
  Group name
- contacts: string | string[]
  
  Participants id '000000000000@c.us'
Returns Promise<InterfaceScope>

decryptFile

decryptFile(message: any): Promise<Buffer>

Inherited from RetrieverLayer.decryptFile
- Defined in webpack/api/layes/whatsapp.ts:22
Decrypts message file

Parameters
- message: any
  
  Message object
Returns Promise<Buffer>

Decrypted file buffer (null otherwise)

getAllChatsGroups

getAllChatsGroups(): Promise<any>

Inherited from RetrieverLayer.getAllChatsGroups
- Defined in webpack/api/layes/group.layer.ts:36
Retrieve all groups

Returns Promise<any>

getAllContacts

getAllContacts(): Promise<Contact>

Inherited from RetrieverLayer.getAllContacts
- Defined in webpack/api/layes/retriever.layer.ts:34
Returns a list of contacts

Returns Promise<Contact>

List of contacts

getGroupParticipant

getGroupParticipant(groupId: string): Promise<any>

Inherited from RetrieverLayer.getGroupParticipant
- Defined in webpack/api/layes/group.layer.ts:26
Get group participants

Parameters
- groupId: string
  
  Group id exemple: 000000000000-0000000000@c.us
Returns Promise<any>

getHost

getHost(): Promise<InterfaceHost>

Inherited from RetrieverLayer.getHost
- Defined in webpack/api/layes/retriever.layer.ts:42
Get information from the connected number

Returns Promise<InterfaceHost>

Current host device details

getPairingType

getPairingType(): Promise<string>

Inherited from RetrieverLayer.getPairingType
- Defined in webpack/api/layes/scraping.layes.ts:31
Function to get the pairing type

Returns Promise<string>

string

getWAVersion

getWAVersion(): Promise<any>

Inherited from RetrieverLayer.getWAVersion
- Defined in webpack/api/layes/retriever.layer.ts:50
Get version of the current whatsapp

Returns Promise<any>

Current whatsapp version

handleApiCallPage

handleApiCallPage<K>(functionName: K, ...args: FunctionParameters[K]): Promise<any>

Inherited from RetrieverLayer.handleApiCallPage
- Defined in webpack/api/layes/helpers.ts:13
Type parameters
- K: FunctionsLayer
Parameters
- functionName: K
- Rest ...args: FunctionParameters[K]
Returns Promise<any>

handleApiCallParametres

handleApiCallParametres<K>(functionName: K, ...args: FunctionParameters[K]): Promise<any>

Inherited from RetrieverLayer.handleApiCallParametres
- Defined in webpack/api/layes/helpers.ts:38
Function to handle API calls with error handling

Type parameters
- K: FunctionsLayer
Parameters
- functionName: K
  
  Function name to be called in the API object
- Rest ...args: FunctionParameters[K]
  
  Function parameters to be passed to the function
Returns Promise<any>
- Returns the result of the function call

initListener

initListener(): Promise<void>

Inherited from RetrieverLayer.initListener
- Defined in webpack/api/layes/listener.layes.ts:20
Returns Promise<void>

interfaceChange

interfaceChange(): void

Inherited from RetrieverLayer.interfaceChange
- Defined in webpack/api/layes/on-wpp.ts:28
Listen to interface changes.

Returns void

loadAndGetAllMessagesInChat

loadAndGetAllMessagesInChat(chatId: string, date: string): Promise<any>

Inherited from RetrieverLayer.loadAndGetAllMessagesInChat
- Defined in webpack/api/layes/retriever.layer.ts:22
Get all messages in chat by chatId

Parameters
- chatId: string
  
  Chat id
- date: string
  
  Date to get messages
Returns Promise<any>

logoutSession

logoutSession(): Promise<any>

Inherited from RetrieverLayer.logoutSession
- Defined in webpack/api/layes/profile.layes.ts:19
Logout of the current session

Returns Promise<any>

newDeleteMessage

newDeleteMessage(): void

Inherited from RetrieverLayer.newDeleteMessage
- Defined in webpack/api/layes/on-wpp.ts:47
Listen to deleted messages.

Returns void

newEditMessage

newEditMessage(): void

Inherited from RetrieverLayer.newEditMessage
- Defined in webpack/api/layes/on-wpp.ts:61
Listen to edited messages.

Returns void

newMessage

newMessage(): void

Inherited from RetrieverLayer.newMessage
- Defined in webpack/api/layes/on-wpp.ts:80
Listen to new messages.

Returns void

newOnAck

newOnAck(): void

Inherited from RetrieverLayer.newOnAck
- Defined in webpack/api/layes/on-wpp.ts:129
Listen to message acknowledgment (read receipt).

Returns void

onIntroReactionMessage

onIntroReactionMessage(): void

Inherited from RetrieverLayer.onIntroReactionMessage
- Defined in webpack/api/layes/on-wpp.ts:113
Listen to introductory reactions.

Returns void

onReactionMessage

onReactionMessage(): void

Inherited from RetrieverLayer.onReactionMessage
- Defined in webpack/api/layes/on-wpp.ts:94
Listen to reaction messages.

Returns void

qrCode

qrCode(): Promise<undefined | { base64Image: string; urlCode: null | string }>

Inherited from RetrieverLayer.qrCode
- Defined in webpack/api/layes/scraping.layes.ts:286
Function scrape qrcode from page whatsapp web and return base64 image and code

Returns Promise<undefined | { base64Image: string; urlCode: null | string }>
- base64Image and urlCode

qrCodeScan

qrCodeScan(): Promise<void>

Inherited from RetrieverLayer.qrCodeScan
- Defined in webpack/api/layes/scraping.layes.ts:184
Function to qrcode scan

Returns Promise<void>

scanPhoneNumbers

scanPhoneNumbers(): Promise<void>

Inherited from RetrieverLayer.scanPhoneNumbers
- Defined in webpack/api/layes/scraping.layes.ts:83
Function to scan phone numbers

Returns Promise<void>

screenshot

screenshot(): Promise<{ base64Image: string }>

Inherited from RetrieverLayer.screenshot
- Defined in webpack/api/layes/retriever.layer.ts:58
Get screenshot

Returns Promise<{ base64Image: string }>

base64 image

sendAudio

sendAudio(to: string, filePath: string, options?: any): Promise<unknown>

- Defined in webpack/api/layes/sender.layes.ts:257
Send audio file

Parameters
- to: string
  
  Chat id
- filePath: string
  
  Path file
- options: any = {}
Returns Promise<unknown>

sendAudioBase64

sendAudioBase64(to: string, base64: string, options?: any): Promise<unknown>

- Defined in webpack/api/layes/sender.layes.ts:214
Send audio base64

Parameters
- to: string
  
  Chat id
- base64: string
  
  base64 data
- options: any = {}
Returns Promise<unknown>

sendFile

sendFile(to: string, filePath: string, options?: any): Promise<unknown>

- Defined in webpack/api/layes/sender.layes.ts:145
Sends file from path

Parameters
- to: string
  
  Chat id
- filePath: string
  
  File path
- options: any = {}
Returns Promise<unknown>

sendImage

sendImage(to: string, filePath: string, options?: any): Promise<unknown>

- Defined in webpack/api/layes/sender.layes.ts:30
Sends image message

Parameters
- to: string
  
  Chat id
- filePath: string
  
  File path or http link
- options: any = {}
Returns Promise<unknown>

sendImageFromBase64

sendImageFromBase64(to: string, base64: string, options?: any): Promise<unknown>

- Defined in webpack/api/layes/sender.layes.ts:98
Sends image message base64

Parameters
- to: string
  
  Chat id
- base64: string
  
  File path, http link or base64Encoded
- options: any = {}
Returns Promise<unknown>

sendMessage

sendMessage(options: SendOptions): Promise<any>

- Defined in webpack/api/layes/sender.layes.ts:303
Parameters
- options: SendOptions
Returns Promise<any>

sendText

sendText(to: string, body: string, options?: any): Promise<any>

- Defined in webpack/api/layes/sender.layes.ts:199
Sends a text message to given chat

Parameters
- to: string
  
  chat id: xxxxx@us.c
- body: string
  
  text message
- options: any = {}
Returns Promise<any>

setGroupDescription

setGroupDescription(groupId: string, description: string): Promise<InterfaceScope>

Inherited from RetrieverLayer.setGroupDescription
- Defined in webpack/api/layes/group.layer.ts:77
Parameters to change group description

Parameters
- groupId: string
  
  group number
- description: string
  
  group description
Returns Promise<InterfaceScope>

setGroupImage

setGroupImage(groupId: string, path: string): Promise<InterfaceScope>

Inherited from RetrieverLayer.setGroupImage
- Defined in webpack/api/layes/group.layer.ts:93
Parameters to change group image

Parameters
- groupId: string
  
  group number
- path: string
  
  of image
Returns Promise<InterfaceScope>

withPhoneNumber

withPhoneNumber(): Promise<boolean>

Inherited from RetrieverLayer.withPhoneNumber
- Defined in webpack/api/layes/scraping.layes.ts:46
Function to determine which click interface to use for retrieving a phone number

Returns Promise<boolean>

boolean

Generated using TypeDoc