@@ -20,8 +22,8 @@ Hierarchy
+
Defined in src/bot/client.ts:24
+
Defined in src/bot/client.ts:36
+
Defined in src/bot/client.ts:42
+
Defined in src/bot/client.ts:69
Optional data data
Stores
?: IStore < string , unknown >
+
Defined in src/bot/client.ts:74
+
Defined in src/bot/client.ts:73
+
Defined in src/bot/client.ts:70
+
Defined in src/bot/client.ts:75
Private Optional options
+
Defined in src/bot/client.ts:44
Optional qr qr?: Server < typeof IncomingMessage , typeof ServerResponse >
+
Defined in src/bot/client.ts:77
Optional raw raw
?: { appPatch
: ( ( patchCreate
: WAPatchCreate ) => Promise < void > ) ; assertSessions
: ( ( jids
: string [] , force
: boolean ) => Promise < boolean > ) ; authState
: { creds
: AuthenticationCreds ; keys
: SignalKeyStoreWithTransaction ; } ; chatModify
: ( ( mod
: ChatModification , jid
: string ) => Promise < void > ) ; end
: ( ( error
: undefined | Error ) => void ) ; ev
: BaileysEventEmitter & { buffer
: any ; createBufferedFunction
: any ; flush
: any ; process
: any ; processInBuffer
: any ; } ; fetchBlocklist
: ( ( ) => Promise < string [] > ) ; fetchPrivacySettings
: ( ( force
?: boolean ) => Promise < { [_:
string ]
: string ; } > ) ; fetchStatus
: ( ( jid
: string ) => Promise < undefined | { setAt
: Date ; status
: undefined | string ; } > ) ; generateMessageTag
: ( ( ) => string ) ; getBusinessProfile
: ( ( jid
: string ) => Promise < void | WABusinessProfile > ) ; getCatalog
: ( ( jid
?: string , limit
?: number ) => Promise < { products
: Product [] ; } > ) ; getCollections
: ( ( jid
?: string , limit
?: number ) => Promise < { collections
: CatalogCollection [] ; } > ) ; getOrderDetails
: ( ( orderId
: string , tokenBase64
: string ) => Promise < OrderDetails > ) ; getPrivacyTokens
: ( ( jids
: string [] ) => Promise < BinaryNode > ) ; groupAcceptInvite
: ( ( code
: string ) => Promise < undefined | string > ) ; groupAcceptInviteV4
: ( ( key
: string | IMessageKey , inviteMessage
: IGroupInviteMessage ) => Promise < string > ) ; groupCreate
: ( ( subject
: string , participants
: string [] ) => Promise < GroupMetadata > ) ; groupFetchAllParticipating
: ( ( ) => Promise < { [_:
string ]
: GroupMetadata ; } > ) ; groupGetInviteInfo
: ( ( code
: string ) => Promise < GroupMetadata > ) ; groupInviteCode
: ( ( jid
: string ) => Promise < undefined | string > ) ; groupLeave
: ( ( id
: string ) => Promise < void > ) ; groupMetadata
: ( ( jid
: string ) => Promise < GroupMetadata > ) ; groupParticipantsUpdate
: ( ( jid
: string , participants
: string [] , action
: ParticipantAction ) => Promise < { jid
: string ; status
: string ; } [] > ) ; groupRevokeInvite
: ( ( jid
: string ) => Promise < undefined | string > ) ; groupSettingUpdate
: ( ( jid
: string , setting
: "announcement" | "locked" | "not_announcement" | "unlocked" ) => Promise < void > ) ; groupToggleEphemeral
: ( ( jid
: string , ephemeralExpiration
: number ) => Promise < void > ) ; groupUpdateDescription
: ( ( jid
: string , description
?: string ) => Promise < void > ) ; groupUpdateSubject
: ( ( jid
: string , subject
: string ) => Promise < void > ) ; logout
: ( ( msg
?: string ) => Promise < void > ) ; onUnexpectedError
: ( ( error
: Error , msg
: string ) => void ) ; onWhatsApp
: ( ( ... jids
: string [] ) => Promise < { exists
: boolean ; jid
: string ; } [] > ) ; presenceSubscribe
: ( ( toJid
: string ) => Promise < void > ) ; processingMutex
: { mutex
: any ; } ; productCreate
: ( ( create
: ProductCreate ) => Promise < Product > ) ; productDelete
: ( ( productIds
: string [] ) => Promise < { deleted
: number ; } > ) ; productUpdate
: ( ( productId
: string , update
: ProductUpdate ) => Promise < Product > ) ; profilePictureUrl
: ( ( jid
: string , type
?: "image" | "preview" , timeoutMs
?: number ) => Promise < undefined | string > ) ; query
: ( ( node
: BinaryNode , timeoutMs
?: number ) => Promise < BinaryNode > ) ; readMessages
: ( ( keys
: IMessageKey [] ) => Promise < void > ) ; refreshMediaConn
: ( ( forceGet
?: boolean ) => Promise < MediaConnInfo > ) ; rejectCall
: ( ( callId
: string , callFrom
: string ) => Promise < void > ) ; relayMessage
: ( ( jid
: string , message
: IMessage , __namedParameters
: MessageRelayOptions ) => Promise < string > ) ; resyncAppState
: ( ( collections
: readonly ( "critical_block" | "critical_unblock_low" | "regular_high" | "regular_low" | "regular" ) [] , isInitialSync
: boolean ) => Promise < void > ) ; sendMessage
: ( ( jid
: string , content
: AnyMessageContent , options
?: MiscMessageGenerationOptions ) => Promise < undefined | WebMessageInfo > ) ; sendMessageAck
: ( ( __namedParameters
: BinaryNode ) => Promise < void > ) ; sendNode
: ( ( frame
: BinaryNode ) => Promise < void > ) ; sendPresenceUpdate
: ( ( type
: WAPresence , toJid
?: string ) => Promise < void > ) ; sendRawMessage
: ( ( data
: Uint8Array | Buffer ) => Promise < void > ) ; sendReceipt
: ( ( jid
: string , participant
: undefined | string , messageIds
: string [] , type
: MessageReceiptType ) => Promise < void > ) ; sendReceipts
: ( ( keys
: IMessageKey [] , type
: MessageReceiptType ) => Promise < void > ) ; sendRetryRequest
: ( ( node
: BinaryNode , forceIncludeKeys
?: boolean ) => Promise < void > ) ; type
: "md" ; updateBlockStatus
: ( ( jid
: string , action
: "block" | "unblock" ) => Promise < void > ) ; updateMediaMessage
: ( ( message
: IWebMessageInfo ) => Promise < IWebMessageInfo > ) ; updateProfileName
: ( ( name
: string ) => Promise < void > ) ; updateProfilePicture
: ( ( jid
: string , content
: WAMediaUpload ) => Promise < void > ) ; updateProfileStatus
: ( ( status
: string ) => Promise < void > ) ; uploadPreKeys
: ( ( count
?: number ) => Promise < void > ) ; upsertMessage
: ( ( msg
: IWebMessageInfo , type
: MessageUpsertType ) => Promise < void > ) ; user
: undefined | Contact ; waUploadToServer
: WAMediaUploadFunction ; waitForConnectionUpdate
: ( ( check
: ( ( u
: Partial < ConnectionState > ) => undefined | boolean ) , timeoutMs
?: number ) => Promise < void > ) ; waitForMessage
: ( ( msgId
: string , timeoutMs
?: number ) => Promise < any > ) ; waitForSocketOpen
: ( ( ) => Promise < void > ) ; ws
: any ; } raw
?: { appPatch
: ( ( patchCreate
: WAPatchCreate ) => Promise < void > ) ; assertSessions
: ( ( jids
: string [] , force
: boolean ) => Promise < boolean > ) ; authState
: { creds
: AuthenticationCreds ; keys
: SignalKeyStoreWithTransaction ; } ; chatModify
: ( ( mod
: ChatModification , jid
: string ) => Promise < void > ) ; end
: ( ( error
: undefined | Error ) => void ) ; ev
: BaileysEventEmitter & { buffer
( ) : boolean ; createBufferedFunction
< A , T_1 > ( work
: ( ( ... args
: A ) => Promise < T_1 > ) ) : ( ( ... args
: A ) => Promise < T_1 > ) ; flush
( ) : Promise < void > ; process
( handler
: ( ( events
: Partial < BaileysEventMap > ) => void | Promise < void > ) ) : ( ( ) => void ) ; processInBuffer
( task
: Promise < any > ) : any ; } ; fetchBlocklist
: ( ( ) => Promise < string [] > ) ; fetchPrivacySettings
: ( ( force
?: boolean ) => Promise < { [_:
string ]
: string ; } > ) ; fetchStatus
: ( ( jid
: string ) => Promise < undefined | { setAt
: Date ; status
: undefined | string ; } > ) ; generateMessageTag
: ( ( ) => string ) ; getBusinessProfile
: ( ( jid
: string ) => Promise < void | WABusinessProfile > ) ; getCatalog
: ( ( jid
?: string , limit
?: number ) => Promise < { products
: Product [] ; } > ) ; getCollections
: ( ( jid
?: string , limit
?: number ) => Promise < { collections
: CatalogCollection [] ; } > ) ; getOrderDetails
: ( ( orderId
: string , tokenBase64
: string ) => Promise < OrderDetails > ) ; getPrivacyTokens
: ( ( jids
: string [] ) => Promise < BinaryNode > ) ; groupAcceptInvite
: ( ( code
: string ) => Promise < undefined | string > ) ; groupAcceptInviteV4
: ( ( key
: string | IMessageKey , inviteMessage
: IGroupInviteMessage ) => Promise < string > ) ; groupCreate
: ( ( subject
: string , participants
: string [] ) => Promise < GroupMetadata > ) ; groupFetchAllParticipating
: ( ( ) => Promise < { [_:
string ]
: GroupMetadata ; } > ) ; groupGetInviteInfo
: ( ( code
: string ) => Promise < GroupMetadata > ) ; groupInviteCode
: ( ( jid
: string ) => Promise < undefined | string > ) ; groupLeave
: ( ( id
: string ) => Promise < void > ) ; groupMetadata
: ( ( jid
: string ) => Promise < GroupMetadata > ) ; groupParticipantsUpdate
: ( ( jid
: string , participants
: string [] , action
: ParticipantAction ) => Promise < { jid
: string ; status
: string ; } [] > ) ; groupRevokeInvite
: ( ( jid
: string ) => Promise < undefined | string > ) ; groupSettingUpdate
: ( ( jid
: string , setting
: "announcement" | "locked" | "not_announcement" | "unlocked" ) => Promise < void > ) ; groupToggleEphemeral
: ( ( jid
: string , ephemeralExpiration
: number ) => Promise < void > ) ; groupUpdateDescription
: ( ( jid
: string , description
?: string ) => Promise < void > ) ; groupUpdateSubject
: ( ( jid
: string , subject
: string ) => Promise < void > ) ; logout
: ( ( msg
?: string ) => Promise < void > ) ; onUnexpectedError
: ( ( error
: Error , msg
: string ) => void ) ; onWhatsApp
: ( ( ... jids
: string [] ) => Promise < { exists
: boolean ; jid
: string ; } [] > ) ; presenceSubscribe
: ( ( toJid
: string ) => Promise < void > ) ; processingMutex
: { mutex
< T > ( code
: ( ( ) => T | Promise < T > ) ) : Promise < T > ; } ; productCreate
: ( ( create
: ProductCreate ) => Promise < Product > ) ; productDelete
: ( ( productIds
: string [] ) => Promise < { deleted
: number ; } > ) ; productUpdate
: ( ( productId
: string , update
: ProductUpdate ) => Promise < Product > ) ; profilePictureUrl
: ( ( jid
: string , type
?: "image" | "preview" , timeoutMs
?: number ) => Promise < undefined | string > ) ; query
: ( ( node
: BinaryNode , timeoutMs
?: number ) => Promise < BinaryNode > ) ; readMessages
: ( ( keys
: IMessageKey [] ) => Promise < void > ) ; refreshMediaConn
: ( ( forceGet
?: boolean ) => Promise < MediaConnInfo > ) ; rejectCall
: ( ( callId
: string , callFrom
: string ) => Promise < void > ) ; relayMessage
: ( ( jid
: string , message
: IMessage , __namedParameters
: MessageRelayOptions ) => Promise < string > ) ; resyncAppState
: ( ( collections
: readonly ( "critical_block" | "critical_unblock_low" | "regular_high" | "regular_low" | "regular" ) [] , isInitialSync
: boolean ) => Promise < void > ) ; sendMessage
: ( ( jid
: string , content
: AnyMessageContent , options
?: MiscMessageGenerationOptions ) => Promise < undefined | WebMessageInfo > ) ; sendMessageAck
: ( ( __namedParameters
: BinaryNode ) => Promise < void > ) ; sendNode
: ( ( frame
: BinaryNode ) => Promise < void > ) ; sendPresenceUpdate
: ( ( type
: WAPresence , toJid
?: string ) => Promise < void > ) ; sendRawMessage
: ( ( data
: Uint8Array | Buffer ) => Promise < void > ) ; sendReceipt
: ( ( jid
: string , participant
: undefined | string , messageIds
: string [] , type
: MessageReceiptType ) => Promise < void > ) ; sendReceipts
: ( ( keys
: IMessageKey [] , type
: MessageReceiptType ) => Promise < void > ) ; sendRetryRequest
: ( ( node
: BinaryNode , forceIncludeKeys
?: boolean ) => Promise < void > ) ; type
: "md" ; updateBlockStatus
: ( ( jid
: string , action
: "block" | "unblock" ) => Promise < void > ) ; updateMediaMessage
: ( ( message
: IWebMessageInfo ) => Promise < IWebMessageInfo > ) ; updateProfileName
: ( ( name
: string ) => Promise < void > ) ; updateProfilePicture
: ( ( jid
: string , content
: WAMediaUpload ) => Promise < void > ) ; updateProfileStatus
: ( ( status
: string ) => Promise < void > ) ; uploadPreKeys
: ( ( count
?: number ) => Promise < void > ) ; upsertMessage
: ( ( msg
: IWebMessageInfo , type
: MessageUpsertType ) => Promise < void > ) ; user
: undefined | Contact ; waUploadToServer
: WAMediaUploadFunction ; waitForConnectionUpdate
: ( ( check
: ( ( u
: Partial < ConnectionState > ) => undefined | boolean ) , timeoutMs
?: number ) => Promise < void > ) ; waitForMessage
: ( ( msgId
: string , timeoutMs
?: number ) => Promise < any > ) ; waitForSocketOpen
: ( ( ) => Promise < void > ) ; ws
: any ; }
Type declaration
@@ -208,7 +212,7 @@ Parameters
error: undefined | Error
Returns void
-ev: BaileysEventEmitter & { buffer: any ; createBufferedFunction: any ; flush: any ; process: any ; processInBuffer: any ; }
+ev: BaileysEventEmitter & { buffer( ) : boolean ; createBufferedFunction< A , T_1 > ( work: ( ( ... args: A ) => Promise < T_1 > ) ) : ( ( ... args: A ) => Promise < T_1 > ) ; flush( ) : Promise < void > ; process( handler: ( ( events: Partial < BaileysEventMap > ) => void | Promise < void > ) ) : ( ( ) => void ) ; processInBuffer( task: Promise < any > ) : any ; }
fetch: ( ( ) => Promise < string [] > )
@@ -570,7 +574,7 @@ Parameters
toJid: string
TODO: These should be described using static getter/setter pairs: