Preparing search index...
The search index is not available baileys
makeWASocket ( config ) : { addChatLabel : ( ( jid , labelId ) => Promise < void > ) ; addLabel : ( ( jid , labels ) => Promise < void > ) ; addMessageLabel : ( ( jid , messageId , labelId ) => Promise < void > ) ; appPatch : ( ( patchCreate ) => Promise < void > ) ; assertSessions : ( ( jids , force ) => Promise < boolean > ) ; authState : { creds : AuthenticationCreds ; keys : SignalKeyStoreWithTransaction ; } ; chatModify : ( ( mod , jid ) => Promise < void > ) ; cleanDirtyBits : ( ( type , fromTimestamp ? ) => Promise < void > ) ; createParticipantNodes : ( ( jids , message , extraAttrs ? ) => Promise < { nodes : BinaryNode [] ; shouldIncludeDeviceIdentity : boolean ; } > ) ; end : ( ( error ) => void ) ; ev : BaileysBufferableEventEmitter ; fetchBlocklist : ( ( ) => Promise < string [] > ) ; fetchMessageHistory : ( ( count , oldestMsgKey , oldestMsgTimestamp ) => Promise < string > ) ; fetchPrivacySettings : ( ( force ? ) => Promise < { [_ : string ]: string ; } > ) ; fetchStatus : ( ( jid ) => Promise < undefined | { setAt : Date ; status : undefined | string ; } > ) ; generateMessageTag : ( ( ) => string ) ; getBusinessProfile : ( ( jid ) => Promise < void | WABusinessProfile > ) ; getCatalog : ( ( __namedParameters ) => Promise < { nextPageCursor : undefined | string ; products : Product [] ; } > ) ; getCollections : ( ( jid ? , limit ? ) => Promise < { collections : CatalogCollection [] ; } > ) ; getOrderDetails : ( ( orderId , tokenBase64 ) => Promise < OrderDetails > ) ; getPrivacyTokens : ( ( jids ) => Promise < BinaryNode > ) ; getUSyncDevices : ( ( jids , useCache , ignoreZeroDevices ) => Promise < JidWithDevice [] > ) ; groupAcceptInvite : ( ( code ) => Promise < undefined | string > ) ; groupAcceptInviteV4 : ( ( ... args ) => Promise < string > ) ; groupCreate : ( ( subject , participants ) => Promise < GroupMetadata > ) ; groupFetchAllParticipating : ( ( ) => Promise < { [_ : string ]: GroupMetadata ; } > ) ; groupGetInviteInfo : ( ( code ) => Promise < GroupMetadata > ) ; groupInviteCode : ( ( jid ) => Promise < undefined | string > ) ; groupJoinApprovalMode : ( ( jid , mode ) => Promise < void > ) ; groupLeave : ( ( id ) => Promise < void > ) ; groupMemberAddMode : ( ( jid , mode ) => Promise < void > ) ; groupMetadata : ( ( jid ) => Promise < GroupMetadata > ) ; groupParticipantsUpdate : ( ( jid , participants , action ) => Promise < { content : BinaryNode ; jid : string ; status : string ; } [] > ) ; groupRequestParticipantsList : ( ( jid ) => Promise < { [key : string ]: string ; } [] > ) ; groupRequestParticipantsUpdate : ( ( jid , participants , action ) => Promise < { jid : string ; status : string ; } [] > ) ; groupRevokeInvite : ( ( jid ) => Promise < undefined | string > ) ; groupRevokeInviteV4 : ( ( groupJid , invitedJid ) => Promise < boolean > ) ; groupSettingUpdate : ( ( jid , setting ) => Promise < void > ) ; groupToggleEphemeral : ( ( jid , ephemeralExpiration ) => Promise < void > ) ; groupUpdateDescription : ( ( jid , description ? ) => Promise < void > ) ; groupUpdateSubject : ( ( jid , subject ) => Promise < void > ) ; logger : Logger < LoggerOptions > ; logout : ( ( msg ? ) => Promise < void > ) ; onUnexpectedError : ( ( err , msg ) => void ) ; onWhatsApp : ( ( ... jids ) => Promise < { exists : boolean ; jid : string ; } [] > ) ; presenceSubscribe : ( ( toJid , tcToken ? ) => Promise < void > ) ; processingMutex : { mutex < T > ( code ) => Promise < T > ; } ; productCreate : ( ( create ) => Promise < Product > ) ; productDelete : ( ( productIds ) => Promise < { deleted : number ; } > ) ; productUpdate : ( ( productId , update ) => Promise < Product > ) ; profilePictureUrl : ( ( jid , type ? , timeoutMs ? ) => Promise < undefined | string > ) ; query : ( ( node , timeoutMs ? ) => Promise < BinaryNode > ) ; readMessages : ( ( keys ) => Promise < void > ) ; refreshMediaConn : ( ( forceGet ? ) => Promise < MediaConnInfo > ) ; rejectCall : ( ( callId , callFrom ) => Promise < void > ) ; relayMessage : ( ( jid , message , __namedParameters ) => Promise < string > ) ; removeChatLabel : ( ( jid , labelId ) => Promise < void > ) ; removeMessageLabel : ( ( jid , messageId , labelId ) => Promise < void > ) ; removeProfilePicture : ( ( jid ) => Promise < void > ) ; requestPairingCode : ( ( phoneNumber ) => Promise < string > ) ; requestPlaceholderResend : ( ( messageKey ) => Promise < undefined | string > ) ; resyncAppState : ( ( ... args ) => Promise < void > ) ; sendMessage : ( ( jid , content , options ? ) => Promise < undefined | WebMessageInfo > ) ; sendMessageAck : ( ( __namedParameters ) => Promise < void > ) ; sendNode : ( ( frame ) => Promise < void > ) ; sendPeerDataOperationMessage : ( ( pdoMessage ) => Promise < string > ) ; sendPresenceUpdate : ( ( type , toJid ? ) => Promise < void > ) ; sendRawMessage : ( ( data ) => Promise < void > ) ; sendReceipt : ( ( jid , participant , messageIds , type ) => Promise < void > ) ; sendReceipts : ( ( keys , type ) => Promise < void > ) ; sendRetryRequest : ( ( node , forceIncludeKeys ? ) => Promise < void > ) ; sendWAMBuffer : ( ( wamBuffer ) => Promise < BinaryNode > ) ; signalRepository : SignalRepository ; star : ( ( jid , messages , star ) => Promise < void > ) ; type : "md" ; updateBlockStatus : ( ( jid , action ) => Promise < void > ) ; updateCallPrivacy : ( ( value ) => Promise < void > ) ; updateDefaultDisappearingMode : ( ( duration ) => Promise < void > ) ; updateGroupsAddPrivacy : ( ( value ) => Promise < void > ) ; updateLastSeenPrivacy : ( ( value ) => Promise < void > ) ; updateMediaMessage : ( ( message ) => Promise < IWebMessageInfo > ) ; updateOnlinePrivacy : ( ( value ) => Promise < void > ) ; updateProfileName : ( ( name ) => Promise < void > ) ; updateProfilePicture : ( ( jid , content ) => Promise < void > ) ; updateProfilePicturePrivacy : ( ( value ) => Promise < void > ) ; updateProfileStatus : ( ( status ) => Promise < void > ) ; updateReadReceiptsPrivacy : ( ( value ) => Promise < void > ) ; updateStatusPrivacy : ( ( value ) => Promise < void > ) ; uploadPreKeys : ( ( count ? ) => Promise < void > ) ; uploadPreKeysToServerIfRequired : ( ( ) => Promise < void > ) ; upsertMessage : ( ( ... args ) => Promise < void > ) ; user : undefined | Contact ; waUploadToServer : WAMediaUploadFunction ; waitForConnectionUpdate : ( ( check , timeoutMs ? ) => Promise < void > ) ; waitForMessage : ( < T > ( msgId , timeoutMs ? ) => Promise < T > ) ; waitForSocketOpen : ( ( ) => Promise < void > ) ; ws : WebSocketClient ; }
Returns { addChatLabel : ( ( jid , labelId ) => Promise < void > ) ; addLabel : ( ( jid , labels ) => Promise < void > ) ; addMessageLabel : ( ( jid , messageId , labelId ) => Promise < void > ) ; appPatch : ( ( patchCreate ) => Promise < void > ) ; assertSessions : ( ( jids , force ) => Promise < boolean > ) ; authState : { creds : AuthenticationCreds ; keys : SignalKeyStoreWithTransaction ; } ; chatModify : ( ( mod , jid ) => Promise < void > ) ; cleanDirtyBits : ( ( type , fromTimestamp ? ) => Promise < void > ) ; createParticipantNodes : ( ( jids , message , extraAttrs ? ) => Promise < { nodes : BinaryNode [] ; shouldIncludeDeviceIdentity : boolean ; } > ) ; end : ( ( error ) => void ) ; ev : BaileysBufferableEventEmitter ; fetchBlocklist : ( ( ) => Promise < string [] > ) ; fetchMessageHistory : ( ( count , oldestMsgKey , oldestMsgTimestamp ) => Promise < string > ) ; fetchPrivacySettings : ( ( force ? ) => Promise < { [_ : string ]: string ; } > ) ; fetchStatus : ( ( jid ) => Promise < undefined | { setAt : Date ; status : undefined | string ; } > ) ; generateMessageTag : ( ( ) => string ) ; getBusinessProfile : ( ( jid ) => Promise < void | WABusinessProfile > ) ; getCatalog : ( ( __namedParameters ) => Promise < { nextPageCursor : undefined | string ; products : Product [] ; } > ) ; getCollections : ( ( jid ? , limit ? ) => Promise < { collections : CatalogCollection [] ; } > ) ; getOrderDetails : ( ( orderId , tokenBase64 ) => Promise < OrderDetails > ) ; getPrivacyTokens : ( ( jids ) => Promise < BinaryNode > ) ; getUSyncDevices : ( ( jids , useCache , ignoreZeroDevices ) => Promise < JidWithDevice [] > ) ; groupAcceptInvite : ( ( code ) => Promise < undefined | string > ) ; groupAcceptInviteV4 : ( ( ... args ) => Promise < string > ) ; groupCreate : ( ( subject , participants ) => Promise < GroupMetadata > ) ; groupFetchAllParticipating : ( ( ) => Promise < { [_ : string ]: GroupMetadata ; } > ) ; groupGetInviteInfo : ( ( code ) => Promise < GroupMetadata > ) ; groupInviteCode : ( ( jid ) => Promise < undefined | string > ) ; groupJoinApprovalMode : ( ( jid , mode ) => Promise < void > ) ; groupLeave : ( ( id ) => Promise < void > ) ; groupMemberAddMode : ( ( jid , mode ) => Promise < void > ) ; groupMetadata : ( ( jid ) => Promise < GroupMetadata > ) ; groupParticipantsUpdate : ( ( jid , participants , action ) => Promise < { content : BinaryNode ; jid : string ; status : string ; } [] > ) ; groupRequestParticipantsList : ( ( jid ) => Promise < { [key : string ]: string ; } [] > ) ; groupRequestParticipantsUpdate : ( ( jid , participants , action ) => Promise < { jid : string ; status : string ; } [] > ) ; groupRevokeInvite : ( ( jid ) => Promise < undefined | string > ) ; groupRevokeInviteV4 : ( ( groupJid , invitedJid ) => Promise < boolean > ) ; groupSettingUpdate : ( ( jid , setting ) => Promise < void > ) ; groupToggleEphemeral : ( ( jid , ephemeralExpiration ) => Promise < void > ) ; groupUpdateDescription : ( ( jid , description ? ) => Promise < void > ) ; groupUpdateSubject : ( ( jid , subject ) => Promise < void > ) ; logger : Logger < LoggerOptions > ; logout : ( ( msg ? ) => Promise < void > ) ; onUnexpectedError : ( ( err , msg ) => void ) ; onWhatsApp : ( ( ... jids ) => Promise < { exists : boolean ; jid : string ; } [] > ) ; presenceSubscribe : ( ( toJid , tcToken ? ) => Promise < void > ) ; processingMutex : { mutex < T > ( code ) => Promise < T > ; } ; productCreate : ( ( create ) => Promise < Product > ) ; productDelete : ( ( productIds ) => Promise < { deleted : number ; } > ) ; productUpdate : ( ( productId , update ) => Promise < Product > ) ; profilePictureUrl : ( ( jid , type ? , timeoutMs ? ) => Promise < undefined | string > ) ; query : ( ( node , timeoutMs ? ) => Promise < BinaryNode > ) ; readMessages : ( ( keys ) => Promise < void > ) ; refreshMediaConn : ( ( forceGet ? ) => Promise < MediaConnInfo > ) ; rejectCall : ( ( callId , callFrom ) => Promise < void > ) ; relayMessage : ( ( jid , message , __namedParameters ) => Promise < string > ) ; removeChatLabel : ( ( jid , labelId ) => Promise < void > ) ; removeMessageLabel : ( ( jid , messageId , labelId ) => Promise < void > ) ; removeProfilePicture : ( ( jid ) => Promise < void > ) ; requestPairingCode : ( ( phoneNumber ) => Promise < string > ) ; requestPlaceholderResend : ( ( messageKey ) => Promise < undefined | string > ) ; resyncAppState : ( ( ... args ) => Promise < void > ) ; sendMessage : ( ( jid , content , options ? ) => Promise < undefined | WebMessageInfo > ) ; sendMessageAck : ( ( __namedParameters ) => Promise < void > ) ; sendNode : ( ( frame ) => Promise < void > ) ; sendPeerDataOperationMessage : ( ( pdoMessage ) => Promise < string > ) ; sendPresenceUpdate : ( ( type , toJid ? ) => Promise < void > ) ; sendRawMessage : ( ( data ) => Promise < void > ) ; sendReceipt : ( ( jid , participant , messageIds , type ) => Promise < void > ) ; sendReceipts : ( ( keys , type ) => Promise < void > ) ; sendRetryRequest : ( ( node , forceIncludeKeys ? ) => Promise < void > ) ; sendWAMBuffer : ( ( wamBuffer ) => Promise < BinaryNode > ) ; signalRepository : SignalRepository ; star : ( ( jid , messages , star ) => Promise < void > ) ; type : "md" ; updateBlockStatus : ( ( jid , action ) => Promise < void > ) ; updateCallPrivacy : ( ( value ) => Promise < void > ) ; updateDefaultDisappearingMode : ( ( duration ) => Promise < void > ) ; updateGroupsAddPrivacy : ( ( value ) => Promise < void > ) ; updateLastSeenPrivacy : ( ( value ) => Promise < void > ) ; updateMediaMessage : ( ( message ) => Promise < IWebMessageInfo > ) ; updateOnlinePrivacy : ( ( value ) => Promise < void > ) ; updateProfileName : ( ( name ) => Promise < void > ) ; updateProfilePicture : ( ( jid , content ) => Promise < void > ) ; updateProfilePicturePrivacy : ( ( value ) => Promise < void > ) ; updateProfileStatus : ( ( status ) => Promise < void > ) ; updateReadReceiptsPrivacy : ( ( value ) => Promise < void > ) ; updateStatusPrivacy : ( ( value ) => Promise < void > ) ; uploadPreKeys : ( ( count ? ) => Promise < void > ) ; uploadPreKeysToServerIfRequired : ( ( ) => Promise < void > ) ; upsertMessage : ( ( ... args ) => Promise < void > ) ; user : undefined | Contact ; waUploadToServer : WAMediaUploadFunction ; waitForConnectionUpdate : ( ( check , timeoutMs ? ) => Promise < void > ) ; waitForMessage : ( < T > ( msgId , timeoutMs ? ) => Promise < T > ) ; waitForSocketOpen : ( ( ) => Promise < void > ) ; ws : WebSocketClient ; }
add Chat Label : ( ( jid , labelId ) => Promise < void > )
( jid , labelId ) : Promise < void >
Parameters
jid : string
labelId : string
Returns Promise < void >
add Label : ( ( jid , labels ) => Promise < void > )
( jid , labels ) : Promise < void >
Parameters
jid : string
labels : LabelActionBody
Returns Promise < void >
add Message Label : ( ( jid , messageId , labelId ) => Promise < void > )
( jid , messageId , labelId ) : Promise < void >
Parameters
jid : string
messageId : string
labelId : string
Returns Promise < void >
app Patch : ( ( patchCreate ) => Promise < void > )
( patchCreate ) : Promise < void >
Returns Promise < void >
assert Sessions : ( ( jids , force ) => Promise < boolean > )
( jids , force ) : Promise < boolean >
Parameters
jids : string []
force : boolean
Returns Promise < boolean >
chat Modify : ( ( mod , jid ) => Promise < void > )
( mod , jid ) : Promise < void >
Returns Promise < void >
clean Dirty Bits : ( ( type , fromTimestamp ? ) => Promise < void > )
( type , fromTimestamp ? ) : Promise < void >
Parameters
type : "account_sync" | "groups"
Optional
fromTimestamp : string | number
Returns Promise < void >
create Participant Nodes : ( ( jids , message , extraAttrs ? ) => Promise < { nodes : BinaryNode [] ; shouldIncludeDeviceIdentity : boolean ; } > )
( jids , message , extraAttrs ? ) : Promise < { nodes : BinaryNode [] ; shouldIncludeDeviceIdentity : boolean ; } >
Parameters
jids : string []
Optional
extraAttrs : { [key : string ]: string ; }
Returns Promise < { nodes : BinaryNode [] ; shouldIncludeDeviceIdentity : boolean ; } >
end : ( ( error ) => void )
( error ) : void
Returns void
ev : BaileysBufferableEventEmitter
fetch Blocklist : ( ( ) => Promise < string [] > )
( ) : Promise < string [] >
Returns Promise < string [] >
fetch Message History : ( ( count , oldestMsgKey , oldestMsgTimestamp ) => Promise < string > )
( count , oldestMsgKey , oldestMsgTimestamp ) : Promise < string >
Parameters
count : number
oldestMsgTimestamp : number | Long
Returns Promise < string >
fetch Privacy Settings : ( ( force ? ) => Promise < { [_ : string ]: string ; } > )
( force ? ) : Promise < { [_ : string ]: string ; } >
Returns Promise < { [_ : string ]: string ; } >
fetch Status : ( ( jid ) => Promise < undefined | { setAt : Date ; status : undefined | string ; } > )
( jid ) : Promise < undefined | { setAt : Date ; status : undefined | string ; } >
Returns Promise < undefined | { setAt : Date ; status : undefined | string ; } >
generate Message Tag : ( ( ) => string )
( ) : string
Returns string
get Business Profile : ( ( jid ) => Promise < void | WABusinessProfile > )
get Catalog : ( ( __namedParameters ) => Promise < { nextPageCursor : undefined | string ; products : Product [] ; } > )
( __namedParameters ) : Promise < { nextPageCursor : undefined | string ; products : Product [] ; } >
Returns Promise < { nextPageCursor : undefined | string ; products : Product [] ; } >
get Collections : ( ( jid ? , limit ? ) => Promise < { collections : CatalogCollection [] ; } > )
get Order Details : ( ( orderId , tokenBase64 ) => Promise < OrderDetails > )
( orderId , tokenBase64 ) : Promise < OrderDetails >
Parameters
orderId : string
tokenBase64 : string
get Privacy Tokens : ( ( jids ) => Promise < BinaryNode > )
getUSync Devices : ( ( jids , useCache , ignoreZeroDevices ) => Promise < JidWithDevice [] > )
( jids , useCache , ignoreZeroDevices ) : Promise < JidWithDevice [] >
Parameters
jids : string []
useCache : boolean
ignoreZeroDevices : boolean
group Accept Invite : ( ( code ) => Promise < undefined | string > )
( code ) : Promise < undefined | string >
Returns Promise < undefined | string >
group Accept Invite V4 : ( ( ... args ) => Promise < string > )
( ... args ) : Promise < string >
Returns Promise < string >
group Create : ( ( subject , participants ) => Promise < GroupMetadata > )
( subject , participants ) : Promise < GroupMetadata >
Parameters
subject : string
participants : string []
group Fetch All Participating : ( ( ) => Promise < { [_ : string ]: GroupMetadata ; } > )
group Get Invite Info : ( ( code ) => Promise < GroupMetadata > )
group Invite Code : ( ( jid ) => Promise < undefined | string > )
( jid ) : Promise < undefined | string >
Returns Promise < undefined | string >
group Join Approval Mode : ( ( jid , mode ) => Promise < void > )
( jid , mode ) : Promise < void >
Parameters
jid : string
mode : "on" | "off"
Returns Promise < void >
group Leave : ( ( id ) => Promise < void > )
( id ) : Promise < void >
Returns Promise < void >
group Member Add Mode : ( ( jid , mode ) => Promise < void > )
( jid , mode ) : Promise < void >
Parameters
jid : string
mode : "all_member_add" | "admin_add"
Returns Promise < void >
group Metadata : ( ( jid ) => Promise < GroupMetadata > )
group Participants Update : ( ( jid , participants , action ) => Promise < { content : BinaryNode ; jid : string ; status : string ; } [] > )
( jid , participants , action ) : Promise < { content : BinaryNode ; jid : string ; status : string ; } [] >
Parameters
jid : string
participants : string []
Returns Promise < { content : BinaryNode ; jid : string ; status : string ; } [] >
group Request Participants List : ( ( jid ) => Promise < { [key : string ]: string ; } [] > )
( jid ) : Promise < { [key : string ]: string ; } [] >
Returns Promise < { [key : string ]: string ; } [] >
group Request Participants Update : ( ( jid , participants , action ) => Promise < { jid : string ; status : string ; } [] > )
( jid , participants , action ) : Promise < { jid : string ; status : string ; } [] >
Parameters
jid : string
participants : string []
action : "reject" | "approve"
Returns Promise < { jid : string ; status : string ; } [] >
group Revoke Invite : ( ( jid ) => Promise < undefined | string > )
( jid ) : Promise < undefined | string >
Returns Promise < undefined | string >
group Revoke Invite V4 : ( ( groupJid , invitedJid ) => Promise < boolean > )
( groupJid , invitedJid ) : Promise < boolean >
Parameters
groupJid : string
invitedJid : string
Returns Promise < boolean > true if successful
group Setting Update : ( ( jid , setting ) => Promise < void > )
( jid , setting ) : Promise < void >
Parameters
jid : string
setting : "announcement" | "locked" | "not_announcement" | "unlocked"
Returns Promise < void >
group Toggle Ephemeral : ( ( jid , ephemeralExpiration ) => Promise < void > )
( jid , ephemeralExpiration ) : Promise < void >
Parameters
jid : string
ephemeralExpiration : number
Returns Promise < void >
group Update Description : ( ( jid , description ? ) => Promise < void > )
( jid , description ? ) : Promise < void >
Parameters
jid : string
Optional
description : string
Returns Promise < void >
group Update Subject : ( ( jid , subject ) => Promise < void > )
( jid , subject ) : Promise < void >
Parameters
jid : string
subject : string
Returns Promise < void >
logger : Logger < LoggerOptions >
logout : ( ( msg ? ) => Promise < void > )
( msg ? ) : Promise < void >
Returns Promise < void >
on Unexpected Error : ( ( err , msg ) => void )
( err , msg ) : void
Parameters
err : Error | Boom < any >
msg : string
Returns void
on Whats App : ( ( ... jids ) => Promise < { exists : boolean ; jid : string ; } [] > )
( ... jids ) : Promise < { exists : boolean ; jid : string ; } [] >
Returns Promise < { exists : boolean ; jid : string ; } [] >
presence Subscribe : ( ( toJid , tcToken ? ) => Promise < void > )
( toJid , tcToken ? ) : Promise < void >
Parameters
toJid : string
Optional
tcToken : Buffer
Returns Promise < void >
processing Mutex : { mutex < T > ( code ) => Promise < T > ; }
mutex : function
mutex < T > ( code ) : Promise < T >
Parameters
code : ( ( ) => T | Promise < T > )
( ) : T | Promise < T >
Returns T | Promise < T >
Returns Promise < T >
product Create : ( ( create ) => Promise < Product > )
product Delete : ( ( productIds ) => Promise < { deleted : number ; } > )
( productIds ) : Promise < { deleted : number ; } >
Returns Promise < { deleted : number ; } >
product Update : ( ( productId , update ) => Promise < Product > )
profile Picture Url : ( ( jid , type ? , timeoutMs ? ) => Promise < undefined | string > )
( jid , type ? , timeoutMs ? ) : Promise < undefined | string >
Parameters
jid : string
type : "image" | "preview" = 'preview'
Optional
timeoutMs : number
Returns Promise < undefined | string >
query : ( ( node , timeoutMs ? ) => Promise < BinaryNode > )
( node , timeoutMs ? ) : Promise < BinaryNode >
Parameters
Optional
timeoutMs : number
read Messages : ( ( keys ) => Promise < void > )
( keys ) : Promise < void >
Returns Promise < void >
refresh Media Conn : ( ( forceGet ? ) => Promise < MediaConnInfo > )
( forceGet ? ) : Promise < MediaConnInfo >
Parameters
forceGet : boolean = false
reject Call : ( ( callId , callFrom ) => Promise < void > )
( callId , callFrom ) : Promise < void >
Parameters
callId : string
callFrom : string
Returns Promise < void >
relay Message : ( ( jid , message , __namedParameters ) => Promise < string > )
( jid , message , __namedParameters ) : Promise < string >
Returns Promise < string >
remove Chat Label : ( ( jid , labelId ) => Promise < void > )
( jid , labelId ) : Promise < void >
Parameters
jid : string
labelId : string
Returns Promise < void >
remove Message Label : ( ( jid , messageId , labelId ) => Promise < void > )
( jid , messageId , labelId ) : Promise < void >
Parameters
jid : string
messageId : string
labelId : string
Returns Promise < void >
remove Profile Picture : ( ( jid ) => Promise < void > )
( jid ) : Promise < void >
Returns Promise < void >
request Pairing Code : ( ( phoneNumber ) => Promise < string > )
( phoneNumber ) : Promise < string >
Returns Promise < string >
request Placeholder Resend : ( ( messageKey ) => Promise < undefined | string > )
( messageKey ) : Promise < undefined | string >
Returns Promise < undefined | string >
resync App State : ( ( ... args ) => Promise < void > )
( ... args ) : Promise < void >
Parameters
Rest
... args : [ collections: readonly ( "critical_block" | "critical_unblock_low" | "regular_high" | "regular_low" | "regular" ) [] , isInitialSync: boolean ]
Returns Promise < void >
send Message : ( ( jid , content , options ? ) => Promise < undefined | WebMessageInfo > )
send Message Ack : ( ( __namedParameters ) => Promise < void > )
( __namedParameters ) : Promise < void >
Returns Promise < void >
send Node : ( ( frame ) => Promise < void > )
( frame ) : Promise < void >
Returns Promise < void >
send Peer Data Operation Message : ( ( pdoMessage ) => Promise < string > )
( pdoMessage ) : Promise < string >
Returns Promise < string >
send Presence Update : ( ( type , toJid ? ) => Promise < void > )
( type , toJid ? ) : Promise < void >
Returns Promise < void >
send Raw Message : ( ( data ) => Promise < void > )
( data ) : Promise < void >
Parameters
data : Uint8Array | Buffer
Returns Promise < void >
send Receipt : ( ( jid , participant , messageIds , type ) => Promise < void > )
( jid , participant , messageIds , type ) : Promise < void >
Parameters
jid : string
participant : undefined | string
messageIds : string []
Returns Promise < void >
send Receipts : ( ( keys , type ) => Promise < void > )
( keys , type ) : Promise < void >
Returns Promise < void >
send Retry Request : ( ( node , forceIncludeKeys ? ) => Promise < void > )
( node , forceIncludeKeys ? ) : Promise < void >
Parameters
forceIncludeKeys : boolean = false
Returns Promise < void >
sendWAMBuffer : ( ( wamBuffer ) => Promise < BinaryNode > )
star : ( ( jid , messages , star ) => Promise < void > )
( jid , messages , star ) : Promise < void >
Parameters
jid : string
messages : { fromMe ?: boolean ; id : string ; } []
star : boolean
Returns Promise < void >
type : "md"
update Block Status : ( ( jid , action ) => Promise < void > )
( jid , action ) : Promise < void >
Parameters
jid : string
action : "block" | "unblock"
Returns Promise < void >
update Call Privacy : ( ( value ) => Promise < void > )
( value ) : Promise < void >
Returns Promise < void >
update Default Disappearing Mode : ( ( duration ) => Promise < void > )
( duration ) : Promise < void >
Returns Promise < void >
update Groups Add Privacy : ( ( value ) => Promise < void > )
( value ) : Promise < void >
Returns Promise < void >
update Last Seen Privacy : ( ( value ) => Promise < void > )
( value ) : Promise < void >
Returns Promise < void >
update Media Message : ( ( message ) => Promise < IWebMessageInfo > )
update Online Privacy : ( ( value ) => Promise < void > )
( value ) : Promise < void >
Returns Promise < void >
update Profile Name : ( ( name ) => Promise < void > )
( name ) : Promise < void >
Returns Promise < void >
update Profile Picture : ( ( jid , content ) => Promise < void > )
( jid , content ) : Promise < void >
Returns Promise < void >
update Profile Picture Privacy : ( ( value ) => Promise < void > )
( value ) : Promise < void >
Returns Promise < void >
update Profile Status : ( ( status ) => Promise < void > )
( status ) : Promise < void >
Returns Promise < void >
update Read Receipts Privacy : ( ( value ) => Promise < void > )
( value ) : Promise < void >
Returns Promise < void >
update Status Privacy : ( ( value ) => Promise < void > )
( value ) : Promise < void >
Returns Promise < void >
upload Pre Keys : ( ( count ? ) => Promise < void > )
( count ? ) : Promise < void >
Parameters
count : number = INITIAL_PREKEY_COUNT
Returns Promise < void >
upload Pre Keys To Server If Required : ( ( ) => Promise < void > )
( ) : Promise < void >
Returns Promise < void >
upsert Message : ( ( ... args ) => Promise < void > )
( ... args ) : Promise < void >
Returns Promise < void >
user : undefined | Contact
wait For Connection Update : ( ( check , timeoutMs ? ) => Promise < void > )
( check , timeoutMs ? ) : Promise < void >
Parameters
check : ( ( u ) => undefined | boolean )
( u ) : undefined | boolean
Returns undefined | boolean
Optional
timeoutMs : number
Returns Promise < void >
wait For Message : ( < T > ( msgId , timeoutMs ? ) => Promise < T > )
< T > ( msgId , timeoutMs ? ) : Promise < T >
Parameters
msgId : string
timeoutMs : undefined | number = defaultQueryTimeoutMs
Returns Promise < T >
wait For Socket Open : ( ( ) => Promise < void > )
( ) : Promise < void >
Returns Promise < void >
ws : WebSocketClient
Adds label for the chats