Interface API

Hierarchy

API

Indexable

[key: string]: (...args: any[]) => any

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

Methods

addParticipant

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

- Defined in webpack/model/api-types.ts:66
Add participants to a group

Parameters
- groupId: string
- contacts: string | string[]
Returns Promise<InterfaceScope>

checkNumberStatus

checkNumberStatus(number: string): Promise<CheckNumber>

- Defined in webpack/model/api-types.ts:92
Check if a number exists

Parameters
- number: string
Returns Promise<CheckNumber>

createGroup

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

- Defined in webpack/model/api-types.ts:59
Creates a new chat group

Parameters
- groupName: string
- contacts: string | string[]
Returns Promise<InterfaceScope>

eventInterfaceChange

eventInterfaceChange(): Promise<void>

- Defined in webpack/model/api-types.ts:120
Returns Promise<void>

eventNewDeleteMessage

eventNewDeleteMessage(): Promise<void>

- Defined in webpack/model/api-types.ts:121
Returns Promise<void>

eventNewEditMessage

eventNewEditMessage(): Promise<void>

- Defined in webpack/model/api-types.ts:122
Returns Promise<void>

eventNewMessage

eventNewMessage(): Promise<void>

- Defined in webpack/model/api-types.ts:123
Returns Promise<void>

eventNewOnAck

eventNewOnAck(): Promise<void>

- Defined in webpack/model/api-types.ts:126
Returns Promise<void>

eventOnIntroReactionMessage

eventOnIntroReactionMessage(): Promise<void>

- Defined in webpack/model/api-types.ts:125
Returns Promise<void>

eventOnReactionMessage

eventOnReactionMessage(): Promise<void>

- Defined in webpack/model/api-types.ts:124
Returns Promise<void>

getAllChats

getAllChats(): Promise<any>

- Defined in webpack/model/api-types.ts:47
Get all chats

Returns Promise<any>

getAllChatsGroups

getAllChatsGroups(): Promise<any>

- Defined in webpack/model/api-types.ts:51
Get all chat groups

Returns Promise<any>

getAllContacts

getAllContacts(): Promise<Contact>

- Defined in webpack/model/api-types.ts:43
Returns a list of all contacts

Returns Promise<Contact>

getCodeForPhoneNumber

getCodeForPhoneNumber(PhoneNumber: string): Promise<any>

- Defined in webpack/model/api-types.ts:31
Get the code for a phone number

Parameters
- PhoneNumber: string
Returns Promise<any>

getGroupParticipant

getGroupParticipant(groupId: string): Promise<any>

- Defined in webpack/model/api-types.ts:55
Get group participants

Parameters
- groupId: string
Returns Promise<any>

getHost

getHost(): Promise<InterfaceHost>

- Defined in webpack/model/api-types.ts:84
Get information about the connected number

Returns Promise<InterfaceHost>

getInterface

getInterface(): Promise<any>

- Defined in webpack/model/api-types.ts:39
Get the interface

Returns Promise<any>

getWAVersion

getWAVersion(): Promise<string>

- Defined in webpack/model/api-types.ts:96
Get the current WhatsApp version

Returns Promise<string>

loadAndGetAllMessagesInChat

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

- Defined in webpack/model/api-types.ts:115
Load and get all messages in a chat

Parameters
- chatId: string
- date: string
Returns Promise<any>

logoutSession

logoutSession(): Promise<any>

- Defined in webpack/model/api-types.ts:88
Logout from WhatsApp Web

Returns Promise<any>

refreshAltLinkingCode

refreshAltLinkingCode(): Promise<any>

- Defined in webpack/model/api-types.ts:35
Function refresh code for phone number

Returns Promise<any>

screenshot

screenshot(options: Readonly<ScreenshotOptions> & { encoding: "base64" }): Promise<string>

- Defined in webpack/model/api-types.ts:15
Function to take a screenshot

Parameters
- options: Readonly<ScreenshotOptions> & { encoding: "base64" }
  
  Options for the screenshot
Returns Promise<string>

sendMessage

sendMessage(to: string, body: string, options: object): Promise<any>

- Defined in webpack/model/api-types.ts:23
Send a message to a contact or group

Parameters
- to: string
- body: string
- options: object
Returns Promise<any>

serializeIntroReactions

serializeIntroReactions(emoji: object, type: object): Promise<[] | ReactionIntro>

- Defined in webpack/model/api-types.ts:108
Serialize intro reactions

Parameters
- emoji: object
- type: object
Returns Promise<[] | ReactionIntro>

serializeMessageObj

serializeMessageObj(msg: object): Promise<void>

- Defined in webpack/model/api-types.ts:27
Serialize a message object

Parameters
- msg: object
Returns Promise<void>

serializeReactions

serializeReactions(emoji: object, collections: object, type: object): Promise<object[]>

- Defined in webpack/model/api-types.ts:100
Serialize reactions

Parameters
- emoji: object
- collections: object
- type: object
Returns Promise<object[]>

setGroupDescription

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

- Defined in webpack/model/api-types.ts:73
Set the group description

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

setGroupImage

setGroupImage(path: object, to: string): Promise<InterfaceScope>

- Defined in webpack/model/api-types.ts:80
Set the group image

Parameters
- path: object
- to: string
Returns Promise<InterfaceScope>

Generated using TypeDoc