From 8698ab603e3f7592ae45339fb560725355bfa8e2 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Fri, 4 Oct 2024 22:40:15 +0000 Subject: [PATCH] deploy: df72c50014691d9db834686e30153ec87f278b19 --- classes/util.WPPError.html | 4 +- classes/whatsapp.AggReactionsCollection.html | 40 ++++---- classes/whatsapp.AggReactionsModel.html | 38 +++---- classes/whatsapp.AttachMediaModel.html | 38 +++---- classes/whatsapp.BaseCollection.html | 40 ++++---- classes/whatsapp.BlocklistCollection.html | 40 ++++---- classes/whatsapp.BlocklistModel.html | 38 +++---- ...pp.BusinessCategoriesResultCollection.html | 40 ++++---- ...hatsapp.BusinessCategoriesResultModel.html | 38 +++---- .../whatsapp.BusinessProfileCollection.html | 40 ++++---- classes/whatsapp.BusinessProfileModel.html | 38 +++---- classes/whatsapp.ButtonCollection.html | 38 +++---- classes/whatsapp.CallCollection.html | 42 ++++---- classes/whatsapp.CallModel.html | 40 ++++---- classes/whatsapp.CartCollection.html | 40 ++++---- classes/whatsapp.CartItemCollection.html | 40 ++++---- classes/whatsapp.CartItemModel.html | 38 +++---- classes/whatsapp.CartModel.html | 38 +++---- classes/whatsapp.CatalogCollection.html | 40 ++++---- classes/whatsapp.CatalogModel.html | 38 +++---- classes/whatsapp.ChatCollection.html | 40 ++++---- classes/whatsapp.ChatModel.html | 36 +++---- classes/whatsapp.ChatPreferenceModel.html | 38 +++---- classes/whatsapp.ChatstateCollection.html | 40 ++++---- classes/whatsapp.ChatstateModel.html | 38 +++---- classes/whatsapp.CmdClass.html | 40 ++++---- classes/whatsapp.Collection.html | 40 ++++---- classes/whatsapp.ComposeBoxActionsClass.html | 38 +++---- classes/whatsapp.ConnModel.html | 38 +++---- classes/whatsapp.ContactCollection.html | 40 ++++---- classes/whatsapp.ContactModel.html | 98 +++++++++---------- classes/whatsapp.ConversionTupleModel.html | 38 +++---- classes/whatsapp.EmojiVariantCollection.html | 40 ++++---- classes/whatsapp.EmojiVariantModel.html | 38 +++---- classes/whatsapp.EventEmitter.html | 38 +++---- classes/whatsapp.GroupMetadataCollection.html | 40 ++++---- classes/whatsapp.GroupMetadataModel.html | 38 +++---- .../whatsapp.HistorySyncProgressModel.html | 36 +++---- classes/whatsapp.LabelCollection.html | 40 ++++---- classes/whatsapp.LabelItemCollection.html | 40 ++++---- classes/whatsapp.LabelItemModel.html | 38 +++---- classes/whatsapp.LabelModel.html | 38 +++---- classes/whatsapp.MediaBlobCacheImpl.html | 6 +- classes/whatsapp.MediaDataModel.html | 38 +++---- classes/whatsapp.MediaEntry.html | 6 +- classes/whatsapp.MediaObject.html | 6 +- classes/whatsapp.Model.html | 36 +++---- classes/whatsapp.ModelChatBase.html | 36 +++---- classes/whatsapp.MsgButtonReplyMsgModel.html | 38 +++---- classes/whatsapp.MsgCollection.html | 40 ++++---- classes/whatsapp.MsgInfoCollection.html | 40 ++++---- classes/whatsapp.MsgInfoModel.html | 38 +++---- ...whatsapp.MsgInfoParticipantCollection.html | 38 +++---- classes/whatsapp.MsgInfoParticipantModel.html | 36 +++---- classes/whatsapp.MsgKey.html | 12 +-- classes/whatsapp.MsgLoad.html | 40 ++++---- classes/whatsapp.MsgLoadState.html | 36 +++---- classes/whatsapp.MsgModel.html | 40 ++++---- classes/whatsapp.MuteCollection.html | 38 +++---- classes/whatsapp.MuteModel.html | 38 +++---- classes/whatsapp.NetworkStatusModel.html | 36 +++---- classes/whatsapp.OpaqueData.html | 6 +- classes/whatsapp.OpaqueDataBase.html | 6 +- classes/whatsapp.OrderCollection.html | 40 ++++---- classes/whatsapp.OrderItemCollection.html | 40 ++++---- classes/whatsapp.OrderItemModel.html | 38 +++---- classes/whatsapp.OrderModel.html | 38 +++---- classes/whatsapp.ParticipantCollection.html | 44 ++++----- classes/whatsapp.ParticipantModel.html | 38 +++---- classes/whatsapp.PinInChatCollection.html | 38 +++---- classes/whatsapp.PresenceCollection.html | 40 ++++---- classes/whatsapp.PresenceModel.html | 38 +++---- classes/whatsapp.ProductCatalogSession.html | 4 +- classes/whatsapp.ProductCollCollection.html | 40 ++++---- classes/whatsapp.ProductCollModel.html | 38 +++---- classes/whatsapp.ProductCollection.html | 40 ++++---- classes/whatsapp.ProductImageCollection.html | 40 ++++---- classes/whatsapp.ProductImageModel.html | 38 +++---- ...whatsapp.ProductMessageListCollection.html | 38 +++---- classes/whatsapp.ProductMessageListModel.html | 38 +++---- classes/whatsapp.ProductModel.html | 38 +++---- .../whatsapp.ProfilePicThumbCollection.html | 40 ++++---- classes/whatsapp.ProfilePicThumbModel.html | 38 +++---- classes/whatsapp.QuickReplyCollection.html | 40 ++++---- classes/whatsapp.QuickReplyModel.html | 38 +++---- classes/whatsapp.ReactionsCollection.html | 40 ++++---- classes/whatsapp.ReactionsModel.html | 40 ++++---- .../whatsapp.ReactionsSendersCollection.html | 40 ++++---- classes/whatsapp.ReactionsSendersModel.html | 38 +++---- classes/whatsapp.RecentEmojiCollection.html | 40 ++++---- classes/whatsapp.RecentEmojiModel.html | 36 +++---- classes/whatsapp.RecentStickerCollection.html | 42 ++++---- classes/whatsapp.RecentStickerModel.html | 38 +++---- classes/whatsapp.ReplyButtonModel.html | 38 +++---- classes/whatsapp.ServerPropsModel.html | 38 +++---- classes/whatsapp.SocketModel.html | 36 +++---- classes/whatsapp.StarredMsgCollection.html | 40 ++++---- classes/whatsapp.StatusCollection.html | 40 ++++---- classes/whatsapp.StatusModel.html | 38 +++---- classes/whatsapp.StatusV3Collection.html | 40 ++++---- classes/whatsapp.StatusV3Model.html | 38 +++---- classes/whatsapp.StickerCollection.html | 40 ++++---- classes/whatsapp.StickerModel.html | 40 ++++---- classes/whatsapp.StickerPackCollection.html | 42 ++++---- classes/whatsapp.StickerPackModel.html | 38 +++---- classes/whatsapp.StickerSearchCollection.html | 40 ++++---- classes/whatsapp.StreamModel.html | 38 +++---- .../whatsapp.TemplateButtonCollection.html | 40 ++++---- classes/whatsapp.TemplateButtonModel.html | 38 +++---- classes/whatsapp.USyncQuery.html | 4 +- classes/whatsapp.USyncUser.html | 4 +- classes/whatsapp.UnreadMentionModel.html | 38 +++---- classes/whatsapp.Wid.html | 8 +- classes/whatsapp.websocket.WapNode.html | 4 +- enums/group.GroupProperty.html | 2 +- enums/whatsapp.enums.ACK.html | 10 +- enums/whatsapp.enums.ACK_STRING.html | 10 +- enums/whatsapp.enums.CALL_STATES.html | 10 +- enums/whatsapp.enums.EDIT_ATTR.html | 10 +- enums/whatsapp.enums.GROUP_SETTING_TYPE.html | 10 +- .../whatsapp.enums.KIC_ENTRY_POINT_TYPE.html | 6 +- enums/whatsapp.enums.LOGOUT_REASON_CODE.html | 2 +- enums/whatsapp.enums.LogoutReason.html | 12 +-- enums/whatsapp.enums.MSG_TYPE.html | 10 +- enums/whatsapp.enums.OUTWARD_TYPES.html | 6 +- enums/whatsapp.enums.PIN_STATE.html | 6 +- enums/whatsapp.enums.SendMsgResult.html | 10 +- functions/call.accept.html | 4 +- functions/call.end.html | 4 +- functions/call.offer.html | 4 +- functions/call.reject.html | 4 +- functions/catalog.addProductImage.html | 4 +- functions/catalog.changeProductImage.html | 4 +- functions/catalog.createCollection.html | 4 +- functions/catalog.delProducts.html | 4 +- functions/catalog.deleteCollection.html | 4 +- functions/catalog.getCollections.html | 4 +- functions/catalog.getMyCatalog.html | 4 +- functions/catalog.getProductById.html | 4 +- functions/catalog.getProducts.html | 4 +- functions/catalog.removeProductImage.html | 4 +- functions/catalog.setProductVisibility.html | 4 +- functions/catalog.updateCartEnabled.html | 4 +- functions/chat.archive.html | 4 +- functions/chat.canMarkPlayed.html | 4 +- functions/chat.canMute.html | 4 +- functions/chat.canReply.html | 4 +- functions/chat.closeChat.html | 4 +- functions/chat.deleteMessage.html | 4 +- functions/chat.editMessage.html | 4 +- functions/chat.forwardMessage.html | 4 +- functions/chat.getActiveChat.html | 4 +- functions/chat.getLastSeen.html | 4 +- functions/chat.getMessageACK.html | 4 +- functions/chat.getMessageById.html | 4 +- functions/chat.getMessages.html | 4 +- functions/chat.getPlatformFromMessage.html | 4 +- functions/chat.getReactions.html | 4 +- functions/chat.getVotes.html | 4 +- functions/chat.keepMessage.html | 4 +- functions/chat.list.html | 4 +- functions/chat.markIsComposing.html | 4 +- functions/chat.markIsPaused.html | 4 +- functions/chat.markIsRead.html | 4 +- functions/chat.markIsRecording.html | 4 +- functions/chat.markIsUnread.html | 4 +- functions/chat.markPlayed.html | 4 +- functions/chat.mute.html | 4 +- functions/chat.openChatAt.html | 4 +- functions/chat.openChatBottom.html | 4 +- functions/chat.openChatFromUnread.html | 4 +- functions/chat.pin.html | 4 +- functions/chat.pinMsg.html | 4 +- functions/chat.requestPhoneNumber.html | 4 +- functions/chat.sendChargeMessage.html | 4 +- functions/chat.sendCreatePollMessage.html | 4 +- functions/chat.sendFileMessage.html | 4 +- functions/chat.sendGroupInviteMessage.html | 4 +- functions/chat.sendListMessage.html | 4 +- functions/chat.sendLocationMessage.html | 4 +- functions/chat.sendPixKeyMessage.html | 4 +- functions/chat.sendReactionToMessage.html | 4 +- functions/chat.sendScheduledCallMessage.html | 4 +- functions/chat.sendTextMessage.html | 4 +- functions/chat.sendVCardContactMessage.html | 4 +- functions/chat.starMessage.html | 8 +- functions/chat.unarchive.html | 6 +- functions/chat.unmute.html | 4 +- functions/chat.unpin.html | 6 +- functions/chat.unpinMsg.html | 6 +- functions/community.addSubgroups.html | 4 +- functions/community.create.html | 4 +- functions/community.deactivate.html | 4 +- functions/community.demoteParticipants.html | 4 +- functions/community.getParticipants.html | 4 +- functions/community.promoteParticipants.html | 4 +- functions/community.removeSubgroups.html | 4 +- .../conn.genLinkDeviceCodeForPhoneNumber.html | 4 +- functions/conn.getAuthCode.html | 4 +- functions/conn.getHistorySyncProgress.html | 4 +- functions/conn.getMyDeviceId.html | 4 +- functions/conn.getMyUserId.html | 4 +- functions/conn.getPlatform.html | 4 +- functions/conn.isMainInit.html | 4 +- functions/conn.isMainLoaded.html | 4 +- functions/conn.isMainReady.html | 4 +- functions/conn.isOnline.html | 4 +- functions/conn.isRegistered.html | 4 +- functions/conn.joinWebBeta.html | 4 +- functions/conn.markAvailable.html | 4 +- functions/conn.markUnavailable.html | 4 +- functions/conn.needsUpdate.html | 4 +- functions/conn.refreshQR.html | 4 +- functions/conn.setKeepAlive.html | 4 +- functions/conn.setLimit.html | 24 ++--- functions/conn.setMultiDevice.html | 4 +- functions/contact.get.html | 4 +- functions/contact.getBusinessProfile.html | 4 +- functions/contact.getCommonGroups.html | 4 +- functions/contact.getProfilePictureUrl.html | 4 +- functions/contact.getStatus.html | 4 +- functions/contact.list.html | 4 +- functions/contact.queryExists.html | 4 +- functions/group.addParticipants.html | 4 +- functions/group.approve.html | 4 +- functions/group.canAdd.html | 4 +- functions/group.canDemote.html | 4 +- functions/group.canPromote.html | 4 +- functions/group.canRemove.html | 4 +- functions/group.create.html | 4 +- functions/group.demoteParticipants.html | 4 +- functions/group.getAllGroups.html | 4 +- .../group.getGroupInfoFromInviteCode.html | 4 +- functions/group.getGroupSizeLimit.html | 4 +- functions/group.getInviteCode.html | 4 +- functions/group.getMembershipRequests.html | 4 +- functions/group.getParticipants.html | 4 +- functions/group.getPastParticipants.html | 4 +- functions/group.join.html | 4 +- functions/group.leave.html | 4 +- functions/group.promoteParticipants.html | 4 +- functions/group.reject.html | 4 +- functions/group.removeIcon.html | 4 +- functions/group.removeParticipants.html | 4 +- functions/group.revokeInviteCode.html | 4 +- functions/group.setDescription.html | 4 +- functions/group.setIcon.html | 4 +- functions/group.setProperty.html | 4 +- functions/group.setSubject.html | 4 +- functions/labels.addNewLabel.html | 4 +- functions/labels.addOrRemoveLabels.html | 4 +- functions/labels.colorIsInLabelPalette.html | 4 +- functions/labels.editLabel.html | 4 +- functions/newsletter.create.html | 4 +- functions/newsletter.destroy.html | 4 +- functions/newsletter.edit.html | 4 +- functions/newsletter.getSubscribers.html | 4 +- functions/newsletter.mute.html | 4 +- functions/order.get.html | 4 +- functions/profile.editBusinessProfile.html | 4 +- functions/profile.getMyProfileName.html | 4 +- functions/profile.getMyStatus.html | 4 +- functions/profile.isBusiness.html | 4 +- functions/profile.removeMyProfilePicture.html | 4 +- functions/profile.setMyProfileName.html | 4 +- functions/profile.setMyProfilePicture.html | 4 +- functions/profile.setMyStatus.html | 4 +- functions/status.sendImageStatus.html | 4 +- functions/status.sendReadStatus.html | 4 +- functions/status.sendTextStatus.html | 4 +- functions/status.sendVideoStatus.html | 4 +- functions/status.updateParticipants.html | 4 +- functions/util.getVideoInfoFromBuffer.html | 4 +- functions/whatsapp.functions.GROUP_JID.html | 4 +- ...tsapp.functions.addAndSendMessageEdit.html | 4 +- ...hatsapp.functions.addAndSendMsgToChat.html | 8 +- .../whatsapp.functions.addParticipants.html | 8 +- functions/whatsapp.functions.addProduct.html | 8 +- ...atsapp.functions.addToLabelCollection.html | 4 +- .../whatsapp.functions.blockContact.html | 8 +- ...p.functions.calculateFilehashFromBlob.html | 4 +- .../whatsapp.functions.canEditCaption.html | 4 +- functions/whatsapp.functions.canEditMsg.html | 4 +- .../whatsapp.functions.canMarkPlayed.html | 6 +- functions/whatsapp.functions.canReplyMsg.html | 4 +- ...s.changeOptInStatusForExternalWebBeta.html | 4 +- .../whatsapp.functions.colorIndexToHex.html | 4 +- ...tsapp.functions.createBusinessCatalog.html | 4 +- .../whatsapp.functions.createCollection.html | 4 +- functions/whatsapp.functions.createGroup.html | 4 +- .../whatsapp.functions.createMsgProtobuf.html | 8 +- ...tsapp.functions.createNewsletterQuery.html | 4 +- ...app.functions.createOrUpdateReactions.html | 8 +- functions/whatsapp.functions.createOrder.html | 4 +- ...functions.currencyForCountryShortcode.html | 4 +- .../whatsapp.functions.deleteCollection.html | 4 +- .../whatsapp.functions.deleteNewsletter.html | 4 +- .../whatsapp.functions.deleteProducts.html | 8 +- ...functions.demoteCommunityParticipants.html | 4 +- ...whatsapp.functions.demoteParticipants.html | 8 +- ...hatsapp.functions.editBusinessProfile.html | 4 +- .../whatsapp.functions.editCollection.html | 4 +- ...unctions.editNewsletterMetadataAction.html | 4 +- functions/whatsapp.functions.editProduct.html | 8 +- ...atsapp.functions.encodeMaybeMediaType.html | 4 +- ...sapp.functions.encryptAndSendGroupMsg.html | 8 +- .../whatsapp.functions.encryptAndSendMsg.html | 8 +- ....functions.encryptAndSendSenderKeyMsg.html | 8 +- ...app.functions.encryptAndSendStatusMsg.html | 4 +- ...whatsapp.functions.encryptMsgProtobuf.html | 4 +- .../whatsapp.functions.fetchLinkPreview.html | 10 +- functions/whatsapp.functions.findChat.html | 8 +- .../whatsapp.functions.findCommonGroups.html | 4 +- .../whatsapp.functions.findFirstWebLink.html | 8 +- ...sapp.functions.forwardMessagesToChats.html | 6 +- ...tsapp.functions.frontendFireAndForget.html | 4 +- ...tions.genLinkDeviceCodeForPhoneNumber.html | 4 +- ...tsapp.functions.genMinimalLinkPreview.html | 8 +- ...ctions.generateVideoThumbsAndDuration.html | 6 +- ...atsapp.functions.getABPropConfigValue.html | 8 +- functions/whatsapp.functions.getAsMms.html | 4 +- ...pp.functions.getCanRequestPhoneNumber.html | 4 +- ...pp.functions.getCommunityParticipants.html | 4 +- ....functions.getCountryShortcodeByPhone.html | 4 +- .../whatsapp.functions.getCurrentLid.html | 6 +- .../whatsapp.functions.getDisplayName.html | 4 +- ...pp.functions.getDisplayNameOrPnForLid.html | 4 +- ...whatsapp.functions.getEphemeralFields.html | 4 +- ...unctions.getErrorCodeFromLogoutReason.html | 4 +- .../whatsapp.functions.getFanOutList.html | 8 +- .../whatsapp.functions.getFormattedName.html | 4 +- .../whatsapp.functions.getFormattedPhone.html | 4 +- ...tsapp.functions.getFormattedShortName.html | 4 +- ...rmattedShortNameWithNonBreakingSpaces.html | 4 +- .../whatsapp.functions.getFormattedUser.html | 4 +- ...tsapp.functions.getGroupSenderKeyList.html | 6 +- .../whatsapp.functions.getGroupSizeLimit.html | 4 +- functions/whatsapp.functions.getHeader.html | 4 +- ...sapp.functions.getHistorySyncProgress.html | 4 +- .../whatsapp.functions.getIsBroadcast.html | 4 +- ...pp.functions.getIsDisplayNameApproved.html | 4 +- functions/whatsapp.functions.getIsGroup.html | 4 +- functions/whatsapp.functions.getIsIAS.html | 4 +- functions/whatsapp.functions.getIsMe.html | 4 +- .../whatsapp.functions.getIsMyContact.html | 4 +- functions/whatsapp.functions.getIsPSA.html | 4 +- ...hatsapp.functions.getIsSupportAccount.html | 4 +- functions/whatsapp.functions.getIsUser.html | 4 +- .../whatsapp.functions.getIsWAContact.html | 4 +- ...nctions.getMembershipApprovalRequests.html | 4 +- .../whatsapp.functions.getMentionName.html | 4 +- ...pp.functions.getNewsletterSubscribers.html | 4 +- .../whatsapp.functions.getNextLabelId.html | 4 +- .../whatsapp.functions.getNotifyName.html | 4 +- .../whatsapp.functions.getNumChatsPinned.html | 8 +- .../whatsapp.functions.getOrderInfo.html | 4 +- .../whatsapp.functions.getParticipants.html | 6 +- functions/whatsapp.functions.getPnForLid.html | 4 +- ...tsapp.functions.getPremiumMessageName.html | 4 +- ...nctions.getPrivacyDisallowedListTable.html | 4 +- functions/whatsapp.functions.getPushname.html | 6 +- .../whatsapp.functions.getQuotedMsgObj.html | 4 +- .../whatsapp.functions.getSearchContext.html | 4 +- .../whatsapp.functions.getSearchName.html | 4 +- ...tsapp.functions.getSearchVerifiedName.html | 4 +- ...unctions.getShouldForceBusinessUpdate.html | 4 +- ...ons.getShowBusinessCheckmarkAsPrimary.html | 4 +- ...s.getShowBusinessCheckmarkAsSecondary.html | 4 +- ...ns.getShowBusinessCheckmarkInChatlist.html | 4 +- functions/whatsapp.functions.getStatus.html | 8 +- ...whatsapp.functions.getStatusAllowList.html | 4 +- .../whatsapp.functions.getTableVotes.html | 4 +- functions/whatsapp.functions.getUserhash.html | 4 +- functions/whatsapp.functions.getUserid.html | 4 +- functions/whatsapp.functions.getVotes.html | 6 +- ...s.getWhatsAppWebExternalBetaJoinedIdb.html | 4 +- ...hatsapp.functions.handleChatSimpleAck.html | 8 +- ...app.functions.handleChatSimpleReceipt.html | 8 +- ...atsapp.functions.handleGroupSimpleAck.html | 8 +- ...pp.functions.handleGroupSimpleReceipt.html | 8 +- .../whatsapp.functions.handleSingleMsg.html | 4 +- ...tsapp.functions.handleStatusSimpleAck.html | 8 +- ...p.functions.handleStatusSimpleReceipt.html | 8 +- ....functions.initializeAltDeviceLinking.html | 4 +- .../whatsapp.functions.isAnimatedWebp.html | 4 +- .../whatsapp.functions.isAuthenticated.html | 8 +- functions/whatsapp.functions.isLoggedIn.html | 8 +- .../whatsapp.functions.isRegistered.html | 4 +- .../whatsapp.functions.isUnreadTypeMsg.html | 4 +- functions/whatsapp.functions.isWid.html | 4 +- ...whatsapp.functions.joinGroupViaInvite.html | 4 +- functions/whatsapp.functions.keepMessage.html | 4 +- .../whatsapp.functions.labelAddAction.html | 4 +- ...hatsapp.functions.markForgetSenderKey.html | 6 +- functions/whatsapp.functions.markPlayed.html | 8 +- functions/whatsapp.functions.markUnread.html | 6 +- ...tsapp.functions.mediaTypeFromProtobuf.html | 10 +- ...tions.membershipApprovalRequestAction.html | 4 +- ...hatsapp.functions.msgDataFromMsgModel.html | 4 +- .../whatsapp.functions.msgFindQuery.html | 4 +- .../whatsapp.functions.muteNewsletter.html | 4 +- ...tsapp.functions.primaryFeatureEnabled.html | 4 +- ...atsapp.functions.processRawAudioVideo.html | 4 +- .../whatsapp.functions.processRawMedia.html | 4 +- .../whatsapp.functions.processRawSticker.html | 4 +- ...atsapp.functions.productVisibilitySet.html | 4 +- ...unctions.promoteCommunityParticipants.html | 4 +- ...hatsapp.functions.promoteParticipants.html | 8 +- .../whatsapp.functions.queryCatalog.html | 4 +- ...whatsapp.functions.queryCollectionsIQ.html | 4 +- ...atsapp.functions.queryGroupInviteCode.html | 4 +- ...unctions.queryNewsletterMetadataByJid.html | 4 +- functions/whatsapp.functions.queryOrder.html | 4 +- .../whatsapp.functions.queryProduct.html | 4 +- functions/whatsapp.functions.randomHex.html | 6 +- .../whatsapp.functions.randomMessageId.html | 12 +-- ...whatsapp.functions.removeParticipants.html | 8 +- ...atsapp.functions.requestDeletePicture.html | 6 +- ...atsapp.functions.resetGroupInviteCode.html | 4 +- .../whatsapp.functions.revokeStatus.html | 4 +- ...hatsapp.functions.sendAddParticipants.html | 4 +- functions/whatsapp.functions.sendClear.html | 8 +- ...hatsapp.functions.sendCreateCommunity.html | 4 +- .../whatsapp.functions.sendCreateGroup.html | 4 +- ...app.functions.sendDeactivateCommunity.html | 4 +- functions/whatsapp.functions.sendDelete.html | 8 +- ...sapp.functions.sendDemoteParticipants.html | 4 +- .../whatsapp.functions.sendExitGroup.html | 8 +- ...sapp.functions.sendJoinGroupViaInvite.html | 6 +- .../whatsapp.functions.sendLinkSubgroups.html | 4 +- ...pp.functions.sendNewsletterMessageJob.html | 4 +- .../whatsapp.functions.sendPinInChatMsg.html | 4 +- .../whatsapp.functions.sendProductToChat.html | 8 +- ...app.functions.sendPromoteParticipants.html | 4 +- .../whatsapp.functions.sendQueryExists.html | 6 +- ...atsapp.functions.sendQueryGroupInvite.html | 6 +- ...pp.functions.sendQueryGroupInviteCode.html | 4 +- .../whatsapp.functions.sendReactionToMsg.html | 8 +- ...sapp.functions.sendRemoveParticipants.html | 4 +- ...p.functions.sendRevokeGroupInviteCode.html | 6 +- functions/whatsapp.functions.sendSeen.html | 6 +- ...app.functions.sendSetGroupDescription.html | 6 +- ...atsapp.functions.sendSetGroupProperty.html | 6 +- ...hatsapp.functions.sendSetGroupSubject.html | 6 +- .../whatsapp.functions.sendSetPicture.html | 6 +- .../whatsapp.functions.sendTextMsgToChat.html | 8 +- ...hatsapp.functions.sendUnlinkSubgroups.html | 4 +- functions/whatsapp.functions.setArchive.html | 10 +- functions/whatsapp.functions.setMyStatus.html | 8 +- functions/whatsapp.functions.setPin.html | 12 +-- functions/whatsapp.functions.setPushname.html | 4 +- .../whatsapp.functions.syncABPropsTask.html | 4 +- ...p.functions.typeAttributeFromProtobuf.html | 8 +- .../whatsapp.functions.unblockContact.html | 8 +- functions/whatsapp.functions.unixTime.html | 4 +- functions/whatsapp.functions.unixTimeMs.html | 4 +- .../whatsapp.functions.unmuteNewsletter.html | 4 +- functions/whatsapp.functions.updateCart.html | 4 +- .../whatsapp.functions.updateCartEnabled.html | 4 +- ...sapp.functions.updateDBForGroupAction.html | 4 +- ...p.functions.updateNewsletterMsgRecord.html | 4 +- ...whatsapp.functions.updateParticipants.html | 6 +- functions/whatsapp.functions.uploadMedia.html | 4 +- ...whatsapp.functions.uploadProductImage.html | 6 +- .../whatsapp.functions.uploadThumbnail.html | 6 +- functions/whatsapp.functions.upsertVotes.html | 6 +- .../whatsapp.functions.voteFromDbRow.html | 4 +- .../whatsapp.websocket.ensureE2ESessions.html | 4 +- functions/whatsapp.websocket.generateId.html | 4 +- .../whatsapp.websocket.sendSmaxStanza.html | 4 +- functions/whatsapp.websocket.smax.html | 4 +- .../whatsapp.websocket.startWebComms.html | 4 +- functions/whatsapp.websocket.stopComms.html | 4 +- functions/whatsapp.websocket.wap.html | 4 +- interfaces/Config.html | 16 +-- interfaces/chat.AudioMessageOptions.html | 46 ++++----- interfaces/chat.AutoDetectMessageOptions.html | 38 +++---- interfaces/chat.DocumentMessageOptions.html | 40 ++++---- interfaces/chat.FileMessageOptions.html | 38 +++---- interfaces/chat.GroupInviteMessage.html | 38 +++---- interfaces/chat.ImageMessageOptions.html | 40 ++++---- interfaces/chat.LinkPreviewOptions.html | 6 +- interfaces/chat.ListMessageOptions.html | 38 +++---- interfaces/chat.LocationMessageOptions.html | 38 +++---- interfaces/chat.OrderMessageOptions.html | 38 +++---- interfaces/chat.PoolMessageOptions.html | 38 +++---- .../chat.ScheduledCallMessageOptions.html | 38 +++---- interfaces/chat.SendMessageOptions.html | 38 +++---- interfaces/chat.StickerMessageOptions.html | 38 +++---- interfaces/chat.VideoMessageOptions.html | 40 ++++---- interfaces/conn.AuthCodeMultiDevice.html | 2 +- interfaces/conn.AuthCodeSingleDevice.html | 2 +- interfaces/ev.CallEventTypes.html | 4 +- interfaces/ev.ChatEventTypes.html | 16 +-- interfaces/ev.ConnEventTypes.html | 24 ++--- interfaces/ev.GroupEventTypes.html | 4 +- interfaces/ev.OrderEventTypes.html | 4 +- interfaces/whatsapp.VCardData.html | 2 +- interfaces/whatsapp.functions.Group.html | 4 +- .../whatsapp.functions.GroupActionChange.html | 4 +- ...sapp.functions.GroupActionParticipant.html | 4 +- ...p.functions.QueryCollectionsIQtParams.html | 2 +- .../whatsapp.functions.ReactionReturn.html | 6 +- .../whatsapp.functions.SimpleAckData.html | 2 +- modules/whatsapp.Base64.html | 6 +- modules/whatsapp.Browser.html | 8 +- modules/whatsapp.ChatPresence.html | 8 +- modules/whatsapp.ImageUtils.html | 8 +- modules/whatsapp.IsOfficialClient.html | 4 +- modules/whatsapp.MediaObjectUtil.html | 6 +- modules/whatsapp.MediaPrep.html | 6 +- modules/whatsapp.MediaUtils.html | 6 +- modules/whatsapp.UserPrefs.html | 4 +- modules/whatsapp.VCard.html | 8 +- modules/whatsapp.WidFactory.html | 8 +- modules/whatsapp.multidevice.adv.html | 8 +- ...hatsapp.Base64.BASE64_DATA_URL_SCHEME.html | 2 +- variables/whatsapp.BlocklistStore.html | 6 +- ...hatsapp.BusinessCategoriesResultStore.html | 6 +- variables/whatsapp.BusinessProfileStore.html | 6 +- variables/whatsapp.CallStore.html | 8 +- variables/whatsapp.CartStore.html | 6 +- variables/whatsapp.CatalogStore.html | 6 +- variables/whatsapp.ChatStore.html | 6 +- variables/whatsapp.Cmd.html | 8 +- variables/whatsapp.ComposeBoxActions.html | 4 +- variables/whatsapp.Conn.html | 6 +- variables/whatsapp.Constants.html | 8 +- variables/whatsapp.ContactStore.html | 6 +- variables/whatsapp.EmojiVariantStore.html | 6 +- variables/whatsapp.GroupMetadataStore.html | 6 +- variables/whatsapp.LabelStore.html | 6 +- variables/whatsapp.MediaBlobCache.html | 6 +- variables/whatsapp.MsgInfoStore.html | 6 +- variables/whatsapp.MsgStore.html | 6 +- variables/whatsapp.MuteStore.html | 4 +- variables/whatsapp.NetworkStatus.html | 4 +- variables/whatsapp.NewsletterStore.html | 6 +- variables/whatsapp.OrderStore.html | 6 +- variables/whatsapp.PresenceStore.html | 6 +- .../whatsapp.ProductMessageListStore.html | 4 +- variables/whatsapp.ProfilePicThumbStore.html | 6 +- variables/whatsapp.QuickReplyStore.html | 6 +- variables/whatsapp.ReactionsStore.html | 6 +- variables/whatsapp.RecentEmojiStore.html | 6 +- variables/whatsapp.RecentStickerStore.html | 6 +- variables/whatsapp.ServerProps.html | 6 +- variables/whatsapp.Socket.html | 6 +- variables/whatsapp.StarredMsgStore.html | 6 +- variables/whatsapp.StatusStore.html | 4 +- variables/whatsapp.StatusV3Store.html | 6 +- variables/whatsapp.StickerPackStore.html | 6 +- variables/whatsapp.StickerSearchStore.html | 6 +- variables/whatsapp.StickerStore.html | 6 +- variables/whatsapp.Stream.html | 6 +- variables/whatsapp.contants.DROP_ATTR.html | 4 +- ...atsapp.contants.SANITIZED_VERSION_STR.html | 4 +- .../whatsapp.enums.SYSTEM_MESSAGE_TYPES.html | 8 +- variables/whatsapp.functions.STATUS_JID.html | 4 +- .../whatsapp.multidevice.waNoiseInfo.html | 10 +- .../whatsapp.multidevice.waSignalStore.html | 8 +- 561 files changed, 3421 insertions(+), 3421 deletions(-) diff --git a/classes/util.WPPError.html b/classes/util.WPPError.html index 8398a9f704..f38d15952a 100644 --- a/classes/util.WPPError.html +++ b/classes/util.WPPError.html @@ -7,6 +7,6 @@ stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new WPPError(code, message, extra?): WPPError

  • Parameters

    • code: string
    • message: string
    • extra: {
          [key: string]: any;
      } = {}
      • [key: string]: any

    Returns WPPError

Properties

Readonlycode

code: string

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

-

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

-

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/whatsapp.AggReactionsCollection.html b/classes/whatsapp.AggReactionsCollection.html index d8fed5e085..2af581af4f 100644 --- a/classes/whatsapp.AggReactionsCollection.html +++ b/classes/whatsapp.AggReactionsCollection.html @@ -1,6 +1,6 @@ -AggReactionsCollection | @wppconnect/wa-js - v3.10.1

Class AggReactionsCollection

Whatsapp

81130

-

Whatsapp

981130 >= 2.2222.8

-

Hierarchy (view full)

Constructors

constructor +AggReactionsCollection | @wppconnect/wa-js - v3.10.1

Class AggReactionsCollection

Whatsapp

81130

+

Whatsapp

981130 >= 2.2222.8

+

Hierarchy (view full)

Constructors

constructor

Properties

findFirst modelClass model @@ -57,10 +57,10 @@

Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | AggReactionsModel

  • Parameters

    Returns undefined | AggReactionsModel

    • modelClass

    modelClass: AggReactionsModel

    Staticmodel

    model: AggReactionsModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: AggReactionsModel, index: number, array: AggReactionsModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: AggReactionsModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: AggReactionsModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: AggReactionsModel, index: number, array: AggReactionsModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): AggReactionsModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.AggReactionsModel.html b/classes/whatsapp.AggReactionsModel.html index c8752b1915..418cf9fce3 100644 --- a/classes/whatsapp.AggReactionsModel.html +++ b/classes/whatsapp.AggReactionsModel.html @@ -1,6 +1,6 @@ -AggReactionsModel | @wppconnect/wa-js - v3.10.1

    Class AggReactionsModel

    Whatsapp

    81130

    -

    Whatsapp

    981130 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +AggReactionsModel | @wppconnect/wa-js - v3.10.1

    Class AggReactionsModel

    Whatsapp

    81130

    +

    Whatsapp

    981130 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    aggregateEmoji? attributes collection? @@ -44,40 +44,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionalaggregateEmoji

    aggregateEmoji?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    hasReactionByMe

    hasReactionByMe: boolean

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:aggregateEmoji: undefined | number;
        change:hasReactionByMe: number;
        change:id: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    senders

    senders: ReactionsSendersCollection

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalaggregateEmoji

    aggregateEmoji?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    hasReactionByMe

    hasReactionByMe: boolean

    Optionalid

    id?: any

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:aggregateEmoji: undefined | number;
        change:hasReactionByMe: number;
        change:id: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    senders

    senders: ReactionsSendersCollection

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.AttachMediaModel.html b/classes/whatsapp.AttachMediaModel.html index 7024c2de3f..4d2fc0c9a1 100644 --- a/classes/whatsapp.AttachMediaModel.html +++ b/classes/whatsapp.AttachMediaModel.html @@ -1,6 +1,6 @@ -AttachMediaModel | @wppconnect/wa-js - v3.10.1

    Class AttachMediaModel

    Whatsapp

    80666

    -

    Whatsapp

    480666 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +AttachMediaModel | @wppconnect/wa-js - v3.10.1

    Class AttachMediaModel

    Whatsapp

    80666

    +

    Whatsapp

    480666 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes caption? collection? @@ -79,40 +79,40 @@

    WhatsappupdateMediaEditorData updatePreview isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcaption

    caption?: any

    Optionalcollection

    collection?: undefined

    OptionaldocumentPageCount

    documentPageCount?: any

    OptionaleditedFile

    editedFile?: any

    Optionalexception

    exception?: any

    Optionalfile

    file?: any

    Optional ReadonlyfileExt

    fileExt?: any

    Optionalfilename

    filename?: any

    OptionalfileOrigin

    fileOrigin?: any

    Optional Readonlyfilesize

    filesize?: any

    OptionalfullPreview

    fullPreview?: any

    OptionalfullPreviewSize

    fullPreviewSize?: any

    OptionalgifAttribution

    gifAttribution?: any

    Optionalid

    id?: any

    isGif

    isGif: boolean

    ReadonlyisState

    isState: true

    isVcardOverMmsDocument

    isVcardOverMmsDocument: boolean

    OptionalmediaEditorData

    mediaEditorData?: any

    OptionalmediaPrep

    mediaPrep?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:caption: undefined | number;
        change:documentPageCount: undefined | number;
        change:editedFile: undefined | number;
        change:exception: undefined | number;
        change:file: undefined | number;
        change:fileExt: undefined | number;
        change:filename: undefined | number;
        change:fileOrigin: undefined | number;
        change:filesize: undefined | number;
        change:fullPreview: undefined | number;
        change:fullPreviewSize: undefined | number;
        change:gifAttribution: undefined | number;
        change:id: undefined | number;
        change:isGif: number;
        change:isVcardOverMmsDocument: number;
        change:mediaEditorData: undefined | number;
        change:mediaPrep: undefined | number;
        change:mimetype: undefined | number;
        change:originalMimetype: undefined | number;
        change:preview: undefined | number;
        change:previewable: undefined | number;
        change:processPromise: undefined | number;
        change:stale: undefined | number;
        change:state: undefined | number;
        change:type: undefined | number;
        change:uiProcessed: undefined | number;
    }

    OptionaloriginalMimetype

    originalMimetype?: any

    Optionalparent

    parent?: any

    Optionalpreview

    preview?: any

    Optional Readonlypreviewable

    previewable?: any

    OptionalprocessPromise

    processPromise?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalstate

    state?: any

    Optionaltype

    type?: any

    OptionaluiProcessed

    uiProcessed?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canRedoMediaEditorData

    canUndoMediaEditorData

    clear

    decObservers

    delete

    emit

    get

    getDefault

    getFileType

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    isViewableOnce

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcaption

    caption?: any

    Optionalcollection

    collection?: undefined

    OptionaldocumentPageCount

    documentPageCount?: any

    OptionaleditedFile

    editedFile?: any

    Optionalexception

    exception?: any

    Optionalfile

    file?: any

    Optional ReadonlyfileExt

    fileExt?: any

    Optionalfilename

    filename?: any

    OptionalfileOrigin

    fileOrigin?: any

    Optional Readonlyfilesize

    filesize?: any

    OptionalfullPreview

    fullPreview?: any

    OptionalfullPreviewSize

    fullPreviewSize?: any

    OptionalgifAttribution

    gifAttribution?: any

    Optionalid

    id?: any

    isGif

    isGif: boolean

    ReadonlyisState

    isState

    isVcardOverMmsDocument

    isVcardOverMmsDocument: boolean

    OptionalmediaEditorData

    mediaEditorData?: any

    OptionalmediaPrep

    mediaPrep?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:caption: undefined | number;
        change:documentPageCount: undefined | number;
        change:editedFile: undefined | number;
        change:exception: undefined | number;
        change:file: undefined | number;
        change:fileExt: undefined | number;
        change:filename: undefined | number;
        change:fileOrigin: undefined | number;
        change:filesize: undefined | number;
        change:fullPreview: undefined | number;
        change:fullPreviewSize: undefined | number;
        change:gifAttribution: undefined | number;
        change:id: undefined | number;
        change:isGif: number;
        change:isVcardOverMmsDocument: number;
        change:mediaEditorData: undefined | number;
        change:mediaPrep: undefined | number;
        change:mimetype: undefined | number;
        change:originalMimetype: undefined | number;
        change:preview: undefined | number;
        change:previewable: undefined | number;
        change:processPromise: undefined | number;
        change:stale: undefined | number;
        change:state: undefined | number;
        change:type: undefined | number;
        change:uiProcessed: undefined | number;
    }

    OptionaloriginalMimetype

    originalMimetype?: any

    Optionalparent

    parent?: any

    Optionalpreview

    preview?: any

    Optional Readonlypreviewable

    previewable?: any

    OptionalprocessPromise

    processPromise?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalstate

    state?: any

    Optionaltype

    type?: any

    OptionaluiProcessed

    uiProcessed?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canRedoMediaEditorData

    canUndoMediaEditorData

    clear

    decObservers

    delete

    emit

    get

    getDefault

    getFileType

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    isViewableOnce

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    processAttachment

    redoMediaEditorData

    removeAllListeners

    removeListener

    reset

    sendToChat

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    sendToChat

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    undoMediaEditorData

    unset

    updateCaption

    updateEditedFile

    updateFullPreview

    updateMediaEditorData

    updatePreview

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    undoMediaEditorData

    unset

    updateCaption

    updateEditedFile

    updateFullPreview

    updateMediaEditorData

    updatePreview

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.BaseCollection.html b/classes/whatsapp.BaseCollection.html index be8b097867..52ac4cd8e0 100644 --- a/classes/whatsapp.BaseCollection.html +++ b/classes/whatsapp.BaseCollection.html @@ -1,6 +1,6 @@ -BaseCollection | @wppconnect/wa-js - v3.10.1

    Class BaseCollection<C, A>

    Whatsapp

    1255

    -

    Whatsapp

    801255 >= 2.2222.8

    -

    Type Parameters

    • C
    • A = C | C[]

    Hierarchy (view full)

    Constructors

    constructor +BaseCollection | @wppconnect/wa-js - v3.10.1

    Class BaseCollection<C, A>

    Whatsapp

    1255

    +

    Whatsapp

    801255 >= 2.2222.8

    +

    Type Parameters

    • C
    • A = C | C[]

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -69,10 +69,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | C

  • Parameters

    • predicate: ((value: C, index: number, obj: C[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          • value: C
          • index: number
          • obj: C[]

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | C

    • modelClass

    modelClass: C

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      • S

      Parameters

      • predicate: ((value: C, index: number, array: C[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -96,33 +96,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: C

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: C

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: C, index: number, array: C[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          • (value, index, array): U

          • Parameters

            • value: C
            • index: number
            • array: C[]

            Returns U

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -134,8 +134,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): C[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -148,8 +148,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.BlocklistCollection.html b/classes/whatsapp.BlocklistCollection.html index 01acfc5ef0..1d6cf40958 100644 --- a/classes/whatsapp.BlocklistCollection.html +++ b/classes/whatsapp.BlocklistCollection.html @@ -1,6 +1,6 @@ -BlocklistCollection | @wppconnect/wa-js - v3.10.1

    Class BlocklistCollection

    Whatsapp

    32826

    -

    Whatsapp

    132826 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +BlocklistCollection | @wppconnect/wa-js - v3.10.1

    Class BlocklistCollection

    Whatsapp

    32826

    +

    Whatsapp

    132826 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -59,10 +59,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | BlocklistModel

  • Parameters

    Returns undefined | BlocklistModel

    • modelClass

    modelClass: BlocklistModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: BlocklistModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    blockContact

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    blockContact

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: BlocklistModel, index: number, array: BlocklistModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -86,33 +86,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: BlocklistModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: BlocklistModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: BlocklistModel, index: number, array: BlocklistModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -124,8 +124,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): BlocklistModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    unblockContact

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unblockContact

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.BlocklistModel.html b/classes/whatsapp.BlocklistModel.html index 3d308d40ac..0b00887c02 100644 --- a/classes/whatsapp.BlocklistModel.html +++ b/classes/whatsapp.BlocklistModel.html @@ -1,6 +1,6 @@ -BlocklistModel | @wppconnect/wa-js - v3.10.1

    Class BlocklistModel

    Whatsapp

    89310

    -

    Whatsapp

    689310 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +BlocklistModel | @wppconnect/wa-js - v3.10.1

    Class BlocklistModel

    Whatsapp

    89310

    +

    Whatsapp

    689310 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id @@ -45,40 +45,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: BlocklistCollection

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    contact

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: BlocklistCollection

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    contact

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.BusinessCategoriesResultCollection.html b/classes/whatsapp.BusinessCategoriesResultCollection.html index 4f5ccdda7b..663e0b2431 100644 --- a/classes/whatsapp.BusinessCategoriesResultCollection.html +++ b/classes/whatsapp.BusinessCategoriesResultCollection.html @@ -1,6 +1,6 @@ -BusinessCategoriesResultCollection | @wppconnect/wa-js - v3.10.1

    Class BusinessCategoriesResultCollection

    Whatsapp

    3754

    -

    Whatsapp

    203754 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +BusinessCategoriesResultCollection | @wppconnect/wa-js - v3.10.1

    Class BusinessCategoriesResultCollection

    Whatsapp

    3754

    +

    Whatsapp

    203754 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -58,10 +58,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | BusinessCategoriesResultModel

  • Parameters

    Returns undefined | BusinessCategoriesResultModel

    • modelClass

    modelClass: BusinessCategoriesResultModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: BusinessCategoriesResultModel

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: BusinessCategoriesResultModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: BusinessCategoriesResultModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -123,8 +123,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): BusinessCategoriesResultModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.BusinessCategoriesResultModel.html b/classes/whatsapp.BusinessCategoriesResultModel.html index db4a2062e6..53eedcb04b 100644 --- a/classes/whatsapp.BusinessCategoriesResultModel.html +++ b/classes/whatsapp.BusinessCategoriesResultModel.html @@ -1,6 +1,6 @@ -BusinessCategoriesResultModel | @wppconnect/wa-js - v3.10.1

    Class BusinessCategoriesResultModel

    Whatsapp

    32742

    -

    Whatsapp

    132742 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +BusinessCategoriesResultModel | @wppconnect/wa-js - v3.10.1

    Class BusinessCategoriesResultModel

    Whatsapp

    32742

    +

    Whatsapp

    132742 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes categories? collection? @@ -45,40 +45,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcategories

    categories?: any

    Optionalcollection

    collection?: BusinessCategoriesResultCollection

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:categories: undefined | number;
        change:id: number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcategories

    categories?: any

    Optionalcollection

    collection?: BusinessCategoriesResultCollection

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:categories: undefined | number;
        change:id: number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.BusinessProfileCollection.html b/classes/whatsapp.BusinessProfileCollection.html index 8472b1d96c..ecdb8bc60e 100644 --- a/classes/whatsapp.BusinessProfileCollection.html +++ b/classes/whatsapp.BusinessProfileCollection.html @@ -1,6 +1,6 @@ -BusinessProfileCollection | @wppconnect/wa-js - v3.10.1

    Class BusinessProfileCollection

    Whatsapp

    93581

    -

    Whatsapp

    493581 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +BusinessProfileCollection | @wppconnect/wa-js - v3.10.1

    Class BusinessProfileCollection

    Whatsapp

    93581

    +

    Whatsapp

    493581 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -61,10 +61,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | BusinessProfileModel

  • Parameters

    Returns undefined | BusinessProfileModel

    • modelClass

    modelClass: BusinessProfileModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: BusinessProfileModel

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: BusinessProfileModel, index: number, array: BusinessProfileModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -88,33 +88,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    getValid

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: BusinessProfileModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: BusinessProfileModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: BusinessProfileModel, index: number, array: BusinessProfileModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -126,8 +126,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): BusinessProfileModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.BusinessProfileModel.html b/classes/whatsapp.BusinessProfileModel.html index 2c84f3cc30..e9065b5e51 100644 --- a/classes/whatsapp.BusinessProfileModel.html +++ b/classes/whatsapp.BusinessProfileModel.html @@ -1,6 +1,6 @@ -BusinessProfileModel | @wppconnect/wa-js - v3.10.1

    Class BusinessProfileModel

    Whatsapp

    48018

    -

    Whatsapp

    348018 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +BusinessProfileModel | @wppconnect/wa-js - v3.10.1

    Class BusinessProfileModel

    Whatsapp

    48018

    +

    Whatsapp

    348018 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    address? attributes businessHours? @@ -58,40 +58,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Optionaladdress

    address?: any

    Readonlyattributes

    attributes: Props & Session

    OptionalbusinessHours

    businessHours?: any

    OptionalcatalogStatus

    catalogStatus?: any

    Optionalcategories

    categories?: any

    Optionalcollection

    collection?: BusinessProfileCollection

    Optionaldescription

    description?: any

    Optionalemail

    email?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState: true

    Optionallatitude

    latitude?: any

    Optionallongitude

    longitude?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:address: undefined | number;
        change:businessHours: undefined | number;
        change:catalogStatus: undefined | number;
        change:categories: undefined | number;
        change:description: undefined | number;
        change:email: undefined | number;
        change:id: number;
        change:latitude: undefined | number;
        change:longitude: undefined | number;
        change:profileOptions: undefined | number;
        change:stale: undefined | number;
        change:structuredAddress: undefined | number;
        change:tag: undefined | number;
        change:website: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalprofileOptions

    profileOptions?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    OptionalstructuredAddress

    structuredAddress?: any

    Optionaltag

    tag?: any

    Optionalwebsite

    website?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    isValid

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Optionaladdress

    address?: any

    Readonlyattributes

    attributes: Props & Session

    OptionalbusinessHours

    businessHours?: any

    OptionalcatalogStatus

    catalogStatus?: any

    Optionalcategories

    categories?: any

    Optionalcollection

    collection?: BusinessProfileCollection

    Optionaldescription

    description?: any

    Optionalemail

    email?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState

    Optionallatitude

    latitude?: any

    Optionallongitude

    longitude?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:address: undefined | number;
        change:businessHours: undefined | number;
        change:catalogStatus: undefined | number;
        change:categories: undefined | number;
        change:description: undefined | number;
        change:email: undefined | number;
        change:id: number;
        change:latitude: undefined | number;
        change:longitude: undefined | number;
        change:profileOptions: undefined | number;
        change:stale: undefined | number;
        change:structuredAddress: undefined | number;
        change:tag: undefined | number;
        change:website: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalprofileOptions

    profileOptions?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    OptionalstructuredAddress

    structuredAddress?: any

    Optionaltag

    tag?: any

    Optionalwebsite

    website?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    isValid

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    markStale

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ButtonCollection.html b/classes/whatsapp.ButtonCollection.html index 67d7d2156d..7fb0c813d8 100644 --- a/classes/whatsapp.ButtonCollection.html +++ b/classes/whatsapp.ButtonCollection.html @@ -1,5 +1,5 @@ -ButtonCollection | @wppconnect/wa-js - v3.10.1

    Class ButtonCollection

    Whatsapp

    47688

    -

    Hierarchy (view full)

    Constructors

    constructor +ButtonCollection | @wppconnect/wa-js - v3.10.1

    Class ButtonCollection

    Whatsapp

    47688

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -68,10 +68,10 @@
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ReplyButtonModel

  • Parameters

    Returns undefined | ReplyButtonModel

    • modelClass

    modelClass: ReplyButtonModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticmodel

    model: ReplyButtonModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ReplyButtonModel, index: number, array: ReplyButtonModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -95,33 +95,33 @@

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ReplyButtonModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ReplyButtonModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ReplyButtonModel, index: number, array: ReplyButtonModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -133,8 +133,8 @@

    Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    sort

    stopListening

    toArray

    toJSON

    trigger

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.CallCollection.html b/classes/whatsapp.CallCollection.html index a088c766e0..c5ffc7fe95 100644 --- a/classes/whatsapp.CallCollection.html +++ b/classes/whatsapp.CallCollection.html @@ -1,7 +1,7 @@ -CallCollection | @wppconnect/wa-js - v3.10.1

    Class CallCollection

    Whatsapp

    60868

    -

    Whatsapp

    31218 >= 2.2204.13

    -

    Whatsapp

    160868 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CallCollection | @wppconnect/wa-js - v3.10.1

    Class CallCollection

    Whatsapp

    60868

    +

    Whatsapp

    31218 >= 2.2204.13

    +

    Whatsapp

    160868 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass pendingOffers? @@ -64,10 +64,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | CallModel

  • Parameters

    • predicate: ((value: CallModel, index: number, obj: CallModel[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | CallModel

    • modelClass

    modelClass: CallModel

    OptionalpendingOffers

    pendingOffers?: any

    OptionalpendingVoipCapChecks

    pendingVoipCapChecks?: any

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: CallModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    cleanupPendingOffer

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    cleanupPendingOffer

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: CallModel, index: number, array: CallModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -91,33 +91,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    handleQuery

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: CallModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: CallModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: CallModel, index: number, array: CallModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -129,8 +129,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setActiveCall

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setActiveCall

    slice

    • slice(start?, end?): CallModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -143,8 +143,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.CallModel.html b/classes/whatsapp.CallModel.html index 72019136a0..7feccc61f4 100644 --- a/classes/whatsapp.CallModel.html +++ b/classes/whatsapp.CallModel.html @@ -1,7 +1,7 @@ -CallModel | @wppconnect/wa-js - v3.10.1

    Class CallModel

    Whatsapp

    36473

    -

    Whatsapp

    40122 >= 2.2204.13

    -

    Whatsapp

    736473 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CallModel | @wppconnect/wa-js - v3.10.1

    Class CallModel

    Whatsapp

    36473

    +

    Whatsapp

    40122 >= 2.2204.13

    +

    Whatsapp

    736473 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes callInfo? canHandleLocally @@ -55,40 +55,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    OptionalcallInfo

    callInfo?: any

    canHandleLocally

    canHandleLocally: boolean

    Optionalcollection

    collection?: CallCollection

    OptionalgroupCallParticipants

    groupCallParticipants?: any

    id

    id: string

    isGroup

    isGroup: boolean

    ReadonlyisState

    isState: true

    isVideo

    isVideo: boolean

    ReadonlymirrorMask

    mirrorMask: {
        change:callInfo: undefined | number;
        change:canHandleLocally: number;
        change:groupCallParticipants: undefined | number;
        change:id: number;
        change:isGroup: number;
        change:isVideo: number;
        change:offerTime: number;
        change:outgoing: number;
        change:peerJid: number;
        change:stale: undefined | number;
        change:webClientShouldHandle: number;
    }

    offerTime

    offerTime: number

    outgoing

    outgoing: boolean

    Optionalparent

    parent?: any

    peerJid

    peerJid: Wid

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    webClientShouldHandle

    webClientShouldHandle: boolean

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    getState

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    OptionalcallInfo

    callInfo?: any

    canHandleLocally

    canHandleLocally: boolean

    Optionalcollection

    collection?: CallCollection

    OptionalgroupCallParticipants

    groupCallParticipants?: any

    id

    id: string

    isGroup

    isGroup: boolean

    ReadonlyisState

    isState

    isVideo

    isVideo: boolean

    ReadonlymirrorMask

    mirrorMask: {
        change:callInfo: undefined | number;
        change:canHandleLocally: number;
        change:groupCallParticipants: undefined | number;
        change:id: number;
        change:isGroup: number;
        change:isVideo: number;
        change:offerTime: number;
        change:outgoing: number;
        change:peerJid: number;
        change:stale: undefined | number;
        change:webClientShouldHandle: number;
    }

    offerTime

    offerTime: number

    outgoing

    outgoing: boolean

    Optionalparent

    parent?: any

    peerJid

    peerJid: Wid

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    webClientShouldHandle

    webClientShouldHandle: boolean

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    getState

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    setState

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    setState

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.CartCollection.html b/classes/whatsapp.CartCollection.html index f8865d2773..23012146b6 100644 --- a/classes/whatsapp.CartCollection.html +++ b/classes/whatsapp.CartCollection.html @@ -1,6 +1,6 @@ -CartCollection | @wppconnect/wa-js - v3.10.1

    Class CartCollection

    Whatsapp

    12392

    -

    Whatsapp

    612392 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CartCollection | @wppconnect/wa-js - v3.10.1

    Class CartCollection

    Whatsapp

    12392

    +

    Whatsapp

    612392 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst imageHeight? imageWidth? @@ -61,10 +61,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | CartModel

  • Parameters

    • predicate: ((value: CartModel, index: number, obj: CartModel[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | CartModel

    • OptionalimageHeight

    imageHeight?: any

    OptionalimageWidth

    imageWidth?: any

    modelClass

    modelClass: CartModel

    Static OptionalcachePolicy

    cachePolicy?: any

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: CartModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: CartModel, index: number, array: CartModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -88,33 +88,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: CartModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: CartModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: CartModel, index: number, array: CartModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -126,8 +126,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): CartModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -140,8 +140,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.CartItemCollection.html b/classes/whatsapp.CartItemCollection.html index bbf70c5c61..8f5b0eb8b1 100644 --- a/classes/whatsapp.CartItemCollection.html +++ b/classes/whatsapp.CartItemCollection.html @@ -1,6 +1,6 @@ -CartItemCollection | @wppconnect/wa-js - v3.10.1

    Class CartItemCollection

    Whatsapp

    57037

    -

    Whatsapp

    457037 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CartItemCollection | @wppconnect/wa-js - v3.10.1

    Class CartItemCollection

    Whatsapp

    57037

    +

    Whatsapp

    457037 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -57,10 +57,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | CartItemModel

  • Parameters

    Returns undefined | CartItemModel

    • modelClass

    modelClass: CartItemModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: CartItemModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: CartItemModel, index: number, array: CartItemModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: CartItemModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: CartItemModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: CartItemModel, index: number, array: CartItemModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): CartItemModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -136,8 +136,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.CartItemModel.html b/classes/whatsapp.CartItemModel.html index f183a19b36..2bc5747445 100644 --- a/classes/whatsapp.CartItemModel.html +++ b/classes/whatsapp.CartItemModel.html @@ -1,6 +1,6 @@ -CartItemModel | @wppconnect/wa-js - v3.10.1

    Class CartItemModel

    Whatsapp

    9581

    -

    Whatsapp

    109581 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CartItemModel | @wppconnect/wa-js - v3.10.1

    Class CartItemModel

    Whatsapp

    9581

    +

    Whatsapp

    109581 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? currency? @@ -49,40 +49,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: CartCollection

    Optionalcurrency

    currency?: any

    Optionalid

    id?: any

    OptionalimageCdnUrl

    imageCdnUrl?: any

    OptionalimageHash

    imageHash?: any

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:currency: undefined | number;
        change:id: undefined | number;
        change:imageCdnUrl: undefined | number;
        change:imageHash: undefined | number;
        change:name: undefined | number;
        change:priceAmount1000: undefined | number;
        change:quantity: undefined | number;
        change:stale: undefined | number;
    }

    Optionalname

    name?: string

    Optionalparent

    parent?: any

    OptionalpriceAmount1000

    priceAmount1000?: any

    proxyName

    proxyName: string

    Optionalquantity

    quantity?: any

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: CartCollection

    Optionalcurrency

    currency?: any

    Optionalid

    id?: any

    OptionalimageCdnUrl

    imageCdnUrl?: any

    OptionalimageHash

    imageHash?: any

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:currency: undefined | number;
        change:id: undefined | number;
        change:imageCdnUrl: undefined | number;
        change:imageHash: undefined | number;
        change:name: undefined | number;
        change:priceAmount1000: undefined | number;
        change:quantity: undefined | number;
        change:stale: undefined | number;
    }

    Optionalname

    name?: string

    Optionalparent

    parent?: any

    OptionalpriceAmount1000

    priceAmount1000?: any

    proxyName

    proxyName: string

    Optionalquantity

    quantity?: any

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.CartModel.html b/classes/whatsapp.CartModel.html index 3bccde9d13..f7a3daaa25 100644 --- a/classes/whatsapp.CartModel.html +++ b/classes/whatsapp.CartModel.html @@ -1,6 +1,6 @@ -CartModel | @wppconnect/wa-js - v3.10.1

    Class CartModel

    Whatsapp

    65999

    -

    Whatsapp

    565999 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CartModel | @wppconnect/wa-js - v3.10.1

    Class CartModel

    Whatsapp

    65999

    +

    Whatsapp

    565999 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? currency? @@ -49,40 +49,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: CartCollection

    Optionalcurrency

    currency?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    OptionalitemCount

    itemCount?: any

    Optionalmessage

    message?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:currency: undefined | number;
        change:id: undefined | number;
        change:itemCount: undefined | number;
        change:message: undefined | number;
        change:products: undefined | number;
        change:stale: undefined | number;
        change:total: undefined | number;
    }

    Optionalparent

    parent?: any

    Optionalproducts

    products?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltotal

    total?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    countTotals

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: CartCollection

    Optionalcurrency

    currency?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState

    OptionalitemCount

    itemCount?: any

    Optionalmessage

    message?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:currency: undefined | number;
        change:id: undefined | number;
        change:itemCount: undefined | number;
        change:message: undefined | number;
        change:products: undefined | number;
        change:stale: undefined | number;
        change:total: undefined | number;
    }

    Optionalparent

    parent?: any

    Optionalproducts

    products?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltotal

    total?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    countTotals

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.CatalogCollection.html b/classes/whatsapp.CatalogCollection.html index 545209aa8d..184ec52106 100644 --- a/classes/whatsapp.CatalogCollection.html +++ b/classes/whatsapp.CatalogCollection.html @@ -1,6 +1,6 @@ -CatalogCollection | @wppconnect/wa-js - v3.10.1

    Class CatalogCollection

    Whatsapp

    99989

    -

    Whatsapp

    599989 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CatalogCollection | @wppconnect/wa-js - v3.10.1

    Class CatalogCollection

    Whatsapp

    99989

    +

    Whatsapp

    599989 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -64,10 +64,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | CatalogModel

  • Parameters

    Returns undefined | CatalogModel

    • modelClass

    modelClass: CatalogModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: CatalogModel

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    _queryCatalog

    add

    addMsgAsProduct

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: CatalogModel, index: number, array: CatalogModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -91,33 +91,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: CatalogModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: CatalogModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: CatalogModel, index: number, array: CatalogModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -129,8 +129,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): CatalogModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -143,8 +143,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.CatalogModel.html b/classes/whatsapp.CatalogModel.html index bb8deb00cf..4deca84eb0 100644 --- a/classes/whatsapp.CatalogModel.html +++ b/classes/whatsapp.CatalogModel.html @@ -1,6 +1,6 @@ -CatalogModel | @wppconnect/wa-js - v3.10.1

    Class CatalogModel

    Whatsapp

    52388

    -

    Whatsapp

    652388 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CatalogModel | @wppconnect/wa-js - v3.10.1

    Class CatalogModel

    Whatsapp

    52388

    +

    Whatsapp

    652388 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    afterCursor? attributes collection? @@ -56,40 +56,40 @@

    Whatsappunset updateProduct isIdType -

    Constructors

    constructor

    Properties

    OptionalafterCursor

    afterCursor?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: CatalogCollection

    collections

    collections: any

    OptionalfetchedFromServer

    fetchedFromServer?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    Optionalindex

    index?: any

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:afterCursor: undefined | number;
        change:fetchedFromServer: undefined | number;
        change:id: number;
        change:index: undefined | number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    productCollection

    productCollection: ProductModel[]

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    addProduct

    bind

    clear

    decObservers

    delete

    editProduct

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalafterCursor

    afterCursor?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: CatalogCollection

    collections

    collections: any

    OptionalfetchedFromServer

    fetchedFromServer?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    Optionalindex

    index?: any

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:afterCursor: undefined | number;
        change:fetchedFromServer: undefined | number;
        change:id: number;
        change:index: undefined | number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    productCollection

    productCollection: ProductModel[]

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    addProduct

    bind

    clear

    decObservers

    delete

    editProduct

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    markProductCollectionOld

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    pullProduct

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    triggerMsgUpdate

    triggerProductUpdate

    unbind

    unset

    updateProduct

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    updateProduct

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ChatCollection.html b/classes/whatsapp.ChatCollection.html index f1526ada5d..a4512e6da7 100644 --- a/classes/whatsapp.ChatCollection.html +++ b/classes/whatsapp.ChatCollection.html @@ -1,6 +1,6 @@ -ChatCollection | @wppconnect/wa-js - v3.10.1

    Class ChatCollection

    Whatsapp

    69951

    -

    Whatsapp

    669951 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ChatCollection | @wppconnect/wa-js - v3.10.1

    Class ChatCollection

    Whatsapp

    69951

    +

    Whatsapp

    669951 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass notSpam? @@ -80,10 +80,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ChatModel

  • Parameters

    • predicate: ((value: ChatModel, index: number, obj: ChatModel[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | ChatModel

    • modelClass

    modelClass: ChatModel

    OptionalnotSpam

    notSpam?: any

    onResume

    onResume: ((...args: any) => any)

    Optionalpromises

    promises?: any

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticmodel

    model: ChatModel

    Accessors

    length

    Methods

    active

    add

    assertGet

    at

    bind

    delete

    disableSortListener

    emit

    enableSortListener

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    disableSortListener

    emit

    enableSortListener

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ChatModel, index: number, array: ChatModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -107,33 +107,33 @@

        Whatsapp

      Returns void

    forwardMessagesToChats

    gadd

    gaddUp

    get

    getKeysForResyncMsgs

    getModelsArray

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ChatModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ChatModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ChatModel, index: number, array: ChatModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -145,8 +145,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    resyncMessages

    saveToCache

    serialize

    set

    setIndexes

    slice

    reorder

    reorderMutate

    replaceId

    reset

    resyncMessages

    saveToCache

    serialize

    set

    setIndexes

    slice

    • slice(start?, end?): ChatModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -159,8 +159,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    unbind

    unstarAllMessages

    update

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unstarAllMessages

    update

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ChatModel.html b/classes/whatsapp.ChatModel.html index 7848508c79..4e39e59046 100644 --- a/classes/whatsapp.ChatModel.html +++ b/classes/whatsapp.ChatModel.html @@ -1,5 +1,5 @@ -ChatModel | @wppconnect/wa-js - v3.10.1

    Class ChatModel

    Whatsapp

    63183

    -

    Hierarchy (view full)

    Constructors

    constructor +ChatModel | @wppconnect/wa-js - v3.10.1

    Class ChatModel

    Whatsapp

    63183

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    ackedProps? active? archive? @@ -204,40 +204,40 @@ updateTitle waitForChatLoading isIdType -

    Constructors

    constructor

    Properties

    OptionalackedProps

    ackedProps?: any

    Optionalactive

    active?: any

    Optionalarchive

    archive?: any

    OptionalattachMediaContents

    attachMediaContents?: any

    Readonlyattributes

    attributes: Props & Session

    canSend

    canSend: boolean

    ReadonlycanUnread

    canUnread: boolean

    OptionalchangeNumberNewJid

    changeNumberNewJid?: any

    OptionalchangeNumberOldJid

    changeNumberOldJid?: any

    Optionalcollection

    collection?: ChatCollection

    Optionalcolors

    colors?: any

    OptionalcomposeContents

    composeContents?: any

    OptionalcomposeQuotedMsg

    composeQuotedMsg?: any

    OptionalcomposeQuotedMsgRemoteJid

    composeQuotedMsgRemoteJid?: any

    Optionalcontact

    contact?: any

    OptionalcreatedLocally

    createdLocally?: any

    disableUnreadAnchor

    disableUnreadAnchor: any

    OptionaldisappearingModeInitiator

    disappearingModeInitiator?: any

    OptionaldocCount

    docCount?: any

    OptionalendOfHistoryTransfer

    endOfHistoryTransfer?: any

    OptionalendOfHistoryTransferType

    endOfHistoryTransferType?: any

    OptionalephemeralDuration

    ephemeralDuration?: any

    OptionalephemeralSettingTimestamp

    ephemeralSettingTimestamp?: any

    OptionalformattedTitle

    formattedTitle?: string

    OptionalftsCache

    ftsCache?: any

    OptionalgroupMetadata

    groupMetadata?: GroupMetadataModel

    hasEstablishedE2EESession

    hasEstablishedE2EESession: boolean

    ReadonlyhasUnread

    hasUnread: boolean

    id

    id: Wid

    idClass

    idClass: typeof Wid

    isAnnounceGrpRestrict

    isAnnounceGrpRestrict: boolean

    ReadonlyisBroadcast

    isBroadcast: boolean

    ReadonlyisGroup

    isGroup: boolean

    ReadonlyisNewsletter

    isNewsletter: boolean

    ReadonlyisPSA

    isPSA: boolean

    isReadOnly

    isReadOnly: boolean

    ReadonlyisState

    isState: true

    ReadonlyisUser

    isUser: boolean

    Optional Readonlykind

    kind?: any

    Optionallabels

    labels?: string[]

    OptionallastReceivedKey

    lastReceivedKey?: MsgKey

    OptionallinkCount

    linkCount?: any

    OptionalliveLocation

    liveLocation?: any

    OptionalliveLocationQueried

    liveLocationQueried?: any

    OptionalmarkedUnread

    markedUnread?: any

    OptionalmediaCount

    mediaCount?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:ackedProps: undefined | number;
        change:active: undefined | number;
        change:archive: undefined | number;
        change:attachMediaContents: undefined | number;
        change:canSend: number;
        change:canUnread: number;
        change:changeNumberNewJid: undefined | number;
        change:changeNumberOldJid: undefined | number;
        change:colors: undefined | number;
        change:composeContents: undefined | number;
        change:composeQuotedMsg: undefined | number;
        change:composeQuotedMsgRemoteJid: undefined | number;
        change:contact: undefined | number;
        change:createdLocally: undefined | number;
        change:disableUnreadAnchor: number;
        change:disappearingModeInitiator: undefined | number;
        change:docCount: undefined | number;
        change:endOfHistoryTransfer: undefined | number;
        change:endOfHistoryTransferType: undefined | number;
        change:ephemeralDuration: undefined | number;
        change:ephemeralSettingTimestamp: undefined | number;
        change:formattedTitle: undefined | number;
        change:ftsCache: undefined | number;
        change:groupMetadata: undefined | number;
        change:hasEstablishedE2EESession: number;
        change:hasUnread: number;
        change:id: number;
        change:isAnnounceGrpRestrict: number;
        change:isBroadcast: number;
        change:isGroup: number;
        change:isNewsletter: number;
        change:isPSA: number;
        change:isReadOnly: number;
        change:isUser: number;
        change:kind: undefined | number;
        change:labels: undefined | number;
        change:lastReceivedKey: undefined | number;
        change:linkCount: undefined | number;
        change:liveLocation: undefined | number;
        change:liveLocationQueried: undefined | number;
        change:markedUnread: undefined | number;
        change:mediaCount: undefined | number;
        change:modifyTag: undefined | number;
        change:msgChunks: number;
        change:msgsChanged: number;
        change:msgsLength: number;
        change:msgUnsyncedButtonReplyMsgs: undefined | number;
        change:mute: number;
        change:muteExpiration: undefined | number;
        change:name: undefined | number;
        change:notSpam: undefined | number;
        change:optimisticUnreadCount: undefined | number;
        change:pausedTimerId: undefined | number;
        change:pendingAction: undefined | number;
        change:pendingInitialLoading: undefined | number;
        change:pendingMsgs: number;
        change:pendingSeenCount: undefined | number;
        change:pin: undefined | number;
        change:presence: undefined | number;
        change:presenceResendTimerId: undefined | number;
        change:previewMessage: undefined | number;
        change:productCount: undefined | number;
        change:promises: number;
        change:quotedMsgAdminGroupJid: undefined | number;
        change:recording: undefined | number;
        change:shouldAppearInList: undefined | number;
        change:shouldShowUnreadDivider: undefined | number;
        change:shouldShowUnreadInTitle: undefined | number;
        change:showChangeNumberNotification: undefined | number;
        change:squelch: undefined | number;
        change:stale: undefined | number;
        change:t: undefined | number;
        change:trusted: undefined | number;
        change:typing: undefined | number;
        change:unreadCount: number;
        change:unreadMentionsOfMe: undefined | number;
        change:unreadMsgAnchor: number;
        change:vcardDismissed: undefined | number;
    }

    OptionalmodifyTag

    modifyTag?: any

    msgChunks

    msgChunks: MsgLoad[]

    msgs

    msgs: MsgLoad

    msgsChanged

    msgsChanged: number

    msgsLength

    msgsLength: number

    OptionalmsgUnsyncedButtonReplyMsgs

    msgUnsyncedButtonReplyMsgs?: any

    mute

    mute: MuteModel

    OptionalmuteExpiration

    muteExpiration?: any

    Optionalname

    name?: string

    OptionalnotSpam

    notSpam?: any

    Optional ReadonlyoptimisticUnreadCount

    optimisticUnreadCount?: any

    Optionalparent

    parent?: any

    OptionalpausedTimerId

    pausedTimerId?: any

    OptionalpendingAction

    pendingAction?: any

    OptionalpendingInitialLoading

    pendingInitialLoading?: any

    pendingMsgs

    pendingMsgs: boolean

    OptionalpendingSeenCount

    pendingSeenCount?: any

    Optionalpin

    pin?: any

    Optionalpresence

    presence?: any

    OptionalpresenceResendTimerId

    presenceResendTimerId?: any

    Optional ReadonlypreviewMessage

    previewMessage?: any

    OptionalproductCount

    productCount?: any

    promises

    promises: {
        [key: string]: Promise<any> | undefined | null;
    }

    proxyName

    proxyName: string

    OptionalquotedMsgAdminGroupJid

    quotedMsgAdminGroupJid?: any

    Optionalrecording

    recording?: any

    Optional ReadonlyshouldAppearInList

    shouldAppearInList?: any

    Optional ReadonlyshouldShowUnreadDivider

    shouldShowUnreadDivider?: any

    Optional ReadonlyshouldShowUnreadInTitle

    shouldShowUnreadInTitle?: any

    Optional ReadonlyshowChangeNumberNotification

    showChangeNumberNotification?: any

    Optionalsquelch

    squelch?: any

    Optionalstale

    stale?: any

    Optionalt

    t?: number

    Optionaltrusted

    trusted?: any

    Optionaltyping

    typing?: any

    unreadCount

    unreadCount: number

    OptionalunreadMentionsOfMe

    unreadMentionsOfMe?: any

    unreadMsgAnchor

    unreadMsgAnchor: any

    OptionalvcardDismissed

    vcardDismissed?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    addMediaMsgs

    assignedColor

    bind

    canArchive

    cancelPendingPromises

    canPin

    canSenderRevoke

    clear

    constructMediaMsgs

    decObservers

    decPending

    delete

    deleteMsgs

    deleteMsgsBeforeMsgInclusive

    deleteMsgsOlderThan

    deleteMsgsPartial

    deregisterExpiredViewOnceBulkMessages

    dismissVcard

    emit

    forwardMessages

    fts

    get

    getAckedPhoneProps

    getAllCMCs

    getAllMsgs

    getCollection

    getComposeContents

    getDefault

    getDisappearingModeInitiator

    getDocMsgs

    getEphemeralSetting

    getEphemeralSettingTimestamp

    getFirstMsgWithStatus

    getGroupMetadataCollection

    getLastMsgKeyForAction

    getLastReceivedMsg

    getLastReceivedNonExpiredMsg

    getLastTimestampMsg

    getLinkMsgs

    getMediaMsgs

    getParticipantCount

    getProductMsgs

    getReceivedVcardMsgs

    OptionalgetSearchContext

    getSessionPersistedComposeContents

    getStarredMsgs

    getWebcChatType

    hasMaybeSentMsgToChat

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isDirty

    isEphemeralSettingOn

    isListening

    isMostRecentCMC

    isMsgForMediaCollection

    isSupportGroup

    isTrusted

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalackedProps

    ackedProps?: any

    Optionalactive

    active?: any

    Optionalarchive

    archive?: any

    OptionalattachMediaContents

    attachMediaContents?: any

    Readonlyattributes

    attributes: Props & Session

    canSend

    canSend: boolean

    ReadonlycanUnread

    canUnread: boolean

    OptionalchangeNumberNewJid

    changeNumberNewJid?: any

    OptionalchangeNumberOldJid

    changeNumberOldJid?: any

    Optionalcollection

    collection?: ChatCollection

    Optionalcolors

    colors?: any

    OptionalcomposeContents

    composeContents?: any

    OptionalcomposeQuotedMsg

    composeQuotedMsg?: any

    OptionalcomposeQuotedMsgRemoteJid

    composeQuotedMsgRemoteJid?: any

    Optionalcontact

    contact?: any

    OptionalcreatedLocally

    createdLocally?: any

    disableUnreadAnchor

    disableUnreadAnchor: any

    OptionaldisappearingModeInitiator

    disappearingModeInitiator?: any

    OptionaldocCount

    docCount?: any

    OptionalendOfHistoryTransfer

    endOfHistoryTransfer?: any

    OptionalendOfHistoryTransferType

    endOfHistoryTransferType?: any

    OptionalephemeralDuration

    ephemeralDuration?: any

    OptionalephemeralSettingTimestamp

    ephemeralSettingTimestamp?: any

    OptionalformattedTitle

    formattedTitle?: string

    OptionalftsCache

    ftsCache?: any

    OptionalgroupMetadata

    groupMetadata?: GroupMetadataModel

    hasEstablishedE2EESession

    hasEstablishedE2EESession: boolean

    ReadonlyhasUnread

    hasUnread: boolean

    id

    id: Wid

    idClass

    idClass: typeof Wid

    isAnnounceGrpRestrict

    isAnnounceGrpRestrict: boolean

    ReadonlyisBroadcast

    isBroadcast: boolean

    ReadonlyisGroup

    isGroup: boolean

    ReadonlyisNewsletter

    isNewsletter: boolean

    ReadonlyisPSA

    isPSA: boolean

    isReadOnly

    isReadOnly: boolean

    ReadonlyisState

    isState

    ReadonlyisUser

    isUser: boolean

    Optional Readonlykind

    kind?: any

    Optionallabels

    labels?: string[]

    OptionallastReceivedKey

    lastReceivedKey?: MsgKey

    OptionallinkCount

    linkCount?: any

    OptionalliveLocation

    liveLocation?: any

    OptionalliveLocationQueried

    liveLocationQueried?: any

    OptionalmarkedUnread

    markedUnread?: any

    OptionalmediaCount

    mediaCount?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:ackedProps: undefined | number;
        change:active: undefined | number;
        change:archive: undefined | number;
        change:attachMediaContents: undefined | number;
        change:canSend: number;
        change:canUnread: number;
        change:changeNumberNewJid: undefined | number;
        change:changeNumberOldJid: undefined | number;
        change:colors: undefined | number;
        change:composeContents: undefined | number;
        change:composeQuotedMsg: undefined | number;
        change:composeQuotedMsgRemoteJid: undefined | number;
        change:contact: undefined | number;
        change:createdLocally: undefined | number;
        change:disableUnreadAnchor: number;
        change:disappearingModeInitiator: undefined | number;
        change:docCount: undefined | number;
        change:endOfHistoryTransfer: undefined | number;
        change:endOfHistoryTransferType: undefined | number;
        change:ephemeralDuration: undefined | number;
        change:ephemeralSettingTimestamp: undefined | number;
        change:formattedTitle: undefined | number;
        change:ftsCache: undefined | number;
        change:groupMetadata: undefined | number;
        change:hasEstablishedE2EESession: number;
        change:hasUnread: number;
        change:id: number;
        change:isAnnounceGrpRestrict: number;
        change:isBroadcast: number;
        change:isGroup: number;
        change:isNewsletter: number;
        change:isPSA: number;
        change:isReadOnly: number;
        change:isUser: number;
        change:kind: undefined | number;
        change:labels: undefined | number;
        change:lastReceivedKey: undefined | number;
        change:linkCount: undefined | number;
        change:liveLocation: undefined | number;
        change:liveLocationQueried: undefined | number;
        change:markedUnread: undefined | number;
        change:mediaCount: undefined | number;
        change:modifyTag: undefined | number;
        change:msgChunks: number;
        change:msgsChanged: number;
        change:msgsLength: number;
        change:msgUnsyncedButtonReplyMsgs: undefined | number;
        change:mute: number;
        change:muteExpiration: undefined | number;
        change:name: undefined | number;
        change:notSpam: undefined | number;
        change:optimisticUnreadCount: undefined | number;
        change:pausedTimerId: undefined | number;
        change:pendingAction: undefined | number;
        change:pendingInitialLoading: undefined | number;
        change:pendingMsgs: number;
        change:pendingSeenCount: undefined | number;
        change:pin: undefined | number;
        change:presence: undefined | number;
        change:presenceResendTimerId: undefined | number;
        change:previewMessage: undefined | number;
        change:productCount: undefined | number;
        change:promises: number;
        change:quotedMsgAdminGroupJid: undefined | number;
        change:recording: undefined | number;
        change:shouldAppearInList: undefined | number;
        change:shouldShowUnreadDivider: undefined | number;
        change:shouldShowUnreadInTitle: undefined | number;
        change:showChangeNumberNotification: undefined | number;
        change:squelch: undefined | number;
        change:stale: undefined | number;
        change:t: undefined | number;
        change:trusted: undefined | number;
        change:typing: undefined | number;
        change:unreadCount: number;
        change:unreadMentionsOfMe: undefined | number;
        change:unreadMsgAnchor: number;
        change:vcardDismissed: undefined | number;
    }

    OptionalmodifyTag

    modifyTag?: any

    msgChunks

    msgChunks: MsgLoad[]

    msgs

    msgs: MsgLoad

    msgsChanged

    msgsChanged: number

    msgsLength

    msgsLength: number

    OptionalmsgUnsyncedButtonReplyMsgs

    msgUnsyncedButtonReplyMsgs?: any

    mute

    mute: MuteModel

    OptionalmuteExpiration

    muteExpiration?: any

    Optionalname

    name?: string

    OptionalnotSpam

    notSpam?: any

    Optional ReadonlyoptimisticUnreadCount

    optimisticUnreadCount?: any

    Optionalparent

    parent?: any

    OptionalpausedTimerId

    pausedTimerId?: any

    OptionalpendingAction

    pendingAction?: any

    OptionalpendingInitialLoading

    pendingInitialLoading?: any

    pendingMsgs

    pendingMsgs: boolean

    OptionalpendingSeenCount

    pendingSeenCount?: any

    Optionalpin

    pin?: any

    Optionalpresence

    presence?: any

    OptionalpresenceResendTimerId

    presenceResendTimerId?: any

    Optional ReadonlypreviewMessage

    previewMessage?: any

    OptionalproductCount

    productCount?: any

    promises

    promises: {
        [key: string]: Promise<any> | undefined | null;
    }

    proxyName

    proxyName: string

    OptionalquotedMsgAdminGroupJid

    quotedMsgAdminGroupJid?: any

    Optionalrecording

    recording?: any

    Optional ReadonlyshouldAppearInList

    shouldAppearInList?: any

    Optional ReadonlyshouldShowUnreadDivider

    shouldShowUnreadDivider?: any

    Optional ReadonlyshouldShowUnreadInTitle

    shouldShowUnreadInTitle?: any

    Optional ReadonlyshowChangeNumberNotification

    showChangeNumberNotification?: any

    Optionalsquelch

    squelch?: any

    Optionalstale

    stale?: any

    Optionalt

    t?: number

    Optionaltrusted

    trusted?: any

    Optionaltyping

    typing?: any

    unreadCount

    unreadCount: number

    OptionalunreadMentionsOfMe

    unreadMentionsOfMe?: any

    unreadMsgAnchor

    unreadMsgAnchor: any

    OptionalvcardDismissed

    vcardDismissed?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    addMediaMsgs

    assignedColor

    bind

    canArchive

    cancelPendingPromises

    canPin

    canSenderRevoke

    clear

    constructMediaMsgs

    decObservers

    decPending

    delete

    deleteMsgs

    deleteMsgsBeforeMsgInclusive

    deleteMsgsOlderThan

    deleteMsgsPartial

    deregisterExpiredViewOnceBulkMessages

    dismissVcard

    emit

    forwardMessages

    fts

    get

    getAckedPhoneProps

    getAllCMCs

    getAllMsgs

    getCollection

    getComposeContents

    getDefault

    getDisappearingModeInitiator

    getDocMsgs

    getEphemeralSetting

    getEphemeralSettingTimestamp

    getFirstMsgWithStatus

    getGroupMetadataCollection

    getLastMsgKeyForAction

    getLastReceivedMsg

    getLastReceivedNonExpiredMsg

    getLastTimestampMsg

    getLinkMsgs

    getMediaMsgs

    getParticipantCount

    getProductMsgs

    getReceivedVcardMsgs

    OptionalgetSearchContext

    getSessionPersistedComposeContents

    getStarredMsgs

    getWebcChatType

    hasMaybeSentMsgToChat

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isDirty

    isEphemeralSettingOn

    isListening

    isMostRecentCMC

    isMsgForMediaCollection

    isSupportGroup

    isTrusted

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    loadAssignedColors

    loadEarlierMsgs

    loadRecentMsgs

    matchFilter

    notifyMsgCollectionMerge

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onActiveUpdate

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onEmptyMRM

    onNewMsg

    onNotSpamChange

    onPendingActionUpdate

    preload

    regCancellablePromise

    removeAllListeners

    removeFromCollection

    removeListener

    removeMsg

    removeMsgsCollection

    replaceMsgsCollection

    reset

    resetMediaMsgs

    resetMediasCount

    saveAssignedColors

    sendDeleteMsgs

    sendDismissChangeNumber

    sendGroupInviteMessage

    • sendGroupInviteMessage(e?, t?, r?, a?, i?, n?): any

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any
      • Optionala: any
      • Optionali: any
      • Optionaln: any

      Returns any

    sendRevokeMsgs

    serialize

    set

    setAndKeepPrevious

    setAttachMediaContents

    setComposeContents

    shouldShowEphemeralSetting

    sortMsgs

    stopListening

    title

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    removeMsg

    removeMsgsCollection

    replaceMsgsCollection

    reset

    resetMediaMsgs

    resetMediasCount

    saveAssignedColors

    sendDeleteMsgs

    sendDismissChangeNumber

    sendGroupInviteMessage

    • sendGroupInviteMessage(e?, t?, r?, a?, i?, n?): any

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any
      • Optionala: any
      • Optionali: any
      • Optionaln: any

      Returns any

    sendRevokeMsgs

    serialize

    set

    setAndKeepPrevious

    setAttachMediaContents

    setComposeContents

    shouldShowEphemeralSetting

    sortMsgs

    stopListening

    title

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    unstarAll

    updateCanSend

    updateIsAnnounceGrpRestrict

    updateMediasCountOnMsg

    updateMuteExpiration

    updateReadOnly

    updateSortTime

    updateTitle

    waitForChatLoading

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    ackedPropsactivearchiveattachMediaContentsattributescanSendcanUnreadchangeNumberNewJidchangeNumberOldJidcollectioncolorscomposeContentscomposeQuotedMsgcomposeQuotedMsgRemoteJidcontactcreatedLocallydisableUnreadAnchordisappearingModeInitiatordocCountendOfHistoryTransferendOfHistoryTransferTypeephemeralDurationephemeralSettingTimestampformattedTitleftsCachegroupMetadatahasEstablishedE2EESessionhasUnreadididClassisAnnounceGrpRestrictisBroadcastisGroupisNewsletterisPSAisReadOnlyisStateisUserkindlabelslastReceivedKeylinkCountliveLocationliveLocationQueriedmarkedUnreadmediaCountmirrorMaskmodifyTagmsgChunksmsgsmsgsChangedmsgsLengthmsgUnsyncedButtonReplyMsgsmutemuteExpirationnamenotSpamoptimisticUnreadCountparentpausedTimerIdpendingActionpendingInitialLoadingpendingMsgspendingSeenCountpinpresencepresenceResendTimerIdpreviewMessageproductCountpromisesproxyNamequotedMsgAdminGroupJidrecordingshouldAppearInListshouldShowUnreadDividershouldShowUnreadInTitleshowChangeNumberNotificationsquelchstalettrustedtypingunreadCountunreadMentionsOfMeunreadMsgAnchorvcardDismissedallowedIdsidClassProxy
    Methods
    addChildaddMediaMsgsassignedColorbindcanArchivecancelPendingPromisescanPincanSenderRevokeclearconstructMediaMsgsdecObserversdecPendingdeletedeleteMsgsdeleteMsgsBeforeMsgInclusivedeleteMsgsOlderThandeleteMsgsPartialderegisterExpiredViewOnceBulkMessagesdismissVcardemitforwardMessagesftsgetgetAckedPhonePropsgetAllCMCsgetAllMsgsgetCollectiongetComposeContentsgetDefaultgetDisappearingModeInitiatorgetDocMsgsgetEphemeralSettinggetEphemeralSettingTimestampgetFirstMsgWithStatusgetGroupMetadataCollectiongetLastMsgKeyForActiongetLastReceivedMsggetLastReceivedNonExpiredMsggetLastTimestampMsggetLinkMsgsgetMediaMsgsgetParticipantCountgetProductMsgsgetReceivedVcardMsgsgetSearchContextgetSessionPersistedComposeContentsgetStarredMsgsgetWebcChatTypehasMaybeSentMsgToChathasObservershasUnfiredChangesincObserversinitializeisDirtyisEphemeralSettingOnisListeningisMostRecentCMCisMsgForMediaCollectionisSupportGroupisTrustedlistenTolistenToAndRunlistenToOnceloadAssignedColorsloadEarlierMsgsloadRecentMsgsmatchFilternotifyMsgCollectionMergeoffononActiveUpdateonceonEmptyMRMonNewMsgonNotSpamChangeonPendingActionUpdatepreloadregCancellablePromiseremoveAllListenersremoveFromCollectionremoveListenerremoveMsgremoveMsgsCollectionreplaceMsgsCollectionresetresetMediaMsgsresetMediasCountsaveAssignedColorssendDeleteMsgssendDismissChangeNumbersendGroupInviteMessagesendRevokeMsgsserializesetsetAndKeepPrevioussetAttachMediaContentssetComposeContentsshouldShowEphemeralSettingsortMsgsstopListeningtitletoJSONtriggerunbindunsetunstarAllupdateCanSendupdateIsAnnounceGrpRestrictupdateMediasCountOnMsgupdateMuteExpirationupdateReadOnlyupdateSortTimeupdateTitlewaitForChatLoadingisIdType
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    unstarAll

    updateCanSend

    updateIsAnnounceGrpRestrict

    updateMediasCountOnMsg

    updateMuteExpiration

    updateReadOnly

    updateSortTime

    updateTitle

    waitForChatLoading

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    ackedPropsactivearchiveattachMediaContentsattributescanSendcanUnreadchangeNumberNewJidchangeNumberOldJidcollectioncolorscomposeContentscomposeQuotedMsgcomposeQuotedMsgRemoteJidcontactcreatedLocallydisableUnreadAnchordisappearingModeInitiatordocCountendOfHistoryTransferendOfHistoryTransferTypeephemeralDurationephemeralSettingTimestampformattedTitleftsCachegroupMetadatahasEstablishedE2EESessionhasUnreadididClassisAnnounceGrpRestrictisBroadcastisGroupisNewsletterisPSAisReadOnlyisStateisUserkindlabelslastReceivedKeylinkCountliveLocationliveLocationQueriedmarkedUnreadmediaCountmirrorMaskmodifyTagmsgChunksmsgsmsgsChangedmsgsLengthmsgUnsyncedButtonReplyMsgsmutemuteExpirationnamenotSpamoptimisticUnreadCountparentpausedTimerIdpendingActionpendingInitialLoadingpendingMsgspendingSeenCountpinpresencepresenceResendTimerIdpreviewMessageproductCountpromisesproxyNamequotedMsgAdminGroupJidrecordingshouldAppearInListshouldShowUnreadDividershouldShowUnreadInTitleshowChangeNumberNotificationsquelchstalettrustedtypingunreadCountunreadMentionsOfMeunreadMsgAnchorvcardDismissedallowedIdsidClassProxy
    Methods
    addChildaddMediaMsgsassignedColorbindcanArchivecancelPendingPromisescanPincanSenderRevokeclearconstructMediaMsgsdecObserversdecPendingdeletedeleteMsgsdeleteMsgsBeforeMsgInclusivedeleteMsgsOlderThandeleteMsgsPartialderegisterExpiredViewOnceBulkMessagesdismissVcardemitforwardMessagesftsgetgetAckedPhonePropsgetAllCMCsgetAllMsgsgetCollectiongetComposeContentsgetDefaultgetDisappearingModeInitiatorgetDocMsgsgetEphemeralSettinggetEphemeralSettingTimestampgetFirstMsgWithStatusgetGroupMetadataCollectiongetLastMsgKeyForActiongetLastReceivedMsggetLastReceivedNonExpiredMsggetLastTimestampMsggetLinkMsgsgetMediaMsgsgetParticipantCountgetProductMsgsgetReceivedVcardMsgsgetSearchContextgetSessionPersistedComposeContentsgetStarredMsgsgetWebcChatTypehasMaybeSentMsgToChathasObservershasUnfiredChangesincObserversinitializeisDirtyisEphemeralSettingOnisListeningisMostRecentCMCisMsgForMediaCollectionisSupportGroupisTrustedlistenTolistenToAndRunlistenToOnceloadAssignedColorsloadEarlierMsgsloadRecentMsgsmatchFilternotifyMsgCollectionMergeoffononActiveUpdateonceonEmptyMRMonNewMsgonNotSpamChangeonPendingActionUpdatepreloadregCancellablePromiseremoveAllListenersremoveFromCollectionremoveListenerremoveMsgremoveMsgsCollectionreplaceMsgsCollectionresetresetMediaMsgsresetMediasCountsaveAssignedColorssendDeleteMsgssendDismissChangeNumbersendGroupInviteMessagesendRevokeMsgsserializesetsetAndKeepPrevioussetAttachMediaContentssetComposeContentsshouldShowEphemeralSettingsortMsgsstopListeningtitletoJSONtriggerunbindunsetunstarAllupdateCanSendupdateIsAnnounceGrpRestrictupdateMediasCountOnMsgupdateMuteExpirationupdateReadOnlyupdateSortTimeupdateTitlewaitForChatLoadingisIdType
    diff --git a/classes/whatsapp.ChatPreferenceModel.html b/classes/whatsapp.ChatPreferenceModel.html index 4031967ecd..f591470cee 100644 --- a/classes/whatsapp.ChatPreferenceModel.html +++ b/classes/whatsapp.ChatPreferenceModel.html @@ -1,6 +1,6 @@ -ChatPreferenceModel | @wppconnect/wa-js - v3.10.1

    Class ChatPreferenceModel

    Whatsapp

    33929

    -

    Whatsapp

    133929 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ChatPreferenceModel | @wppconnect/wa-js - v3.10.1

    Class ChatPreferenceModel

    Whatsapp

    33929

    +

    Whatsapp

    133929 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    allowedIds? attributes collection? @@ -48,40 +48,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionalallowedIds

    allowedIds?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:saveToCameraRoll: undefined | number;
        change:showDoodle: undefined | number;
        change:stale: undefined | number;
        change:wallpaperColor: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    OptionalsaveToCameraRoll

    saveToCameraRoll?: any

    OptionalshowDoodle

    showDoodle?: any

    Optionalstale

    stale?: any

    OptionalwallpaperColor

    wallpaperColor?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalallowedIds

    allowedIds?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:saveToCameraRoll: undefined | number;
        change:showDoodle: undefined | number;
        change:stale: undefined | number;
        change:wallpaperColor: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    OptionalsaveToCameraRoll

    saveToCameraRoll?: any

    OptionalshowDoodle

    showDoodle?: any

    Optionalstale

    stale?: any

    OptionalwallpaperColor

    wallpaperColor?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ChatstateCollection.html b/classes/whatsapp.ChatstateCollection.html index f85ab7f11a..019ea99063 100644 --- a/classes/whatsapp.ChatstateCollection.html +++ b/classes/whatsapp.ChatstateCollection.html @@ -1,6 +1,6 @@ -ChatstateCollection | @wppconnect/wa-js - v3.10.1

    Class ChatstateCollection

    Whatsapp

    30000

    -

    Whatsapp

    330000 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ChatstateCollection | @wppconnect/wa-js - v3.10.1

    Class ChatstateCollection

    Whatsapp

    30000

    +

    Whatsapp

    330000 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -57,10 +57,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ChatstateModel

  • Parameters

    Returns undefined | ChatstateModel

    • modelClass

    modelClass: ChatstateModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: ChatstateModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ChatstateModel, index: number, array: ChatstateModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ChatstateModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ChatstateModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ChatstateModel, index: number, array: ChatstateModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): ChatstateModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ChatstateModel.html b/classes/whatsapp.ChatstateModel.html index 90522182b6..1faac3285f 100644 --- a/classes/whatsapp.ChatstateModel.html +++ b/classes/whatsapp.ChatstateModel.html @@ -1,6 +1,6 @@ -ChatstateModel | @wppconnect/wa-js - v3.10.1

    Class ChatstateModel

    Whatsapp

    30000

    -

    Whatsapp

    330000 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ChatstateModel | @wppconnect/wa-js - v3.10.1

    Class ChatstateModel

    Whatsapp

    30000

    +

    Whatsapp

    330000 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    allowedIds? attributes collection? @@ -49,40 +49,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionalallowedIds

    allowedIds?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionaldeny

    deny?: any

    OptionalexpireTimerId

    expireTimerId?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:deny: undefined | number;
        change:expireTimerId: undefined | number;
        change:id: number;
        change:t: undefined | number;
        change:type: undefined | number;
        change:updateTime: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalt

    t?: any

    Optionaltype

    type?: any

    OptionalupdateTime

    updateTime?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalallowedIds

    allowedIds?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionaldeny

    deny?: any

    OptionalexpireTimerId

    expireTimerId?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:deny: undefined | number;
        change:expireTimerId: undefined | number;
        change:id: number;
        change:t: undefined | number;
        change:type: undefined | number;
        change:updateTime: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalt

    t?: any

    Optionaltype

    type?: any

    OptionalupdateTime

    updateTime?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.CmdClass.html b/classes/whatsapp.CmdClass.html index dd95f03d8b..ce58b2c8e9 100644 --- a/classes/whatsapp.CmdClass.html +++ b/classes/whatsapp.CmdClass.html @@ -1,7 +1,7 @@ -CmdClass | @wppconnect/wa-js - v3.10.1

    Class CmdClass

    Whatsapp

    88102

    -

    Whatsapp

    81572 >= 2.2218.4

    -

    Whatsapp

    781572 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +CmdClass | @wppconnect/wa-js - v3.10.1

    Class CmdClass

    Whatsapp

    88102

    +

    Whatsapp

    81572 >= 2.2218.4

    +

    Whatsapp

    781572 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    isMainLoaded uiBusy

    Methods

    _openChat @@ -143,41 +143,41 @@

    WhatsappwindowError windowMouseDown

    Constructors

    constructor

    Properties

    isMainLoaded

    isMainLoaded: boolean

    uiBusy

    uiBusy: number

    Methods

    _openChat

    _scrollChatToBottom

    _scrollToFocusedMsg

    alertCall

    • alertCall(e?, t?, r?, n?, i?): void

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any
      • Optionaln: any
      • Optionali: any

      Returns void

    alertNewMsg

    archiveChat

    attachMediaDrawer

    attachProduct

    autoplayPTT

    bind

    cancelCall

    cannotReachPhone

    chatInfoDrawer

    chatSearch

    clearChat

    closeChat

    closeContextMenu

    closeDrawerLeft

    closeDrawerMid

    closeDrawerRight

    closeModal

    closeModalMedia

    closeStatusViewer

    closeToast

    closeTooltip

    criticalSyncDone

    deleteOrExitChat

    downgradeWebclient

    emit

    enterChatTextInput

    ephemeralDrawer

    existsDrawerLeft

    existsDrawerMid

    existsDrawerRight

    expiredLocationDrawer

    flashFocusedMsg

    floaterEscapeOverlap

    focusChatList

    focusChatSearch

    focusChatTextInput

    focusNextChat

    focusPrevChat

    focusShowMsg

    getConversationHeaderOffset

    handleFatalError

    handleOfflineProgressUpdate

    incrementProgress

    initialLoadReady

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

    cancelCall

    cannotReachPhone

    chatInfoDrawer

    chatSearch

    clearChat

    closeChat

    closeContextMenu

    closeDrawerLeft

    closeDrawerMid

    closeDrawerRight

    closeModal

    closeModalMedia

    closeStatusViewer

    closeToast

    closeTooltip

    criticalSyncDone

    deleteOrExitChat

    downgradeWebclient

    emit

    enterChatTextInput

    ephemeralDrawer

    existsDrawerLeft

    existsDrawerMid

    existsDrawerRight

    expiredLocationDrawer

    flashFocusedMsg

    floaterEscapeOverlap

    focusChatList

    focusChatSearch

    focusChatTextInput

    focusNextChat

    focusPrevChat

    focusShowMsg

    getConversationHeaderOffset

    handleFatalError

    handleOfflineProgressUpdate

    incrementProgress

    initialLoadReady

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    liveLocationDrawer

    login

    logout

    logSocketSummary

    mainLoaded

    markChatUnread

    mediaPlaying

    mediaViewerModal

    merchantDetailsDrawer

    midnight

    msgInfoDrawer

    muteAll

    muteAllCall

    muteChat

    muteChats

    newMediaMsg

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onFullChatHistorySynced

    onHistorySyncChunkProcessed

    onInitialChatHistorySynced

    onPanesDidChange

    onPanesWillChange

    onRecentChatHistorySynced

    onStartingLogout

    onTemporaryBan

    openChatAt

    openChatBottom

    openChatFromUnread

    openComposeBoxPanel

    openContextMenu

    openDrawerLeft

    • openDrawerLeft(e?, t?, r?, n?, i?): void

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any
      • Optionaln: any
      • Optionali: any

      Returns void

    openDrawerMid

    • openDrawerMid(e?, t?, r?, n?, i?, a?): void

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any
      • Optionaln: any
      • Optionali: any
      • Optionala: any

      Returns void

    openDrawerRight

    • openDrawerRight(e?, t?, r?, n?, i?): void

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any
      • Optionaln: any
      • Optionali: any

      Returns void

    openGroupInviteModal

    openGroupV4InviteRequestFlow

    • openGroupV4InviteRequestFlow(e?, t?, r?, n?): void

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any
      • Optionaln: any

      Returns void

    openMediaViewerForAlbumMedia

    openModal

    openModalMedia

    openSocketStream

    openToast

    openTooltip

    pasteChatTextInput

    pinChat

    pinChats

    productImageViewerModal

    pttPlaying

    pttRecording

    readyForMainStreamMode

    refreshMessages

    refreshQR

    removeAllListeners

    removeListener

    restartBackend

    scrollMessages

    scrollToPtt

    sendDeleteMsgs

    restartBackend

    scrollMessages

    scrollToPtt

    sendDeleteMsgs

    • sendDeleteMsgs(chat, msg, options?): void

    • Whatsapp <= 2.3000.1014080102

      Parameters

      • chat: ChatModel
      • msg: MsgModel[] | {
            list: MsgModel[];
            type: string;
        }
      • Optionaloptions: {
            clearMedia?: boolean;
            toastPosition?: any;
        }
        • OptionalclearMedia?: boolean
        • OptionaltoastPosition?: any

      Returns void

    • sendDeleteMsgs(chat, msg, clearMedia?): void

    • Whatsapp >= 2.3000.1014080102

      -

      Parameters

      Returns void

    sendPasteToCompose

    sendRevokeMsgs

    • sendRevokeMsgs(chat, msg, options?): void

    • Parameters

      • chat: ChatModel
      • msg: MsgModel[] | {
            list: MsgModel[];
            type: string;
        }
      • Optionaloptions: {
            clearMedia?: boolean;
            toastPosition?: any;
        }
        • OptionalclearMedia?: boolean
        • OptionaltoastPosition?: any

      Returns void

    sendStarMsgs

    sendUnstarMsgs

    sentPing

    serverPropsUpdated

    setChatCtwaContextLinkData

    setDrawerContext

    setSocketState

    setUiBusy

    showCountrySelector

    • showCountrySelector(e?, t?, r?): void

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any

      Returns void

    showMerchantDetailsEntityTypePopup

    socketStreamDisconnected

    startGroupCall

    stopListening

    storageInitializationError

    textsizeChange

    toggleStickerMaker

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    Returns void

    sendPasteToCompose

    sendRevokeMsgs

    • sendRevokeMsgs(chat, msg, options?): void

    • Parameters

      • chat: ChatModel
      • msg: MsgModel[] | {
            list: MsgModel[];
            type: string;
        }
      • Optionaloptions: {
            clearMedia?: boolean;
            toastPosition?: any;
        }
        • OptionalclearMedia?: boolean
        • OptionaltoastPosition?: any

      Returns void

    sendStarMsgs

    sendUnstarMsgs

    sentPing

    serverPropsUpdated

    setChatCtwaContextLinkData

    setDrawerContext

    setSocketState

    setUiBusy

    showCountrySelector

    • showCountrySelector(e?, t?, r?): void

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any

      Returns void

    showMerchantDetailsEntityTypePopup

    socketStreamDisconnected

    startGroupCall

    stopListening

    storageInitializationError

    textsizeChange

    toggleStickerMaker

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    uiResize

    unbind

    updateChatlistSelection

    upgradeToMDInternal

    upgradeToMDProd

    verificationDrawer

    windowClick

    windowError

    windowMouseDown

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    _openChat_scrollChatToBottom_scrollToFocusedMsgalertCallalertNewMsgarchiveChatattachMediaDrawerattachProductautoplayPTTbindcancelCallcannotReachPhonechatInfoDrawerchatSearchclearChatcloseChatcloseContextMenucloseDrawerLeftcloseDrawerMidcloseDrawerRightcloseModalcloseModalMediacloseStatusViewercloseToastcloseTooltipcriticalSyncDonedeleteOrExitChatdowngradeWebclientemitenterChatTextInputephemeralDrawerexistsDrawerLeftexistsDrawerMidexistsDrawerRightexpiredLocationDrawerflashFocusedMsgfloaterEscapeOverlapfocusChatListfocusChatSearchfocusChatTextInputfocusNextChatfocusPrevChatfocusShowMsggetConversationHeaderOffsethandleFatalErrorhandleOfflineProgressUpdateincrementProgressinitialLoadReadyisListeninglistenTolistenToAndRunlistenToOnceliveLocationDrawerloginlogoutlogSocketSummarymainLoadedmarkChatUnreadmediaPlayingmediaViewerModalmerchantDetailsDrawermidnightmsgInfoDrawermuteAllmuteAllCallmuteChatmuteChatsnewMediaMsgoffononceonFullChatHistorySyncedonHistorySyncChunkProcessedonInitialChatHistorySyncedonPanesDidChangeonPanesWillChangeonRecentChatHistorySyncedonStartingLogoutonTemporaryBanopenChatAtopenChatBottomopenChatFromUnreadopenComposeBoxPanelopenContextMenuopenDrawerLeftopenDrawerMidopenDrawerRightopenGroupInviteModalopenGroupV4InviteRequestFlowopenMediaViewerForAlbumMediaopenModalopenModalMediaopenSocketStreamopenToastopenTooltippasteChatTextInputpinChatpinChatsproductImageViewerModalpttPlayingpttRecordingreadyForMainStreamModerefreshMessagesrefreshQRremoveAllListenersremoveListenerrestartBackendscrollMessagesscrollToPttsendDeleteMsgssendPasteToComposesendRevokeMsgssendStarMsgssendUnstarMsgssentPingserverPropsUpdatedsetChatCtwaContextLinkDatasetDrawerContextsetSocketStatesetUiBusyshowCountrySelectorshowMerchantDetailsEntityTypePopupsocketStreamDisconnectedstartGroupCallstopListeningstorageInitializationErrortextsizeChangetoggleStickerMakertriggeruiResizeunbindupdateChatlistSelectionupgradeToMDInternalupgradeToMDProdverificationDrawerwindowClickwindowErrorwindowMouseDown
    +

    Parameters

    Returns this

    Alias

    off

    +

    updateChatlistSelection

    upgradeToMDInternal

    upgradeToMDProd

    verificationDrawer

    windowClick

    windowError

    windowMouseDown

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    _openChat_scrollChatToBottom_scrollToFocusedMsgalertCallalertNewMsgarchiveChatattachMediaDrawerattachProductautoplayPTTbindcancelCallcannotReachPhonechatInfoDrawerchatSearchclearChatcloseChatcloseContextMenucloseDrawerLeftcloseDrawerMidcloseDrawerRightcloseModalcloseModalMediacloseStatusViewercloseToastcloseTooltipcriticalSyncDonedeleteOrExitChatdowngradeWebclientemitenterChatTextInputephemeralDrawerexistsDrawerLeftexistsDrawerMidexistsDrawerRightexpiredLocationDrawerflashFocusedMsgfloaterEscapeOverlapfocusChatListfocusChatSearchfocusChatTextInputfocusNextChatfocusPrevChatfocusShowMsggetConversationHeaderOffsethandleFatalErrorhandleOfflineProgressUpdateincrementProgressinitialLoadReadyisListeninglistenTolistenToAndRunlistenToOnceliveLocationDrawerloginlogoutlogSocketSummarymainLoadedmarkChatUnreadmediaPlayingmediaViewerModalmerchantDetailsDrawermidnightmsgInfoDrawermuteAllmuteAllCallmuteChatmuteChatsnewMediaMsgoffononceonFullChatHistorySyncedonHistorySyncChunkProcessedonInitialChatHistorySyncedonPanesDidChangeonPanesWillChangeonRecentChatHistorySyncedonStartingLogoutonTemporaryBanopenChatAtopenChatBottomopenChatFromUnreadopenComposeBoxPanelopenContextMenuopenDrawerLeftopenDrawerMidopenDrawerRightopenGroupInviteModalopenGroupV4InviteRequestFlowopenMediaViewerForAlbumMediaopenModalopenModalMediaopenSocketStreamopenToastopenTooltippasteChatTextInputpinChatpinChatsproductImageViewerModalpttPlayingpttRecordingreadyForMainStreamModerefreshMessagesrefreshQRremoveAllListenersremoveListenerrestartBackendscrollMessagesscrollToPttsendDeleteMsgssendPasteToComposesendRevokeMsgssendStarMsgssendUnstarMsgssentPingserverPropsUpdatedsetChatCtwaContextLinkDatasetDrawerContextsetSocketStatesetUiBusyshowCountrySelectorshowMerchantDetailsEntityTypePopupsocketStreamDisconnectedstartGroupCallstopListeningstorageInitializationErrortextsizeChangetoggleStickerMakertriggeruiResizeunbindupdateChatlistSelectionupgradeToMDInternalupgradeToMDProdverificationDrawerwindowClickwindowErrorwindowMouseDown
    diff --git a/classes/whatsapp.Collection.html b/classes/whatsapp.Collection.html index 32781fea4b..f3e0986555 100644 --- a/classes/whatsapp.Collection.html +++ b/classes/whatsapp.Collection.html @@ -1,6 +1,6 @@ -Collection | @wppconnect/wa-js - v3.10.1

    Class Collection<M, A>

    Whatsapp

    31727

    -

    Whatsapp

    631727 >= 2.2222.8

    -

    Type Parameters

    • M
    • A = M | M[]

    Hierarchy (view full)

    Constructors

    constructor +Collection | @wppconnect/wa-js - v3.10.1

    Class Collection<M, A>

    Whatsapp

    31727

    +

    Whatsapp

    631727 >= 2.2222.8

    +

    Type Parameters

    • M
    • A = M | M[]

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -57,10 +57,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | M

  • Parameters

    • predicate: ((value: M, index: number, obj: M[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          • value: M
          • index: number
          • obj: M[]

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | M

    • modelClass

    modelClass: M

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      • S

      Parameters

      • predicate: ((value: M, index: number, array: M[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: M

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: M

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: M, index: number, array: M[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          • (value, index, array): U

          • Parameters

            • value: M
            • index: number
            • array: M[]

            Returns U

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    • remove(value, options?): M[]

    • Parameters

      • value: A
      • Optionaloptions: {
            index?: boolean;
            silent?: boolean;
        }
        • Optionalindex?: boolean
        • Optionalsilent?: boolean

      Returns M[]

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): M[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -136,8 +136,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ComposeBoxActionsClass.html b/classes/whatsapp.ComposeBoxActionsClass.html index 1857fe68fd..b91c269d80 100644 --- a/classes/whatsapp.ComposeBoxActionsClass.html +++ b/classes/whatsapp.ComposeBoxActionsClass.html @@ -1,7 +1,7 @@ -ComposeBoxActionsClass | @wppconnect/wa-js - v3.10.1

    Class ComposeBoxActionsClass

    Whatsapp

    88102

    -

    Whatsapp

    81572 >= 2.2218.4

    -

    Whatsapp

    781572 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ComposeBoxActionsClass | @wppconnect/wa-js - v3.10.1

    Class ComposeBoxActionsClass

    Whatsapp

    88102

    +

    Whatsapp

    81572 >= 2.2218.4

    +

    Whatsapp

    781572 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    addMsgSendingLogAttributes bind emit @@ -25,39 +25,39 @@

    Whatsapptrigger unbind

    Constructors

    constructor

    Methods

    addMsgSendingLogAttributes

    bind

    emit

    focus

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

    emit

    focus

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    paste

    removeAllListeners

    removeListener

    send

    sendPaste

    setCtwaContextLinkData

    setTextContent

    stopListening

    toggleQuickReplies

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    send

    sendPaste

    setCtwaContextLinkData

    setTextContent

    stopListening

    toggleQuickReplies

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/whatsapp.ConnModel.html b/classes/whatsapp.ConnModel.html index 4e91758d79..cb545336b4 100644 --- a/classes/whatsapp.ConnModel.html +++ b/classes/whatsapp.ConnModel.html @@ -1,6 +1,6 @@ -ConnModel | @wppconnect/wa-js - v3.10.1

    Class ConnModel

    Whatsapp

    17239

    -

    Whatsapp

    317239 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ConnModel | @wppconnect/wa-js - v3.10.1

    Class ConnModel

    Whatsapp

    17239

    +

    Whatsapp

    317239 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    allLanguages? allLocales? attributes @@ -77,40 +77,40 @@

    Whatsappunset updateVoipAvailability isIdType -

    Constructors

    constructor

    Properties

    Optional ReadonlyallLanguages

    allLanguages?: any

    Optional ReadonlyallLocales

    allLocales?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalbattery

    battery?: any

    OptionalblockStoreAdds

    blockStoreAdds?: any

    OptionalclientToken

    clientToken?: string

    Optionalcollection

    collection?: undefined

    Optionalconnected

    connected?: boolean

    id

    id: string

    Optionalis24h

    is24h?: boolean

    OptionalisResponse

    isResponse?: boolean

    Optional ReadonlyisSMB

    isSMB?: boolean

    ReadonlyisState

    isState: true

    OptionalisVoipInitialized

    isVoipInitialized?: boolean

    Optionallc

    lc?: any

    Optionallg

    lg?: any

    Optional Readonlylocale

    locale?: any

    Optionallocales

    locales?: any

    Optional ReadonlylocalesList

    localesList?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:allLanguages: undefined | number;
        change:allLocales: undefined | number;
        change:battery: undefined | number;
        change:blockStoreAdds: undefined | number;
        change:clientToken: undefined | number;
        change:connected: undefined | number;
        change:id: number;
        change:is24h: undefined | number;
        change:isResponse: undefined | number;
        change:isSMB: undefined | number;
        change:isVoipInitialized: undefined | number;
        change:lc: undefined | number;
        change:lg: undefined | number;
        change:locale: undefined | number;
        change:locales: undefined | number;
        change:localesList: undefined | number;
        change:phone: undefined | number;
        change:platform: undefined | number;
        change:platformField: undefined | number;
        change:plugged: undefined | number;
        change:protoVersion: undefined | number;
        change:pushname: undefined | number;
        change:ref: undefined | number;
        change:refExpiry: undefined | number;
        change:refId: undefined | number;
        change:refTTL: undefined | number;
        change:secret: undefined | number;
        change:serverToken: undefined | number;
        change:smbTos: undefined | number;
        change:tos: undefined | number;
        change:tosShowCallNotification: undefined | number;
        change:wid: undefined | number;
    }

    Optionalparent

    parent?: any

    Optionalphone

    phone?: string

    Optionalplatform

    platform?: string

    Optional ReadonlyplatformField

    platformField?: any

    Optionalplugged

    plugged?: any

    OptionalprotoVersion

    protoVersion?: string

    proxyName

    proxyName: string

    Optionalpushname

    pushname?: string

    Optionalref

    ref?: string

    Optional ReadonlyrefExpiry

    refExpiry?: number

    OptionalrefId

    refId?: any

    OptionalrefTTL

    refTTL?: number

    Optionalsecret

    secret?: string

    OptionalserverToken

    serverToken?: string

    OptionalsmbTos

    smbTos?: any

    Optionaltos

    tos?: any

    Optional ReadonlytosShowCallNotification

    tosShowCallNotification?: any

    Optionalwid

    wid?: Wid

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canSetMyPushname

    clear

    decObservers

    delete

    emit

    formatLocale

    get

    getDefault

    handlePlatformChange

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Optional ReadonlyallLanguages

    allLanguages?: any

    Optional ReadonlyallLocales

    allLocales?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalbattery

    battery?: any

    OptionalblockStoreAdds

    blockStoreAdds?: any

    OptionalclientToken

    clientToken?: string

    Optionalcollection

    collection?: undefined

    Optionalconnected

    connected?: boolean

    id

    id: string

    Optionalis24h

    is24h?: boolean

    OptionalisResponse

    isResponse?: boolean

    Optional ReadonlyisSMB

    isSMB?: boolean

    ReadonlyisState

    isState

    OptionalisVoipInitialized

    isVoipInitialized?: boolean

    Optionallc

    lc?: any

    Optionallg

    lg?: any

    Optional Readonlylocale

    locale?: any

    Optionallocales

    locales?: any

    Optional ReadonlylocalesList

    localesList?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:allLanguages: undefined | number;
        change:allLocales: undefined | number;
        change:battery: undefined | number;
        change:blockStoreAdds: undefined | number;
        change:clientToken: undefined | number;
        change:connected: undefined | number;
        change:id: number;
        change:is24h: undefined | number;
        change:isResponse: undefined | number;
        change:isSMB: undefined | number;
        change:isVoipInitialized: undefined | number;
        change:lc: undefined | number;
        change:lg: undefined | number;
        change:locale: undefined | number;
        change:locales: undefined | number;
        change:localesList: undefined | number;
        change:phone: undefined | number;
        change:platform: undefined | number;
        change:platformField: undefined | number;
        change:plugged: undefined | number;
        change:protoVersion: undefined | number;
        change:pushname: undefined | number;
        change:ref: undefined | number;
        change:refExpiry: undefined | number;
        change:refId: undefined | number;
        change:refTTL: undefined | number;
        change:secret: undefined | number;
        change:serverToken: undefined | number;
        change:smbTos: undefined | number;
        change:tos: undefined | number;
        change:tosShowCallNotification: undefined | number;
        change:wid: undefined | number;
    }

    Optionalparent

    parent?: any

    Optionalphone

    phone?: string

    Optionalplatform

    platform?: string

    Optional ReadonlyplatformField

    platformField?: any

    Optionalplugged

    plugged?: any

    OptionalprotoVersion

    protoVersion?: string

    proxyName

    proxyName: string

    Optionalpushname

    pushname?: string

    Optionalref

    ref?: string

    Optional ReadonlyrefExpiry

    refExpiry?: number

    OptionalrefId

    refId?: any

    OptionalrefTTL

    refTTL?: number

    Optionalsecret

    secret?: string

    OptionalserverToken

    serverToken?: string

    OptionalsmbTos

    smbTos?: any

    Optionaltos

    tos?: any

    Optional ReadonlytosShowCallNotification

    tosShowCallNotification?: any

    Optionalwid

    wid?: Wid

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canSetMyPushname

    clear

    decObservers

    delete

    emit

    formatLocale

    get

    getDefault

    handlePlatformChange

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    shouldSaveToCache

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    shouldSaveToCache

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    updateVoipAvailability

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    updateVoipAvailability

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ContactCollection.html b/classes/whatsapp.ContactCollection.html index 7405af452c..6f99efd6ee 100644 --- a/classes/whatsapp.ContactCollection.html +++ b/classes/whatsapp.ContactCollection.html @@ -1,6 +1,6 @@ -ContactCollection | @wppconnect/wa-js - v3.10.1

    Class ContactCollection

    Whatsapp

    19380

    -

    Whatsapp

    719380 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ContactCollection | @wppconnect/wa-js - v3.10.1

    Class ContactCollection

    Whatsapp

    19380

    +

    Whatsapp

    719380 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    checksum? findFirst modelClass @@ -82,10 +82,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ContactModel

  • Parameters

    Returns undefined | ContactModel

    • modelClass

    modelClass: ContactModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticmodel

    model: ContactModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    contactAdded

    contactHashLength

    contactRemoved

    delete

    emit

    ensureSorted

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    contactAdded

    contactHashLength

    contactRemoved

    delete

    emit

    ensureSorted

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ContactModel, index: number, array: ContactModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -109,33 +109,33 @@

        Whatsapp

      Returns void

    frequentContacts

    gadd

    gaddUp

    get

    getFilteredContacts

    getModelsArray

    getUserCount

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ContactModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isFilteredContact

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isFilteredContact

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ContactModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ContactModel, index: number, array: ContactModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -147,8 +147,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    resolveWidsFromHash

    saveToCache

    serialize

    set

    setChecksum

    slice

    reorder

    reorderMutate

    replaceId

    reset

    resolveWidsFromHash

    saveToCache

    serialize

    set

    setChecksum

    slice

    • slice(start?, end?): ContactModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -161,8 +161,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    unbind

    update

    updateFrequentContacts

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    updateFrequentContacts

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ContactModel.html b/classes/whatsapp.ContactModel.html index 865773d034..c07ab81915 100644 --- a/classes/whatsapp.ContactModel.html +++ b/classes/whatsapp.ContactModel.html @@ -1,6 +1,6 @@ -ContactModel | @wppconnect/wa-js - v3.10.1

    Class ContactModel

    Whatsapp

    121

    -

    Whatsapp

    400121 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ContactModel | @wppconnect/wa-js - v3.10.1

    Class ContactModel

    Whatsapp

    121

    +

    Whatsapp

    400121 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes businessCatalog? businessProfile? @@ -111,70 +111,70 @@

    WhatsappupdateShortName isIdType

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    OptionalbusinessCatalog

    businessCatalog?: any

    OptionalbusinessProfile

    businessProfile?: any

    ReadonlycanRequestPhoneNumber

    canRequestPhoneNumber: boolean

    Deprecated in favor of getCanRequestPhoneNumber

    -

    Deprecated

    Optionalcollection

    collection?: ContactCollection

    OptionalcommonGroups

    commonGroups?: any

    OptionaldisappearingModeDuration

    disappearingModeDuration?: any

    OptionaldisappearingModeSettingTimestamp

    disappearingModeSettingTimestamp?: any

    Optional ReadonlydisplayName

    displayName?: any

    Deprecated in favor of getDisplayName

    -

    Deprecated

    Optional ReadonlydisplayNameOrPnForLid

    displayNameOrPnForLid?: any

    Deprecated in favor of getDisplayNameOrPnForLid

    -

    Deprecated

    Optional ReadonlyformattedName

    formattedName?: any

    Deprecated in favor of getFormattedName

    -

    Deprecated

    Optional ReadonlyformattedPhone

    formattedPhone?: any

    Deprecated in favor of getFormattedPhone

    -

    Deprecated

    Optional ReadonlyformattedShortName

    formattedShortName?: any

    Deprecated in favor of getFormattedShortName

    -

    Deprecated

    Optional ReadonlyformattedShortNameWithNonBreakingSpaces

    formattedShortNameWithNonBreakingSpaces?: any

    Deprecated in favor of getFormattedShortNameWithNonBreakingSpaces

    -

    Deprecated

    Optional ReadonlyformattedUser

    formattedUser?: any

    Deprecated in favor of getFormattedUser

    -

    Deprecated

    Optional Readonlyheader

    header?: any

    Deprecated in favor of getHeader

    -

    Deprecated

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisBroadcast

    isBroadcast: boolean

    Deprecated in favor of getIsBroadcast

    -

    Deprecated

    isBusiness

    isBusiness: boolean

    isContactBlocked

    isContactBlocked: boolean

    Optional ReadonlyisDisplayNameApproved

    isDisplayNameApproved?: any

    Deprecated in favor of getIsDisplayNameApproved

    -

    Deprecated

    isEnterprise

    isEnterprise: boolean

    ReadonlyisGroup

    isGroup: boolean

    Deprecated in favor of getIsGroup

    -

    Deprecated

    ReadonlyisIAS

    isIAS: boolean

    Deprecated in favor of getIsIAS

    -

    Deprecated

    ReadonlyisMe

    isMe: boolean

    Deprecated in favor of getIsMe

    -

    Deprecated

    ReadonlyisMyContact

    isMyContact: boolean

    Deprecated in favor of getIsMyContact

    -

    Deprecated

    ReadonlyisPSA

    isPSA: boolean

    Deprecated in favor of getIsPSA

    -

    Deprecated

    ReadonlyisState

    isState: true

    ReadonlyisSupportAccount

    isSupportAccount: boolean

    Deprecated in favor of getIsSupportAccount

    -

    Deprecated

    ReadonlyisUser

    isUser: boolean

    Deprecated in favor of getIsUser

    -

    Deprecated

    ReadonlyisWAContact

    isWAContact: boolean

    Deprecated in favor of getIsWAContact

    -

    Deprecated

    Optionallabels

    labels?: string[]

    OptionalliveLocations

    liveLocations?: any

    Optionallocale

    locale?: any

    Optional ReadonlymentionName

    mentionName?: any

    Deprecated in favor of getMentionName

    -

    Deprecated

    ReadonlymirrorMask

    mirrorMask: {
        change:businessCatalog: undefined | number;
        change:businessProfile: undefined | number;
        change:canRequestPhoneNumber: number;
        change:commonGroups: undefined | number;
        change:disappearingModeDuration: undefined | number;
        change:disappearingModeSettingTimestamp: undefined | number;
        change:displayName: undefined | number;
        change:displayNameOrPnForLid: undefined | number;
        change:formattedName: undefined | number;
        change:formattedPhone: undefined | number;
        change:formattedShortName: undefined | number;
        change:formattedShortNameWithNonBreakingSpaces: undefined | number;
        change:formattedUser: undefined | number;
        change:header: undefined | number;
        change:id: number;
        change:isBroadcast: number;
        change:isBusiness: number;
        change:isContactBlocked: number;
        change:isDisplayNameApproved: undefined | number;
        change:isEnterprise: number;
        change:isGroup: number;
        change:isIAS: number;
        change:isMe: number;
        change:isMyContact: number;
        change:isPSA: number;
        change:isSupportAccount: number;
        change:isUser: number;
        change:isWAContact: number;
        change:labels: undefined | number;
        change:liveLocations: undefined | number;
        change:locale: undefined | number;
        change:mentionName: undefined | number;
        change:name: undefined | number;
        change:notifyName: undefined | number;
        change:pendingAction: undefined | number;
        change:pnForLid: undefined | number;
        change:premiumMessageName: undefined | number;
        change:privacyMode: undefined | number;
        change:profilePicThumb: undefined | number;
        change:promises: undefined | number;
        change:pushname: undefined | number;
        change:searchName: undefined | number;
        change:searchVerifiedName: undefined | number;
        change:sectionHeader: undefined | number;
        change:shortName: undefined | number;
        change:shouldForceBusinessUpdate: undefined | number;
        change:showBusinessCheckmarkAsPrimary: undefined | number;
        change:showBusinessCheckmarkAsSecondary: undefined | number;
        change:showBusinessCheckmarkInChatlist: undefined | number;
        change:stale: undefined | number;
        change:status: undefined | number;
        change:statusMute: undefined | number;
        change:type: undefined | number;
        change:userhash: undefined | number;
        change:userid: undefined | number;
        change:verificationBinary: undefined | number;
        change:verificationString: undefined | number;
        change:verifiedLevel: undefined | number;
        change:verifiedName: undefined | number;
    }

    Optionalname

    name?: any

    Optional ReadonlynotifyName

    notifyName?: any

    Deprecated in favor of getNotifyName

    -

    Deprecated

    Optionalparent

    parent?: any

    OptionalpendingAction

    pendingAction?: any

    Optional ReadonlypnForLid

    pnForLid?: any

    Deprecated in favor of getPnForLid

    -

    Deprecated

    Optional ReadonlypremiumMessageName

    premiumMessageName?: any

    Deprecated in favor of getPremiumMessageName

    -

    Deprecated

    OptionalprivacyMode

    privacyMode?: any

    OptionalprofilePicThumb

    profilePicThumb?: any

    Optionalpromises

    promises?: any

    proxyName

    proxyName: string

    Optionalpushname

    pushname?: any

    Optional ReadonlysearchName

    searchName?: any

    Deprecated in favor of getSearchName

    -

    Deprecated

    Optional ReadonlysearchVerifiedName

    searchVerifiedName?: any

    Deprecated in favor of getSearchVerifiedName

    -

    Deprecated

    OptionalsectionHeader

    sectionHeader?: any

    OptionalshortName

    shortName?: any

    Optional ReadonlyshouldForceBusinessUpdate

    shouldForceBusinessUpdate?: any

    Deprecated in favor of getShouldForceBusinessUpdate

    -

    Deprecated

    Optional ReadonlyshowBusinessCheckmarkAsPrimary

    showBusinessCheckmarkAsPrimary?: any

    Deprecated in favor of getShowBusinessCheckmarkAsPrimary

    -

    Deprecated

    Optional ReadonlyshowBusinessCheckmarkAsSecondary

    showBusinessCheckmarkAsSecondary?: any

    Deprecated in favor of getShowBusinessCheckmarkAsSecondary

    -

    Deprecated

    Optional ReadonlyshowBusinessCheckmarkInChatlist

    showBusinessCheckmarkInChatlist?: any

    Deprecated in favor of getShowBusinessCheckmarkInChatlist

    -

    Deprecated

    Optionalstale

    stale?: any

    Optionalstatus

    status?: any

    OptionalstatusMute

    statusMute?: any

    Optionaltype

    type?: any

    Optional Readonlyuserhash

    userhash?: any

    Deprecated in favor of getUserhash

    -

    Deprecated

    Optional Readonlyuserid

    userid?: any

    Deprecated in favor of getUserid

    -

    Deprecated

    OptionalverificationBinary

    verificationBinary?: any

    OptionalverificationString

    verificationString?: any

    OptionalverifiedLevel

    verifiedLevel?: any

    OptionalverifiedName

    verifiedName?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    addPendingAction

    bind

    clear

    decObservers

    decPending

    delete

    emit

    get

    getCollection

    getDefault

    getFormattedUser

    getProfilePicThumb

    getStatus

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isBlocked

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

    Optionalcollection

    collection?: ContactCollection

    OptionalcommonGroups

    commonGroups?: any

    OptionaldisappearingModeDuration

    disappearingModeDuration?: any

    OptionaldisappearingModeSettingTimestamp

    disappearingModeSettingTimestamp?: any

    Optional ReadonlydisplayName

    displayName?: any

    Deprecated in favor of getDisplayName

    +

    Deprecated

    Optional ReadonlydisplayNameOrPnForLid

    displayNameOrPnForLid?: any

    Deprecated in favor of getDisplayNameOrPnForLid

    +

    Deprecated

    Optional ReadonlyformattedName

    formattedName?: any

    Deprecated in favor of getFormattedName

    +

    Deprecated

    Optional ReadonlyformattedPhone

    formattedPhone?: any

    Deprecated in favor of getFormattedPhone

    +

    Deprecated

    Optional ReadonlyformattedShortName

    formattedShortName?: any

    Deprecated in favor of getFormattedShortName

    +

    Deprecated

    Optional ReadonlyformattedShortNameWithNonBreakingSpaces

    formattedShortNameWithNonBreakingSpaces?: any

    Deprecated in favor of getFormattedShortNameWithNonBreakingSpaces

    +

    Deprecated

    Optional ReadonlyformattedUser

    formattedUser?: any

    Deprecated in favor of getFormattedUser

    +

    Deprecated

    Optional Readonlyheader

    header?: any

    Deprecated in favor of getHeader

    +

    Deprecated

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisBroadcast

    isBroadcast: boolean

    Deprecated in favor of getIsBroadcast

    +

    Deprecated

    isBusiness

    isBusiness: boolean

    isContactBlocked

    isContactBlocked: boolean

    Optional ReadonlyisDisplayNameApproved

    isDisplayNameApproved?: any

    Deprecated in favor of getIsDisplayNameApproved

    +

    Deprecated

    isEnterprise

    isEnterprise: boolean

    ReadonlyisGroup

    isGroup: boolean

    Deprecated in favor of getIsGroup

    +

    Deprecated

    ReadonlyisIAS

    isIAS: boolean

    Deprecated in favor of getIsIAS

    +

    Deprecated

    ReadonlyisMe

    isMe: boolean

    Deprecated in favor of getIsMe

    +

    Deprecated

    ReadonlyisMyContact

    isMyContact: boolean

    Deprecated in favor of getIsMyContact

    +

    Deprecated

    ReadonlyisPSA

    isPSA: boolean

    Deprecated in favor of getIsPSA

    +

    Deprecated

    ReadonlyisState

    isState

    ReadonlyisSupportAccount

    isSupportAccount: boolean

    Deprecated in favor of getIsSupportAccount

    +

    Deprecated

    ReadonlyisUser

    isUser: boolean

    Deprecated in favor of getIsUser

    +

    Deprecated

    ReadonlyisWAContact

    isWAContact: boolean

    Deprecated in favor of getIsWAContact

    +

    Deprecated

    Optionallabels

    labels?: string[]

    OptionalliveLocations

    liveLocations?: any

    Optionallocale

    locale?: any

    Optional ReadonlymentionName

    mentionName?: any

    Deprecated in favor of getMentionName

    +

    Deprecated

    ReadonlymirrorMask

    mirrorMask: {
        change:businessCatalog: undefined | number;
        change:businessProfile: undefined | number;
        change:canRequestPhoneNumber: number;
        change:commonGroups: undefined | number;
        change:disappearingModeDuration: undefined | number;
        change:disappearingModeSettingTimestamp: undefined | number;
        change:displayName: undefined | number;
        change:displayNameOrPnForLid: undefined | number;
        change:formattedName: undefined | number;
        change:formattedPhone: undefined | number;
        change:formattedShortName: undefined | number;
        change:formattedShortNameWithNonBreakingSpaces: undefined | number;
        change:formattedUser: undefined | number;
        change:header: undefined | number;
        change:id: number;
        change:isBroadcast: number;
        change:isBusiness: number;
        change:isContactBlocked: number;
        change:isDisplayNameApproved: undefined | number;
        change:isEnterprise: number;
        change:isGroup: number;
        change:isIAS: number;
        change:isMe: number;
        change:isMyContact: number;
        change:isPSA: number;
        change:isSupportAccount: number;
        change:isUser: number;
        change:isWAContact: number;
        change:labels: undefined | number;
        change:liveLocations: undefined | number;
        change:locale: undefined | number;
        change:mentionName: undefined | number;
        change:name: undefined | number;
        change:notifyName: undefined | number;
        change:pendingAction: undefined | number;
        change:pnForLid: undefined | number;
        change:premiumMessageName: undefined | number;
        change:privacyMode: undefined | number;
        change:profilePicThumb: undefined | number;
        change:promises: undefined | number;
        change:pushname: undefined | number;
        change:searchName: undefined | number;
        change:searchVerifiedName: undefined | number;
        change:sectionHeader: undefined | number;
        change:shortName: undefined | number;
        change:shouldForceBusinessUpdate: undefined | number;
        change:showBusinessCheckmarkAsPrimary: undefined | number;
        change:showBusinessCheckmarkAsSecondary: undefined | number;
        change:showBusinessCheckmarkInChatlist: undefined | number;
        change:stale: undefined | number;
        change:status: undefined | number;
        change:statusMute: undefined | number;
        change:type: undefined | number;
        change:userhash: undefined | number;
        change:userid: undefined | number;
        change:verificationBinary: undefined | number;
        change:verificationString: undefined | number;
        change:verifiedLevel: undefined | number;
        change:verifiedName: undefined | number;
    }

    Optionalname

    name?: any

    Optional ReadonlynotifyName

    notifyName?: any

    Deprecated in favor of getNotifyName

    +

    Deprecated

    Optionalparent

    parent?: any

    OptionalpendingAction

    pendingAction?: any

    Optional ReadonlypnForLid

    pnForLid?: any

    Deprecated in favor of getPnForLid

    +

    Deprecated

    Optional ReadonlypremiumMessageName

    premiumMessageName?: any

    Deprecated in favor of getPremiumMessageName

    +

    Deprecated

    OptionalprivacyMode

    privacyMode?: any

    OptionalprofilePicThumb

    profilePicThumb?: any

    Optionalpromises

    promises?: any

    proxyName

    proxyName: string

    Optionalpushname

    pushname?: any

    Optional ReadonlysearchName

    searchName?: any

    Deprecated in favor of getSearchName

    +

    Deprecated

    Optional ReadonlysearchVerifiedName

    searchVerifiedName?: any

    Deprecated in favor of getSearchVerifiedName

    +

    Deprecated

    OptionalsectionHeader

    sectionHeader?: any

    OptionalshortName

    shortName?: any

    Optional ReadonlyshouldForceBusinessUpdate

    shouldForceBusinessUpdate?: any

    Deprecated in favor of getShouldForceBusinessUpdate

    +

    Deprecated

    Optional ReadonlyshowBusinessCheckmarkAsPrimary

    showBusinessCheckmarkAsPrimary?: any

    Deprecated in favor of getShowBusinessCheckmarkAsPrimary

    +

    Deprecated

    Optional ReadonlyshowBusinessCheckmarkAsSecondary

    showBusinessCheckmarkAsSecondary?: any

    Deprecated in favor of getShowBusinessCheckmarkAsSecondary

    +

    Deprecated

    Optional ReadonlyshowBusinessCheckmarkInChatlist

    showBusinessCheckmarkInChatlist?: any

    Deprecated in favor of getShowBusinessCheckmarkInChatlist

    +

    Deprecated

    Optionalstale

    stale?: any

    Optionalstatus

    status?: any

    OptionalstatusMute

    statusMute?: any

    Optionaltype

    type?: any

    Optional Readonlyuserhash

    userhash?: any

    Deprecated in favor of getUserhash

    +

    Deprecated

    Optional Readonlyuserid

    userid?: any

    Deprecated in favor of getUserid

    +

    Deprecated

    OptionalverificationBinary

    verificationBinary?: any

    OptionalverificationString

    verificationString?: any

    OptionalverifiedLevel

    verifiedLevel?: any

    OptionalverifiedName

    verifiedName?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    addPendingAction

    bind

    clear

    decObservers

    decPending

    delete

    emit

    get

    getCollection

    getDefault

    getFormattedUser

    getProfilePicThumb

    getStatus

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isBlocked

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    searchMatch

    serialize

    set

    setNotMyContact

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    searchMatch

    serialize

    set

    setNotMyContact

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    updateShortName

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    attributesbusinessCatalogbusinessProfilecanRequestPhoneNumbercollectioncommonGroupsdisappearingModeDurationdisappearingModeSettingTimestampdisplayNamedisplayNameOrPnForLidformattedNameformattedPhoneformattedShortNameformattedShortNameWithNonBreakingSpacesformattedUserheaderididClassisBroadcastisBusinessisContactBlockedisDisplayNameApprovedisEnterpriseisGroupisIASisMeisMyContactisPSAisStateisSupportAccountisUserisWAContactlabelsliveLocationslocalementionNamemirrorMasknamenotifyNameparentpendingActionpnForLidpremiumMessageNameprivacyModeprofilePicThumbpromisesproxyNamepushnamesearchNamesearchVerifiedNamesectionHeadershortNameshouldForceBusinessUpdateshowBusinessCheckmarkAsPrimaryshowBusinessCheckmarkAsSecondaryshowBusinessCheckmarkInChatliststalestatusstatusMutetypeuserhashuseridverificationBinaryverificationStringverifiedLevelverifiedNameallowedIdsidClassProxy
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    updateShortName

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    attributesbusinessCatalogbusinessProfilecanRequestPhoneNumbercollectioncommonGroupsdisappearingModeDurationdisappearingModeSettingTimestampdisplayNamedisplayNameOrPnForLidformattedNameformattedPhoneformattedShortNameformattedShortNameWithNonBreakingSpacesformattedUserheaderididClassisBroadcastisBusinessisContactBlockedisDisplayNameApprovedisEnterpriseisGroupisIASisMeisMyContactisPSAisStateisSupportAccountisUserisWAContactlabelsliveLocationslocalementionNamemirrorMasknamenotifyNameparentpendingActionpnForLidpremiumMessageNameprivacyModeprofilePicThumbpromisesproxyNamepushnamesearchNamesearchVerifiedNamesectionHeadershortNameshouldForceBusinessUpdateshowBusinessCheckmarkAsPrimaryshowBusinessCheckmarkAsSecondaryshowBusinessCheckmarkInChatliststalestatusstatusMutetypeuserhashuseridverificationBinaryverificationStringverifiedLevelverifiedNameallowedIdsidClassProxy
    Methods
    diff --git a/classes/whatsapp.ConversionTupleModel.html b/classes/whatsapp.ConversionTupleModel.html index 8be06ea29c..11b3635e98 100644 --- a/classes/whatsapp.ConversionTupleModel.html +++ b/classes/whatsapp.ConversionTupleModel.html @@ -1,6 +1,6 @@ -ConversionTupleModel | @wppconnect/wa-js - v3.10.1

    Class ConversionTupleModel

    Whatsapp

    18787

    -

    Whatsapp

    118787 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ConversionTupleModel | @wppconnect/wa-js - v3.10.1

    Class ConversionTupleModel

    Whatsapp

    18787

    +

    Whatsapp

    118787 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    alarmId? attributes collection? @@ -50,40 +50,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionalalarmId

    alarmId?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionalconversionData

    conversionData?: any

    OptionalconversionSource

    conversionSource?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:alarmId: undefined | number;
        change:conversionData: undefined | number;
        change:conversionSource: undefined | number;
        change:id: number;
        change:stale: undefined | number;
        change:timestamp: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltimestamp

    timestamp?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    elapsedSeconds

    emit

    formatTuple

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalalarmId

    alarmId?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionalconversionData

    conversionData?: any

    OptionalconversionSource

    conversionSource?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:alarmId: undefined | number;
        change:conversionData: undefined | number;
        change:conversionSource: undefined | number;
        change:id: number;
        change:stale: undefined | number;
        change:timestamp: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltimestamp

    timestamp?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    elapsedSeconds

    emit

    formatTuple

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.EmojiVariantCollection.html b/classes/whatsapp.EmojiVariantCollection.html index e705f6f290..0f7c1e4df9 100644 --- a/classes/whatsapp.EmojiVariantCollection.html +++ b/classes/whatsapp.EmojiVariantCollection.html @@ -1,6 +1,6 @@ -EmojiVariantCollection | @wppconnect/wa-js - v3.10.1

    Class EmojiVariantCollection

    Whatsapp

    13185

    -

    Whatsapp

    513185 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +EmojiVariantCollection | @wppconnect/wa-js - v3.10.1

    Class EmojiVariantCollection

    Whatsapp

    13185

    +

    Whatsapp

    513185 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass cachePolicy? @@ -61,10 +61,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | EmojiVariantModel

  • Parameters

    Returns undefined | EmojiVariantModel

    • modelClass

    modelClass: EmojiVariantModel

    Static OptionalcachePolicy

    cachePolicy?: any

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: EmojiVariantModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: EmojiVariantModel, index: number, array: EmojiVariantModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -88,33 +88,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    getVariant

    getVariantIfExists

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: EmojiVariantModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: EmojiVariantModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: EmojiVariantModel, index: number, array: EmojiVariantModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -126,8 +126,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setVariant

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setVariant

    slice

    • slice(start?, end?): EmojiVariantModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.EmojiVariantModel.html b/classes/whatsapp.EmojiVariantModel.html index 8da7a8f0f7..27cd791eaa 100644 --- a/classes/whatsapp.EmojiVariantModel.html +++ b/classes/whatsapp.EmojiVariantModel.html @@ -1,6 +1,6 @@ -EmojiVariantModel | @wppconnect/wa-js - v3.10.1

    Class EmojiVariantModel

    Whatsapp

    20472

    -

    Whatsapp

    120472 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +EmojiVariantModel | @wppconnect/wa-js - v3.10.1

    Class EmojiVariantModel

    Whatsapp

    20472

    +

    Whatsapp

    120472 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id? @@ -43,40 +43,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:stale: undefined | number;
        change:variant: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalvariant

    variant?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:stale: undefined | number;
        change:variant: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalvariant

    variant?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.EventEmitter.html b/classes/whatsapp.EventEmitter.html index 6ce18aedab..4960732083 100644 --- a/classes/whatsapp.EventEmitter.html +++ b/classes/whatsapp.EventEmitter.html @@ -1,7 +1,7 @@ -EventEmitter | @wppconnect/wa-js - v3.10.1

    Class EventEmitter

    Whatsapp

    76521

    -

    Whatsapp

    34342 >= 2.2204.13

    -

    Whatsapp

    876521 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +EventEmitter | @wppconnect/wa-js - v3.10.1

    Class EventEmitter

    Whatsapp

    76521

    +

    Whatsapp

    34342 >= 2.2204.13

    +

    Whatsapp

    876521 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    bind emit isListening @@ -17,39 +17,39 @@

    Whatsapptrigger unbind

    Constructors

    constructor

    Methods

    bind

    emit

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event
        • listener: Listener
        • Optionalcontext: any

        Returns this

        Alias

        on

        +

    emit

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    • removeListener(eventName?, listener?, context?): this

    • Alias of off

      -

      Parameters

      • OptionaleventName: Event
      • Optionallistener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      off

      -

    stopListening

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    stopListening

    • stopListening(context?, eventName?, listener?): this

    • Parameters

      • Optionalcontext: any
      • OptionaleventName: Event
      • Optionallistener: Listener

      Returns this

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/whatsapp.GroupMetadataCollection.html b/classes/whatsapp.GroupMetadataCollection.html index 887e180616..1b6f6e76d7 100644 --- a/classes/whatsapp.GroupMetadataCollection.html +++ b/classes/whatsapp.GroupMetadataCollection.html @@ -1,6 +1,6 @@ -GroupMetadataCollection | @wppconnect/wa-js - v3.10.1

    Class GroupMetadataCollection

    Whatsapp

    63928

    -

    Whatsapp

    963928 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +GroupMetadataCollection | @wppconnect/wa-js - v3.10.1

    Class GroupMetadataCollection

    Whatsapp

    63928

    +

    Whatsapp

    963928 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -70,10 +70,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | GroupMetadataModel

  • Parameters

    Returns undefined | GroupMetadataModel

    • modelClass

    modelClass: GroupMetadataModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: GroupMetadataModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: GroupMetadataModel, index: number, array: GroupMetadataModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -97,33 +97,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    handle

    handlePendingInvite

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: GroupMetadataModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: GroupMetadataModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: GroupMetadataModel, index: number, array: GroupMetadataModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -135,8 +135,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): GroupMetadataModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.GroupMetadataModel.html b/classes/whatsapp.GroupMetadataModel.html index 09ddde6a66..6ded03bd0a 100644 --- a/classes/whatsapp.GroupMetadataModel.html +++ b/classes/whatsapp.GroupMetadataModel.html @@ -1,6 +1,6 @@ -GroupMetadataModel | @wppconnect/wa-js - v3.10.1

    Class GroupMetadataModel

    Whatsapp

    14423

    -

    Whatsapp

    614423 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +GroupMetadataModel | @wppconnect/wa-js - v3.10.1

    Class GroupMetadataModel

    Whatsapp

    14423

    +

    Whatsapp

    614423 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    allowNonAdminSubGroupCreation? announce? attributes @@ -107,40 +107,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionalallowNonAdminSubGroupCreation

    allowNonAdminSubGroupCreation?: any

    Optionalannounce

    announce?: any

    Readonlyattributes

    attributes: Props & Session

    OptionalcachedDeviceCount

    cachedDeviceCount?: any

    OptionalcachedDeviceSizeBucket

    cachedDeviceSizeBucket?: any

    Optionalcollection

    collection?: undefined

    Optionalcreation

    creation?: any

    OptionaldefaultSubgroup

    defaultSubgroup?: any

    Optionaldesc

    desc?: string

    OptionaldescId

    descId?: string

    OptionaldescOwner

    descOwner?: any

    OptionaldescTime

    descTime?: any

    OptionaldeviceQueryPromise

    deviceQueryPromise?: any

    OptionaldeviceStale

    deviceStale?: any

    OptionaldisplayedDesc

    displayedDesc?: any

    OptionalephemeralDuration

    ephemeralDuration?: any

    OptionalgroupInviteCodePromise

    groupInviteCodePromise?: any

    Optional ReadonlygroupInviteLink

    groupInviteLink?: any

    Optional ReadonlygroupType

    groupType?: string

    OptionalgrowthLockExpiration

    growthLockExpiration?: any

    OptionalgrowthLockType

    growthLockType?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    Optionalincognito

    incognito?: any

    OptionalinviteCode

    inviteCode?: any

    Optional ReadonlyisIncognitoCag

    isIncognitoCag?: boolean

    isLidAddressingMode

    isLidAddressingMode: boolean

    isParentGroup

    isParentGroup: boolean

    isParentGroupClosed

    isParentGroupClosed: boolean

    ReadonlyisState

    isState: true

    Optional ReadonlyisUnnamed

    isUnnamed?: boolean

    OptionaljoinedSubgroups

    joinedSubgroups?: any

    OptionallastActivityTimestamp

    lastActivityTimestamp?: any

    OptionallastReportToAdminTimestamp

    lastReportToAdminTimestamp?: any

    OptionallastSeenActivityTimestamp

    lastSeenActivityTimestamp?: any

    OptionalmemberAddMode

    memberAddMode?: string

    OptionalmembershipApprovalMode

    membershipApprovalMode?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:allowNonAdminSubGroupCreation: undefined | number;
        change:announce: undefined | number;
        change:cachedDeviceCount: undefined | number;
        change:cachedDeviceSizeBucket: undefined | number;
        change:creation: undefined | number;
        change:defaultSubgroup: undefined | number;
        change:desc: undefined | number;
        change:descId: undefined | number;
        change:descOwner: undefined | number;
        change:descTime: undefined | number;
        change:deviceQueryPromise: undefined | number;
        change:deviceStale: undefined | number;
        change:displayedDesc: undefined | number;
        change:ephemeralDuration: undefined | number;
        change:groupInviteCodePromise: undefined | number;
        change:groupInviteLink: undefined | number;
        change:groupType: undefined | number;
        change:growthLockExpiration: undefined | number;
        change:growthLockType: undefined | number;
        change:id: number;
        change:incognito: undefined | number;
        change:inviteCode: undefined | number;
        change:isIncognitoCag: undefined | number;
        change:isLidAddressingMode: number;
        change:isParentGroup: number;
        change:isParentGroupClosed: number;
        change:isUnnamed: undefined | number;
        change:joinedSubgroups: undefined | number;
        change:lastActivityTimestamp: undefined | number;
        change:lastReportToAdminTimestamp: undefined | number;
        change:lastSeenActivityTimestamp: undefined | number;
        change:memberAddMode: undefined | number;
        change:membershipApprovalMode: undefined | number;
        change:noFrequentlyForwarded: undefined | number;
        change:numSubgroups: undefined | number;
        change:owner: undefined | number;
        change:parentGroup: undefined | number;
        change:participantQueryPromise: undefined | number;
        change:reportToAdminMode: undefined | number;
        change:restrict: undefined | number;
        change:revokeGroupInvitePromise: undefined | number;
        change:revokeGroupsV4AddInvitePromise: undefined | number;
        change:size: undefined | number;
        change:stale: undefined | number;
        change:subject: undefined | number;
        change:subjectTime: undefined | number;
        change:support: undefined | number;
        change:suspended: undefined | number;
        change:terminated: undefined | number;
        change:trusted: undefined | number;
        change:uniqueShortNameMap: undefined | number;
        change:unjoinedSubgroups: undefined | number;
        change:unjoinedSubgroupsQueryPromise: undefined | number;
    }

    OptionalnoFrequentlyForwarded

    noFrequentlyForwarded?: any

    OptionalnumSubgroups

    numSubgroups?: any

    Optionalowner

    owner?: any

    Optionalparent

    parent?: any

    OptionalparentGroup

    parentGroup?: any

    OptionalparticipantQueryPromise

    participantQueryPromise?: any

    participants

    participants: ParticipantCollection

    pastParticipants

    pastParticipants: ParticipantCollection

    proxyName

    proxyName: string

    OptionalreportToAdminMode

    reportToAdminMode?: any

    Optionalrestrict

    restrict?: any

    OptionalrevokeGroupInvitePromise

    revokeGroupInvitePromise?: any

    OptionalrevokeGroupsV4AddInvitePromise

    revokeGroupsV4AddInvitePromise?: any

    Optionalsize

    size?: any

    Optionalstale

    stale?: any

    Optionalsubject

    subject?: string

    OptionalsubjectTime

    subjectTime?: any

    Optionalsupport

    support?: any

    Optionalsuspended

    suspended?: any

    Optionalterminated

    terminated?: any

    Optionaltrusted

    trusted?: any

    OptionaluniqueShortNameMap

    uniqueShortNameMap?: any

    OptionalunjoinedSubgroups

    unjoinedSubgroups?: any

    OptionalunjoinedSubgroupsQueryPromise

    unjoinedSubgroupsQueryPromise?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canSetDescription

    canSetEphemeralSetting

    canSetGroupProperty

    canSetSubject

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    hasUniqueShortNameMention

    incObservers

    initialize

    isListening

    isTrusted

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalallowNonAdminSubGroupCreation

    allowNonAdminSubGroupCreation?: any

    Optionalannounce

    announce?: any

    Readonlyattributes

    attributes: Props & Session

    OptionalcachedDeviceCount

    cachedDeviceCount?: any

    OptionalcachedDeviceSizeBucket

    cachedDeviceSizeBucket?: any

    Optionalcollection

    collection?: undefined

    Optionalcreation

    creation?: any

    OptionaldefaultSubgroup

    defaultSubgroup?: any

    Optionaldesc

    desc?: string

    OptionaldescId

    descId?: string

    OptionaldescOwner

    descOwner?: any

    OptionaldescTime

    descTime?: any

    OptionaldeviceQueryPromise

    deviceQueryPromise?: any

    OptionaldeviceStale

    deviceStale?: any

    OptionaldisplayedDesc

    displayedDesc?: any

    OptionalephemeralDuration

    ephemeralDuration?: any

    OptionalgroupInviteCodePromise

    groupInviteCodePromise?: any

    Optional ReadonlygroupInviteLink

    groupInviteLink?: any

    Optional ReadonlygroupType

    groupType?: string

    OptionalgrowthLockExpiration

    growthLockExpiration?: any

    OptionalgrowthLockType

    growthLockType?: any

    id

    id: Wid

    idClass

    idClass: typeof Wid

    Optionalincognito

    incognito?: any

    OptionalinviteCode

    inviteCode?: any

    Optional ReadonlyisIncognitoCag

    isIncognitoCag?: boolean

    isLidAddressingMode

    isLidAddressingMode: boolean

    isParentGroup

    isParentGroup: boolean

    isParentGroupClosed

    isParentGroupClosed: boolean

    ReadonlyisState

    isState

    Optional ReadonlyisUnnamed

    isUnnamed?: boolean

    OptionaljoinedSubgroups

    joinedSubgroups?: any

    OptionallastActivityTimestamp

    lastActivityTimestamp?: any

    OptionallastReportToAdminTimestamp

    lastReportToAdminTimestamp?: any

    OptionallastSeenActivityTimestamp

    lastSeenActivityTimestamp?: any

    OptionalmemberAddMode

    memberAddMode?: string

    OptionalmembershipApprovalMode

    membershipApprovalMode?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:allowNonAdminSubGroupCreation: undefined | number;
        change:announce: undefined | number;
        change:cachedDeviceCount: undefined | number;
        change:cachedDeviceSizeBucket: undefined | number;
        change:creation: undefined | number;
        change:defaultSubgroup: undefined | number;
        change:desc: undefined | number;
        change:descId: undefined | number;
        change:descOwner: undefined | number;
        change:descTime: undefined | number;
        change:deviceQueryPromise: undefined | number;
        change:deviceStale: undefined | number;
        change:displayedDesc: undefined | number;
        change:ephemeralDuration: undefined | number;
        change:groupInviteCodePromise: undefined | number;
        change:groupInviteLink: undefined | number;
        change:groupType: undefined | number;
        change:growthLockExpiration: undefined | number;
        change:growthLockType: undefined | number;
        change:id: number;
        change:incognito: undefined | number;
        change:inviteCode: undefined | number;
        change:isIncognitoCag: undefined | number;
        change:isLidAddressingMode: number;
        change:isParentGroup: number;
        change:isParentGroupClosed: number;
        change:isUnnamed: undefined | number;
        change:joinedSubgroups: undefined | number;
        change:lastActivityTimestamp: undefined | number;
        change:lastReportToAdminTimestamp: undefined | number;
        change:lastSeenActivityTimestamp: undefined | number;
        change:memberAddMode: undefined | number;
        change:membershipApprovalMode: undefined | number;
        change:noFrequentlyForwarded: undefined | number;
        change:numSubgroups: undefined | number;
        change:owner: undefined | number;
        change:parentGroup: undefined | number;
        change:participantQueryPromise: undefined | number;
        change:reportToAdminMode: undefined | number;
        change:restrict: undefined | number;
        change:revokeGroupInvitePromise: undefined | number;
        change:revokeGroupsV4AddInvitePromise: undefined | number;
        change:size: undefined | number;
        change:stale: undefined | number;
        change:subject: undefined | number;
        change:subjectTime: undefined | number;
        change:support: undefined | number;
        change:suspended: undefined | number;
        change:terminated: undefined | number;
        change:trusted: undefined | number;
        change:uniqueShortNameMap: undefined | number;
        change:unjoinedSubgroups: undefined | number;
        change:unjoinedSubgroupsQueryPromise: undefined | number;
    }

    OptionalnoFrequentlyForwarded

    noFrequentlyForwarded?: any

    OptionalnumSubgroups

    numSubgroups?: any

    Optionalowner

    owner?: any

    Optionalparent

    parent?: any

    OptionalparentGroup

    parentGroup?: any

    OptionalparticipantQueryPromise

    participantQueryPromise?: any

    participants

    participants: ParticipantCollection

    pastParticipants

    pastParticipants: ParticipantCollection

    proxyName

    proxyName: string

    OptionalreportToAdminMode

    reportToAdminMode?: any

    Optionalrestrict

    restrict?: any

    OptionalrevokeGroupInvitePromise

    revokeGroupInvitePromise?: any

    OptionalrevokeGroupsV4AddInvitePromise

    revokeGroupsV4AddInvitePromise?: any

    Optionalsize

    size?: any

    Optionalstale

    stale?: any

    Optionalsubject

    subject?: string

    OptionalsubjectTime

    subjectTime?: any

    Optionalsupport

    support?: any

    Optionalsuspended

    suspended?: any

    Optionalterminated

    terminated?: any

    Optionaltrusted

    trusted?: any

    OptionaluniqueShortNameMap

    uniqueShortNameMap?: any

    OptionalunjoinedSubgroups

    unjoinedSubgroups?: any

    OptionalunjoinedSubgroupsQueryPromise

    unjoinedSubgroupsQueryPromise?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canSetDescription

    canSetEphemeralSetting

    canSetGroupProperty

    canSetSubject

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    hasUniqueShortNameMention

    incObservers

    initialize

    isListening

    isTrusted

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onParticipantShortNameUpdated

    queryGroupV4PendingInvite

    removeAllListeners

    removeListener

    reset

    revokeGroupV4AddInvite

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    revokeGroupV4AddInvite

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    triggerParticipantsChange

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    allowNonAdminSubGroupCreationannounceattributescachedDeviceCountcachedDeviceSizeBucketcollectioncreationdefaultSubgroupdescdescIddescOwnerdescTimedeviceQueryPromisedeviceStaledisplayedDescephemeralDurationgroupInviteCodePromisegroupInviteLinkgroupTypegrowthLockExpirationgrowthLockTypeididClassincognitoinviteCodeisIncognitoCagisLidAddressingModeisParentGroupisParentGroupClosedisStateisUnnamedjoinedSubgroupslastActivityTimestamplastReportToAdminTimestamplastSeenActivityTimestampmemberAddModemembershipApprovalModemirrorMasknoFrequentlyForwardednumSubgroupsownerparentparentGroupparticipantQueryPromiseparticipantspastParticipantsproxyNamereportToAdminModerestrictrevokeGroupInvitePromiserevokeGroupsV4AddInvitePromisesizestalesubjectsubjectTimesupportsuspendedterminatedtrusteduniqueShortNameMapunjoinedSubgroupsunjoinedSubgroupsQueryPromiseallowedIdsidClassProxy
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    allowNonAdminSubGroupCreationannounceattributescachedDeviceCountcachedDeviceSizeBucketcollectioncreationdefaultSubgroupdescdescIddescOwnerdescTimedeviceQueryPromisedeviceStaledisplayedDescephemeralDurationgroupInviteCodePromisegroupInviteLinkgroupTypegrowthLockExpirationgrowthLockTypeididClassincognitoinviteCodeisIncognitoCagisLidAddressingModeisParentGroupisParentGroupClosedisStateisUnnamedjoinedSubgroupslastActivityTimestamplastReportToAdminTimestamplastSeenActivityTimestampmemberAddModemembershipApprovalModemirrorMasknoFrequentlyForwardednumSubgroupsownerparentparentGroupparticipantQueryPromiseparticipantspastParticipantsproxyNamereportToAdminModerestrictrevokeGroupInvitePromiserevokeGroupsV4AddInvitePromisesizestalesubjectsubjectTimesupportsuspendedterminatedtrusteduniqueShortNameMapunjoinedSubgroupsunjoinedSubgroupsQueryPromiseallowedIdsidClassProxy
    Methods
    diff --git a/classes/whatsapp.HistorySyncProgressModel.html b/classes/whatsapp.HistorySyncProgressModel.html index 5863eac5f2..678e2259f1 100644 --- a/classes/whatsapp.HistorySyncProgressModel.html +++ b/classes/whatsapp.HistorySyncProgressModel.html @@ -1,5 +1,5 @@ -HistorySyncProgressModel | @wppconnect/wa-js - v3.10.1

    Class HistorySyncProgressModel

    Whatsapp

    649959 >= 2.2244.5

    -

    Hierarchy (view full)

    Constructors

    constructor +HistorySyncProgressModel | @wppconnect/wa-js - v3.10.1

    Class HistorySyncProgressModel

    Whatsapp

    649959 >= 2.2244.5

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? inProgress @@ -45,40 +45,40 @@ unbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    ReadonlyinProgress

    inProgress: boolean

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:inProgress: number;
        change:paused: number;
        change:progress: number;
    }

    Optionalparent

    parent?: any

    Readonlypaused

    paused: boolean

    Readonlyprogress

    progress: null | number

    proxyName

    proxyName: string

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    ReadonlyinProgress

    inProgress: boolean

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:inProgress: number;
        change:paused: number;
        change:progress: number;
    }

    Optionalparent

    parent?: any

    Readonlypaused

    paused: boolean

    Readonlyprogress

    progress: null | number

    proxyName

    proxyName: string

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    setInProgress

    setPaused

    setProgress

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    setInProgress

    setPaused

    setProgress

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.LabelCollection.html b/classes/whatsapp.LabelCollection.html index 0e1faa285e..5d8d70fe35 100644 --- a/classes/whatsapp.LabelCollection.html +++ b/classes/whatsapp.LabelCollection.html @@ -1,6 +1,6 @@ -LabelCollection | @wppconnect/wa-js - v3.10.1

    Class LabelCollection

    Whatsapp

    16770

    -

    Whatsapp

    316770 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +LabelCollection | @wppconnect/wa-js - v3.10.1

    Class LabelCollection

    Whatsapp

    16770

    +

    Whatsapp

    316770 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    checksum? findFirst modelClass @@ -86,10 +86,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | LabelModel

  • Parameters

    Returns undefined | LabelModel

    • modelClass

    modelClass: LabelModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: LabelModel

    Static OptionalresumeOnAvailable

    resumeOnAvailable?: any

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    _find

    add

    addNewLabel

    addOrRemoveLabels

    addOrRemoveLabelsMD

    assertGet

    at

    bind

    delete

    deleteLabel

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    deleteLabel

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: LabelModel, index: number, array: LabelModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -113,33 +113,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getLabelColorPalette

    getLabelsForModel

    getModelsArray

    getNewLabelColor

    getNextAvailableColor

    handle

    handleRemove

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: LabelModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeAssociationsFromCache

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeAssociationsFromCache

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: LabelModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: LabelModel, index: number, array: LabelModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -151,8 +151,8 @@

        Whatsapp

      Returns U

    remove

    removeAllLabelsMD

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): LabelModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -165,8 +165,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    updateChecksum

    updateLabel

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    updateChecksum

    updateLabel

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.LabelItemCollection.html b/classes/whatsapp.LabelItemCollection.html index cc74e586ff..7626bc8d84 100644 --- a/classes/whatsapp.LabelItemCollection.html +++ b/classes/whatsapp.LabelItemCollection.html @@ -1,6 +1,6 @@ -LabelItemCollection | @wppconnect/wa-js - v3.10.1

    Class LabelItemCollection

    Whatsapp

    34741

    -

    Whatsapp

    634741 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +LabelItemCollection | @wppconnect/wa-js - v3.10.1

    Class LabelItemCollection

    Whatsapp

    34741

    +

    Whatsapp

    634741 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -57,10 +57,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | LabelItemModel

  • Parameters

    Returns undefined | LabelItemModel

    • modelClass

    modelClass: LabelItemModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: LabelItemModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: LabelItemModel, index: number, array: LabelItemModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: LabelItemModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: LabelItemModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: LabelItemModel, index: number, array: LabelItemModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): LabelItemModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.LabelItemModel.html b/classes/whatsapp.LabelItemModel.html index 0ca7feeb14..81bb75f148 100644 --- a/classes/whatsapp.LabelItemModel.html +++ b/classes/whatsapp.LabelItemModel.html @@ -1,6 +1,6 @@ -LabelItemModel | @wppconnect/wa-js - v3.10.1

    Class LabelItemModel

    Whatsapp

    24137

    -

    Whatsapp

    724137 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +LabelItemModel | @wppconnect/wa-js - v3.10.1

    Class LabelItemModel

    Whatsapp

    24137

    +

    Whatsapp

    724137 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id? @@ -45,40 +45,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    OptionallabelId

    labelId?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:labelId: undefined | number;
        change:parentId: undefined | number;
        change:parentType: undefined | number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalparentId

    parentId?: any

    OptionalparentType

    parentType?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState

    OptionallabelId

    labelId?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:labelId: undefined | number;
        change:parentId: undefined | number;
        change:parentType: undefined | number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalparentId

    parentId?: any

    OptionalparentType

    parentType?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.LabelModel.html b/classes/whatsapp.LabelModel.html index 2cba65743e..92b79c92fd 100644 --- a/classes/whatsapp.LabelModel.html +++ b/classes/whatsapp.LabelModel.html @@ -1,6 +1,6 @@ -LabelModel | @wppconnect/wa-js - v3.10.1

    Class LabelModel

    Whatsapp

    8803

    -

    Whatsapp

    208803 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +LabelModel | @wppconnect/wa-js - v3.10.1

    Class LabelModel

    Whatsapp

    8803

    +

    Whatsapp

    208803 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? color? @@ -47,40 +47,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalcolor

    color?: number

    OptionalcolorIndex

    colorIndex?: number

    Optionalcount

    count?: any

    ReadonlyhexColor

    hexColor: string

    id

    id: string

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:color: undefined | number;
        change:colorIndex: undefined | number;
        change:count: undefined | number;
        change:hexColor: number;
        change:id: number;
        change:name: number;
        change:stale: undefined | number;
    }

    name

    name: string

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalcolor

    color?: number

    OptionalcolorIndex

    colorIndex?: number

    Optionalcount

    count?: any

    ReadonlyhexColor

    hexColor: string

    id

    id: string

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:color: undefined | number;
        change:colorIndex: undefined | number;
        change:count: undefined | number;
        change:hexColor: number;
        change:id: number;
        change:name: number;
        change:stale: undefined | number;
    }

    name

    name: string

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.MediaBlobCacheImpl.html b/classes/whatsapp.MediaBlobCacheImpl.html index a1fa6f56d9..126460ee32 100644 --- a/classes/whatsapp.MediaBlobCacheImpl.html +++ b/classes/whatsapp.MediaBlobCacheImpl.html @@ -1,6 +1,6 @@ -MediaBlobCacheImpl | @wppconnect/wa-js - v3.10.1

    Class MediaBlobCacheImpl

    Whatsapp

    84866

    -

    Whatsapp

    284866 >= 2.2222.8

    -

    Constructors

    constructor +MediaBlobCacheImpl | @wppconnect/wa-js - v3.10.1

    Class MediaBlobCacheImpl

    Whatsapp

    84866

    +

    Whatsapp

    284866 >= 2.2222.8

    +

    Constructors

    constructor

    Properties

    is24h

    Methods

    clear decreaseUsageCount diff --git a/classes/whatsapp.MediaDataModel.html b/classes/whatsapp.MediaDataModel.html index 2b50fa3b7f..8b645e1c85 100644 --- a/classes/whatsapp.MediaDataModel.html +++ b/classes/whatsapp.MediaDataModel.html @@ -1,6 +1,6 @@ -MediaDataModel | @wppconnect/wa-js - v3.10.1

    Class MediaDataModel

    Whatsapp

    2320

    -

    Whatsapp

    502320 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +MediaDataModel | @wppconnect/wa-js - v3.10.1

    Class MediaDataModel

    Whatsapp

    2320

    +

    Whatsapp

    502320 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    animatedAsNewMsg? animationDuration? aspectRatio? @@ -87,40 +87,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionalanimatedAsNewMsg

    animatedAsNewMsg?: any

    OptionalanimationDuration

    animationDuration?: any

    OptionalaspectRatio

    aspectRatio?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionaldirectPath

    directPath?: any

    OptionaldocumentPreview

    documentPreview?: any

    Optionalduration

    duration?: any

    OptionaldurationFloat

    durationFloat?: any

    Optionalemojis

    emojis?: any

    OptionalencFilehash

    encFilehash?: any

    Optionalfilehash

    filehash?: any

    Optionalfilename

    filename?: any

    OptionalfirstFrameLength

    firstFrameLength?: any

    OptionalfirstFrameSidecar

    firstFrameSidecar?: any

    OptionalfullHeight

    fullHeight?: any

    OptionalfullPreviewData

    fullPreviewData?: any

    OptionalfullPreviewSize

    fullPreviewSize?: any

    OptionalfullWidth

    fullWidth?: any

    OptionalgifAttribution

    gifAttribution?: any

    isAnimated

    isAnimated: boolean

    isGif

    isGif: boolean

    ReadonlyisState

    isState: true

    isVcardOverMmsDocument

    isVcardOverMmsDocument: boolean

    isViewOnce

    isViewOnce: boolean

    OptionalmediaBlob

    mediaBlob?: OpaqueData

    OptionalmediaKey

    mediaKey?: any

    OptionalmediaKeyTimestamp

    mediaKeyTimestamp?: any

    OptionalmediaStage

    mediaStage?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:animatedAsNewMsg: undefined | number;
        change:animationDuration: undefined | number;
        change:aspectRatio: undefined | number;
        change:directPath: undefined | number;
        change:documentPreview: undefined | number;
        change:duration: undefined | number;
        change:durationFloat: undefined | number;
        change:emojis: undefined | number;
        change:encFilehash: undefined | number;
        change:filehash: undefined | number;
        change:filename: undefined | number;
        change:firstFrameLength: undefined | number;
        change:firstFrameSidecar: undefined | number;
        change:fullHeight: undefined | number;
        change:fullPreviewData: undefined | number;
        change:fullPreviewSize: undefined | number;
        change:fullWidth: undefined | number;
        change:gifAttribution: undefined | number;
        change:isAnimated: number;
        change:isGif: number;
        change:isVcardOverMmsDocument: number;
        change:isViewOnce: number;
        change:mediaBlob: undefined | number;
        change:mediaKey: undefined | number;
        change:mediaKeyTimestamp: undefined | number;
        change:mediaStage: undefined | number;
        change:mimetype: undefined | number;
        change:pageCount: undefined | number;
        change:parsedVcards: undefined | number;
        change:preview: undefined | number;
        change:progressiveStage: undefined | number;
        change:renderableUrl: undefined | number;
        change:rgbaBuffer: undefined | number;
        change:rgbaHeight: undefined | number;
        change:rgbaWidth: undefined | number;
        change:sidecar: undefined | number;
        change:singleLoopDuration: undefined | number;
        change:size: undefined | number;
        change:stale: undefined | number;
        change:streamable: undefined | number;
        change:subtype: undefined | number;
        change:type: undefined | number;
    }

    OptionalpageCount

    pageCount?: any

    Optionalparent

    parent?: any

    OptionalparsedVcards

    parsedVcards?: any

    Optionalpreview

    preview?: any

    OptionalprogressiveStage

    progressiveStage?: any

    proxyName

    proxyName: string

    OptionalrenderableUrl

    renderableUrl?: any

    OptionalrgbaBuffer

    rgbaBuffer?: any

    OptionalrgbaHeight

    rgbaHeight?: any

    OptionalrgbaWidth

    rgbaWidth?: any

    Optionalsidecar

    sidecar?: any

    OptionalsingleLoopDuration

    singleLoopDuration?: any

    Optionalsize

    size?: any

    Optionalstale

    stale?: any

    Optional Readonlystreamable

    streamable?: any

    Optionalsubtype

    subtype?: any

    Optionaltype

    type?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Static OptionalTYPE

    TYPE?: any

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isDownloadable

    isListening

    isStreamable

    isStreamableType

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalanimatedAsNewMsg

    animatedAsNewMsg?: any

    OptionalanimationDuration

    animationDuration?: any

    OptionalaspectRatio

    aspectRatio?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionaldirectPath

    directPath?: any

    OptionaldocumentPreview

    documentPreview?: any

    Optionalduration

    duration?: any

    OptionaldurationFloat

    durationFloat?: any

    Optionalemojis

    emojis?: any

    OptionalencFilehash

    encFilehash?: any

    Optionalfilehash

    filehash?: any

    Optionalfilename

    filename?: any

    OptionalfirstFrameLength

    firstFrameLength?: any

    OptionalfirstFrameSidecar

    firstFrameSidecar?: any

    OptionalfullHeight

    fullHeight?: any

    OptionalfullPreviewData

    fullPreviewData?: any

    OptionalfullPreviewSize

    fullPreviewSize?: any

    OptionalfullWidth

    fullWidth?: any

    OptionalgifAttribution

    gifAttribution?: any

    isAnimated

    isAnimated: boolean

    isGif

    isGif: boolean

    ReadonlyisState

    isState

    isVcardOverMmsDocument

    isVcardOverMmsDocument: boolean

    isViewOnce

    isViewOnce: boolean

    OptionalmediaBlob

    mediaBlob?: OpaqueData

    OptionalmediaKey

    mediaKey?: any

    OptionalmediaKeyTimestamp

    mediaKeyTimestamp?: any

    OptionalmediaStage

    mediaStage?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:animatedAsNewMsg: undefined | number;
        change:animationDuration: undefined | number;
        change:aspectRatio: undefined | number;
        change:directPath: undefined | number;
        change:documentPreview: undefined | number;
        change:duration: undefined | number;
        change:durationFloat: undefined | number;
        change:emojis: undefined | number;
        change:encFilehash: undefined | number;
        change:filehash: undefined | number;
        change:filename: undefined | number;
        change:firstFrameLength: undefined | number;
        change:firstFrameSidecar: undefined | number;
        change:fullHeight: undefined | number;
        change:fullPreviewData: undefined | number;
        change:fullPreviewSize: undefined | number;
        change:fullWidth: undefined | number;
        change:gifAttribution: undefined | number;
        change:isAnimated: number;
        change:isGif: number;
        change:isVcardOverMmsDocument: number;
        change:isViewOnce: number;
        change:mediaBlob: undefined | number;
        change:mediaKey: undefined | number;
        change:mediaKeyTimestamp: undefined | number;
        change:mediaStage: undefined | number;
        change:mimetype: undefined | number;
        change:pageCount: undefined | number;
        change:parsedVcards: undefined | number;
        change:preview: undefined | number;
        change:progressiveStage: undefined | number;
        change:renderableUrl: undefined | number;
        change:rgbaBuffer: undefined | number;
        change:rgbaHeight: undefined | number;
        change:rgbaWidth: undefined | number;
        change:sidecar: undefined | number;
        change:singleLoopDuration: undefined | number;
        change:size: undefined | number;
        change:stale: undefined | number;
        change:streamable: undefined | number;
        change:subtype: undefined | number;
        change:type: undefined | number;
    }

    OptionalpageCount

    pageCount?: any

    Optionalparent

    parent?: any

    OptionalparsedVcards

    parsedVcards?: any

    Optionalpreview

    preview?: any

    OptionalprogressiveStage

    progressiveStage?: any

    proxyName

    proxyName: string

    OptionalrenderableUrl

    renderableUrl?: any

    OptionalrgbaBuffer

    rgbaBuffer?: any

    OptionalrgbaHeight

    rgbaHeight?: any

    OptionalrgbaWidth

    rgbaWidth?: any

    Optionalsidecar

    sidecar?: any

    OptionalsingleLoopDuration

    singleLoopDuration?: any

    Optionalsize

    size?: any

    Optionalstale

    stale?: any

    Optional Readonlystreamable

    streamable?: any

    Optionalsubtype

    subtype?: any

    Optionaltype

    type?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Static OptionalTYPE

    TYPE?: any

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isDownloadable

    isListening

    isStreamable

    isStreamableType

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToServiceWorkerSupport

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.MediaEntry.html b/classes/whatsapp.MediaEntry.html index c9dcafe5bf..af9e362fea 100644 --- a/classes/whatsapp.MediaEntry.html +++ b/classes/whatsapp.MediaEntry.html @@ -1,6 +1,6 @@ -MediaEntry | @wppconnect/wa-js - v3.10.1

    Class MediaEntry

    Whatsapp

    80923

    -

    Whatsapp

    480923 >= 2.2222.8

    -

    Constructors

    constructor +MediaEntry | @wppconnect/wa-js - v3.10.1

    Class MediaEntry

    Whatsapp

    80923

    +

    Whatsapp

    480923 >= 2.2222.8

    +

    Constructors

    constructor

    Properties

    deprecatedMms3Url? directPath encFilehash diff --git a/classes/whatsapp.MediaObject.html b/classes/whatsapp.MediaObject.html index f62a075dc0..751a6e6f7e 100644 --- a/classes/whatsapp.MediaObject.html +++ b/classes/whatsapp.MediaObject.html @@ -1,6 +1,6 @@ -MediaObject | @wppconnect/wa-js - v3.10.1

    Class MediaObject

    Whatsapp

    21009

    -

    Whatsapp

    721009 >= 2.2222.8

    -

    Constructors

    constructor +MediaObject | @wppconnect/wa-js - v3.10.1

    Class MediaObject

    Whatsapp

    21009

    +

    Whatsapp

    721009 >= 2.2222.8

    +

    Constructors

    constructor

    Properties

    contentInfo downloadPromise downloadStage diff --git a/classes/whatsapp.Model.html b/classes/whatsapp.Model.html index 31fec8fb96..1246e4e9f5 100644 --- a/classes/whatsapp.Model.html +++ b/classes/whatsapp.Model.html @@ -1,6 +1,6 @@ -Model | @wppconnect/wa-js - v3.10.1

    Class Model<Collection>

    Whatsapp

    11290

    -

    Whatsapp

    411290 >= 2.2222.8

    -

    Type Parameters

    • Collection = undefined

    Hierarchy (view full)

    Constructors

    constructor +Model | @wppconnect/wa-js - v3.10.1

    Class Model<Collection>

    Whatsapp

    11290

    +

    Whatsapp

    411290 >= 2.2222.8

    +

    Type Parameters

    • Collection = undefined

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    collection? parent? proxyName @@ -36,39 +36,39 @@

    Whatsappunset isIdType

    Constructors

    constructor

    Properties

    Optionalcollection

    collection?: Collection

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    • addChild(id, context): void

    • Parameters

      • id: Stringable
      • context: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns void

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    set

    stopListening

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    set

    stopListening

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ModelChatBase.html b/classes/whatsapp.ModelChatBase.html index 08283bd8e0..62e58be3ca 100644 --- a/classes/whatsapp.ModelChatBase.html +++ b/classes/whatsapp.ModelChatBase.html @@ -1,6 +1,6 @@ -ModelChatBase | @wppconnect/wa-js - v3.10.1

    Class ModelChatBase

    Whatsapp

    58492

    -

    Whatsapp

    558492 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ModelChatBase | @wppconnect/wa-js - v3.10.1

    Class ModelChatBase

    Whatsapp

    58492

    +

    Whatsapp

    558492 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    collection? msgs parent? @@ -44,39 +44,39 @@

    Whatsappunset isIdType

    Constructors

    constructor

    Properties

    Optionalcollection

    collection?: ChatCollection

    msgs

    msgs: MsgLoad

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getAllCMCs

    getAllMsgs

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event
        • listener: Listener
        • Optionalcontext: any

        Returns this

        Alias

        on

        +

    clear

    decObservers

    delete

    emit

    get

    getAllCMCs

    getAllMsgs

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    notifyMsgCollectionMerge

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onEmptyMRM

    removeAllListeners

    removeListener

    removeMsg

    removeMsgsCollection

    replaceMsgsCollection

    reset

    set

    stopListening

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    removeMsg

    removeMsgsCollection

    replaceMsgsCollection

    reset

    set

    stopListening

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.MsgButtonReplyMsgModel.html b/classes/whatsapp.MsgButtonReplyMsgModel.html index 8c2a9a5cc5..47f7d629a9 100644 --- a/classes/whatsapp.MsgButtonReplyMsgModel.html +++ b/classes/whatsapp.MsgButtonReplyMsgModel.html @@ -1,6 +1,6 @@ -MsgButtonReplyMsgModel | @wppconnect/wa-js - v3.10.1

    Class MsgButtonReplyMsgModel

    Whatsapp

    52846

    -

    Whatsapp

    252846 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgButtonReplyMsgModel | @wppconnect/wa-js - v3.10.1

    Class MsgButtonReplyMsgModel

    Whatsapp

    52846

    +

    Whatsapp

    252846 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id @@ -44,40 +44,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    id

    id: MsgKey

    idClass

    idClass: typeof MsgKey

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:stale: undefined | number;
        change:unsyncedButtonReplies: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    OptionalunsyncedButtonReplies

    unsyncedButtonReplies?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    id

    id: MsgKey

    idClass

    idClass: typeof MsgKey

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:stale: undefined | number;
        change:unsyncedButtonReplies: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    OptionalunsyncedButtonReplies

    unsyncedButtonReplies?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.MsgCollection.html b/classes/whatsapp.MsgCollection.html index 895c0b4a4b..97719960b6 100644 --- a/classes/whatsapp.MsgCollection.html +++ b/classes/whatsapp.MsgCollection.html @@ -1,6 +1,6 @@ -MsgCollection | @wppconnect/wa-js - v3.10.1

    Class MsgCollection

    Whatsapp

    59871

    -

    Whatsapp

    559871 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgCollection | @wppconnect/wa-js - v3.10.1

    Class MsgCollection

    Whatsapp

    59871

    +

    Whatsapp

    559871 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst ftsCache? lastReceivedPaymentTransaction? @@ -91,10 +91,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | MsgModel

  • Parameters

    • predicate: ((value: MsgModel, index: number, obj: MsgModel[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | MsgModel

    • OptionalftsCache

    ftsCache?: any

    OptionallastReceivedPaymentTransaction

    lastReceivedPaymentTransaction?: any

    OptionallastReceivedReceipt

    lastReceivedReceipt?: any

    modelClass

    modelClass: MsgModel

    onResume

    onResume: ((...args: any) => any)

    OptionalpendingAdd

    pendingAdd?: any

    OptionalpreAck

    preAck?: any

    OptionalproductListMessagesPrefetchChain

    productListMessagesPrefetchChain?: any

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: MsgModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: MsgModel, index: number, array: MsgModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -118,33 +118,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getContext

    getKeysForResyncReceipts

    getMessagesById

    getModelsArray

    getStarred

    handle

    hasSynced

    head

    includes

    incrementalStarredUpdate

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: MsgModel, index: number, array: MsgModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    markAllAsStale

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -156,8 +156,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeFromCollection

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    resyncReceipts

    saveToCache

    search

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    resyncReceipts

    saveToCache

    search

    serialize

    set

    slice

    • slice(start?, end?): MsgModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -170,8 +170,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    updateLastReceipt

    updateLastTransactionTime

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    updateLastReceipt

    updateLastTransactionTime

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.MsgInfoCollection.html b/classes/whatsapp.MsgInfoCollection.html index f882f98748..9a9f5d5ef7 100644 --- a/classes/whatsapp.MsgInfoCollection.html +++ b/classes/whatsapp.MsgInfoCollection.html @@ -1,6 +1,6 @@ -MsgInfoCollection | @wppconnect/wa-js - v3.10.1

    Class MsgInfoCollection

    Whatsapp

    617972 >= 2.2222.8

    -

    Whatsapp

    739245 >= 2.2242.6

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgInfoCollection | @wppconnect/wa-js - v3.10.1

    Class MsgInfoCollection

    Whatsapp

    617972 >= 2.2222.8

    +

    Whatsapp

    739245 >= 2.2242.6

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -71,10 +71,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | MsgInfoModel

  • Parameters

    Returns undefined | MsgInfoModel

    • modelClass

    modelClass: MsgInfoModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: MsgInfoModel

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: MsgInfoModel, index: number, array: MsgInfoModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -98,33 +98,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgInfoModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgInfoModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: MsgInfoModel, index: number, array: MsgInfoModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -136,8 +136,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): MsgInfoModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -150,8 +150,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    updateInfo

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    updateInfo

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.MsgInfoModel.html b/classes/whatsapp.MsgInfoModel.html index 9e35df4791..b301222d2e 100644 --- a/classes/whatsapp.MsgInfoModel.html +++ b/classes/whatsapp.MsgInfoModel.html @@ -1,6 +1,6 @@ -MsgInfoModel | @wppconnect/wa-js - v3.10.1

    Class MsgInfoModel

    Whatsapp

    54311

    -

    Whatsapp

    738482 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgInfoModel | @wppconnect/wa-js - v3.10.1

    Class MsgInfoModel

    Whatsapp

    54311

    +

    Whatsapp

    738482 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? delivery @@ -53,40 +53,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: MsgInfoCollection

    delivery

    delivery: MsgInfoParticipantCollection

    OptionaldeliveryPrivacyMode

    deliveryPrivacyMode?: any

    deliveryRemaining

    deliveryRemaining: number

    id

    id: MsgKey

    idClass

    idClass: typeof MsgKey

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:deliveryPrivacyMode: undefined | number;
        change:deliveryRemaining: number;
        change:id: number;
        change:playedRemaining: number;
        change:readRemaining: number;
        change:settled: undefined | number;
        change:stale: undefined | number;
        change:usePlayReceipt: undefined | number;
    }

    Optionalparent

    parent?: any

    played

    played: MsgInfoParticipantCollection

    playedRemaining

    playedRemaining: number

    proxyName

    proxyName: string

    read

    read: MsgInfoParticipantCollection

    readRemaining

    readRemaining: number

    Optional Readonlysettled

    settled?: any

    Optionalstale

    stale?: any

    OptionalusePlayReceipt

    usePlayReceipt?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: MsgInfoCollection

    delivery

    delivery: MsgInfoParticipantCollection

    OptionaldeliveryPrivacyMode

    deliveryPrivacyMode?: any

    deliveryRemaining

    deliveryRemaining: number

    id

    id: MsgKey

    idClass

    idClass: typeof MsgKey

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:deliveryPrivacyMode: undefined | number;
        change:deliveryRemaining: number;
        change:id: number;
        change:playedRemaining: number;
        change:readRemaining: number;
        change:settled: undefined | number;
        change:stale: undefined | number;
        change:usePlayReceipt: undefined | number;
    }

    Optionalparent

    parent?: any

    played

    played: MsgInfoParticipantCollection

    playedRemaining

    playedRemaining: number

    proxyName

    proxyName: string

    read

    read: MsgInfoParticipantCollection

    readRemaining

    readRemaining: number

    Optional Readonlysettled

    settled?: any

    Optionalstale

    stale?: any

    OptionalusePlayReceipt

    usePlayReceipt?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.MsgInfoParticipantCollection.html b/classes/whatsapp.MsgInfoParticipantCollection.html index 316e228952..12423804a4 100644 --- a/classes/whatsapp.MsgInfoParticipantCollection.html +++ b/classes/whatsapp.MsgInfoParticipantCollection.html @@ -1,5 +1,5 @@ -MsgInfoParticipantCollection | @wppconnect/wa-js - v3.10.1

    Class MsgInfoParticipantCollection

    Whatsapp

    738482 >= 2.2242.6

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgInfoParticipantCollection | @wppconnect/wa-js - v3.10.1

    Class MsgInfoParticipantCollection

    Whatsapp

    738482 >= 2.2242.6

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass model @@ -56,10 +56,10 @@
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | MsgInfoParticipantModel

  • Parameters

    Returns undefined | MsgInfoParticipantModel

    • modelClass

    modelClass: MsgInfoParticipantModel

    Staticmodel

    model: MsgInfoParticipantModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: MsgInfoParticipantModel, index: number, array: MsgInfoParticipantModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -83,33 +83,33 @@

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgInfoParticipantModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgInfoParticipantModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: MsgInfoParticipantModel, index: number, array: MsgInfoParticipantModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -121,8 +121,8 @@

    Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    sort

    stopListening

    toArray

    toJSON

    trigger

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.MsgInfoParticipantModel.html b/classes/whatsapp.MsgInfoParticipantModel.html index aef8181a50..ed40f7975e 100644 --- a/classes/whatsapp.MsgInfoParticipantModel.html +++ b/classes/whatsapp.MsgInfoParticipantModel.html @@ -1,5 +1,5 @@ -MsgInfoParticipantModel | @wppconnect/wa-js - v3.10.1

    Class MsgInfoParticipantModel

    Whatsapp

    738482 >= 2.2242.6

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgInfoParticipantModel | @wppconnect/wa-js - v3.10.1

    Class MsgInfoParticipantModel

    Whatsapp

    738482 >= 2.2242.6

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? contact @@ -43,40 +43,40 @@ unbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: MsgInfoCollection

    contact

    contact: ContactModel

    id

    id: Wid

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:contact: number;
        change:id: number;
        change:t: number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    t

    t: number

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: MsgInfoCollection

    contact

    contact: ContactModel

    id

    id: Wid

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:contact: number;
        change:id: number;
        change:t: number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    t

    t: number

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.MsgKey.html b/classes/whatsapp.MsgKey.html index b83ee9a22f..fb5821f074 100644 --- a/classes/whatsapp.MsgKey.html +++ b/classes/whatsapp.MsgKey.html @@ -1,7 +1,7 @@ -MsgKey | @wppconnect/wa-js - v3.10.1

    Class MsgKey

    Whatsapp

    65212

    -

    Whatsapp

    32219 >= 2.2204.13

    -

    Whatsapp

    465212 >= 2.2222.8

    -

    Constructors

    constructor +MsgKey | @wppconnect/wa-js - v3.10.1

    Class MsgKey

    Whatsapp

    65212

    +

    Whatsapp

    32219 >= 2.2204.13

    +

    Whatsapp

    465212 >= 2.2222.8

    +

    Constructors

    constructor

    Properties

    _serialized fromMe id @@ -12,7 +12,7 @@

    WhatsapptoString fromString newId -

    Constructors

    constructor

    • new MsgKey(options): MsgKey

    • Parameters

      • options: {
            from: Wid;
            id: string;
            participant?: any;
            selfDir: "in" | "out";
            to: Wid;
        } | {
            fromMe: boolean;
            id: string;
            participant?: any;
            remote: Wid;
        }

      Returns MsgKey

    Properties

    _serialized

    _serialized: string

    fromMe

    fromMe: boolean

    id

    id: string

    participant

    participant: any

    remote

    remote: Wid

    Methods

    clone

    equals

    toString

    StaticfromString

    StaticnewId

    Constructors

    constructor

    • new MsgKey(options): MsgKey

    • Parameters

      • options: {
            from: Wid;
            id: string;
            participant?: any;
            selfDir: "in" | "out";
            to: Wid;
        } | {
            fromMe: boolean;
            id: string;
            participant?: any;
            remote: Wid;
        }

      Returns MsgKey

    Properties

    _serialized

    _serialized: string

    fromMe

    fromMe: boolean

    id

    id: string

    participant

    participant: any

    remote

    remote: Wid

    Methods

    clone

    equals

    toString

    StaticfromString

    StaticnewId

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.MsgLoad.html b/classes/whatsapp.MsgLoad.html index 1a7e8c8d12..a17e3d67b2 100644 --- a/classes/whatsapp.MsgLoad.html +++ b/classes/whatsapp.MsgLoad.html @@ -1,6 +1,6 @@ -MsgLoad | @wppconnect/wa-js - v3.10.1

    Class MsgLoad

    Whatsapp

    51612

    -

    Whatsapp

    951612 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgLoad | @wppconnect/wa-js - v3.10.1

    Class MsgLoad

    Whatsapp

    51612

    +

    Whatsapp

    951612 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst loadAroundPromise? loadEarlierPromise? @@ -73,10 +73,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | MsgModel

  • Parameters

    • predicate: ((value: MsgModel, index: number, obj: MsgModel[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | MsgModel

    • OptionalloadAroundPromise

    loadAroundPromise?: Promise<any>

    OptionalloadEarlierPromise

    loadEarlierPromise?: Promise<any>

    OptionalloadRecentPromise

    loadRecentPromise?: Promise<any>

    modelClass

    modelClass: MsgModel

    msgLoadState

    msgLoadState: MsgLoadState

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: MsgModel, index: number, array: MsgModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -100,33 +100,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: MsgModel, index: number, array: MsgModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -138,8 +138,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): MsgModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -152,8 +152,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.MsgLoadState.html b/classes/whatsapp.MsgLoadState.html index 52814e707f..974369abe3 100644 --- a/classes/whatsapp.MsgLoadState.html +++ b/classes/whatsapp.MsgLoadState.html @@ -1,6 +1,6 @@ -MsgLoadState | @wppconnect/wa-js - v3.10.1

    Class MsgLoadState

    Whatsapp

    51612

    -

    Whatsapp

    951612 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgLoadState | @wppconnect/wa-js - v3.10.1

    Class MsgLoadState

    Whatsapp

    51612

    +

    Whatsapp

    951612 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    collection? contextLoaded isLoadingAroundMsgs @@ -41,39 +41,39 @@

    Whatsappunset isIdType

    Constructors

    constructor

    Properties

    Optionalcollection

    collection?: undefined

    contextLoaded

    contextLoaded: any

    isLoadingAroundMsgs

    isLoadingAroundMsgs: any

    isLoadingEarlierMsgs

    isLoadingEarlierMsgs: any

    isLoadingRecentMsgs

    isLoadingRecentMsgs: any

    noEarlierMsgs

    noEarlierMsgs: any

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event
        • listener: Listener
        • Optionalcontext: any

        Returns this

        Alias

        on

        +

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    set

    stopListening

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    set

    stopListening

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.MsgModel.html b/classes/whatsapp.MsgModel.html index 1d01037435..bc6a488342 100644 --- a/classes/whatsapp.MsgModel.html +++ b/classes/whatsapp.MsgModel.html @@ -1,5 +1,5 @@ -MsgModel | @wppconnect/wa-js - v3.10.1

    Class MsgModel

    Whatsapp

    17304

    -

    Hierarchy (view full)

    Constructors

    constructor +MsgModel | @wppconnect/wa-js - v3.10.1

    Class MsgModel

    Whatsapp

    17304

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    accuracy? ack? appStateFatalExceptionNotification? @@ -341,41 +341,41 @@ waitForPrep isIdType

    Constructors

    constructor

    Properties

    Optionalaccuracy

    accuracy?: number

    Optionalack

    ack?: ACK

    See Constants

    -

    OptionalappStateFatalExceptionNotification

    appStateFatalExceptionNotification?: any

    OptionalappStateSyncKeyRequest

    appStateSyncKeyRequest?: any

    OptionalappStateSyncKeyShare

    appStateSyncKeyShare?: any

    Optional ReadonlyasAlbumAsset

    asAlbumAsset?: any

    Optional ReadonlyasBroadcastNotification

    asBroadcastNotification?: any

    Optional ReadonlyasDoc

    asDoc?: any

    Optional ReadonlyasGroupedSticker

    asGroupedSticker?: any

    Optional ReadonlyasGroupNotification

    asGroupNotification?: any

    Optional ReadonlyasImage

    asImage?: any

    Optional ReadonlyasMms

    asMms?: any

    Optional ReadonlyasPollCreation

    asPollCreation?: any

    Optional ReadonlyasPollUpdate

    asPollUpdate?: any

    Optional ReadonlyasProduct

    asProduct?: any

    Optional ReadonlyasProductInquiry

    asProductInquiry?: any

    Optional ReadonlyasRevoked

    asRevoked?: any

    Optional ReadonlyasUrl

    asUrl?: any

    Optional ReadonlyasVideo

    asVideo?: any

    Optional ReadonlyasViewOnce

    asViewOnce?: any

    Optional ReadonlyasVisualMedia

    asVisualMedia?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalauthor

    author?: Wid

    OptionalbackgroundColor

    backgroundColor?: number

    OptionalbizPrivacyStatus

    bizPrivacyStatus?: any

    Optionalbody

    body?: string

    Optionalbroadcast

    broadcast?: any

    OptionalbroadcastEphSettings

    broadcastEphSettings?: any

    OptionalbroadcastId

    broadcastId?: any

    OptionalbroadcastParticipants

    broadcastParticipants?: any

    OptionalbusinessOwnerJid

    businessOwnerJid?: any

    Optionalbuttons

    buttons?: TemplateButtonCollection

    OptionalbuttonsResponse

    buttonsResponse?: any

    canonicalUrl

    canonicalUrl: boolean

    Optionalcaption

    caption?: string

    Optional Readonlychat

    chat?: ChatModel

    Deprecated

    OptionalclearMedia

    clearMedia?: any

    OptionalclientUrl

    clientUrl?: any

    Optionalcollection

    collection?: undefined

    Optionalcomment

    comment?: string

    Optional ReadonlycontainsEmoji

    containsEmoji?: any

    OptionalctwaContext

    ctwaContext?: any

    OptionalcurrencyCode

    currencyCode?: any

    Optionaldegrees

    degrees?: number

    OptionaldeprecatedMms3Url

    deprecatedMms3Url?: any

    Optionaldescription

    description?: any

    OptionaldevicesAdded

    devicesAdded?: any

    OptionaldevicesRemoved

    devicesRemoved?: any

    Optional Readonlydir

    dir?: any

    OptionaldirectPath

    directPath?: any

    OptionaldisappearingModeInitiator

    disappearingModeInitiator?: any

    OptionaldoNotPlayInline

    doNotPlayInline?: any

    Optionalduration

    duration?: number

    OptionaldynamicReplyButtons

    dynamicReplyButtons?: {
        buttonId: string;
        buttonText: {
            displayText: string;
        };
        type: number;
    }[]

    OptionalencFilehash

    encFilehash?: any

    OptionalephemeralDuration

    ephemeralDuration?: number

    Optional ReadonlyephemeralExpirationTimestamp

    ephemeralExpirationTimestamp?: any

    OptionalephemeralOutOfSync

    ephemeralOutOfSync?: any

    OptionalephemeralSettingTimestamp

    ephemeralSettingTimestamp?: number

    OptionalephemeralSharedSecret

    ephemeralSharedSecret?: any

    OptionalephemeralStartTimestamp

    ephemeralStartTimestamp?: any

    Optional ReadonlyeventType

    eventType?: any

    Optionalfilehash

    filehash?: any

    Optionalfilename

    filename?: any

    OptionalfinalAccuracy

    finalAccuracy?: any

    OptionalfinalDegrees

    finalDegrees?: any

    OptionalfinalLat

    finalLat?: any

    OptionalfinalLng

    finalLng?: any

    OptionalfinalSpeed

    finalSpeed?: any

    OptionalfinalThumbnail

    finalThumbnail?: any

    OptionalfinalTimeOffset

    finalTimeOffset?: any

    OptionalfirstFrameLength

    firstFrameLength?: any

    OptionalfirstFrameSidecar

    firstFrameSidecar?: any

    Optionalfont

    font?: TextFontStyle

    Optionalfooter

    footer?: string

    OptionalforwardedFromWeb

    forwardedFromWeb?: any

    OptionalforwardingScore

    forwardingScore?: any

    Optionalfrom

    from?: Wid

    OptionalgifAttribution

    gifAttribution?: any

    ReadonlyhasBodyOrFooter

    hasBodyOrFooter: boolean

    ReadonlyhasTemplateButtons

    hasTemplateButtons: boolean

    Optionalheight

    height?: any

    OptionalhistorySyncMetaData

    historySyncMetaData?: any

    OptionalhydratedButtons

    hydratedButtons?: {
        callButton?: {
            displayText: string;
            phoneNumber: string;
        };
        index?: number;
        quickReplyButton?: {
            displayText: string;
            id: string;
        };
        urlButton?: {
            displayText: string;
            url: string;
        };
    }[]

    id

    id: MsgKey

    idClass

    idClass: typeof MsgKey

    Optional ReadonlyinitialPageSize

    initialPageSize?: any

    OptionalinteractiveAnnotations

    interactiveAnnotations?: any

    OptionalinteractiveMessage

    interactiveMessage?: any

    Optional ReadonlyinteractivePayload

    interactivePayload?: any

    Optionalinvis

    invis?: any

    OptionalinviteCode

    inviteCode?: any

    OptionalinviteCodeExp

    inviteCodeExp?: any

    OptionalinviteGrp

    inviteGrp?: any

    OptionalinviteGrpJpegThum

    inviteGrpJpegThum?: any

    OptionalinviteGrpName

    inviteGrpName?: any

    isAnimated

    isAnimated: boolean

    ReadonlyisBizNotification

    isBizNotification: boolean

    isCaptionByUser

    isCaptionByUser: boolean

    isDynamicReplyButtonsMsg

    isDynamicReplyButtonsMsg: boolean

    ReadonlyisEphemeral

    isEphemeral: boolean

    ReadonlyisFailed

    isFailed: boolean

    isForwarded

    isForwarded: boolean

    ReadonlyisFrequentlyForwarded

    isFrequentlyForwarded: boolean

    isFromTemplate

    isFromTemplate: boolean

    ReadonlyisFutureproof

    isFutureproof: boolean

    isGif

    isGif: boolean

    ReadonlyisGroupMsg

    isGroupMsg: boolean

    Deprecated

    ReadonlyisGroupsV4InviteExpired

    isGroupsV4InviteExpired: boolean

    ReadonlyisInternational

    isInternational: boolean

    isLive

    isLive: boolean

    isMdHistoryMsg

    isMdHistoryMsg: boolean

    ReadonlyisMedia

    isMedia: boolean

    isNewMsg

    isNewMsg: boolean

    ReadonlyisNotification

    isNotification: boolean

    ReadonlyisPersistent

    isPersistent: boolean

    ReadonlyisPSA

    isPSA: boolean

    ReadonlyisQuickReply

    isQuickReply: boolean

    isQuotedMsgAvailable

    isQuotedMsgAvailable: boolean

    ReadonlyisRevokedByMe

    isRevokedByMe: boolean

    ReadonlyisRTL

    isRTL: boolean

    isSendFailure

    isSendFailure: boolean

    ReadonlyisSentByMe

    isSentByMe: boolean

    ReadonlyisSentByMeFromWeb

    isSentByMeFromWeb: boolean

    ReadonlyisState

    isState: true

    ReadonlyisStatusV3

    isStatusV3: boolean

    isThisDeviceAdded

    isThisDeviceAdded: boolean

    ReadonlyisUnreadType

    isUnreadType: boolean

    ReadonlyisUnsentMedia

    isUnsentMedia: boolean

    ReadonlyisUserCreatedType

    isUserCreatedType: boolean

    isVcardOverMmsDocument

    isVcardOverMmsDocument: boolean

    isViewOnce

    isViewOnce: boolean

    OptionalitemCount

    itemCount?: any

    Optionallabels

    labels?: any

    Optionallat

    lat?: number

    Optional ReadonlylinkPreview

    linkPreview?: {
        canonicalUrl?: string;
        description?: string;
        doNotPlayInline: boolean;
        matchedText: string;
        richPreviewType: number;
        thumbnail?: string;
        title?: string;
    }

    OptionallinksIndexParsed

    linksIndexParsed?: any

    Optionallist

    list?: {
        buttonText: string;
        description: string;
        footerText?: string;
        listType: number;
        sections: {
            rows: {
                description: string;
                rowId: string;
                title: string;
            }[];
            title: string;
        }[];
        title?: string;
    }

    OptionallistResponse

    listResponse?: any

    Optionallng

    lng?: number

    Optionalloc

    loc?: any

    Optionallocal

    local?: true

    OptionalmatchedText

    matchedText?: any

    OptionalmdDowngrade

    mdDowngrade?: any

    OptionalmediaData

    mediaData?: MediaDataModel

    OptionalmediaKey

    mediaKey?: any

    OptionalmediaKeyTimestamp

    mediaKeyTimestamp?: any

    OptionalmediaObject

    mediaObject?: MediaObject

    OptionalmentionedJidList

    mentionedJidList?: Wid[]

    Optionalmessage

    message?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:accuracy: undefined | number;
        change:ack: undefined | number;
        change:appStateFatalExceptionNotification: undefined | number;
        change:appStateSyncKeyRequest: undefined | number;
        change:appStateSyncKeyShare: undefined | number;
        change:asAlbumAsset: undefined | number;
        change:asBroadcastNotification: undefined | number;
        change:asDoc: undefined | number;
        change:asGroupedSticker: undefined | number;
        change:asGroupNotification: undefined | number;
        change:asImage: undefined | number;
        change:asMms: undefined | number;
        change:asPollCreation: undefined | number;
        change:asPollUpdate: undefined | number;
        change:asProduct: undefined | number;
        change:asProductInquiry: undefined | number;
        change:asRevoked: undefined | number;
        change:asUrl: undefined | number;
        change:asVideo: undefined | number;
        change:asViewOnce: undefined | number;
        change:asVisualMedia: undefined | number;
        change:author: undefined | number;
        change:backgroundColor: undefined | number;
        change:bizPrivacyStatus: undefined | number;
        change:body: undefined | number;
        change:broadcast: undefined | number;
        change:broadcastEphSettings: undefined | number;
        change:broadcastId: undefined | number;
        change:broadcastParticipants: undefined | number;
        change:businessOwnerJid: undefined | number;
        change:buttons: undefined | number;
        change:buttonsResponse: undefined | number;
        change:canonicalUrl: number;
        change:caption: undefined | number;
        change:chat: undefined | number;
        change:clearMedia: undefined | number;
        change:clientUrl: undefined | number;
        change:comment: undefined | number;
        change:containsEmoji: undefined | number;
        change:ctwaContext: undefined | number;
        change:currencyCode: undefined | number;
        change:degrees: undefined | number;
        change:deprecatedMms3Url: undefined | number;
        change:description: undefined | number;
        change:devicesAdded: undefined | number;
        change:devicesRemoved: undefined | number;
        change:dir: undefined | number;
        change:directPath: undefined | number;
        change:disappearingModeInitiator: undefined | number;
        change:doNotPlayInline: undefined | number;
        change:duration: undefined | number;
        change:dynamicReplyButtons: undefined | number;
        change:encFilehash: undefined | number;
        change:ephemeralDuration: undefined | number;
        change:ephemeralExpirationTimestamp: undefined | number;
        change:ephemeralOutOfSync: undefined | number;
        change:ephemeralSettingTimestamp: undefined | number;
        change:ephemeralSharedSecret: undefined | number;
        change:ephemeralStartTimestamp: undefined | number;
        change:eventType: undefined | number;
        change:filehash: undefined | number;
        change:filename: undefined | number;
        change:finalAccuracy: undefined | number;
        change:finalDegrees: undefined | number;
        change:finalLat: undefined | number;
        change:finalLng: undefined | number;
        change:finalSpeed: undefined | number;
        change:finalThumbnail: undefined | number;
        change:finalTimeOffset: undefined | number;
        change:firstFrameLength: undefined | number;
        change:firstFrameSidecar: undefined | number;
        change:font: undefined | number;
        change:footer: undefined | number;
        change:forwardedFromWeb: undefined | number;
        change:forwardingScore: undefined | number;
        change:from: undefined | number;
        change:gifAttribution: undefined | number;
        change:hasBodyOrFooter: number;
        change:hasTemplateButtons: number;
        change:height: undefined | number;
        change:historySyncMetaData: undefined | number;
        change:hydratedButtons: undefined | number;
        change:id: number;
        change:initialPageSize: undefined | number;
        change:interactiveAnnotations: undefined | number;
        change:interactiveMessage: undefined | number;
        change:interactivePayload: undefined | number;
        change:invis: undefined | number;
        change:inviteCode: undefined | number;
        change:inviteCodeExp: undefined | number;
        change:inviteGrp: undefined | number;
        change:inviteGrpJpegThum: undefined | number;
        change:inviteGrpName: undefined | number;
        change:isAnimated: number;
        change:isBizNotification: number;
        change:isCaptionByUser: number;
        change:isDynamicReplyButtonsMsg: number;
        change:isEphemeral: number;
        change:isFailed: number;
        change:isForwarded: number;
        change:isFrequentlyForwarded: number;
        change:isFromTemplate: number;
        change:isFutureproof: number;
        change:isGif: number;
        change:isGroupMsg: number;
        change:isGroupsV4InviteExpired: number;
        change:isInternational: number;
        change:isLive: number;
        change:isMdHistoryMsg: number;
        change:isMedia: number;
        change:isNewMsg: number;
        change:isNotification: number;
        change:isPersistent: number;
        change:isPSA: number;
        change:isQuickReply: number;
        change:isQuotedMsgAvailable: number;
        change:isRevokedByMe: number;
        change:isRTL: number;
        change:isSendFailure: number;
        change:isSentByMe: number;
        change:isSentByMeFromWeb: number;
        change:isStatusV3: number;
        change:isThisDeviceAdded: number;
        change:isUnreadType: number;
        change:isUnsentMedia: number;
        change:isUserCreatedType: number;
        change:isVcardOverMmsDocument: number;
        change:isViewOnce: number;
        change:itemCount: undefined | number;
        change:labels: undefined | number;
        change:lat: undefined | number;
        change:linkPreview: undefined | number;
        change:linksIndexParsed: undefined | number;
        change:list: undefined | number;
        change:listResponse: undefined | number;
        change:lng: undefined | number;
        change:loc: undefined | number;
        change:local: undefined | number;
        change:matchedText: undefined | number;
        change:mdDowngrade: undefined | number;
        change:mediaData: undefined | number;
        change:mediaKey: undefined | number;
        change:mediaKeyTimestamp: undefined | number;
        change:mentionedJidList: undefined | number;
        change:message: undefined | number;
        change:mimetype: undefined | number;
        change:msgChunk: undefined | number;
        change:multicast: undefined | number;
        change:nativeFlowName: undefined | number;
        change:notifyName: undefined | number;
        change:numTimesForwarded: undefined | number;
        change:orderId: undefined | number;
        change:orderTitle: undefined | number;
        change:pageCount: undefined | number;
        change:paymentAmount1000: undefined | number;
        change:paymentCurrency: undefined | number;
        change:paymentExpiryTimestamp: undefined | number;
        change:paymentMessageReceiverJid: undefined | number;
        change:paymentNoteMsg: undefined | number;
        change:paymentRequestMessageKey: undefined | number;
        change:paymentStatus: undefined | number;
        change:paymentTransactionTimestamp: undefined | number;
        change:paymentTxnStatus: undefined | number;
        change:phoneUploading: undefined | number;
        change:pollInvalidated: undefined | number;
        change:pollName: undefined | number;
        change:pollOptions: undefined | number;
        change:pollSelectableOptionsCount: undefined | number;
        change:pollUpdateParentKey: undefined | number;
        change:priceAmount1000: undefined | number;
        change:privacyModeWhenSent: undefined | number;
        change:productHeaderImageRejected: undefined | number;
        change:productId: undefined | number;
        change:productImageCount: undefined | number;
        change:productListHeaderImage: undefined | number;
        change:productListItemCount: undefined | number;
        change:protocolMessageKey: undefined | number;
        change:quotedGroupSubject: undefined | number;
        change:quotedMsg: undefined | number;
        change:quotedMsgId: undefined | number;
        change:quotedMsgKey: undefined | number;
        change:quotedParentGroupJid: undefined | number;
        change:quotedParticipant: undefined | number;
        change:quotedRemoteJid: undefined | number;
        change:quotedStanzaID: undefined | number;
        change:recipients: undefined | number;
        change:recvFresh: undefined | number;
        change:replyButtons: undefined | number;
        change:retailerId: undefined | number;
        change:richPreviewType: undefined | number;
        change:rowId: undefined | number;
        change:rtl: undefined | number;
        change:salePriceAmount1000: undefined | number;
        change:scanLengths: undefined | number;
        change:scansSidecar: undefined | number;
        change:search: undefined | number;
        change:selectedButtonId: undefined | number;
        change:selectedId: undefined | number;
        change:selectedIndex: undefined | number;
        change:self: undefined | number;
        change:sellerJid: undefined | number;
        change:sendDeferred: undefined | number;
        change:sender: undefined | number;
        change:senderObj: undefined | number;
        change:sequence: undefined | number;
        change:serverId: undefined | number;
        change:sessionId: undefined | number;
        change:shareDuration: undefined | number;
        change:size: undefined | number;
        change:speed: undefined | number;
        change:stale: undefined | number;
        change:star: undefined | number;
        change:startOfDay: undefined | number;
        change:startOfDaySkew: undefined | number;
        change:status: undefined | number;
        change:statusV3TextBg: undefined | number;
        change:streamable: undefined | number;
        change:streamingSidecar: undefined | number;
        change:subtype: undefined | number;
        change:supportsMessageFooter: undefined | number;
        change:supportsMessageFooterLinks: undefined | number;
        change:surface: undefined | number;
        change:t: undefined | number;
        change:templateParams: undefined | number;
        change:text: undefined | number;
        change:textColor: undefined | number;
        change:thumbnail: undefined | number;
        change:thumbnailDirectPath: undefined | number;
        change:thumbnailEncSha256: undefined | number;
        change:thumbnailHeight: undefined | number;
        change:thumbnailHQ: undefined | number;
        change:thumbnailSha256: undefined | number;
        change:thumbnailWidth: undefined | number;
        change:title: undefined | number;
        change:to: undefined | number;
        change:token: undefined | number;
        change:totalAmount1000: undefined | number;
        change:totalCurrencyCode: undefined | number;
        change:type: undefined | number;
        change:url: undefined | number;
        change:urlNumber: undefined | number;
        change:urlText: undefined | number;
        change:vcard: undefined | number;
        change:vcardFormattedName: undefined | number;
        change:vcardList: undefined | number;
        change:verifiedBizName: undefined | number;
        change:waveform: undefined | number;
        change:width: undefined | number;
    }

    OptionalmsgChunk

    msgChunk?: any

    Optionalmulticast

    multicast?: any

    Optional ReadonlynativeFlowName

    nativeFlowName?: string

    OptionalnotifyName

    notifyName?: any

    Optional ReadonlynumTimesForwarded

    numTimesForwarded?: any

    OptionalorderId

    orderId?: any

    OptionalorderTitle

    orderTitle?: any

    OptionalpageCount

    pageCount?: any

    Optionalparent

    parent?: any

    OptionalpaymentAmount1000

    paymentAmount1000?: any

    OptionalpaymentCurrency

    paymentCurrency?: any

    OptionalpaymentExpiryTimestamp

    paymentExpiryTimestamp?: any

    OptionalpaymentMessageReceiverJid

    paymentMessageReceiverJid?: any

    OptionalpaymentNoteMsg

    paymentNoteMsg?: any

    OptionalpaymentRequestMessageKey

    paymentRequestMessageKey?: any

    OptionalpaymentStatus

    paymentStatus?: any

    OptionalpaymentTransactionTimestamp

    paymentTransactionTimestamp?: any

    OptionalpaymentTxnStatus

    paymentTxnStatus?: any

    OptionalphoneUploading

    phoneUploading?: any

    Optional ReadonlypollInvalidated

    pollInvalidated?: boolean

    Optional ReadonlypollName

    pollName?: string

    Optional ReadonlypollOptions

    pollOptions?: any

    Optional ReadonlypollSelectableOptionsCount

    pollSelectableOptionsCount?: number

    Optional ReadonlypollUpdateParentKey

    pollUpdateParentKey?: any

    OptionalpriceAmount1000

    priceAmount1000?: any

    OptionalprivacyModeWhenSent

    privacyModeWhenSent?: any

    OptionalproductHeaderImageRejected

    productHeaderImageRejected?: any

    OptionalproductId

    productId?: any

    OptionalproductImageCount

    productImageCount?: any

    Optional ReadonlyproductListHeaderImage

    productListHeaderImage?: any

    OptionalproductListItemCount

    productListItemCount?: any

    OptionalprotocolMessageKey

    protocolMessageKey?: any

    proxyName

    proxyName: string

    OptionalquotedGroupSubject

    quotedGroupSubject?: any

    OptionalquotedMsg

    quotedMsg?: MsgModel

    OptionalquotedMsgId

    quotedMsgId?: MsgKey

    Deprecated

    OptionalquotedMsgKey

    quotedMsgKey?: MsgKey

    OptionalquotedParentGroupJid

    quotedParentGroupJid?: any

    OptionalquotedParticipant

    quotedParticipant?: any

    OptionalquotedRemoteJid

    quotedRemoteJid?: any

    OptionalquotedStanzaID

    quotedStanzaID?: any

    Optionalrecipients

    recipients?: any

    OptionalrecvFresh

    recvFresh?: any

    OptionalreplyButtons

    replyButtons?: ButtonCollection

    OptionalretailerId

    retailerId?: any

    OptionalrichPreviewType

    richPreviewType?: any

    OptionalrowId

    rowId?: any

    Optional Readonlyrtl

    rtl?: any

    OptionalsalePriceAmount1000

    salePriceAmount1000?: any

    OptionalscanLengths

    scanLengths?: any

    OptionalscansSidecar

    scansSidecar?: any

    Optionalsearch

    search?: any

    OptionalselectedButtonId

    selectedButtonId?: string

    OptionalselectedId

    selectedId?: any

    OptionalselectedIndex

    selectedIndex?: any

    Optionalself

    self?: string

    OptionalsellerJid

    sellerJid?: any

    OptionalsendDeferred

    sendDeferred?: any

    Optional Readonlysender

    sender?: Wid

    OptionalsenderObj

    senderObj?: any

    Optionalsequence

    sequence?: number

    OptionalserverId

    serverId?: number

    OptionalsessionId

    sessionId?: any

    OptionalshareDuration

    shareDuration?: number

    Optionalsize

    size?: any

    Optionalspeed

    speed?: number

    Optionalstale

    stale?: any

    Optionalstar

    star?: any

    OptionalstartOfDay

    startOfDay?: any

    OptionalstartOfDaySkew

    startOfDaySkew?: any

    Optionalstatus

    status?: any

    Optional ReadonlystatusV3TextBg

    statusV3TextBg?: any

    Optionalstreamable

    streamable?: any

    OptionalstreamingSidecar

    streamingSidecar?: any

    Optionalsubtype

    subtype?: null | string

    Optional ReadonlysupportsMessageFooter

    supportsMessageFooter?: any

    Optional ReadonlysupportsMessageFooterLinks

    supportsMessageFooterLinks?: any

    Optionalsurface

    surface?: any

    Optionalt

    t?: number

    OptionaltemplateParams

    templateParams?: any

    Optional Readonlytext

    text?: any

    OptionaltextColor

    textColor?: number

    Optionalthumbnail

    thumbnail?: any

    OptionalthumbnailDirectPath

    thumbnailDirectPath?: any

    OptionalthumbnailEncSha256

    thumbnailEncSha256?: any

    OptionalthumbnailHeight

    thumbnailHeight?: any

    OptionalthumbnailHQ

    thumbnailHQ?: any

    OptionalthumbnailSha256

    thumbnailSha256?: any

    OptionalthumbnailWidth

    thumbnailWidth?: any

    Optionaltitle

    title?: string

    Optionalto

    to?: Wid

    Optionaltoken

    token?: any

    OptionaltotalAmount1000

    totalAmount1000?: any

    OptionaltotalCurrencyCode

    totalCurrencyCode?: any

    Optionaltype

    type?: string

    Optionalurl

    url?: any

    OptionalurlNumber

    urlNumber?: null | string

    OptionalurlText

    urlText?: null | string

    Optional Readonlyvcard

    vcard?: any

    OptionalvcardFormattedName

    vcardFormattedName?: any

    OptionalvcardList

    vcardList?: any

    OptionalverifiedBizName

    verifiedBizName?: any

    Optionalwaveform

    waveform?: any

    Optionalwidth

    width?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    applyUpdate

    avParams

    bind

    cancelDownload

    cancelUpload

    canForward

    canPrivateReply

    canPrivateReplyInRestrictedGrp

    canQuickForward

    OptionalcanReply

    canRevoke

    canStar

    clear

    decObservers

    delete

    displayName

    downloadMedia

    emit

    forceRMR

    get

    getCollection

    getDefault

    getFooterLinks

    getForwardingScoreWhenForwarded

    getGalleryLinks

    getHeaderLinks

    getLinks

    getLocObject

    getQuotedMsgAdminGroupJid

    getSuspiciousLinks

    getVcardWids

    getWamMediaType

    getWamMessageType

    hasObservers

    hasSymbol

    hasUnfiredChanges

    incObservers

    initialize

    interactiveButtonsReleased

    isDownloadable

    isExpired

    isForcingRMR

    isGroupLeave

    isListening

    isMentioned

    isQuoted

    isTrusted

    isUnsentPhoneMsg

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

    OptionalappStateFatalExceptionNotification

    appStateFatalExceptionNotification?: any

    OptionalappStateSyncKeyRequest

    appStateSyncKeyRequest?: any

    OptionalappStateSyncKeyShare

    appStateSyncKeyShare?: any

    Optional ReadonlyasAlbumAsset

    asAlbumAsset?: any

    Optional ReadonlyasBroadcastNotification

    asBroadcastNotification?: any

    Optional ReadonlyasDoc

    asDoc?: any

    Optional ReadonlyasGroupedSticker

    asGroupedSticker?: any

    Optional ReadonlyasGroupNotification

    asGroupNotification?: any

    Optional ReadonlyasImage

    asImage?: any

    Optional ReadonlyasMms

    asMms?: any

    Optional ReadonlyasPollCreation

    asPollCreation?: any

    Optional ReadonlyasPollUpdate

    asPollUpdate?: any

    Optional ReadonlyasProduct

    asProduct?: any

    Optional ReadonlyasProductInquiry

    asProductInquiry?: any

    Optional ReadonlyasRevoked

    asRevoked?: any

    Optional ReadonlyasUrl

    asUrl?: any

    Optional ReadonlyasVideo

    asVideo?: any

    Optional ReadonlyasViewOnce

    asViewOnce?: any

    Optional ReadonlyasVisualMedia

    asVisualMedia?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalauthor

    author?: Wid

    OptionalbackgroundColor

    backgroundColor?: number

    OptionalbizPrivacyStatus

    bizPrivacyStatus?: any

    Optionalbody

    body?: string

    Optionalbroadcast

    broadcast?: any

    OptionalbroadcastEphSettings

    broadcastEphSettings?: any

    OptionalbroadcastId

    broadcastId?: any

    OptionalbroadcastParticipants

    broadcastParticipants?: any

    OptionalbusinessOwnerJid

    businessOwnerJid?: any

    Optionalbuttons

    buttons?: TemplateButtonCollection

    OptionalbuttonsResponse

    buttonsResponse?: any

    canonicalUrl

    canonicalUrl: boolean

    Optionalcaption

    caption?: string

    Optional Readonlychat

    chat?: ChatModel

    Deprecated

    OptionalclearMedia

    clearMedia?: any

    OptionalclientUrl

    clientUrl?: any

    Optionalcollection

    collection?: undefined

    Optionalcomment

    comment?: string

    Optional ReadonlycontainsEmoji

    containsEmoji?: any

    OptionalctwaContext

    ctwaContext?: any

    OptionalcurrencyCode

    currencyCode?: any

    Optionaldegrees

    degrees?: number

    OptionaldeprecatedMms3Url

    deprecatedMms3Url?: any

    Optionaldescription

    description?: any

    OptionaldevicesAdded

    devicesAdded?: any

    OptionaldevicesRemoved

    devicesRemoved?: any

    Optional Readonlydir

    dir?: any

    OptionaldirectPath

    directPath?: any

    OptionaldisappearingModeInitiator

    disappearingModeInitiator?: any

    OptionaldoNotPlayInline

    doNotPlayInline?: any

    Optionalduration

    duration?: number

    OptionaldynamicReplyButtons

    dynamicReplyButtons?: {
        buttonId: string;
        buttonText: {
            displayText: string;
        };
        type: number;
    }[]

    OptionalencFilehash

    encFilehash?: any

    OptionalephemeralDuration

    ephemeralDuration?: number

    Optional ReadonlyephemeralExpirationTimestamp

    ephemeralExpirationTimestamp?: any

    OptionalephemeralOutOfSync

    ephemeralOutOfSync?: any

    OptionalephemeralSettingTimestamp

    ephemeralSettingTimestamp?: number

    OptionalephemeralSharedSecret

    ephemeralSharedSecret?: any

    OptionalephemeralStartTimestamp

    ephemeralStartTimestamp?: any

    Optional ReadonlyeventType

    eventType?: any

    Optionalfilehash

    filehash?: any

    Optionalfilename

    filename?: any

    OptionalfinalAccuracy

    finalAccuracy?: any

    OptionalfinalDegrees

    finalDegrees?: any

    OptionalfinalLat

    finalLat?: any

    OptionalfinalLng

    finalLng?: any

    OptionalfinalSpeed

    finalSpeed?: any

    OptionalfinalThumbnail

    finalThumbnail?: any

    OptionalfinalTimeOffset

    finalTimeOffset?: any

    OptionalfirstFrameLength

    firstFrameLength?: any

    OptionalfirstFrameSidecar

    firstFrameSidecar?: any

    Optionalfont

    font?: TextFontStyle

    Optionalfooter

    footer?: string

    OptionalforwardedFromWeb

    forwardedFromWeb?: any

    OptionalforwardingScore

    forwardingScore?: any

    Optionalfrom

    from?: Wid

    OptionalgifAttribution

    gifAttribution?: any

    ReadonlyhasBodyOrFooter

    hasBodyOrFooter: boolean

    ReadonlyhasTemplateButtons

    hasTemplateButtons: boolean

    Optionalheight

    height?: any

    OptionalhistorySyncMetaData

    historySyncMetaData?: any

    OptionalhydratedButtons

    hydratedButtons?: {
        callButton?: {
            displayText: string;
            phoneNumber: string;
        };
        index?: number;
        quickReplyButton?: {
            displayText: string;
            id: string;
        };
        urlButton?: {
            displayText: string;
            url: string;
        };
    }[]

    id

    id: MsgKey

    idClass

    idClass: typeof MsgKey

    Optional ReadonlyinitialPageSize

    initialPageSize?: any

    OptionalinteractiveAnnotations

    interactiveAnnotations?: any

    OptionalinteractiveMessage

    interactiveMessage?: any

    Optional ReadonlyinteractivePayload

    interactivePayload?: any

    Optionalinvis

    invis?: any

    OptionalinviteCode

    inviteCode?: any

    OptionalinviteCodeExp

    inviteCodeExp?: any

    OptionalinviteGrp

    inviteGrp?: any

    OptionalinviteGrpJpegThum

    inviteGrpJpegThum?: any

    OptionalinviteGrpName

    inviteGrpName?: any

    isAnimated

    isAnimated: boolean

    ReadonlyisBizNotification

    isBizNotification: boolean

    isCaptionByUser

    isCaptionByUser: boolean

    isDynamicReplyButtonsMsg

    isDynamicReplyButtonsMsg: boolean

    ReadonlyisEphemeral

    isEphemeral: boolean

    ReadonlyisFailed

    isFailed: boolean

    isForwarded

    isForwarded: boolean

    ReadonlyisFrequentlyForwarded

    isFrequentlyForwarded: boolean

    isFromTemplate

    isFromTemplate: boolean

    ReadonlyisFutureproof

    isFutureproof: boolean

    isGif

    isGif: boolean

    ReadonlyisGroupMsg

    isGroupMsg: boolean

    Deprecated

    ReadonlyisGroupsV4InviteExpired

    isGroupsV4InviteExpired: boolean

    ReadonlyisInternational

    isInternational: boolean

    isLive

    isLive: boolean

    isMdHistoryMsg

    isMdHistoryMsg: boolean

    ReadonlyisMedia

    isMedia: boolean

    isNewMsg

    isNewMsg: boolean

    ReadonlyisNotification

    isNotification: boolean

    ReadonlyisPersistent

    isPersistent: boolean

    ReadonlyisPSA

    isPSA: boolean

    ReadonlyisQuickReply

    isQuickReply: boolean

    isQuotedMsgAvailable

    isQuotedMsgAvailable: boolean

    ReadonlyisRevokedByMe

    isRevokedByMe: boolean

    ReadonlyisRTL

    isRTL: boolean

    isSendFailure

    isSendFailure: boolean

    ReadonlyisSentByMe

    isSentByMe: boolean

    ReadonlyisSentByMeFromWeb

    isSentByMeFromWeb: boolean

    ReadonlyisState

    isState

    ReadonlyisStatusV3

    isStatusV3: boolean

    isThisDeviceAdded

    isThisDeviceAdded: boolean

    ReadonlyisUnreadType

    isUnreadType: boolean

    ReadonlyisUnsentMedia

    isUnsentMedia: boolean

    ReadonlyisUserCreatedType

    isUserCreatedType: boolean

    isVcardOverMmsDocument

    isVcardOverMmsDocument: boolean

    isViewOnce

    isViewOnce: boolean

    OptionalitemCount

    itemCount?: any

    Optionallabels

    labels?: any

    Optionallat

    lat?: number

    Optional ReadonlylinkPreview

    linkPreview?: {
        canonicalUrl?: string;
        description?: string;
        doNotPlayInline: boolean;
        matchedText: string;
        richPreviewType: number;
        thumbnail?: string;
        title?: string;
    }

    OptionallinksIndexParsed

    linksIndexParsed?: any

    Optionallist

    list?: {
        buttonText: string;
        description: string;
        footerText?: string;
        listType: number;
        sections: {
            rows: {
                description: string;
                rowId: string;
                title: string;
            }[];
            title: string;
        }[];
        title?: string;
    }

    OptionallistResponse

    listResponse?: any

    Optionallng

    lng?: number

    Optionalloc

    loc?: any

    Optionallocal

    local

    OptionalmatchedText

    matchedText?: any

    OptionalmdDowngrade

    mdDowngrade?: any

    OptionalmediaData

    mediaData?: MediaDataModel

    OptionalmediaKey

    mediaKey?: any

    OptionalmediaKeyTimestamp

    mediaKeyTimestamp?: any

    OptionalmediaObject

    mediaObject?: MediaObject

    OptionalmentionedJidList

    mentionedJidList?: Wid[]

    Optionalmessage

    message?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:accuracy: undefined | number;
        change:ack: undefined | number;
        change:appStateFatalExceptionNotification: undefined | number;
        change:appStateSyncKeyRequest: undefined | number;
        change:appStateSyncKeyShare: undefined | number;
        change:asAlbumAsset: undefined | number;
        change:asBroadcastNotification: undefined | number;
        change:asDoc: undefined | number;
        change:asGroupedSticker: undefined | number;
        change:asGroupNotification: undefined | number;
        change:asImage: undefined | number;
        change:asMms: undefined | number;
        change:asPollCreation: undefined | number;
        change:asPollUpdate: undefined | number;
        change:asProduct: undefined | number;
        change:asProductInquiry: undefined | number;
        change:asRevoked: undefined | number;
        change:asUrl: undefined | number;
        change:asVideo: undefined | number;
        change:asViewOnce: undefined | number;
        change:asVisualMedia: undefined | number;
        change:author: undefined | number;
        change:backgroundColor: undefined | number;
        change:bizPrivacyStatus: undefined | number;
        change:body: undefined | number;
        change:broadcast: undefined | number;
        change:broadcastEphSettings: undefined | number;
        change:broadcastId: undefined | number;
        change:broadcastParticipants: undefined | number;
        change:businessOwnerJid: undefined | number;
        change:buttons: undefined | number;
        change:buttonsResponse: undefined | number;
        change:canonicalUrl: number;
        change:caption: undefined | number;
        change:chat: undefined | number;
        change:clearMedia: undefined | number;
        change:clientUrl: undefined | number;
        change:comment: undefined | number;
        change:containsEmoji: undefined | number;
        change:ctwaContext: undefined | number;
        change:currencyCode: undefined | number;
        change:degrees: undefined | number;
        change:deprecatedMms3Url: undefined | number;
        change:description: undefined | number;
        change:devicesAdded: undefined | number;
        change:devicesRemoved: undefined | number;
        change:dir: undefined | number;
        change:directPath: undefined | number;
        change:disappearingModeInitiator: undefined | number;
        change:doNotPlayInline: undefined | number;
        change:duration: undefined | number;
        change:dynamicReplyButtons: undefined | number;
        change:encFilehash: undefined | number;
        change:ephemeralDuration: undefined | number;
        change:ephemeralExpirationTimestamp: undefined | number;
        change:ephemeralOutOfSync: undefined | number;
        change:ephemeralSettingTimestamp: undefined | number;
        change:ephemeralSharedSecret: undefined | number;
        change:ephemeralStartTimestamp: undefined | number;
        change:eventType: undefined | number;
        change:filehash: undefined | number;
        change:filename: undefined | number;
        change:finalAccuracy: undefined | number;
        change:finalDegrees: undefined | number;
        change:finalLat: undefined | number;
        change:finalLng: undefined | number;
        change:finalSpeed: undefined | number;
        change:finalThumbnail: undefined | number;
        change:finalTimeOffset: undefined | number;
        change:firstFrameLength: undefined | number;
        change:firstFrameSidecar: undefined | number;
        change:font: undefined | number;
        change:footer: undefined | number;
        change:forwardedFromWeb: undefined | number;
        change:forwardingScore: undefined | number;
        change:from: undefined | number;
        change:gifAttribution: undefined | number;
        change:hasBodyOrFooter: number;
        change:hasTemplateButtons: number;
        change:height: undefined | number;
        change:historySyncMetaData: undefined | number;
        change:hydratedButtons: undefined | number;
        change:id: number;
        change:initialPageSize: undefined | number;
        change:interactiveAnnotations: undefined | number;
        change:interactiveMessage: undefined | number;
        change:interactivePayload: undefined | number;
        change:invis: undefined | number;
        change:inviteCode: undefined | number;
        change:inviteCodeExp: undefined | number;
        change:inviteGrp: undefined | number;
        change:inviteGrpJpegThum: undefined | number;
        change:inviteGrpName: undefined | number;
        change:isAnimated: number;
        change:isBizNotification: number;
        change:isCaptionByUser: number;
        change:isDynamicReplyButtonsMsg: number;
        change:isEphemeral: number;
        change:isFailed: number;
        change:isForwarded: number;
        change:isFrequentlyForwarded: number;
        change:isFromTemplate: number;
        change:isFutureproof: number;
        change:isGif: number;
        change:isGroupMsg: number;
        change:isGroupsV4InviteExpired: number;
        change:isInternational: number;
        change:isLive: number;
        change:isMdHistoryMsg: number;
        change:isMedia: number;
        change:isNewMsg: number;
        change:isNotification: number;
        change:isPersistent: number;
        change:isPSA: number;
        change:isQuickReply: number;
        change:isQuotedMsgAvailable: number;
        change:isRevokedByMe: number;
        change:isRTL: number;
        change:isSendFailure: number;
        change:isSentByMe: number;
        change:isSentByMeFromWeb: number;
        change:isStatusV3: number;
        change:isThisDeviceAdded: number;
        change:isUnreadType: number;
        change:isUnsentMedia: number;
        change:isUserCreatedType: number;
        change:isVcardOverMmsDocument: number;
        change:isViewOnce: number;
        change:itemCount: undefined | number;
        change:labels: undefined | number;
        change:lat: undefined | number;
        change:linkPreview: undefined | number;
        change:linksIndexParsed: undefined | number;
        change:list: undefined | number;
        change:listResponse: undefined | number;
        change:lng: undefined | number;
        change:loc: undefined | number;
        change:local: undefined | number;
        change:matchedText: undefined | number;
        change:mdDowngrade: undefined | number;
        change:mediaData: undefined | number;
        change:mediaKey: undefined | number;
        change:mediaKeyTimestamp: undefined | number;
        change:mentionedJidList: undefined | number;
        change:message: undefined | number;
        change:mimetype: undefined | number;
        change:msgChunk: undefined | number;
        change:multicast: undefined | number;
        change:nativeFlowName: undefined | number;
        change:notifyName: undefined | number;
        change:numTimesForwarded: undefined | number;
        change:orderId: undefined | number;
        change:orderTitle: undefined | number;
        change:pageCount: undefined | number;
        change:paymentAmount1000: undefined | number;
        change:paymentCurrency: undefined | number;
        change:paymentExpiryTimestamp: undefined | number;
        change:paymentMessageReceiverJid: undefined | number;
        change:paymentNoteMsg: undefined | number;
        change:paymentRequestMessageKey: undefined | number;
        change:paymentStatus: undefined | number;
        change:paymentTransactionTimestamp: undefined | number;
        change:paymentTxnStatus: undefined | number;
        change:phoneUploading: undefined | number;
        change:pollInvalidated: undefined | number;
        change:pollName: undefined | number;
        change:pollOptions: undefined | number;
        change:pollSelectableOptionsCount: undefined | number;
        change:pollUpdateParentKey: undefined | number;
        change:priceAmount1000: undefined | number;
        change:privacyModeWhenSent: undefined | number;
        change:productHeaderImageRejected: undefined | number;
        change:productId: undefined | number;
        change:productImageCount: undefined | number;
        change:productListHeaderImage: undefined | number;
        change:productListItemCount: undefined | number;
        change:protocolMessageKey: undefined | number;
        change:quotedGroupSubject: undefined | number;
        change:quotedMsg: undefined | number;
        change:quotedMsgId: undefined | number;
        change:quotedMsgKey: undefined | number;
        change:quotedParentGroupJid: undefined | number;
        change:quotedParticipant: undefined | number;
        change:quotedRemoteJid: undefined | number;
        change:quotedStanzaID: undefined | number;
        change:recipients: undefined | number;
        change:recvFresh: undefined | number;
        change:replyButtons: undefined | number;
        change:retailerId: undefined | number;
        change:richPreviewType: undefined | number;
        change:rowId: undefined | number;
        change:rtl: undefined | number;
        change:salePriceAmount1000: undefined | number;
        change:scanLengths: undefined | number;
        change:scansSidecar: undefined | number;
        change:search: undefined | number;
        change:selectedButtonId: undefined | number;
        change:selectedId: undefined | number;
        change:selectedIndex: undefined | number;
        change:self: undefined | number;
        change:sellerJid: undefined | number;
        change:sendDeferred: undefined | number;
        change:sender: undefined | number;
        change:senderObj: undefined | number;
        change:sequence: undefined | number;
        change:serverId: undefined | number;
        change:sessionId: undefined | number;
        change:shareDuration: undefined | number;
        change:size: undefined | number;
        change:speed: undefined | number;
        change:stale: undefined | number;
        change:star: undefined | number;
        change:startOfDay: undefined | number;
        change:startOfDaySkew: undefined | number;
        change:status: undefined | number;
        change:statusV3TextBg: undefined | number;
        change:streamable: undefined | number;
        change:streamingSidecar: undefined | number;
        change:subtype: undefined | number;
        change:supportsMessageFooter: undefined | number;
        change:supportsMessageFooterLinks: undefined | number;
        change:surface: undefined | number;
        change:t: undefined | number;
        change:templateParams: undefined | number;
        change:text: undefined | number;
        change:textColor: undefined | number;
        change:thumbnail: undefined | number;
        change:thumbnailDirectPath: undefined | number;
        change:thumbnailEncSha256: undefined | number;
        change:thumbnailHeight: undefined | number;
        change:thumbnailHQ: undefined | number;
        change:thumbnailSha256: undefined | number;
        change:thumbnailWidth: undefined | number;
        change:title: undefined | number;
        change:to: undefined | number;
        change:token: undefined | number;
        change:totalAmount1000: undefined | number;
        change:totalCurrencyCode: undefined | number;
        change:type: undefined | number;
        change:url: undefined | number;
        change:urlNumber: undefined | number;
        change:urlText: undefined | number;
        change:vcard: undefined | number;
        change:vcardFormattedName: undefined | number;
        change:vcardList: undefined | number;
        change:verifiedBizName: undefined | number;
        change:waveform: undefined | number;
        change:width: undefined | number;
    }

    OptionalmsgChunk

    msgChunk?: any

    Optionalmulticast

    multicast?: any

    Optional ReadonlynativeFlowName

    nativeFlowName?: string

    OptionalnotifyName

    notifyName?: any

    Optional ReadonlynumTimesForwarded

    numTimesForwarded?: any

    OptionalorderId

    orderId?: any

    OptionalorderTitle

    orderTitle?: any

    OptionalpageCount

    pageCount?: any

    Optionalparent

    parent?: any

    OptionalpaymentAmount1000

    paymentAmount1000?: any

    OptionalpaymentCurrency

    paymentCurrency?: any

    OptionalpaymentExpiryTimestamp

    paymentExpiryTimestamp?: any

    OptionalpaymentMessageReceiverJid

    paymentMessageReceiverJid?: any

    OptionalpaymentNoteMsg

    paymentNoteMsg?: any

    OptionalpaymentRequestMessageKey

    paymentRequestMessageKey?: any

    OptionalpaymentStatus

    paymentStatus?: any

    OptionalpaymentTransactionTimestamp

    paymentTransactionTimestamp?: any

    OptionalpaymentTxnStatus

    paymentTxnStatus?: any

    OptionalphoneUploading

    phoneUploading?: any

    Optional ReadonlypollInvalidated

    pollInvalidated?: boolean

    Optional ReadonlypollName

    pollName?: string

    Optional ReadonlypollOptions

    pollOptions?: any

    Optional ReadonlypollSelectableOptionsCount

    pollSelectableOptionsCount?: number

    Optional ReadonlypollUpdateParentKey

    pollUpdateParentKey?: any

    OptionalpriceAmount1000

    priceAmount1000?: any

    OptionalprivacyModeWhenSent

    privacyModeWhenSent?: any

    OptionalproductHeaderImageRejected

    productHeaderImageRejected?: any

    OptionalproductId

    productId?: any

    OptionalproductImageCount

    productImageCount?: any

    Optional ReadonlyproductListHeaderImage

    productListHeaderImage?: any

    OptionalproductListItemCount

    productListItemCount?: any

    OptionalprotocolMessageKey

    protocolMessageKey?: any

    proxyName

    proxyName: string

    OptionalquotedGroupSubject

    quotedGroupSubject?: any

    OptionalquotedMsg

    quotedMsg?: MsgModel

    OptionalquotedMsgId

    quotedMsgId?: MsgKey

    Deprecated

    OptionalquotedMsgKey

    quotedMsgKey?: MsgKey

    OptionalquotedParentGroupJid

    quotedParentGroupJid?: any

    OptionalquotedParticipant

    quotedParticipant?: any

    OptionalquotedRemoteJid

    quotedRemoteJid?: any

    OptionalquotedStanzaID

    quotedStanzaID?: any

    Optionalrecipients

    recipients?: any

    OptionalrecvFresh

    recvFresh?: any

    OptionalreplyButtons

    replyButtons?: ButtonCollection

    OptionalretailerId

    retailerId?: any

    OptionalrichPreviewType

    richPreviewType?: any

    OptionalrowId

    rowId?: any

    Optional Readonlyrtl

    rtl?: any

    OptionalsalePriceAmount1000

    salePriceAmount1000?: any

    OptionalscanLengths

    scanLengths?: any

    OptionalscansSidecar

    scansSidecar?: any

    Optionalsearch

    search?: any

    OptionalselectedButtonId

    selectedButtonId?: string

    OptionalselectedId

    selectedId?: any

    OptionalselectedIndex

    selectedIndex?: any

    Optionalself

    self?: string

    OptionalsellerJid

    sellerJid?: any

    OptionalsendDeferred

    sendDeferred?: any

    Optional Readonlysender

    sender?: Wid

    OptionalsenderObj

    senderObj?: any

    Optionalsequence

    sequence?: number

    OptionalserverId

    serverId?: number

    OptionalsessionId

    sessionId?: any

    OptionalshareDuration

    shareDuration?: number

    Optionalsize

    size?: any

    Optionalspeed

    speed?: number

    Optionalstale

    stale?: any

    Optionalstar

    star?: any

    OptionalstartOfDay

    startOfDay?: any

    OptionalstartOfDaySkew

    startOfDaySkew?: any

    Optionalstatus

    status?: any

    Optional ReadonlystatusV3TextBg

    statusV3TextBg?: any

    Optionalstreamable

    streamable?: any

    OptionalstreamingSidecar

    streamingSidecar?: any

    Optionalsubtype

    subtype?: null | string

    Optional ReadonlysupportsMessageFooter

    supportsMessageFooter?: any

    Optional ReadonlysupportsMessageFooterLinks

    supportsMessageFooterLinks?: any

    Optionalsurface

    surface?: any

    Optionalt

    t?: number

    OptionaltemplateParams

    templateParams?: any

    Optional Readonlytext

    text?: any

    OptionaltextColor

    textColor?: number

    Optionalthumbnail

    thumbnail?: any

    OptionalthumbnailDirectPath

    thumbnailDirectPath?: any

    OptionalthumbnailEncSha256

    thumbnailEncSha256?: any

    OptionalthumbnailHeight

    thumbnailHeight?: any

    OptionalthumbnailHQ

    thumbnailHQ?: any

    OptionalthumbnailSha256

    thumbnailSha256?: any

    OptionalthumbnailWidth

    thumbnailWidth?: any

    Optionaltitle

    title?: string

    Optionalto

    to?: Wid

    Optionaltoken

    token?: any

    OptionaltotalAmount1000

    totalAmount1000?: any

    OptionaltotalCurrencyCode

    totalCurrencyCode?: any

    Optionaltype

    type?: string

    Optionalurl

    url?: any

    OptionalurlNumber

    urlNumber?: null | string

    OptionalurlText

    urlText?: null | string

    Optional Readonlyvcard

    vcard?: any

    OptionalvcardFormattedName

    vcardFormattedName?: any

    OptionalvcardList

    vcardList?: any

    OptionalverifiedBizName

    verifiedBizName?: any

    Optionalwaveform

    waveform?: any

    Optionalwidth

    width?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    applyUpdate

    avParams

    bind

    cancelDownload

    cancelUpload

    canForward

    canPrivateReply

    canPrivateReplyInRestrictedGrp

    canQuickForward

    OptionalcanReply

    canRevoke

    canStar

    clear

    decObservers

    delete

    displayName

    downloadMedia

    emit

    forceRMR

    get

    getCollection

    getDefault

    getFooterLinks

    getForwardingScoreWhenForwarded

    getGalleryLinks

    getHeaderLinks

    getLinks

    getLocObject

    getQuotedMsgAdminGroupJid

    getSuspiciousLinks

    getVcardWids

    getWamMediaType

    getWamMessageType

    hasObservers

    hasSymbol

    hasUnfiredChanges

    incObservers

    initialize

    interactiveButtonsReleased

    isDownloadable

    isExpired

    isForcingRMR

    isGroupLeave

    isListening

    isMentioned

    isQuoted

    isTrusted

    isUnsentPhoneMsg

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    mayFail

    mentionMap

    msgContextInfo

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        -

    onCiphertextDecrypted

    onViewOnceMediaStatusChanged

    OptionalquotedMsgObj

    removeAllListeners

    onCiphertextDecrypted

    onViewOnceMediaStatusChanged

    OptionalquotedMsgObj

    removeAllListeners

    removeListener

    resend

    reset

    resumeRemoteUpload

    resumeUpload

    safe

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    resend

    reset

    resumeRemoteUpload

    resumeUpload

    safe

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unsafe

    unset

    updateAck

    updateEphemeralStartTimestamp

    waitForPhoneUpload

    waitForPrep

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    accuracyackappStateFatalExceptionNotificationappStateSyncKeyRequestappStateSyncKeyShareasAlbumAssetasBroadcastNotificationasDocasGroupedStickerasGroupNotificationasImageasMmsasPollCreationasPollUpdateasProductasProductInquiryasRevokedasUrlasVideoasViewOnceasVisualMediaattributesauthorbackgroundColorbizPrivacyStatusbodybroadcastbroadcastEphSettingsbroadcastIdbroadcastParticipantsbusinessOwnerJidbuttonsbuttonsResponsecanonicalUrlcaptionchatclearMediaclientUrlcollectioncommentcontainsEmojictwaContextcurrencyCodedegreesdeprecatedMms3UrldescriptiondevicesAddeddevicesRemoveddirdirectPathdisappearingModeInitiatordoNotPlayInlinedurationdynamicReplyButtonsencFilehashephemeralDurationephemeralExpirationTimestampephemeralOutOfSyncephemeralSettingTimestampephemeralSharedSecretephemeralStartTimestampeventTypefilehashfilenamefinalAccuracyfinalDegreesfinalLatfinalLngfinalSpeedfinalThumbnailfinalTimeOffsetfirstFrameLengthfirstFrameSidecarfontfooterforwardedFromWebforwardingScorefromgifAttributionhasBodyOrFooterhasTemplateButtonsheighthistorySyncMetaDatahydratedButtonsididClassinitialPageSizeinteractiveAnnotationsinteractiveMessageinteractivePayloadinvisinviteCodeinviteCodeExpinviteGrpinviteGrpJpegThuminviteGrpNameisAnimatedisBizNotificationisCaptionByUserisDynamicReplyButtonsMsgisEphemeralisFailedisForwardedisFrequentlyForwardedisFromTemplateisFutureproofisGifisGroupMsgisGroupsV4InviteExpiredisInternationalisLiveisMdHistoryMsgisMediaisNewMsgisNotificationisPersistentisPSAisQuickReplyisQuotedMsgAvailableisRevokedByMeisRTLisSendFailureisSentByMeisSentByMeFromWebisStateisStatusV3isThisDeviceAddedisUnreadTypeisUnsentMediaisUserCreatedTypeisVcardOverMmsDocumentisViewOnceitemCountlabelslatlinkPreviewlinksIndexParsedlistlistResponselngloclocalmatchedTextmdDowngrademediaDatamediaKeymediaKeyTimestampmediaObjectmentionedJidListmessagemimetypemirrorMaskmsgChunkmulticastnativeFlowNamenotifyNamenumTimesForwardedorderIdorderTitlepageCountparentpaymentAmount1000paymentCurrencypaymentExpiryTimestamppaymentMessageReceiverJidpaymentNoteMsgpaymentRequestMessageKeypaymentStatuspaymentTransactionTimestamppaymentTxnStatusphoneUploadingpollInvalidatedpollNamepollOptionspollSelectableOptionsCountpollUpdateParentKeypriceAmount1000privacyModeWhenSentproductHeaderImageRejectedproductIdproductImageCountproductListHeaderImageproductListItemCountprotocolMessageKeyproxyNamequotedGroupSubjectquotedMsgquotedMsgIdquotedMsgKeyquotedParentGroupJidquotedParticipantquotedRemoteJidquotedStanzaIDrecipientsrecvFreshreplyButtonsretailerIdrichPreviewTyperowIdrtlsalePriceAmount1000scanLengthsscansSidecarsearchselectedButtonIdselectedIdselectedIndexselfsellerJidsendDeferredsendersenderObjsequenceserverIdsessionIdshareDurationsizespeedstalestarstartOfDaystartOfDaySkewstatusstatusV3TextBgstreamablestreamingSidecarsubtypesupportsMessageFootersupportsMessageFooterLinkssurfacettemplateParamstexttextColorthumbnailthumbnailDirectPaththumbnailEncSha256thumbnailHeightthumbnailHQthumbnailSha256thumbnailWidthtitletotokentotalAmount1000totalCurrencyCodetypeurlurlNumberurlTextvcardvcardFormattedNamevcardListverifiedBizNamewaveformwidthallowedIdsidClassProxy
    Methods
    addChildapplyUpdateavParamsbindcancelDownloadcancelUploadcanForwardcanPrivateReplycanPrivateReplyInRestrictedGrpcanQuickForwardcanReplycanRevokecanStarcleardecObserversdeletedisplayNamedownloadMediaemitforceRMRgetgetCollectiongetDefaultgetFooterLinksgetForwardingScoreWhenForwardedgetGalleryLinksgetHeaderLinksgetLinksgetLocObjectgetQuotedMsgAdminGroupJidgetSuspiciousLinksgetVcardWidsgetWamMediaTypegetWamMessageTypehasObservershasSymbolhasUnfiredChangesincObserversinitializeinteractiveButtonsReleasedisDownloadableisExpiredisForcingRMRisGroupLeaveisListeningisMentionedisQuotedisTrustedisUnsentPhoneMsglistenTolistenToAndRunlistenToOncemayFailmentionMapmsgContextInfooffononceonCiphertextDecryptedonViewOnceMediaStatusChangedquotedMsgObjremoveAllListenersremoveListenerresendresetresumeRemoteUploadresumeUploadsafeserializesetstopListeningtoJSONtriggerunbindunsafeunsetupdateAckupdateEphemeralStartTimestampwaitForPhoneUploadwaitForPrepisIdType
    +

    Parameters

    Returns this

    Alias

    off

    +

    unsafe

    unset

    updateAck

    updateEphemeralStartTimestamp

    waitForPhoneUpload

    waitForPrep

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    accuracyackappStateFatalExceptionNotificationappStateSyncKeyRequestappStateSyncKeyShareasAlbumAssetasBroadcastNotificationasDocasGroupedStickerasGroupNotificationasImageasMmsasPollCreationasPollUpdateasProductasProductInquiryasRevokedasUrlasVideoasViewOnceasVisualMediaattributesauthorbackgroundColorbizPrivacyStatusbodybroadcastbroadcastEphSettingsbroadcastIdbroadcastParticipantsbusinessOwnerJidbuttonsbuttonsResponsecanonicalUrlcaptionchatclearMediaclientUrlcollectioncommentcontainsEmojictwaContextcurrencyCodedegreesdeprecatedMms3UrldescriptiondevicesAddeddevicesRemoveddirdirectPathdisappearingModeInitiatordoNotPlayInlinedurationdynamicReplyButtonsencFilehashephemeralDurationephemeralExpirationTimestampephemeralOutOfSyncephemeralSettingTimestampephemeralSharedSecretephemeralStartTimestampeventTypefilehashfilenamefinalAccuracyfinalDegreesfinalLatfinalLngfinalSpeedfinalThumbnailfinalTimeOffsetfirstFrameLengthfirstFrameSidecarfontfooterforwardedFromWebforwardingScorefromgifAttributionhasBodyOrFooterhasTemplateButtonsheighthistorySyncMetaDatahydratedButtonsididClassinitialPageSizeinteractiveAnnotationsinteractiveMessageinteractivePayloadinvisinviteCodeinviteCodeExpinviteGrpinviteGrpJpegThuminviteGrpNameisAnimatedisBizNotificationisCaptionByUserisDynamicReplyButtonsMsgisEphemeralisFailedisForwardedisFrequentlyForwardedisFromTemplateisFutureproofisGifisGroupMsgisGroupsV4InviteExpiredisInternationalisLiveisMdHistoryMsgisMediaisNewMsgisNotificationisPersistentisPSAisQuickReplyisQuotedMsgAvailableisRevokedByMeisRTLisSendFailureisSentByMeisSentByMeFromWebisStateisStatusV3isThisDeviceAddedisUnreadTypeisUnsentMediaisUserCreatedTypeisVcardOverMmsDocumentisViewOnceitemCountlabelslatlinkPreviewlinksIndexParsedlistlistResponselngloclocalmatchedTextmdDowngrademediaDatamediaKeymediaKeyTimestampmediaObjectmentionedJidListmessagemimetypemirrorMaskmsgChunkmulticastnativeFlowNamenotifyNamenumTimesForwardedorderIdorderTitlepageCountparentpaymentAmount1000paymentCurrencypaymentExpiryTimestamppaymentMessageReceiverJidpaymentNoteMsgpaymentRequestMessageKeypaymentStatuspaymentTransactionTimestamppaymentTxnStatusphoneUploadingpollInvalidatedpollNamepollOptionspollSelectableOptionsCountpollUpdateParentKeypriceAmount1000privacyModeWhenSentproductHeaderImageRejectedproductIdproductImageCountproductListHeaderImageproductListItemCountprotocolMessageKeyproxyNamequotedGroupSubjectquotedMsgquotedMsgIdquotedMsgKeyquotedParentGroupJidquotedParticipantquotedRemoteJidquotedStanzaIDrecipientsrecvFreshreplyButtonsretailerIdrichPreviewTyperowIdrtlsalePriceAmount1000scanLengthsscansSidecarsearchselectedButtonIdselectedIdselectedIndexselfsellerJidsendDeferredsendersenderObjsequenceserverIdsessionIdshareDurationsizespeedstalestarstartOfDaystartOfDaySkewstatusstatusV3TextBgstreamablestreamingSidecarsubtypesupportsMessageFootersupportsMessageFooterLinkssurfacettemplateParamstexttextColorthumbnailthumbnailDirectPaththumbnailEncSha256thumbnailHeightthumbnailHQthumbnailSha256thumbnailWidthtitletotokentotalAmount1000totalCurrencyCodetypeurlurlNumberurlTextvcardvcardFormattedNamevcardListverifiedBizNamewaveformwidthallowedIdsidClassProxy
    Methods
    addChildapplyUpdateavParamsbindcancelDownloadcancelUploadcanForwardcanPrivateReplycanPrivateReplyInRestrictedGrpcanQuickForwardcanReplycanRevokecanStarcleardecObserversdeletedisplayNamedownloadMediaemitforceRMRgetgetCollectiongetDefaultgetFooterLinksgetForwardingScoreWhenForwardedgetGalleryLinksgetHeaderLinksgetLinksgetLocObjectgetQuotedMsgAdminGroupJidgetSuspiciousLinksgetVcardWidsgetWamMediaTypegetWamMessageTypehasObservershasSymbolhasUnfiredChangesincObserversinitializeinteractiveButtonsReleasedisDownloadableisExpiredisForcingRMRisGroupLeaveisListeningisMentionedisQuotedisTrustedisUnsentPhoneMsglistenTolistenToAndRunlistenToOncemayFailmentionMapmsgContextInfooffononceonCiphertextDecryptedonViewOnceMediaStatusChangedquotedMsgObjremoveAllListenersremoveListenerresendresetresumeRemoteUploadresumeUploadsafeserializesetstopListeningtoJSONtriggerunbindunsafeunsetupdateAckupdateEphemeralStartTimestampwaitForPhoneUploadwaitForPrepisIdType
    diff --git a/classes/whatsapp.MuteCollection.html b/classes/whatsapp.MuteCollection.html index 5f16b26484..59b9f6c6da 100644 --- a/classes/whatsapp.MuteCollection.html +++ b/classes/whatsapp.MuteCollection.html @@ -1,5 +1,5 @@ -MuteCollection | @wppconnect/wa-js - v3.10.1

    Class MuteCollection

    Whatsapp

    72472

    -

    Hierarchy (view full)

    Constructors

    constructor +MuteCollection | @wppconnect/wa-js - v3.10.1

    Class MuteCollection

    Whatsapp

    72472

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass cachePolicy? @@ -68,10 +68,10 @@
      • (value, index, obj): value is S

      • Parameters

        Returns value is S

  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | MuteModel

  • Parameters

    • predicate: ((value: MuteModel, index: number, obj: MuteModel[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | MuteModel

    • modelClass

    modelClass: MuteModel

    Static OptionalcachePolicy

    cachePolicy?: any

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: MuteModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: MuteModel, index: number, array: MuteModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -95,33 +95,33 @@

      Returns void

    get

    getCollapseMuted

    getGlobalNotifications

    getGlobalPreviews

    getGlobalSounds

    getModelsArray

    getOutgoingMessageSound

    globalMute

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MuteModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MuteModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: MuteModel, index: number, array: MuteModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -133,8 +133,8 @@

    Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setCollapseMuted

    setGlobalNotifications

    setGlobalPreviews

    setGlobalSounds

    setOutgoingMessageSound

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setCollapseMuted

    setGlobalNotifications

    setGlobalPreviews

    setGlobalSounds

    setOutgoingMessageSound

    slice

    sort

    stopListening

    toArray

    toJSON

    trigger

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.MuteModel.html b/classes/whatsapp.MuteModel.html index 6833fe7c74..1e978c008f 100644 --- a/classes/whatsapp.MuteModel.html +++ b/classes/whatsapp.MuteModel.html @@ -1,6 +1,6 @@ -MuteModel | @wppconnect/wa-js - v3.10.1

    Class MuteModel

    Whatsapp

    40214

    -

    Whatsapp

    440214 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +MuteModel | @wppconnect/wa-js - v3.10.1

    Class MuteModel

    Whatsapp

    40214

    +

    Whatsapp

    440214 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    allowedIds? attributes collection? @@ -52,40 +52,40 @@

    Whatsappunmute unset isIdType -

    Constructors

    constructor

    Properties

    OptionalallowedIds

    allowedIds?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: MuteCollection

    expiration

    expiration: number

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisMuted

    isMuted: boolean

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:expiration: number;
        change:id: number;
        change:isMuted: number;
        change:promises: undefined | number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    Optionalpromises

    promises?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canMute

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalallowedIds

    allowedIds?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: MuteCollection

    expiration

    expiration: number

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisMuted

    isMuted: boolean

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:expiration: number;
        change:id: number;
        change:isMuted: number;
        change:promises: undefined | number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    Optionalpromises

    promises?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canMute

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    mute

    • mute(args): Promise<number>

    • Parameters

      • args: {
            expiration: number;
            isAutoMuted?: boolean;
            sendDevice?: boolean;
        }
        • expiration: number
        • OptionalisAutoMuted?: boolean
        • OptionalsendDevice?: boolean

      Returns Promise<number>

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    setMute

    • setMute(expiration?, isAutoMuted?, sendDevice?): any

    • Parameters

      • Optionalexpiration: number
      • OptionalisAutoMuted: boolean
      • OptionalsendDevice: boolean

      Returns any

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    setMute

    • setMute(expiration?, isAutoMuted?, sendDevice?): any

    • Parameters

      • Optionalexpiration: number
      • OptionalisAutoMuted: boolean
      • OptionalsendDevice: boolean

      Returns any

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unmute

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unmute

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.NetworkStatusModel.html b/classes/whatsapp.NetworkStatusModel.html index 451e8fb2c5..3614d39e79 100644 --- a/classes/whatsapp.NetworkStatusModel.html +++ b/classes/whatsapp.NetworkStatusModel.html @@ -1,5 +1,5 @@ -NetworkStatusModel | @wppconnect/wa-js - v3.10.1

    Class NetworkStatusModel

    Whatsapp

    99398 >= 2.2318.11

    -

    Hierarchy (view full)

    Constructors

    constructor +NetworkStatusModel | @wppconnect/wa-js - v3.10.1

    Class NetworkStatusModel

    Whatsapp

    99398 >= 2.2318.11

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? isState @@ -43,40 +43,40 @@ unset waitIfOffline isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: MuteCollection

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:online: number;
        change:simulatedOfflineConditions: number;
    }

    online

    online: boolean

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    simulatedOfflineConditions

    simulatedOfflineConditions: boolean

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    checkOnline

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: MuteCollection

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:online: number;
        change:simulatedOfflineConditions: number;
    }

    online

    online: boolean

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    simulatedOfflineConditions

    simulatedOfflineConditions: boolean

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    checkOnline

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    waitIfOffline

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    waitIfOffline

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.OpaqueData.html b/classes/whatsapp.OpaqueData.html index 8cc1de3a9d..38c131e047 100644 --- a/classes/whatsapp.OpaqueData.html +++ b/classes/whatsapp.OpaqueData.html @@ -1,6 +1,6 @@ -OpaqueData | @wppconnect/wa-js - v3.10.1

    Class OpaqueData

    Whatsapp

    34949

    -

    Whatsapp

    534949 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +OpaqueData | @wppconnect/wa-js - v3.10.1

    Class OpaqueData

    Whatsapp

    34949

    +

    Whatsapp

    534949 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    released

    Methods

    autorelease autoreleaseWhenPromiseCompletes diff --git a/classes/whatsapp.OpaqueDataBase.html b/classes/whatsapp.OpaqueDataBase.html index a0481fe6aa..e7f09edf21 100644 --- a/classes/whatsapp.OpaqueDataBase.html +++ b/classes/whatsapp.OpaqueDataBase.html @@ -1,6 +1,6 @@ -OpaqueDataBase | @wppconnect/wa-js - v3.10.1

    Class OpaqueDataBase

    Whatsapp

    34949

    -

    Whatsapp

    534949 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +OpaqueDataBase | @wppconnect/wa-js - v3.10.1

    Class OpaqueDataBase

    Whatsapp

    34949

    +

    Whatsapp

    534949 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    released

    Methods

    autorelease autoreleaseWhenPromiseCompletes diff --git a/classes/whatsapp.OrderCollection.html b/classes/whatsapp.OrderCollection.html index d3220de8fe..d5e5cdfefc 100644 --- a/classes/whatsapp.OrderCollection.html +++ b/classes/whatsapp.OrderCollection.html @@ -1,6 +1,6 @@ -OrderCollection | @wppconnect/wa-js - v3.10.1

    Class OrderCollection

    Whatsapp

    84312

    -

    Whatsapp

    584312 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +OrderCollection | @wppconnect/wa-js - v3.10.1

    Class OrderCollection

    Whatsapp

    84312

    +

    Whatsapp

    584312 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst height? modelClass @@ -62,10 +62,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | OrderModel

  • Parameters

    Returns undefined | OrderModel

    • Optionalheight

    height?: any

    modelClass

    modelClass: OrderModel

    Optionalwidth

    width?: any

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: OrderModel

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    addOrder

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: OrderModel, index: number, array: OrderModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -89,33 +89,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: OrderModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: OrderModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: OrderModel, index: number, array: OrderModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -127,8 +127,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): OrderModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -141,8 +141,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.OrderItemCollection.html b/classes/whatsapp.OrderItemCollection.html index 0d5c58fa1f..06cfb950a7 100644 --- a/classes/whatsapp.OrderItemCollection.html +++ b/classes/whatsapp.OrderItemCollection.html @@ -1,6 +1,6 @@ -OrderItemCollection | @wppconnect/wa-js - v3.10.1

    Class OrderItemCollection

    Whatsapp

    23412

    -

    Whatsapp

    823412 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +OrderItemCollection | @wppconnect/wa-js - v3.10.1

    Class OrderItemCollection

    Whatsapp

    23412

    +

    Whatsapp

    823412 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -57,10 +57,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | OrderItemModel

  • Parameters

    Returns undefined | OrderItemModel

    • modelClass

    modelClass: OrderItemModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: OrderItemModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: OrderItemModel, index: number, array: OrderItemModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: OrderItemModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: OrderItemModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: OrderItemModel, index: number, array: OrderItemModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): OrderItemModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.OrderItemModel.html b/classes/whatsapp.OrderItemModel.html index dacd01aea1..c6c0275fc2 100644 --- a/classes/whatsapp.OrderItemModel.html +++ b/classes/whatsapp.OrderItemModel.html @@ -1,6 +1,6 @@ -OrderItemModel | @wppconnect/wa-js - v3.10.1

    Class OrderItemModel

    Whatsapp

    52822

    -

    Whatsapp

    852822 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +OrderItemModel | @wppconnect/wa-js - v3.10.1

    Class OrderItemModel

    Whatsapp

    52822

    +

    Whatsapp

    852822 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? currency? @@ -52,40 +52,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: OrderCollection

    Optionalcurrency

    currency?: any

    Optionalid

    id?: any

    OptionalisCustomItem

    isCustomItem?: boolean

    OptionalisQuantitySet

    isQuantitySet?: boolean

    ReadonlyisState

    isState: true

    Optional ReadonlymediaData

    mediaData?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:currency: undefined | number;
        change:id: undefined | number;
        change:isCustomItem: undefined | number;
        change:isQuantitySet: undefined | number;
        change:mediaData: undefined | number;
        change:name: undefined | number;
        change:price: undefined | number;
        change:quantity: undefined | number;
        change:stale: undefined | number;
        change:thumbnailId: undefined | number;
        change:thumbnailUrl: undefined | number;
    }

    Optionalname

    name?: string

    Optionalparent

    parent?: any

    Optionalprice

    price?: any

    proxyName

    proxyName: string

    Optionalquantity

    quantity?: any

    Optionalstale

    stale?: any

    OptionalthumbnailId

    thumbnailId?: any

    OptionalthumbnailUrl

    thumbnailUrl?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: OrderCollection

    Optionalcurrency

    currency?: any

    Optionalid

    id?: any

    OptionalisCustomItem

    isCustomItem?: boolean

    OptionalisQuantitySet

    isQuantitySet?: boolean

    ReadonlyisState

    isState

    Optional ReadonlymediaData

    mediaData?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:currency: undefined | number;
        change:id: undefined | number;
        change:isCustomItem: undefined | number;
        change:isQuantitySet: undefined | number;
        change:mediaData: undefined | number;
        change:name: undefined | number;
        change:price: undefined | number;
        change:quantity: undefined | number;
        change:stale: undefined | number;
        change:thumbnailId: undefined | number;
        change:thumbnailUrl: undefined | number;
    }

    Optionalname

    name?: string

    Optionalparent

    parent?: any

    Optionalprice

    price?: any

    proxyName

    proxyName: string

    Optionalquantity

    quantity?: any

    Optionalstale

    stale?: any

    OptionalthumbnailId

    thumbnailId?: any

    OptionalthumbnailUrl

    thumbnailUrl?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.OrderModel.html b/classes/whatsapp.OrderModel.html index c3586510db..867b8799ea 100644 --- a/classes/whatsapp.OrderModel.html +++ b/classes/whatsapp.OrderModel.html @@ -1,6 +1,6 @@ -OrderModel | @wppconnect/wa-js - v3.10.1

    Class OrderModel

    Whatsapp

    86761

    -

    Whatsapp

    286761 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +OrderModel | @wppconnect/wa-js - v3.10.1

    Class OrderModel

    Whatsapp

    86761

    +

    Whatsapp

    286761 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? createdAt? @@ -53,40 +53,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: OrderCollection

    OptionalcreatedAt

    createdAt?: any

    Optionalcurrency

    currency?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    OptionalitemCount

    itemCount?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:createdAt: undefined | number;
        change:currency: undefined | number;
        change:id: undefined | number;
        change:itemCount: undefined | number;
        change:products: undefined | number;
        change:sellerJid: undefined | number;
        change:stale: undefined | number;
        change:subtotal: undefined | number;
        change:tax: undefined | number;
        change:total: undefined | number;
        change:totalItemCount: undefined | number;
    }

    Optionalparent

    parent?: any

    Optionalproducts

    products?: any

    proxyName

    proxyName: string

    OptionalsellerJid

    sellerJid?: any

    Optionalstale

    stale?: any

    Optionalsubtotal

    subtotal?: any

    Optionaltax

    tax?: any

    Optionaltotal

    total?: any

    Optional ReadonlytotalItemCount

    totalItemCount?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: OrderCollection

    OptionalcreatedAt

    createdAt?: any

    Optionalcurrency

    currency?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState

    OptionalitemCount

    itemCount?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:createdAt: undefined | number;
        change:currency: undefined | number;
        change:id: undefined | number;
        change:itemCount: undefined | number;
        change:products: undefined | number;
        change:sellerJid: undefined | number;
        change:stale: undefined | number;
        change:subtotal: undefined | number;
        change:tax: undefined | number;
        change:total: undefined | number;
        change:totalItemCount: undefined | number;
    }

    Optionalparent

    parent?: any

    Optionalproducts

    products?: any

    proxyName

    proxyName: string

    OptionalsellerJid

    sellerJid?: any

    Optionalstale

    stale?: any

    Optionalsubtotal

    subtotal?: any

    Optionaltax

    tax?: any

    Optionaltotal

    total?: any

    Optional ReadonlytotalItemCount

    totalItemCount?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    triggerItemCollectionUpdate

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ParticipantCollection.html b/classes/whatsapp.ParticipantCollection.html index b56412147e..586b015163 100644 --- a/classes/whatsapp.ParticipantCollection.html +++ b/classes/whatsapp.ParticipantCollection.html @@ -1,8 +1,8 @@ -ParticipantCollection | @wppconnect/wa-js - v3.10.1

    Class ParticipantCollection

    Whatsapp

    96091

    -

    Whatsapp

    54311 >= 2.2212.8

    -

    Whatsapp

    754311 >= 2.2222.8

    -

    Whatsapp

    164560 >= 2.2242.6

    -

    Hierarchy (view full)

    Constructors

    constructor +ParticipantCollection | @wppconnect/wa-js - v3.10.1

    Class ParticipantCollection

    Whatsapp

    96091

    +

    Whatsapp

    54311 >= 2.2212.8

    +

    Whatsapp

    754311 >= 2.2222.8

    +

    Whatsapp

    164560 >= 2.2242.6

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass model @@ -70,10 +70,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ParticipantModel

  • Parameters

    Returns undefined | ParticipantModel

    • modelClass

    modelClass: ParticipantModel

    Staticmodel

    model: ParticipantModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    canAdd

    canDemote

    canPromote

    canRemove

    canVerifyIdentity

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    canAdd

    canDemote

    canPromote

    canRemove

    canVerifyIdentity

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ParticipantModel, index: number, array: ParticipantModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -97,33 +97,33 @@

        Whatsapp

      Returns void

    get

    getAdmins

    getModelsArray

    getSuperAdmin

    head

    iAmAdmin

    iAmMember

    iAmRestrictedMember

    iAmSuperAdmin

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ParticipantModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ParticipantModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ParticipantModel, index: number, array: ParticipantModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -135,8 +135,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): ParticipantModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ParticipantModel.html b/classes/whatsapp.ParticipantModel.html index 9968e2cbbf..71616d7da5 100644 --- a/classes/whatsapp.ParticipantModel.html +++ b/classes/whatsapp.ParticipantModel.html @@ -1,6 +1,6 @@ -ParticipantModel | @wppconnect/wa-js - v3.10.1

    Class ParticipantModel

    Whatsapp

    45077

    -

    Whatsapp

    245077 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ParticipantModel | @wppconnect/wa-js - v3.10.1

    Class ParticipantModel

    Whatsapp

    45077

    +

    Whatsapp

    245077 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? contact? @@ -47,40 +47,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalcontact

    contact?: any

    hasSenderKey

    hasSenderKey: boolean

    id

    id: Wid

    idClass

    idClass: typeof Wid

    isAdmin

    isAdmin: boolean

    ReadonlyisState

    isState: true

    isSuperAdmin

    isSuperAdmin: boolean

    ReadonlymirrorMask

    mirrorMask: {
        change:contact: undefined | number;
        change:hasSenderKey: number;
        change:id: number;
        change:isAdmin: number;
        change:isSuperAdmin: number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalcontact

    contact?: any

    hasSenderKey

    hasSenderKey: boolean

    id

    id: Wid

    idClass

    idClass: typeof Wid

    isAdmin

    isAdmin: boolean

    ReadonlyisState

    isState

    isSuperAdmin

    isSuperAdmin: boolean

    ReadonlymirrorMask

    mirrorMask: {
        change:contact: undefined | number;
        change:hasSenderKey: number;
        change:id: number;
        change:isAdmin: number;
        change:isSuperAdmin: number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.PinInChatCollection.html b/classes/whatsapp.PinInChatCollection.html index ec09bd4675..6c7e7f263e 100644 --- a/classes/whatsapp.PinInChatCollection.html +++ b/classes/whatsapp.PinInChatCollection.html @@ -1,5 +1,5 @@ -PinInChatCollection | @wppconnect/wa-js - v3.10.1

    Class PinInChatCollection

    Whatsapp

    WAWebPinInChatCollection >= 2.3000.1012170943

    -

    Hierarchy (view full)

    Constructors

    constructor +PinInChatCollection | @wppconnect/wa-js - v3.10.1

    Class PinInChatCollection

    Whatsapp

    WAWebPinInChatCollection >= 2.3000.1012170943

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass cachePolicy? @@ -62,10 +62,10 @@
      • (value, index, obj): value is S

      • Parameters

        • value: PinInChatModel
        • index: number
        • obj: PinInChatModel[]

        Returns value is S

  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | PinInChatModel

  • Parameters

    • predicate: ((value: PinInChatModel, index: number, obj: PinInChatModel[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          • value: PinInChatModel
          • index: number
          • obj: PinInChatModel[]

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | PinInChatModel

    • modelClass

    modelClass: PinInChatModel

    Static OptionalcachePolicy

    cachePolicy?: any

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: PinInChatModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    byChatId

    byIsFailedByMe

    deleteByParentMessageKey

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    byChatId

    byIsFailedByMe

    deleteByParentMessageKey

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      • S extends PinInChatModel

      Parameters

      • predicate: ((value: PinInChatModel, index: number, array: PinInChatModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -89,33 +89,33 @@

      Returns void

    get

    getByMsgKey

    getByParentMsgKey

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: PinInChatModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: PinInChatModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: PinInChatModel, index: number, array: PinInChatModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          • (value, index, array): U

          • Parameters

            • value: PinInChatModel
            • index: number
            • array: PinInChatModel[]

            Returns U

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -127,8 +127,8 @@

    Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    sort

    stopListening

    toArray

    toJSON

    trigger

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.PresenceCollection.html b/classes/whatsapp.PresenceCollection.html index 3159d7d68d..60b55da65b 100644 --- a/classes/whatsapp.PresenceCollection.html +++ b/classes/whatsapp.PresenceCollection.html @@ -1,6 +1,6 @@ -PresenceCollection | @wppconnect/wa-js - v3.10.1

    Class PresenceCollection

    Whatsapp

    68315

    -

    Whatsapp

    868315 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +PresenceCollection | @wppconnect/wa-js - v3.10.1

    Class PresenceCollection

    Whatsapp

    68315

    +

    Whatsapp

    868315 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -71,10 +71,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | PresenceModel

  • Parameters

    Returns undefined | PresenceModel

    • modelClass

    modelClass: PresenceModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: PresenceModel

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    clearAllPresence

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    clearAllPresence

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: PresenceModel, index: number, array: PresenceModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -98,33 +98,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: PresenceModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: PresenceModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: PresenceModel, index: number, array: PresenceModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -136,8 +136,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): PresenceModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -150,8 +150,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.PresenceModel.html b/classes/whatsapp.PresenceModel.html index 2245f8d9f2..e167d95242 100644 --- a/classes/whatsapp.PresenceModel.html +++ b/classes/whatsapp.PresenceModel.html @@ -1,6 +1,6 @@ -PresenceModel | @wppconnect/wa-js - v3.10.1

    Class PresenceModel

    Whatsapp

    30000

    -

    Whatsapp

    330000 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +PresenceModel | @wppconnect/wa-js - v3.10.1

    Class PresenceModel

    Whatsapp

    30000

    +

    Whatsapp

    330000 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    allowedIds? attributes chatActive @@ -56,40 +56,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionalallowedIds

    allowedIds?: any

    Readonlyattributes

    attributes: Props & Session

    chatActive

    chatActive: boolean

    Optionalchatstate

    chatstate?: ChatstateModel

    chatstates

    chatstates: ChatstateCollection

    Optionalcollection

    collection?: undefined

    forceDisplay

    forceDisplay: boolean

    OptionalforceDisplayTimer

    forceDisplayTimer?: any

    hasData

    hasData: boolean

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisGroup

    isGroup: boolean

    isOnline

    isOnline: boolean

    ReadonlyisState

    isState: true

    isSubscribed

    isSubscribed: boolean

    ReadonlyisUser

    isUser: boolean

    ReadonlymirrorMask

    mirrorMask: {
        change:chatActive: number;
        change:chatstate: undefined | number;
        change:forceDisplay: number;
        change:forceDisplayTimer: undefined | number;
        change:hasData: number;
        change:id: number;
        change:isGroup: number;
        change:isOnline: number;
        change:isSubscribed: number;
        change:isUser: number;
        change:withholdDisplayStage: undefined | number;
        change:withholdDisplayTimer: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    OptionalwithholdDisplayStage

    withholdDisplayStage?: any

    OptionalwithholdDisplayTimer

    withholdDisplayTimer?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalallowedIds

    allowedIds?: any

    Readonlyattributes

    attributes: Props & Session

    chatActive

    chatActive: boolean

    Optionalchatstate

    chatstate?: ChatstateModel

    chatstates

    chatstates: ChatstateCollection

    Optionalcollection

    collection?: undefined

    forceDisplay

    forceDisplay: boolean

    OptionalforceDisplayTimer

    forceDisplayTimer?: any

    hasData

    hasData: boolean

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisGroup

    isGroup: boolean

    isOnline

    isOnline: boolean

    ReadonlyisState

    isState

    isSubscribed

    isSubscribed: boolean

    ReadonlyisUser

    isUser: boolean

    ReadonlymirrorMask

    mirrorMask: {
        change:chatActive: number;
        change:chatstate: undefined | number;
        change:forceDisplay: number;
        change:forceDisplayTimer: undefined | number;
        change:hasData: number;
        change:id: number;
        change:isGroup: number;
        change:isOnline: number;
        change:isSubscribed: number;
        change:isUser: number;
        change:withholdDisplayStage: undefined | number;
        change:withholdDisplayTimer: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    OptionalwithholdDisplayStage

    withholdDisplayStage?: any

    OptionalwithholdDisplayTimer

    withholdDisplayTimer?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ProductCatalogSession.html b/classes/whatsapp.ProductCatalogSession.html index c9781b72ca..28db179607 100644 --- a/classes/whatsapp.ProductCatalogSession.html +++ b/classes/whatsapp.ProductCatalogSession.html @@ -1,5 +1,5 @@ -ProductCatalogSession | @wppconnect/wa-js - v3.10.1

    Class ProductCatalogSession

    Whatsapp

    409153 >= 2.2228.14

    -

    Constructors

    constructor +ProductCatalogSession | @wppconnect/wa-js - v3.10.1

    Class ProductCatalogSession

    Whatsapp

    409153 >= 2.2228.14

    +

    Constructors

    constructor

    Properties

    accidental? sessionId?

    Methods

    initSessionId diff --git a/classes/whatsapp.ProductCollCollection.html b/classes/whatsapp.ProductCollCollection.html index c8c63b9668..e6f81db8a0 100644 --- a/classes/whatsapp.ProductCollCollection.html +++ b/classes/whatsapp.ProductCollCollection.html @@ -1,6 +1,6 @@ -ProductCollCollection | @wppconnect/wa-js - v3.10.1

    Class ProductCollCollection

    Whatsapp

    12496

    -

    Whatsapp

    912496 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProductCollCollection | @wppconnect/wa-js - v3.10.1

    Class ProductCollCollection

    Whatsapp

    12496

    +

    Whatsapp

    912496 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -61,10 +61,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ProductCollModel

  • Parameters

    Returns undefined | ProductCollModel

    • modelClass

    modelClass: ProductCollModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: ProductCollModel

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ProductCollModel, index: number, array: ProductCollModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -88,33 +88,33 @@

        Whatsapp

      Returns void

    get

    getCollectionModels

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProductCollModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProductCollModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ProductCollModel, index: number, array: ProductCollModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -126,8 +126,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): ProductCollModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ProductCollModel.html b/classes/whatsapp.ProductCollModel.html index e6579f23d2..3261af1c78 100644 --- a/classes/whatsapp.ProductCollModel.html +++ b/classes/whatsapp.ProductCollModel.html @@ -1,6 +1,6 @@ -ProductCollModel | @wppconnect/wa-js - v3.10.1

    Class ProductCollModel

    Whatsapp

    94629

    -

    Whatsapp

    394629 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProductCollModel | @wppconnect/wa-js - v3.10.1

    Class ProductCollModel

    Whatsapp

    94629

    +

    Whatsapp

    394629 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    afterCursor? attributes canAppeal? @@ -51,40 +51,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionalafterCursor

    afterCursor?: any

    Readonlyattributes

    attributes: Props & Session

    OptionalcanAppeal

    canAppeal?: any

    Optionalcollection

    collection?: undefined

    OptionalcommerceUrl

    commerceUrl?: any

    Optionalid

    id?: any

    isHidden

    isHidden: boolean

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:afterCursor: undefined | number;
        change:canAppeal: undefined | number;
        change:commerceUrl: undefined | number;
        change:id: undefined | number;
        change:isHidden: number;
        change:name: undefined | number;
        change:rejectReason: undefined | number;
        change:reviewStatus: undefined | number;
        change:stale: undefined | number;
        change:totalItemsCount: undefined | number;
    }

    Optionalname

    name?: string

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    OptionalrejectReason

    rejectReason?: any

    OptionalreviewStatus

    reviewStatus?: any

    Optionalstale

    stale?: any

    OptionaltotalItemsCount

    totalItemsCount?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    addProducts

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionalafterCursor

    afterCursor?: any

    Readonlyattributes

    attributes: Props & Session

    OptionalcanAppeal

    canAppeal?: any

    Optionalcollection

    collection?: undefined

    OptionalcommerceUrl

    commerceUrl?: any

    Optionalid

    id?: any

    isHidden

    isHidden: boolean

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:afterCursor: undefined | number;
        change:canAppeal: undefined | number;
        change:commerceUrl: undefined | number;
        change:id: undefined | number;
        change:isHidden: number;
        change:name: undefined | number;
        change:rejectReason: undefined | number;
        change:reviewStatus: undefined | number;
        change:stale: undefined | number;
        change:totalItemsCount: undefined | number;
    }

    Optionalname

    name?: string

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    OptionalrejectReason

    rejectReason?: any

    OptionalreviewStatus

    reviewStatus?: any

    Optionalstale

    stale?: any

    OptionaltotalItemsCount

    totalItemsCount?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    addProducts

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ProductCollection.html b/classes/whatsapp.ProductCollection.html index 8e65d9b62c..5f01fb3e5e 100644 --- a/classes/whatsapp.ProductCollection.html +++ b/classes/whatsapp.ProductCollection.html @@ -1,6 +1,6 @@ -ProductCollection | @wppconnect/wa-js - v3.10.1

    Class ProductCollection

    Whatsapp

    5641

    -

    Whatsapp

    105641 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProductCollection | @wppconnect/wa-js - v3.10.1

    Class ProductCollection

    Whatsapp

    5641

    +

    Whatsapp

    105641 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass model @@ -59,10 +59,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ProductModel

  • Parameters

    Returns undefined | ProductModel

    • modelClass

    modelClass: ProductModel

    Staticmodel

    model: ProductModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ProductModel, index: number, array: ProductModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -86,33 +86,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    getProductModels

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProductModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProductModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ProductModel, index: number, array: ProductModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -124,8 +124,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): ProductModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -138,8 +138,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ProductImageCollection.html b/classes/whatsapp.ProductImageCollection.html index d6caa1288e..14e9b96fa8 100644 --- a/classes/whatsapp.ProductImageCollection.html +++ b/classes/whatsapp.ProductImageCollection.html @@ -1,6 +1,6 @@ -ProductImageCollection | @wppconnect/wa-js - v3.10.1

    Class ProductImageCollection

    Whatsapp

    7514

    -

    Whatsapp

    307514 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProductImageCollection | @wppconnect/wa-js - v3.10.1

    Class ProductImageCollection

    Whatsapp

    7514

    +

    Whatsapp

    307514 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -57,10 +57,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ProductImageModel

  • Parameters

    Returns undefined | ProductImageModel

    • modelClass

    modelClass: ProductImageModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: ProductImageModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ProductImageModel, index: number, array: ProductImageModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProductImageModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProductImageModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ProductImageModel, index: number, array: ProductImageModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): ProductImageModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ProductImageModel.html b/classes/whatsapp.ProductImageModel.html index 73bb468a25..9aa8a16fee 100644 --- a/classes/whatsapp.ProductImageModel.html +++ b/classes/whatsapp.ProductImageModel.html @@ -1,6 +1,6 @@ -ProductImageModel | @wppconnect/wa-js - v3.10.1

    Class ProductImageModel

    Whatsapp

    51954

    -

    Whatsapp

    951954 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProductImageModel | @wppconnect/wa-js - v3.10.1

    Class ProductImageModel

    Whatsapp

    51954

    +

    Whatsapp

    951954 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes blobUrl? collection? @@ -51,40 +51,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    OptionalblobUrl

    blobUrl?: any

    Optionalcollection

    collection?: undefined

    OptionalfetchedFromServer

    fetchedFromServer?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    OptionalmediaData

    mediaData?: any

    OptionalmediaUrl

    mediaUrl?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:blobUrl: undefined | number;
        change:fetchedFromServer: undefined | number;
        change:id: undefined | number;
        change:mediaData: undefined | number;
        change:mediaUrl: undefined | number;
        change:old: undefined | number;
        change:stale: undefined | number;
        change:type: undefined | number;
    }

    Optionalold

    old?: any

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltype

    type?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    evictFromCache

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    OptionalblobUrl

    blobUrl?: any

    Optionalcollection

    collection?: undefined

    OptionalfetchedFromServer

    fetchedFromServer?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState

    OptionalmediaData

    mediaData?: any

    OptionalmediaUrl

    mediaUrl?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:blobUrl: undefined | number;
        change:fetchedFromServer: undefined | number;
        change:id: undefined | number;
        change:mediaData: undefined | number;
        change:mediaUrl: undefined | number;
        change:old: undefined | number;
        change:stale: undefined | number;
        change:type: undefined | number;
    }

    Optionalold

    old?: any

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltype

    type?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    evictFromCache

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    markOld

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    triggerImageUpdate

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ProductMessageListCollection.html b/classes/whatsapp.ProductMessageListCollection.html index 7151ef37f4..5e2c1b7104 100644 --- a/classes/whatsapp.ProductMessageListCollection.html +++ b/classes/whatsapp.ProductMessageListCollection.html @@ -1,5 +1,5 @@ -ProductMessageListCollection | @wppconnect/wa-js - v3.10.1

    Class ProductMessageListCollection

    Whatsapp

    18952

    -

    Hierarchy (view full)

    Constructors

    constructor +ProductMessageListCollection | @wppconnect/wa-js - v3.10.1

    Class ProductMessageListCollection

    Whatsapp

    18952

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -58,10 +58,10 @@
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ProductMessageListModel

  • Parameters

    Returns undefined | ProductMessageListModel

    • modelClass

    modelClass: ProductMessageListModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: ProductMessageListModel

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ProductMessageListModel, index: number, array: ProductMessageListModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -85,33 +85,33 @@

      Returns void

    get

    getModelsArray

    getOrAdd

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProductMessageListModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProductMessageListModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ProductMessageListModel, index: number, array: ProductMessageListModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -123,8 +123,8 @@

    Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    sort

    stopListening

    toArray

    toJSON

    trigger

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ProductMessageListModel.html b/classes/whatsapp.ProductMessageListModel.html index f625c168a5..9a5e414e30 100644 --- a/classes/whatsapp.ProductMessageListModel.html +++ b/classes/whatsapp.ProductMessageListModel.html @@ -1,6 +1,6 @@ -ProductMessageListModel | @wppconnect/wa-js - v3.10.1

    Class ProductMessageListModel

    Whatsapp

    89295

    -

    Whatsapp

    989295 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProductMessageListModel | @wppconnect/wa-js - v3.10.1

    Class ProductMessageListModel

    Whatsapp

    89295

    +

    Whatsapp

    989295 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes catalogId? collection? @@ -57,40 +57,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    OptionalcatalogId

    catalogId?: any

    Optionalcollection

    collection?: undefined

    id

    id: MsgKey

    idClass

    idClass: typeof MsgKey

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:catalogId: undefined | number;
        change:id: number;
        change:stale: undefined | number;
        change:title: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltitle

    title?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    getNextProductBatchToLoad

    getPageSize

    getProductList

    getProductLoadingStatus

    getProductSize

    getSections

    getSectionsCount

    getTotalProductsFetchedOrFailed

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isFetching

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    OptionalcatalogId

    catalogId?: any

    Optionalcollection

    collection?: undefined

    id

    id: MsgKey

    idClass

    idClass: typeof MsgKey

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:catalogId: undefined | number;
        change:id: number;
        change:stale: undefined | number;
        change:title: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltitle

    title?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    getNextProductBatchToLoad

    getPageSize

    getProductList

    getProductLoadingStatus

    getProductSize

    getSections

    getSectionsCount

    getTotalProductsFetchedOrFailed

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isFetching

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    setProductLoadingStatus

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    setProductLoadingStatus

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    triggerProductRemoved

    triggerProductUpdate

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ProductModel.html b/classes/whatsapp.ProductModel.html index b3153efdff..2ebc75e35e 100644 --- a/classes/whatsapp.ProductModel.html +++ b/classes/whatsapp.ProductModel.html @@ -1,6 +1,6 @@ -ProductModel | @wppconnect/wa-js - v3.10.1

    Class ProductModel

    Whatsapp

    9468

    -

    Whatsapp

    509468 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProductModel | @wppconnect/wa-js - v3.10.1

    Class ProductModel

    Whatsapp

    9468

    +

    Whatsapp

    509468 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    additionalImageCdnUrl? additionalImageHashes? attributes @@ -75,40 +75,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    OptionaladditionalImageCdnUrl

    additionalImageCdnUrl?: any

    OptionaladditionalImageHashes

    additionalImageHashes?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalavailability

    availability?: any

    canAppeal

    canAppeal: boolean

    OptionalcatalogWid

    catalogWid?: any

    Optionalcheckmark

    checkmark?: any

    Optionalcollection

    collection?: undefined

    Optionalcurrency

    currency?: any

    Optionaldescription

    description?: any

    OptionalfetchedFromServer

    fetchedFromServer?: any

    Optionalid

    id?: any

    image

    image: undefined | string

    OptionalimageCdnUrl

    imageCdnUrl?: any

    OptionalimageCount

    imageCount?: any

    OptionalimageHash

    imageHash?: any

    Optionalindex

    index?: any

    OptionalisHidden

    isHidden?: boolean

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:additionalImageCdnUrl: undefined | number;
        change:additionalImageHashes: undefined | number;
        change:availability: undefined | number;
        change:canAppeal: number;
        change:catalogWid: undefined | number;
        change:checkmark: undefined | number;
        change:currency: undefined | number;
        change:description: undefined | number;
        change:fetchedFromServer: undefined | number;
        change:id: undefined | number;
        change:imageCdnUrl: undefined | number;
        change:imageCount: undefined | number;
        change:imageHash: undefined | number;
        change:index: undefined | number;
        change:isHidden: undefined | number;
        change:name: undefined | number;
        change:old: undefined | number;
        change:priceAmount1000: undefined | number;
        change:productImageCollection: undefined | number;
        change:productMsgMediaData: undefined | number;
        change:retailerId: undefined | number;
        change:reviewStatus: undefined | number;
        change:salePriceAmount1000: undefined | number;
        change:salePriceEndDate: undefined | number;
        change:salePriceStartDate: undefined | number;
        change:stale: undefined | number;
        change:t: undefined | number;
        change:url: undefined | number;
    }

    Optionalname

    name?: string

    Optionalold

    old?: any

    Optionalparent

    parent?: any

    OptionalpriceAmount1000

    priceAmount1000?: any

    OptionalproductImageCollection

    productImageCollection?: any

    OptionalproductMsgMediaData

    productMsgMediaData?: any

    proxyName

    proxyName: string

    OptionalretailerId

    retailerId?: any

    OptionalreviewStatus

    reviewStatus?: any

    OptionalsalePriceAmount1000

    salePriceAmount1000?: any

    OptionalsalePriceEndDate

    salePriceEndDate?: any

    OptionalsalePriceStartDate

    salePriceStartDate?: any

    Optionalstale

    stale?: any

    Optionalt

    t?: any

    Optionalurl

    url?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    evictImagesFromCache

    get

    getDefault

    getHeadImageFile

    getPreviewImage

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    OptionaladditionalImageCdnUrl

    additionalImageCdnUrl?: any

    OptionaladditionalImageHashes

    additionalImageHashes?: any

    Readonlyattributes

    attributes: Props & Session

    Optionalavailability

    availability?: any

    canAppeal

    canAppeal: boolean

    OptionalcatalogWid

    catalogWid?: any

    Optionalcheckmark

    checkmark?: any

    Optionalcollection

    collection?: undefined

    Optionalcurrency

    currency?: any

    Optionaldescription

    description?: any

    OptionalfetchedFromServer

    fetchedFromServer?: any

    Optionalid

    id?: any

    image

    image: undefined | string

    OptionalimageCdnUrl

    imageCdnUrl?: any

    OptionalimageCount

    imageCount?: any

    OptionalimageHash

    imageHash?: any

    Optionalindex

    index?: any

    OptionalisHidden

    isHidden?: boolean

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:additionalImageCdnUrl: undefined | number;
        change:additionalImageHashes: undefined | number;
        change:availability: undefined | number;
        change:canAppeal: number;
        change:catalogWid: undefined | number;
        change:checkmark: undefined | number;
        change:currency: undefined | number;
        change:description: undefined | number;
        change:fetchedFromServer: undefined | number;
        change:id: undefined | number;
        change:imageCdnUrl: undefined | number;
        change:imageCount: undefined | number;
        change:imageHash: undefined | number;
        change:index: undefined | number;
        change:isHidden: undefined | number;
        change:name: undefined | number;
        change:old: undefined | number;
        change:priceAmount1000: undefined | number;
        change:productImageCollection: undefined | number;
        change:productMsgMediaData: undefined | number;
        change:retailerId: undefined | number;
        change:reviewStatus: undefined | number;
        change:salePriceAmount1000: undefined | number;
        change:salePriceEndDate: undefined | number;
        change:salePriceStartDate: undefined | number;
        change:stale: undefined | number;
        change:t: undefined | number;
        change:url: undefined | number;
    }

    Optionalname

    name?: string

    Optionalold

    old?: any

    Optionalparent

    parent?: any

    OptionalpriceAmount1000

    priceAmount1000?: any

    OptionalproductImageCollection

    productImageCollection?: any

    OptionalproductMsgMediaData

    productMsgMediaData?: any

    proxyName

    proxyName: string

    OptionalretailerId

    retailerId?: any

    OptionalreviewStatus

    reviewStatus?: any

    OptionalsalePriceAmount1000

    salePriceAmount1000?: any

    OptionalsalePriceEndDate

    salePriceEndDate?: any

    OptionalsalePriceStartDate

    salePriceStartDate?: any

    Optionalstale

    stale?: any

    Optionalt

    t?: any

    Optionalurl

    url?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    evictImagesFromCache

    get

    getDefault

    getHeadImageFile

    getPreviewImage

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    markOld

    markProductImagesOld

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    triggerImageUpdate

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ProfilePicThumbCollection.html b/classes/whatsapp.ProfilePicThumbCollection.html index 1ef17edd5c..b7e51862f5 100644 --- a/classes/whatsapp.ProfilePicThumbCollection.html +++ b/classes/whatsapp.ProfilePicThumbCollection.html @@ -1,6 +1,6 @@ -ProfilePicThumbCollection | @wppconnect/wa-js - v3.10.1

    Class ProfilePicThumbCollection

    Whatsapp

    82039

    -

    Whatsapp

    582039 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProfilePicThumbCollection | @wppconnect/wa-js - v3.10.1

    Class ProfilePicThumbCollection

    Whatsapp

    82039

    +

    Whatsapp

    582039 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -75,10 +75,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ProfilePicThumbModel

  • Parameters

    Returns undefined | ProfilePicThumbModel

    • modelClass

    modelClass: ProfilePicThumbModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: ProfilePicThumbModel

    Static OptionalresumeOnAvailable

    resumeOnAvailable?: any

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ProfilePicThumbModel, index: number, array: ProfilePicThumbModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -102,33 +102,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    getThumbnailWidFromVcard

    handle

    head

    imageChanged

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProfilePicThumbModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ProfilePicThumbModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ProfilePicThumbModel, index: number, array: ProfilePicThumbModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -140,8 +140,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    resyncPictures

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    resyncPictures

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): ProfilePicThumbModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ProfilePicThumbModel.html b/classes/whatsapp.ProfilePicThumbModel.html index a990a5ee2e..78a60d16c1 100644 --- a/classes/whatsapp.ProfilePicThumbModel.html +++ b/classes/whatsapp.ProfilePicThumbModel.html @@ -1,6 +1,6 @@ -ProfilePicThumbModel | @wppconnect/wa-js - v3.10.1

    Class ProfilePicThumbModel

    Whatsapp

    93836

    -

    Whatsapp

    793836 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ProfilePicThumbModel | @wppconnect/wa-js - v3.10.1

    Class ProfilePicThumbModel

    Whatsapp

    93836

    +

    Whatsapp

    793836 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? eurl? @@ -59,40 +59,40 @@

    Whatsappunset validate isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: ProfilePicThumbCollection

    Optionaleurl

    eurl?: any

    OptionaleurlStale

    eurlStale?: any

    Optional ReadonlyfallbackType

    fallbackType?: "SINGLE" | "GROUP"

    id

    id: Wid

    idClass

    idClass: typeof Wid

    Optional Readonlyimg

    img?: null | string

    Optional ReadonlyimgFull

    imgFull?: null | string

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:eurl: undefined | number;
        change:eurlStale: undefined | number;
        change:fallbackType: undefined | number;
        change:id: number;
        change:img: undefined | number;
        change:imgFull: undefined | number;
        change:pendingPic: undefined | number;
        change:previewEurl: undefined | number;
        change:raw: undefined | number;
        change:stale: undefined | number;
        change:tag: undefined | number;
        change:token: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalpendingPic

    pendingPic?: any

    OptionalpreviewEurl

    previewEurl?: any

    proxyName

    proxyName: string

    Optionalraw

    raw?: any

    Optionalstale

    stale?: any

    Optionaltag

    tag?: any

    Optionaltoken

    token?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canDelete

    canSet

    clear

    decObservers

    delete

    emit

    generateUrl

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: ProfilePicThumbCollection

    Optionaleurl

    eurl?: any

    OptionaleurlStale

    eurlStale?: any

    Optional ReadonlyfallbackType

    fallbackType?: "SINGLE" | "GROUP"

    id

    id: Wid

    idClass

    idClass: typeof Wid

    Optional Readonlyimg

    img?: null | string

    Optional ReadonlyimgFull

    imgFull?: null | string

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:eurl: undefined | number;
        change:eurlStale: undefined | number;
        change:fallbackType: undefined | number;
        change:id: number;
        change:img: undefined | number;
        change:imgFull: undefined | number;
        change:pendingPic: undefined | number;
        change:previewEurl: undefined | number;
        change:raw: undefined | number;
        change:stale: undefined | number;
        change:tag: undefined | number;
        change:token: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalpendingPic

    pendingPic?: any

    OptionalpreviewEurl

    previewEurl?: any

    proxyName

    proxyName: string

    Optionalraw

    raw?: any

    Optionalstale

    stale?: any

    Optionaltag

    tag?: any

    Optionaltoken

    token?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canDelete

    canSet

    clear

    decObservers

    delete

    emit

    generateUrl

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    markStale

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    validate

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    validate

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.QuickReplyCollection.html b/classes/whatsapp.QuickReplyCollection.html index b9dd93bf5f..a80fed0414 100644 --- a/classes/whatsapp.QuickReplyCollection.html +++ b/classes/whatsapp.QuickReplyCollection.html @@ -1,6 +1,6 @@ -QuickReplyCollection | @wppconnect/wa-js - v3.10.1

    Class QuickReplyCollection

    Whatsapp

    99662

    -

    Whatsapp

    999662 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +QuickReplyCollection | @wppconnect/wa-js - v3.10.1

    Class QuickReplyCollection

    Whatsapp

    99662

    +

    Whatsapp

    999662 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    checksum? findFirst flushCountsTimer? @@ -69,10 +69,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | QuickReplyModel

  • Parameters

    Returns undefined | QuickReplyModel

    • OptionalflushCountsTimer

    flushCountsTimer?: any

    modelClass

    modelClass: QuickReplyModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: QuickReplyModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: QuickReplyModel, index: number, array: QuickReplyModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -96,33 +96,33 @@

        Whatsapp

      Returns void

    get

    getAllPendingCounts

    getModelsArray

    hasPendingCounts

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: QuickReplyModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: QuickReplyModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: QuickReplyModel, index: number, array: QuickReplyModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -134,8 +134,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): QuickReplyModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    sortQuickReply

    stopListening

    sync

    synced

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    sortQuickReply

    stopListening

    sync

    synced

    toArray

    toJSON

    trigger

    unbind

    updateChecksum

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    updateChecksum

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.QuickReplyModel.html b/classes/whatsapp.QuickReplyModel.html index 038bd390a0..10b407c7bc 100644 --- a/classes/whatsapp.QuickReplyModel.html +++ b/classes/whatsapp.QuickReplyModel.html @@ -1,6 +1,6 @@ -QuickReplyModel | @wppconnect/wa-js - v3.10.1

    Class QuickReplyModel

    Whatsapp

    47169

    -

    Whatsapp

    947169 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +QuickReplyModel | @wppconnect/wa-js - v3.10.1

    Class QuickReplyModel

    Whatsapp

    47169

    +

    Whatsapp

    947169 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? count? @@ -50,40 +50,40 @@

    Whatsappunset useOnce isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: QuickReplyCollection

    Optionalcount

    count?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    Optionalkeywords

    keywords?: any

    Optionalmessage

    message?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:count: undefined | number;
        change:id: undefined | number;
        change:keywords: undefined | number;
        change:message: undefined | number;
        change:pendingCount: undefined | number;
        change:shortcut: undefined | number;
        change:stale: undefined | number;
        change:totalCount: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalpendingCount

    pendingCount?: any

    proxyName

    proxyName: string

    Optionalshortcut

    shortcut?: any

    Optionalstale

    stale?: any

    Optional ReadonlytotalCount

    totalCount?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: QuickReplyCollection

    Optionalcount

    count?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState

    Optionalkeywords

    keywords?: any

    Optionalmessage

    message?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:count: undefined | number;
        change:id: undefined | number;
        change:keywords: undefined | number;
        change:message: undefined | number;
        change:pendingCount: undefined | number;
        change:shortcut: undefined | number;
        change:stale: undefined | number;
        change:totalCount: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalpendingCount

    pendingCount?: any

    proxyName

    proxyName: string

    Optionalshortcut

    shortcut?: any

    Optionalstale

    stale?: any

    Optional ReadonlytotalCount

    totalCount?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    useOnce

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    useOnce

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ReactionsCollection.html b/classes/whatsapp.ReactionsCollection.html index 27b8833955..090b72d869 100644 --- a/classes/whatsapp.ReactionsCollection.html +++ b/classes/whatsapp.ReactionsCollection.html @@ -1,6 +1,6 @@ -ReactionsCollection | @wppconnect/wa-js - v3.10.1

    Class ReactionsCollection

    Whatsapp

    57162

    -

    Whatsapp

    257162 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ReactionsCollection | @wppconnect/wa-js - v3.10.1

    Class ReactionsCollection

    Whatsapp

    57162

    +

    Whatsapp

    257162 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -77,10 +77,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ReactionsModel

  • Parameters

    Returns undefined | ReactionsModel

    • modelClass

    modelClass: ReactionsModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticmodel

    model: ReactionsModel

    Accessors

    length

    Methods

    add

    addOrUpdateReaction

    assertGet

    at

    bind

    delete

    deleteReactionsByParentMessageKey

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    deleteReactionsByParentMessageKey

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ReactionsModel, index: number, array: ReactionsModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -104,33 +104,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getAggregateEmojiAndSender

    getExistingSenderModelFromReactionDetails

    getModelsArray

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ReactionsModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ReactionsModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ReactionsModel, index: number, array: ReactionsModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    markReactionsAsRead

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -142,8 +142,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    removeReaction

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    shouldUpdateAck

    slice

    removeReaction

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    shouldUpdateAck

    slice

    • slice(start?, end?): ReactionsModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    updateFailedPropsForExistingSentReaction

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    updateFailedPropsForExistingSentReaction

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ReactionsModel.html b/classes/whatsapp.ReactionsModel.html index 61ca50e71e..25788b7c8d 100644 --- a/classes/whatsapp.ReactionsModel.html +++ b/classes/whatsapp.ReactionsModel.html @@ -1,7 +1,7 @@ -ReactionsModel | @wppconnect/wa-js - v3.10.1

    Class ReactionsModel

    Whatsapp

    80666

    -

    Whatsapp

    81130 >= 2.2220.8

    -

    Whatsapp

    981130 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ReactionsModel | @wppconnect/wa-js - v3.10.1

    Class ReactionsModel

    Whatsapp

    80666

    +

    Whatsapp

    81130 >= 2.2220.8

    +

    Whatsapp

    981130 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id @@ -46,40 +46,40 @@

    WhatsappunreadSenders unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    id

    id: Wid

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:reactionByMe: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    OptionalreactionByMe

    reactionByMe?: ReactionsSendersModel

    reactions

    reactions: AggReactionsCollection

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    id

    id: Wid

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:reactionByMe: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    OptionalreactionByMe

    reactionByMe?: ReactionsSendersModel

    reactions

    reactions: AggReactionsCollection

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unreadSenders

    • unreadSenders(): {
          msgKey: string;
          parentMsgKey: MsgKey;
          reactionText: string;
          senderUserJid: string;
      }[]

    • Returns {
          msgKey: string;
          parentMsgKey: MsgKey;
          reactionText: string;
          senderUserJid: string;
      }[]

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unreadSenders

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ReactionsSendersCollection.html b/classes/whatsapp.ReactionsSendersCollection.html index 8822595e9f..5fb51e7261 100644 --- a/classes/whatsapp.ReactionsSendersCollection.html +++ b/classes/whatsapp.ReactionsSendersCollection.html @@ -1,6 +1,6 @@ -ReactionsSendersCollection | @wppconnect/wa-js - v3.10.1

    Class ReactionsSendersCollection

    Whatsapp

    81130

    -

    Whatsapp

    981130 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ReactionsSendersCollection | @wppconnect/wa-js - v3.10.1

    Class ReactionsSendersCollection

    Whatsapp

    81130

    +

    Whatsapp

    981130 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass model @@ -57,10 +57,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | ReactionsModel

  • Parameters

    Returns undefined | ReactionsModel

    • modelClass

    modelClass: ReactionsModel

    Staticmodel

    model: ReactionsSendersModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: ReactionsModel, index: number, array: ReactionsModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ReactionsModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: ReactionsModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: ReactionsModel, index: number, array: ReactionsModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): ReactionsModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.ReactionsSendersModel.html b/classes/whatsapp.ReactionsSendersModel.html index 53c39c71a3..4f7c8d0b4a 100644 --- a/classes/whatsapp.ReactionsSendersModel.html +++ b/classes/whatsapp.ReactionsSendersModel.html @@ -1,6 +1,6 @@ -ReactionsSendersModel | @wppconnect/wa-js - v3.10.1

    Class ReactionsSendersModel

    Whatsapp

    81130

    -

    Whatsapp

    981130 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ReactionsSendersModel | @wppconnect/wa-js - v3.10.1

    Class ReactionsSendersModel

    Whatsapp

    81130

    +

    Whatsapp

    981130 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    ack? attributes collection? @@ -53,40 +53,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Optionalack

    ack?: number

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisFailed

    isFailed: boolean

    OptionalisSendFailure

    isSendFailure?: boolean

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:ack: undefined | number;
        change:id: undefined | number;
        change:isFailed: number;
        change:isSendFailure: undefined | number;
        change:msgKey: undefined | number;
        change:orphan: undefined | number;
        change:parentMsg: undefined | number;
        change:parentMsgKey: undefined | number;
        change:reactionText: undefined | number;
        change:read: undefined | number;
        change:senderObj: undefined | number;
        change:senderUserJid: undefined | number;
        change:timestamp: undefined | number;
    }

    OptionalmsgKey

    msgKey?: string

    Optionalorphan

    orphan?: number

    Optionalparent

    parent?: any

    Optional ReadonlyparentMsg

    parentMsg?: any

    OptionalparentMsgKey

    parentMsgKey?: string

    proxyName

    proxyName: string

    OptionalreactionText

    reactionText?: string

    Optionalread

    read?: boolean

    OptionalsenderObj

    senderObj?: any

    OptionalsenderUserJid

    senderUserJid?: string

    Optionaltimestamp

    timestamp?: number

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Optionalack

    ack?: number

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisFailed

    isFailed: boolean

    OptionalisSendFailure

    isSendFailure?: boolean

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:ack: undefined | number;
        change:id: undefined | number;
        change:isFailed: number;
        change:isSendFailure: undefined | number;
        change:msgKey: undefined | number;
        change:orphan: undefined | number;
        change:parentMsg: undefined | number;
        change:parentMsgKey: undefined | number;
        change:reactionText: undefined | number;
        change:read: undefined | number;
        change:senderObj: undefined | number;
        change:senderUserJid: undefined | number;
        change:timestamp: undefined | number;
    }

    OptionalmsgKey

    msgKey?: string

    Optionalorphan

    orphan?: number

    Optionalparent

    parent?: any

    Optional ReadonlyparentMsg

    parentMsg?: any

    OptionalparentMsgKey

    parentMsgKey?: string

    proxyName

    proxyName: string

    OptionalreactionText

    reactionText?: string

    Optionalread

    read?: boolean

    OptionalsenderObj

    senderObj?: any

    OptionalsenderUserJid

    senderUserJid?: string

    Optionaltimestamp

    timestamp?: number

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.RecentEmojiCollection.html b/classes/whatsapp.RecentEmojiCollection.html index fd4734ac1e..a1e978f1a1 100644 --- a/classes/whatsapp.RecentEmojiCollection.html +++ b/classes/whatsapp.RecentEmojiCollection.html @@ -1,6 +1,6 @@ -RecentEmojiCollection | @wppconnect/wa-js - v3.10.1

    Class RecentEmojiCollection

    Whatsapp

    92671

    -

    Whatsapp

    492671 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +RecentEmojiCollection | @wppconnect/wa-js - v3.10.1

    Class RecentEmojiCollection

    Whatsapp

    92671

    +

    Whatsapp

    492671 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    dirty? findFirst modelClass @@ -62,10 +62,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | RecentEmojiModel

  • Parameters

    Returns undefined | RecentEmojiModel

    • modelClass

    modelClass: RecentEmojiModel

    Static OptionalcachePolicy

    cachePolicy?: any

    Staticmodel

    model: RecentEmojiModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: RecentEmojiModel, index: number, array: RecentEmojiModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -89,33 +89,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    increment

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: RecentEmojiModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: RecentEmojiModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: RecentEmojiModel, index: number, array: RecentEmojiModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -127,8 +127,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): RecentEmojiModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    sync

    throttledSync

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    sync

    throttledSync

    toArray

    toJSON

    trigger

    unbind

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.RecentEmojiModel.html b/classes/whatsapp.RecentEmojiModel.html index bfbd96ba21..43606d5844 100644 --- a/classes/whatsapp.RecentEmojiModel.html +++ b/classes/whatsapp.RecentEmojiModel.html @@ -1,5 +1,5 @@ -RecentEmojiModel | @wppconnect/wa-js - v3.10.1

    Class RecentEmojiModel

    Whatsapp

    93894

    -

    Hierarchy (view full)

    Constructors

    constructor +RecentEmojiModel | @wppconnect/wa-js - v3.10.1

    Class RecentEmojiModel

    Whatsapp

    93894

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id? @@ -42,40 +42,40 @@ unbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:stale: undefined | number;
        change:weight: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalweight

    weight?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:stale: undefined | number;
        change:weight: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalweight

    weight?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.RecentStickerCollection.html b/classes/whatsapp.RecentStickerCollection.html index 6c0836f311..21cd502e66 100644 --- a/classes/whatsapp.RecentStickerCollection.html +++ b/classes/whatsapp.RecentStickerCollection.html @@ -1,7 +1,7 @@ -RecentStickerCollection | @wppconnect/wa-js - v3.10.1

    Class RecentStickerCollection

    Whatsapp

    49264

    -

    Whatsapp

    91692 >= 2.2212.8

    -

    Whatsapp

    191692 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +RecentStickerCollection | @wppconnect/wa-js - v3.10.1

    Class RecentStickerCollection

    Whatsapp

    49264

    +

    Whatsapp

    91692 >= 2.2212.8

    +

    Whatsapp

    191692 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -62,10 +62,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | StickerModel

  • Parameters

    Returns undefined | StickerModel

    • modelClass

    modelClass: StickerModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: StickerModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    enqueue

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    enqueue

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: StickerModel, index: number, array: StickerModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -89,33 +89,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StickerModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    isSynced

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    isSynced

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StickerModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: StickerModel, index: number, array: StickerModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -127,8 +127,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setChecksum

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setChecksum

    slice

    • slice(start?, end?): StickerModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -141,8 +141,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.RecentStickerModel.html b/classes/whatsapp.RecentStickerModel.html index 82ef3764a6..00007c5014 100644 --- a/classes/whatsapp.RecentStickerModel.html +++ b/classes/whatsapp.RecentStickerModel.html @@ -1,6 +1,6 @@ -RecentStickerModel | @wppconnect/wa-js - v3.10.1

    Class RecentStickerModel

    Whatsapp

    20238

    -

    Whatsapp

    620238 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +RecentStickerModel | @wppconnect/wa-js - v3.10.1

    Class RecentStickerModel

    Whatsapp

    20238

    +

    Whatsapp

    620238 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id? @@ -45,40 +45,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:msgId: undefined | number;
        change:stale: undefined | number;
        change:sticker: undefined | number;
        change:timestamp: undefined | number;
    }

    OptionalmsgId

    msgId?: any

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalsticker

    sticker?: any

    Optionaltimestamp

    timestamp?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:msgId: undefined | number;
        change:stale: undefined | number;
        change:sticker: undefined | number;
        change:timestamp: undefined | number;
    }

    OptionalmsgId

    msgId?: any

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalsticker

    sticker?: any

    Optionaltimestamp

    timestamp?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ReplyButtonModel.html b/classes/whatsapp.ReplyButtonModel.html index 0765273baa..56d27cf3c9 100644 --- a/classes/whatsapp.ReplyButtonModel.html +++ b/classes/whatsapp.ReplyButtonModel.html @@ -1,6 +1,6 @@ -ReplyButtonModel | @wppconnect/wa-js - v3.10.1

    Class ReplyButtonModel

    Whatsapp

    15871

    -

    Whatsapp

    315871 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ReplyButtonModel | @wppconnect/wa-js - v3.10.1

    Class ReplyButtonModel

    Whatsapp

    15871

    +

    Whatsapp

    315871 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? displayText? @@ -44,40 +44,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionaldisplayText

    displayText?: string

    Optionalid

    id?: string

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:displayText: undefined | number;
        change:id: undefined | number;
        change:selected: undefined | number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalselected

    selected?: any

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionaldisplayText

    displayText?: string

    Optionalid

    id?: string

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:displayText: undefined | number;
        change:id: undefined | number;
        change:selected: undefined | number;
        change:stale: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalselected

    selected?: any

    Optionalstale

    stale?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.ServerPropsModel.html b/classes/whatsapp.ServerPropsModel.html index ff3a0ba1f4..7f0900456c 100644 --- a/classes/whatsapp.ServerPropsModel.html +++ b/classes/whatsapp.ServerPropsModel.html @@ -1,6 +1,6 @@ -ServerPropsModel | @wppconnect/wa-js - v3.10.1

    Class ServerPropsModel

    Whatsapp

    17239

    -

    Whatsapp

    317239 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +ServerPropsModel | @wppconnect/wa-js - v3.10.1

    Class ServerPropsModel

    Whatsapp

    17239

    +

    Whatsapp

    317239 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? frequentlyForwardedMax @@ -46,40 +46,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    frequentlyForwardedMax

    frequentlyForwardedMax: number

    frequentlyForwardedThreshold

    frequentlyForwardedThreshold: number

    ReadonlyisState

    isState: true

    maxFileSize

    maxFileSize: number

    media

    media: number

    ReadonlymirrorMask

    mirrorMask: {
        change:frequentlyForwardedMax: number;
        change:frequentlyForwardedThreshold: number;
        change:maxFileSize: number;
        change:media: number;
        change:multicastLimitGlobal: number;
        change:statusVideoMaxDuration: number;
    }

    multicastLimitGlobal

    multicastLimitGlobal: number

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    statusVideoMaxDuration

    statusVideoMaxDuration: number

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    frequentlyForwardedMax

    frequentlyForwardedMax: number

    frequentlyForwardedThreshold

    frequentlyForwardedThreshold: number

    ReadonlyisState

    isState

    maxFileSize

    maxFileSize: number

    media

    media: number

    ReadonlymirrorMask

    mirrorMask: {
        change:frequentlyForwardedMax: number;
        change:frequentlyForwardedThreshold: number;
        change:maxFileSize: number;
        change:media: number;
        change:multicastLimitGlobal: number;
        change:statusVideoMaxDuration: number;
    }

    multicastLimitGlobal

    multicastLimitGlobal: number

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    statusVideoMaxDuration

    statusVideoMaxDuration: number

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.SocketModel.html b/classes/whatsapp.SocketModel.html index 0c3f6ff709..1c46184f4a 100644 --- a/classes/whatsapp.SocketModel.html +++ b/classes/whatsapp.SocketModel.html @@ -1,5 +1,5 @@ -SocketModel | @wppconnect/wa-js - v3.10.1

    Class SocketModel

    Whatsapp

    65044

    -

    Hierarchy (view full)

    Constructors

    constructor +SocketModel | @wppconnect/wa-js - v3.10.1

    Class SocketModel

    Whatsapp

    65044

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes backoffGeneration cancelHash? @@ -123,40 +123,40 @@ updateImmediately waitForSyncInfo isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    backoffGeneration

    backoffGeneration: number

    OptionalcancelHash

    cancelHash?: any

    OptionalcanSend

    canSend?: any

    Optionalcollection

    collection?: undefined

    OptionalconflictPromise

    conflictPromise?: any

    OptionaldoubleAckHash

    doubleAckHash?: any

    OptionalhasSynced

    hasSynced?: any

    OptionalisIncognito

    isIncognito?: any

    ReadonlyisState

    isState: true

    OptionallastPhoneMessage

    lastPhoneMessage?: any

    Optionallaunched

    launched?: any

    launchGeneration

    launchGeneration: number

    logoutMutex

    logoutMutex: number

    ReadonlymirrorMask

    mirrorMask: {
        change:backoffGeneration: number;
        change:cancelHash: undefined | number;
        change:canSend: undefined | number;
        change:conflictPromise: undefined | number;
        change:doubleAckHash: undefined | number;
        change:hasSynced: undefined | number;
        change:isIncognito: undefined | number;
        change:lastPhoneMessage: undefined | number;
        change:launched: undefined | number;
        change:launchGeneration: number;
        change:logoutMutex: number;
        change:mustExitLoop: undefined | number;
        change:pendingPhoneReqs: number;
        change:phoneWatchdog: undefined | number;
        change:pokeable: undefined | number;
        change:refWatcher: undefined | number;
        change:resumePromise: undefined | number;
        change:retryTimestamp: undefined | number;
        change:runPromise: undefined | number;
        change:sendHash: undefined | number;
        change:sendQueue: undefined | number;
        change:sequence: number;
        change:shortTagBase: undefined | number;
        change:shouldForceReconnect: number;
        change:shouldUpgradeToMDIntern: number;
        change:shouldUpgradeToMDPord: number;
        change:socket: undefined | number;
        change:socketPreload: undefined | number;
        change:socketWatcher: undefined | number;
        change:state: number;
        change:stream: number;
        change:streamPromise: undefined | number;
        change:syncTag: undefined | number;
    }

    OptionalmustExitLoop

    mustExitLoop?: any

    Optionalparent

    parent?: any

    pendingPhoneReqs

    pendingPhoneReqs: number

    OptionalphoneWatchdog

    phoneWatchdog?: any

    Optionalpokeable

    pokeable?: any

    proxyName

    proxyName: string

    OptionalrefWatcher

    refWatcher?: any

    OptionalresumePromise

    resumePromise?: any

    OptionalretryTimestamp

    retryTimestamp?: any

    OptionalrunPromise

    runPromise?: any

    OptionalsendHash

    sendHash?: any

    OptionalsendQueue

    sendQueue?: any

    sequence

    sequence: number

    OptionalshortTagBase

    shortTagBase?: any

    shouldForceReconnect

    shouldForceReconnect: boolean

    shouldUpgradeToMDIntern

    shouldUpgradeToMDIntern: boolean

    shouldUpgradeToMDPord

    shouldUpgradeToMDPord: boolean

    Optionalsocket

    socket?: any

    OptionalsocketPreload

    socketPreload?: any

    OptionalsocketWatcher

    socketWatcher?: any

    state

    state: string

    stream

    stream: string

    OptionalstreamPromise

    streamPromise?: any

    OptionalsyncTag

    syncTag?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canRequestBeSent

    clear

    clearCredentials

    clearCredentialsAndStoredData

    clearSendHash

    clearState

    decObservers

    delete

    deprecatedVersion

    destroyStorage

    emit

    exitLoop

    flushQueue

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initConn

    initialize

    isListening

    launch

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    backoffGeneration

    backoffGeneration: number

    OptionalcancelHash

    cancelHash?: any

    OptionalcanSend

    canSend?: any

    Optionalcollection

    collection?: undefined

    OptionalconflictPromise

    conflictPromise?: any

    OptionaldoubleAckHash

    doubleAckHash?: any

    OptionalhasSynced

    hasSynced?: any

    OptionalisIncognito

    isIncognito?: any

    ReadonlyisState

    isState

    OptionallastPhoneMessage

    lastPhoneMessage?: any

    Optionallaunched

    launched?: any

    launchGeneration

    launchGeneration: number

    logoutMutex

    logoutMutex: number

    ReadonlymirrorMask

    mirrorMask: {
        change:backoffGeneration: number;
        change:cancelHash: undefined | number;
        change:canSend: undefined | number;
        change:conflictPromise: undefined | number;
        change:doubleAckHash: undefined | number;
        change:hasSynced: undefined | number;
        change:isIncognito: undefined | number;
        change:lastPhoneMessage: undefined | number;
        change:launched: undefined | number;
        change:launchGeneration: number;
        change:logoutMutex: number;
        change:mustExitLoop: undefined | number;
        change:pendingPhoneReqs: number;
        change:phoneWatchdog: undefined | number;
        change:pokeable: undefined | number;
        change:refWatcher: undefined | number;
        change:resumePromise: undefined | number;
        change:retryTimestamp: undefined | number;
        change:runPromise: undefined | number;
        change:sendHash: undefined | number;
        change:sendQueue: undefined | number;
        change:sequence: number;
        change:shortTagBase: undefined | number;
        change:shouldForceReconnect: number;
        change:shouldUpgradeToMDIntern: number;
        change:shouldUpgradeToMDPord: number;
        change:socket: undefined | number;
        change:socketPreload: undefined | number;
        change:socketWatcher: undefined | number;
        change:state: number;
        change:stream: number;
        change:streamPromise: undefined | number;
        change:syncTag: undefined | number;
    }

    OptionalmustExitLoop

    mustExitLoop?: any

    Optionalparent

    parent?: any

    pendingPhoneReqs

    pendingPhoneReqs: number

    OptionalphoneWatchdog

    phoneWatchdog?: any

    Optionalpokeable

    pokeable?: any

    proxyName

    proxyName: string

    OptionalrefWatcher

    refWatcher?: any

    OptionalresumePromise

    resumePromise?: any

    OptionalretryTimestamp

    retryTimestamp?: any

    OptionalrunPromise

    runPromise?: any

    OptionalsendHash

    sendHash?: any

    OptionalsendQueue

    sendQueue?: any

    sequence

    sequence: number

    OptionalshortTagBase

    shortTagBase?: any

    shouldForceReconnect

    shouldForceReconnect: boolean

    shouldUpgradeToMDIntern

    shouldUpgradeToMDIntern: boolean

    shouldUpgradeToMDPord

    shouldUpgradeToMDPord: boolean

    Optionalsocket

    socket?: any

    OptionalsocketPreload

    socketPreload?: any

    OptionalsocketWatcher

    socketWatcher?: any

    state

    state: string

    stream

    stream: string

    OptionalstreamPromise

    streamPromise?: any

    OptionalsyncTag

    syncTag?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    canRequestBeSent

    clear

    clearCredentials

    clearCredentialsAndStoredData

    clearSendHash

    clearState

    decObservers

    delete

    deprecatedVersion

    destroyStorage

    emit

    exitLoop

    flushQueue

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initConn

    initialize

    isListening

    launch

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    logout

    lookForAndHandleChallenge

    manageRef

    maybeResendRequestEventually

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on5xx

    onActivity

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onCriticalSyncDone

    onMessage

    onPhoneWatchdogActivated

    onPhoneWatchdogDeactivated

    onPhoneWatchdogFed

    onRefCycle

    onStateChange

    onStreamChange

    openSocket

    openStream

    phoneTimedOut

    poke

    preload

    queryReceivedActions

    registerHandler

    removeAllListeners

    removeListener

    requestSync

    reset

    run

    runResume

    send

    send2

    sendBasic

    sendCurrentLogout

    sendEphemeral

    sendEphemeral2

    sendEphemeralIgnore

    sendRemainingLogouts

    serialize

    set

    setPokeable

    shortTag

    stopListening

    summary

    tag

    takeover

    throwOnClose

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    requestSync

    reset

    run

    runResume

    send

    send2

    sendBasic

    sendCurrentLogout

    sendEphemeral

    sendEphemeral2

    sendEphemeralIgnore

    sendRemainingLogouts

    serialize

    set

    setPokeable

    shortTag

    stopListening

    summary

    tag

    takeover

    throwOnClose

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    updateImmediately

    waitForSyncInfo

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    addChildbindcanRequestBeSentclearclearCredentialsclearCredentialsAndStoredDataclearSendHashclearStatedecObserversdeletedeprecatedVersiondestroyStorageemitexitLoopflushQueuegetgetDefaulthasObservershasUnfiredChangesincObserversinitConninitializeisListeninglaunchlistenTolistenToAndRunlistenToOncelogoutlookForAndHandleChallengemanageRefmaybeResendRequestEventuallyoffonon5xxonActivityonceonCriticalSyncDoneonMessageonPhoneWatchdogActivatedonPhoneWatchdogDeactivatedonPhoneWatchdogFedonRefCycleonStateChangeonStreamChangeopenSocketopenStreamphoneTimedOutpokepreloadqueryReceivedActionsregisterHandlerremoveAllListenersremoveListenerrequestSyncresetrunrunResumesendsend2sendBasicsendCurrentLogoutsendEphemeralsendEphemeral2sendEphemeralIgnoresendRemainingLogoutsserializesetsetPokeableshortTagstopListeningsummarytagtakeoverthrowOnClosetoJSONtriggerunbindunsetupdateImmediatelywaitForSyncInfoisIdType
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    updateImmediately

    waitForSyncInfo

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    addChildbindcanRequestBeSentclearclearCredentialsclearCredentialsAndStoredDataclearSendHashclearStatedecObserversdeletedeprecatedVersiondestroyStorageemitexitLoopflushQueuegetgetDefaulthasObservershasUnfiredChangesincObserversinitConninitializeisListeninglaunchlistenTolistenToAndRunlistenToOncelogoutlookForAndHandleChallengemanageRefmaybeResendRequestEventuallyoffonon5xxonActivityonceonCriticalSyncDoneonMessageonPhoneWatchdogActivatedonPhoneWatchdogDeactivatedonPhoneWatchdogFedonRefCycleonStateChangeonStreamChangeopenSocketopenStreamphoneTimedOutpokepreloadqueryReceivedActionsregisterHandlerremoveAllListenersremoveListenerrequestSyncresetrunrunResumesendsend2sendBasicsendCurrentLogoutsendEphemeralsendEphemeral2sendEphemeralIgnoresendRemainingLogoutsserializesetsetPokeableshortTagstopListeningsummarytagtakeoverthrowOnClosetoJSONtriggerunbindunsetupdateImmediatelywaitForSyncInfoisIdType
    diff --git a/classes/whatsapp.StarredMsgCollection.html b/classes/whatsapp.StarredMsgCollection.html index 7d982c663e..0527e78b00 100644 --- a/classes/whatsapp.StarredMsgCollection.html +++ b/classes/whatsapp.StarredMsgCollection.html @@ -1,6 +1,6 @@ -StarredMsgCollection | @wppconnect/wa-js - v3.10.1

    Class StarredMsgCollection

    Whatsapp

    19011

    -

    Whatsapp

    719011 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StarredMsgCollection | @wppconnect/wa-js - v3.10.1

    Class StarredMsgCollection

    Whatsapp

    19011

    +

    Whatsapp

    719011 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst isSynced modelClass @@ -62,10 +62,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | MsgModel

  • Parameters

    • predicate: ((value: MsgModel, index: number, obj: MsgModel[]) => unknown)
        • (value, index, obj): unknown

        • Parameters

          Returns unknown

    • OptionalthisArg: any

    Returns undefined | MsgModel

    • isSynced

    isSynced: boolean

    modelClass

    modelClass: MsgModel

    OptionalsyncPromise

    syncPromise?: any

    Staticmodel

    model: MsgModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: MsgModel, index: number, array: MsgModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -89,33 +89,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: MsgModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: MsgModel, index: number, array: MsgModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -127,8 +127,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): MsgModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -141,8 +141,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    unbind

    updateMsgs

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    updateMsgs

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.StatusCollection.html b/classes/whatsapp.StatusCollection.html index cec32d4e07..1b12187a3c 100644 --- a/classes/whatsapp.StatusCollection.html +++ b/classes/whatsapp.StatusCollection.html @@ -1,6 +1,6 @@ -StatusCollection | @wppconnect/wa-js - v3.10.1

    Class StatusCollection

    Whatsapp

    46133

    -

    Whatsapp

    WAWebTextStatusCollection >= 2.3000.1013010908

    -

    Hierarchy (view full)

    Constructors

    constructor +StatusCollection | @wppconnect/wa-js - v3.10.1

    Class StatusCollection

    Whatsapp

    46133

    +

    Whatsapp

    WAWebTextStatusCollection >= 2.3000.1013010908

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -72,10 +72,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | StatusModel

  • Parameters

    Returns undefined | StatusModel

    • modelClass

    modelClass: StatusModel

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    StaticidClass

    idClass: typeof Wid

    Staticmodel

    model: StatusModel

    Static OptionalresumeOnAvailable

    resumeOnAvailable?: any

    Static OptionalstaleCollection

    staleCollection?: any

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: StatusModel, index: number, array: StatusModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -99,33 +99,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    handle

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StatusModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StatusModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: StatusModel, index: number, array: StatusModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -137,8 +137,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): StatusModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -151,8 +151,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.StatusModel.html b/classes/whatsapp.StatusModel.html index e40c583384..7023b49c6f 100644 --- a/classes/whatsapp.StatusModel.html +++ b/classes/whatsapp.StatusModel.html @@ -1,6 +1,6 @@ -StatusModel | @wppconnect/wa-js - v3.10.1

    Class StatusModel

    Whatsapp

    67234

    -

    Whatsapp

    167234 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StatusModel | @wppconnect/wa-js - v3.10.1

    Class StatusModel

    Whatsapp

    67234

    +

    Whatsapp

    167234 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id @@ -45,40 +45,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: StatusCollection

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:stale: undefined | number;
        change:status: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalstatus

    status?: string

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: StatusCollection

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: number;
        change:stale: undefined | number;
        change:status: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionalstatus

    status?: string

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getCollection

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.StatusV3Collection.html b/classes/whatsapp.StatusV3Collection.html index a0e0fefc3b..1244f89f4c 100644 --- a/classes/whatsapp.StatusV3Collection.html +++ b/classes/whatsapp.StatusV3Collection.html @@ -1,6 +1,6 @@ -StatusV3Collection | @wppconnect/wa-js - v3.10.1

    Class StatusV3Collection

    Whatsapp

    59387

    -

    Whatsapp

    459387 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StatusV3Collection | @wppconnect/wa-js - v3.10.1

    Class StatusV3Collection

    Whatsapp

    59387

    +

    Whatsapp

    459387 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass onResume @@ -78,10 +78,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | StatusV3Model

  • Parameters

    Returns undefined | StatusV3Model

    • modelClass

    modelClass: StatusV3Model

    onResume

    onResume: ((...args: any) => any)

    StaticcachePolicy

    cachePolicy: {
        id: string;
        policy: string;
        trigger: string;
    }

    Staticmodel

    model: StatusV3Model

    Accessors

    length

    Methods

    add

    addStatusMessages

    assertGet

    at

    bind

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    delete

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: StatusV3Model, index: number, array: StatusV3Model[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -105,33 +105,33 @@

        Whatsapp

      Returns void

    gadd

    gaddUp

    get

    getModelsArray

    getMyStatus

    getUnexpired

    handle

    handleUpdate

    hasSynced

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StatusV3Model

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    initializeFromCache

    isListening

    isModel

    isStateStale

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StatusV3Model

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    loadMore

    logMetrics

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: StatusV3Model, index: number, array: StatusV3Model[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -143,8 +143,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    saveToCache

    serialize

    set

    slice

    • slice(start?, end?): StatusV3Model[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -157,8 +157,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    unbind

    update

    updateChecksum

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    update

    updateChecksum

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.StatusV3Model.html b/classes/whatsapp.StatusV3Model.html index 88d0f96fea..f3ca447a04 100644 --- a/classes/whatsapp.StatusV3Model.html +++ b/classes/whatsapp.StatusV3Model.html @@ -1,6 +1,6 @@ -StatusV3Model | @wppconnect/wa-js - v3.10.1

    Class StatusV3Model

    Whatsapp

    47896

    -

    Whatsapp

    547896 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StatusV3Model | @wppconnect/wa-js - v3.10.1

    Class StatusV3Model

    Whatsapp

    47896

    +

    Whatsapp

    547896 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? contact? @@ -76,40 +76,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: ChatCollection

    Optionalcontact

    contact?: any

    disableUnreadAnchor

    disableUnreadAnchor: any

    OptionalexpireTimer

    expireTimer?: any

    OptionalexpireTs

    expireTs?: any

    ReadonlyhasUnread

    hasUnread: boolean

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState: true

    Optionallabels

    labels?: string[]

    OptionallastReceivedKey

    lastReceivedKey?: MsgKey

    Optional ReadonlylastStatus

    lastStatus?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:contact: undefined | number;
        change:disableUnreadAnchor: number;
        change:expireTimer: undefined | number;
        change:expireTs: undefined | number;
        change:hasUnread: number;
        change:id: number;
        change:labels: undefined | number;
        change:lastReceivedKey: undefined | number;
        change:lastStatus: undefined | number;
        change:msgChunks: number;
        change:msgsChanged: number;
        change:msgsLength: number;
        change:pendingMsgs: number;
        change:pic: undefined | number;
        change:readCount: undefined | number;
        change:readKeys: undefined | number;
        change:stale: undefined | number;
        change:t: undefined | number;
        change:totalCount: undefined | number;
        change:unreadCount: undefined | number;
        change:unreadMsgAnchor: number;
    }

    msgChunks

    msgChunks: MsgLoad[]

    msgs

    msgs: MsgLoad

    msgsChanged

    msgsChanged: number

    msgsLength

    msgsLength: number

    Optionalparent

    parent?: any

    pendingMsgs

    pendingMsgs: boolean

    Optionalpic

    pic?: any

    proxyName

    proxyName: string

    Optional ReadonlyreadCount

    readCount?: any

    OptionalreadKeys

    readKeys?: any

    Optionalstale

    stale?: any

    Optionalt

    t?: any

    OptionaltotalCount

    totalCount?: any

    OptionalunreadCount

    unreadCount?: any

    unreadMsgAnchor

    unreadMsgAnchor: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    expireMsg

    get

    getAllCMCs

    getAllMsgs

    getCollection

    getDefault

    handleReadStatus

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: ChatCollection

    Optionalcontact

    contact?: any

    disableUnreadAnchor

    disableUnreadAnchor: any

    OptionalexpireTimer

    expireTimer?: any

    OptionalexpireTs

    expireTs?: any

    ReadonlyhasUnread

    hasUnread: boolean

    id

    id: Wid

    idClass

    idClass: typeof Wid

    ReadonlyisState

    isState

    Optionallabels

    labels?: string[]

    OptionallastReceivedKey

    lastReceivedKey?: MsgKey

    Optional ReadonlylastStatus

    lastStatus?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:contact: undefined | number;
        change:disableUnreadAnchor: number;
        change:expireTimer: undefined | number;
        change:expireTs: undefined | number;
        change:hasUnread: number;
        change:id: number;
        change:labels: undefined | number;
        change:lastReceivedKey: undefined | number;
        change:lastStatus: undefined | number;
        change:msgChunks: number;
        change:msgsChanged: number;
        change:msgsLength: number;
        change:pendingMsgs: number;
        change:pic: undefined | number;
        change:readCount: undefined | number;
        change:readKeys: undefined | number;
        change:stale: undefined | number;
        change:t: undefined | number;
        change:totalCount: undefined | number;
        change:unreadCount: undefined | number;
        change:unreadMsgAnchor: number;
    }

    msgChunks

    msgChunks: MsgLoad[]

    msgs

    msgs: MsgLoad

    msgsChanged

    msgsChanged: number

    msgsLength

    msgsLength: number

    Optionalparent

    parent?: any

    pendingMsgs

    pendingMsgs: boolean

    Optionalpic

    pic?: any

    proxyName

    proxyName: string

    Optional ReadonlyreadCount

    readCount?: any

    OptionalreadKeys

    readKeys?: any

    Optionalstale

    stale?: any

    Optionalt

    t?: any

    OptionaltotalCount

    totalCount?: any

    OptionalunreadCount

    unreadCount?: any

    unreadMsgAnchor

    unreadMsgAnchor: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    expireMsg

    get

    getAllCMCs

    getAllMsgs

    getCollection

    getDefault

    handleReadStatus

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    loadMore

    notifyMsgCollectionMerge

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onEmptyMRM

    removeAllListeners

    removeListener

    removeMsg

    removeMsgsCollection

    replaceMsgsCollection

    reset

    sendReadStatus

    serialize

    set

    setupStatusExpiration

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    removeMsg

    removeMsgsCollection

    replaceMsgsCollection

    reset

    sendReadStatus

    serialize

    set

    setupStatusExpiration

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.StickerCollection.html b/classes/whatsapp.StickerCollection.html index cb9661f393..324ab437b2 100644 --- a/classes/whatsapp.StickerCollection.html +++ b/classes/whatsapp.StickerCollection.html @@ -1,6 +1,6 @@ -StickerCollection | @wppconnect/wa-js - v3.10.1

    Class StickerCollection

    Whatsapp

    67963

    -

    Whatsapp

    767963 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StickerCollection | @wppconnect/wa-js - v3.10.1

    Class StickerCollection

    Whatsapp

    67963

    +

    Whatsapp

    767963 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -58,10 +58,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | StickerModel

  • Parameters

    Returns undefined | StickerModel

    • modelClass

    modelClass: StickerModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: StickerModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: StickerModel, index: number, array: StickerModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -85,33 +85,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StickerModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StickerModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: StickerModel, index: number, array: StickerModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -123,8 +123,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): StickerModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -137,8 +137,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.StickerModel.html b/classes/whatsapp.StickerModel.html index 9b0b794a92..d420be3ed3 100644 --- a/classes/whatsapp.StickerModel.html +++ b/classes/whatsapp.StickerModel.html @@ -1,7 +1,7 @@ -StickerModel | @wppconnect/wa-js - v3.10.1

    Class StickerModel

    Whatsapp

    99718

    -

    Whatsapp

    89867 >= 2.2204.13

    -

    Whatsapp

    689867 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StickerModel | @wppconnect/wa-js - v3.10.1

    Class StickerModel

    Whatsapp

    99718

    +

    Whatsapp

    89867 >= 2.2204.13

    +

    Whatsapp

    689867 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? deprecatedMms3Url? @@ -61,40 +61,40 @@

    Whatsappunset getPlaceholder isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionaldeprecatedMms3Url

    deprecatedMms3Url?: any

    OptionaldirectPath

    directPath?: any

    OptionalencFilehash

    encFilehash?: any

    Optionalfilehash

    filehash?: any

    Optionalheight

    height?: any

    Optionalid

    id?: any

    Optionalindex

    index?: any

    isPlaceholder

    isPlaceholder: boolean

    ReadonlyisState

    isState: true

    OptionalmediaData

    mediaData?: any

    OptionalmediaKey

    mediaKey?: any

    OptionalmediaKeyTimestamp

    mediaKeyTimestamp?: any

    OptionalmediaObject

    mediaObject?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:deprecatedMms3Url: undefined | number;
        change:directPath: undefined | number;
        change:encFilehash: undefined | number;
        change:filehash: undefined | number;
        change:height: undefined | number;
        change:id: undefined | number;
        change:index: undefined | number;
        change:isPlaceholder: number;
        change:mediaData: undefined | number;
        change:mediaKey: undefined | number;
        change:mediaKeyTimestamp: undefined | number;
        change:mediaObject: undefined | number;
        change:mimetype: undefined | number;
        change:size: undefined | number;
        change:stale: undefined | number;
        change:type: undefined | number;
        change:width: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalsize

    size?: any

    Optionalstale

    stale?: any

    Optionaltype

    type?: any

    Optionalwidth

    width?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    downloadMedia

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionaldeprecatedMms3Url

    deprecatedMms3Url?: any

    OptionaldirectPath

    directPath?: any

    OptionalencFilehash

    encFilehash?: any

    Optionalfilehash

    filehash?: any

    Optionalheight

    height?: any

    Optionalid

    id?: any

    Optionalindex

    index?: any

    isPlaceholder

    isPlaceholder: boolean

    ReadonlyisState

    isState

    OptionalmediaData

    mediaData?: any

    OptionalmediaKey

    mediaKey?: any

    OptionalmediaKeyTimestamp

    mediaKeyTimestamp?: any

    OptionalmediaObject

    mediaObject?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:deprecatedMms3Url: undefined | number;
        change:directPath: undefined | number;
        change:encFilehash: undefined | number;
        change:filehash: undefined | number;
        change:height: undefined | number;
        change:id: undefined | number;
        change:index: undefined | number;
        change:isPlaceholder: number;
        change:mediaData: undefined | number;
        change:mediaKey: undefined | number;
        change:mediaKeyTimestamp: undefined | number;
        change:mediaObject: undefined | number;
        change:mimetype: undefined | number;
        change:size: undefined | number;
        change:stale: undefined | number;
        change:type: undefined | number;
        change:width: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalsize

    size?: any

    Optionalstale

    stale?: any

    Optionaltype

    type?: any

    Optionalwidth

    width?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    downloadMedia

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    sendToChat

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    sendToChat

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticgetPlaceholder

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticgetPlaceholder

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.StickerPackCollection.html b/classes/whatsapp.StickerPackCollection.html index c8dd1cb623..e883e33e40 100644 --- a/classes/whatsapp.StickerPackCollection.html +++ b/classes/whatsapp.StickerPackCollection.html @@ -1,7 +1,7 @@ -StickerPackCollection | @wppconnect/wa-js - v3.10.1

    Class StickerPackCollection

    Whatsapp

    44333

    -

    Whatsapp

    66299 >= 2.2212.8

    -

    Whatsapp

    366299 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StickerPackCollection | @wppconnect/wa-js - v3.10.1

    Class StickerPackCollection

    Whatsapp

    44333

    +

    Whatsapp

    66299 >= 2.2212.8

    +

    Whatsapp

    366299 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    checksum? findFirst modelClass @@ -68,10 +68,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | StickerPackModel

  • Parameters

    Returns undefined | StickerPackModel

    • modelClass

    modelClass: StickerPackModel

    OptionalpageFetchStates

    pageFetchStates?: any

    Staticmodel

    model: StickerPackModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    createPlaceholder

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    createPlaceholder

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: StickerPackModel, index: number, array: StickerPackModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -95,33 +95,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    hasFetchedData

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StickerPackModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isFetchingData

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isFetchingData

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StickerPackModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: StickerPackModel, index: number, array: StickerPackModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -133,8 +133,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setChecksum

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    setChecksum

    slice

    • slice(start?, end?): StickerPackModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    sync

    toArray

    toJSON

    trigger

    unbind

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.StickerPackModel.html b/classes/whatsapp.StickerPackModel.html index 2778e7ffeb..d2021369a0 100644 --- a/classes/whatsapp.StickerPackModel.html +++ b/classes/whatsapp.StickerPackModel.html @@ -1,6 +1,6 @@ -StickerPackModel | @wppconnect/wa-js - v3.10.1

    Class StickerPackModel

    Whatsapp

    74470

    -

    Whatsapp

    574470 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StickerPackModel | @wppconnect/wa-js - v3.10.1

    Class StickerPackModel

    Whatsapp

    74470

    +

    Whatsapp

    574470 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? deprecatedMms3Url? @@ -62,40 +62,40 @@

    WhatsappcreatePlaceholder isIdType isPlaceholderId -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optional ReadonlydeprecatedMms3Url

    deprecatedMms3Url?: any

    OptionaldirectPath

    directPath?: any

    OptionalencFilehash

    encFilehash?: any

    Optionalfilehash

    filehash?: any

    Optionalid

    id?: any

    Optionalindex

    index?: any

    ReadonlyisFirstParty

    isFirstParty: boolean

    ReadonlyisPlaceholder

    isPlaceholder: boolean

    ReadonlyisState

    isState: true

    OptionalmediaData

    mediaData?: any

    OptionalmediaKey

    mediaKey?: any

    OptionalmediaKeyTimestamp

    mediaKeyTimestamp?: any

    OptionalmediaObject

    mediaObject?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:deprecatedMms3Url: undefined | number;
        change:directPath: undefined | number;
        change:encFilehash: undefined | number;
        change:filehash: undefined | number;
        change:id: undefined | number;
        change:index: undefined | number;
        change:isFirstParty: number;
        change:isPlaceholder: number;
        change:mediaData: undefined | number;
        change:mediaKey: undefined | number;
        change:mediaKeyTimestamp: undefined | number;
        change:mediaObject: undefined | number;
        change:mimetype: undefined | number;
        change:page: undefined | number;
        change:size: undefined | number;
        change:stale: undefined | number;
        change:stickers: undefined | number;
        change:type: undefined | number;
        change:url: undefined | number;
    }

    Optionalpage

    page?: any

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalsize

    size?: any

    Optionalstale

    stale?: any

    Optional Readonlystickers

    stickers?: any

    Optionaltype

    type?: any

    Optionalurl

    url?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    downloadMedia

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optional ReadonlydeprecatedMms3Url

    deprecatedMms3Url?: any

    OptionaldirectPath

    directPath?: any

    OptionalencFilehash

    encFilehash?: any

    Optionalfilehash

    filehash?: any

    Optionalid

    id?: any

    Optionalindex

    index?: any

    ReadonlyisFirstParty

    isFirstParty: boolean

    ReadonlyisPlaceholder

    isPlaceholder: boolean

    ReadonlyisState

    isState

    OptionalmediaData

    mediaData?: any

    OptionalmediaKey

    mediaKey?: any

    OptionalmediaKeyTimestamp

    mediaKeyTimestamp?: any

    OptionalmediaObject

    mediaObject?: any

    Optionalmimetype

    mimetype?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:deprecatedMms3Url: undefined | number;
        change:directPath: undefined | number;
        change:encFilehash: undefined | number;
        change:filehash: undefined | number;
        change:id: undefined | number;
        change:index: undefined | number;
        change:isFirstParty: number;
        change:isPlaceholder: number;
        change:mediaData: undefined | number;
        change:mediaKey: undefined | number;
        change:mediaKeyTimestamp: undefined | number;
        change:mediaObject: undefined | number;
        change:mimetype: undefined | number;
        change:page: undefined | number;
        change:size: undefined | number;
        change:stale: undefined | number;
        change:stickers: undefined | number;
        change:type: undefined | number;
        change:url: undefined | number;
    }

    Optionalpage

    page?: any

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalsize

    size?: any

    Optionalstale

    stale?: any

    Optional Readonlystickers

    stickers?: any

    Optionaltype

    type?: any

    Optionalurl

    url?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    downloadMedia

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticcreatePlaceholder

    StaticisIdType

    StaticisPlaceholderId

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticcreatePlaceholder

    StaticisIdType

    StaticisPlaceholderId

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.StickerSearchCollection.html b/classes/whatsapp.StickerSearchCollection.html index dc6f475005..b19c598bc1 100644 --- a/classes/whatsapp.StickerSearchCollection.html +++ b/classes/whatsapp.StickerSearchCollection.html @@ -1,6 +1,6 @@ -StickerSearchCollection | @wppconnect/wa-js - v3.10.1

    Class StickerSearchCollection

    Whatsapp

    45068

    -

    Whatsapp

    545068 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StickerSearchCollection | @wppconnect/wa-js - v3.10.1

    Class StickerSearchCollection

    Whatsapp

    45068

    +

    Whatsapp

    545068 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass comparator @@ -63,10 +63,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | StickerModel

  • Parameters

    Returns undefined | StickerModel

    • modelClass

    modelClass: StickerModel

    Staticcomparator

    comparator: ((a: any, b: any) => number)

    Staticmodel

    model: StickerModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: StickerModel, index: number, array: StickerModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -90,33 +90,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    hasFetchedData

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StickerModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isFetchingData

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isFetchingData

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: StickerModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: StickerModel, index: number, array: StickerModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -128,8 +128,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    search

    searchMood

    serialize

    set

    setStartFetching

    setStopFetching

    slice

    reorder

    reorderMutate

    replaceId

    reset

    search

    searchMood

    serialize

    set

    setStartFetching

    setStopFetching

    slice

    • slice(start?, end?): StickerModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      • Optionalstart: number

        The beginning index of the specified portion of the array. @@ -142,8 +142,8 @@

        Whatsapp

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.StreamModel.html b/classes/whatsapp.StreamModel.html index c78ef5a724..f08a3f0a1d 100644 --- a/classes/whatsapp.StreamModel.html +++ b/classes/whatsapp.StreamModel.html @@ -1,6 +1,6 @@ -StreamModel | @wppconnect/wa-js - v3.10.1

    Class StreamModel

    Whatsapp

    8080

    -

    Whatsapp

    608080 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +StreamModel | @wppconnect/wa-js - v3.10.1

    Class StreamModel

    Whatsapp

    8080

    +

    Whatsapp

    608080 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes available? clientExpired? @@ -71,40 +71,40 @@

    WhatsappupdateHardExpire updateWamLog isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalavailable

    available?: any

    OptionalclientExpired

    clientExpired?: any

    Optionalcollection

    collection?: undefined

    OptionalcouldForce

    couldForce?: any

    Optional ReadonlydisplayInfo

    displayInfo?: any

    OptionalhardExpired

    hardExpired?: any

    Optionalinfo

    info?: any

    ReadonlyisState

    isState: true

    OptionallastSyncStart

    lastSyncStart?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:available: undefined | number;
        change:clientExpired: undefined | number;
        change:couldForce: undefined | number;
        change:displayInfo: undefined | number;
        change:hardExpired: undefined | number;
        change:info: undefined | number;
        change:lastSyncStart: undefined | number;
        change:mode: number;
        change:needsManualDownload: undefined | number;
        change:needsUpdate: undefined | number;
        change:obscurity: undefined | number;
        change:phoneAuthed: undefined | number;
        change:resumeCount: undefined | number;
        change:timeoutEvent: undefined | number;
        change:uiActive: undefined | number;
        change:unavailableLogoutTimer: undefined | number;
        change:unavailableShiftTimer: undefined | number;
        change:unobscureShiftTimer: undefined | number;
    }

    mode

    mode: string

    OptionalneedsManualDownload

    needsManualDownload?: any

    OptionalneedsUpdate

    needsUpdate?: any

    Optionalobscurity

    obscurity?: any

    Optionalparent

    parent?: any

    OptionalphoneAuthed

    phoneAuthed?: any

    proxyName

    proxyName: string

    OptionalresumeCount

    resumeCount?: any

    OptionaltimeoutEvent

    timeoutEvent?: any

    OptionaluiActive

    uiActive?: any

    OptionalunavailableLogoutTimer

    unavailableLogoutTimer?: any

    OptionalunavailableShiftTimer

    unavailableShiftTimer?: any

    OptionalunobscureShiftTimer

    unobscureShiftTimer?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalavailable

    available?: any

    OptionalclientExpired

    clientExpired?: any

    Optionalcollection

    collection?: undefined

    OptionalcouldForce

    couldForce?: any

    Optional ReadonlydisplayInfo

    displayInfo?: any

    OptionalhardExpired

    hardExpired?: any

    Optionalinfo

    info?: any

    ReadonlyisState

    isState

    OptionallastSyncStart

    lastSyncStart?: any

    ReadonlymirrorMask

    mirrorMask: {
        change:available: undefined | number;
        change:clientExpired: undefined | number;
        change:couldForce: undefined | number;
        change:displayInfo: undefined | number;
        change:hardExpired: undefined | number;
        change:info: undefined | number;
        change:lastSyncStart: undefined | number;
        change:mode: number;
        change:needsManualDownload: undefined | number;
        change:needsUpdate: undefined | number;
        change:obscurity: undefined | number;
        change:phoneAuthed: undefined | number;
        change:resumeCount: undefined | number;
        change:timeoutEvent: undefined | number;
        change:uiActive: undefined | number;
        change:unavailableLogoutTimer: undefined | number;
        change:unavailableShiftTimer: undefined | number;
        change:unobscureShiftTimer: undefined | number;
    }

    mode

    mode: string

    OptionalneedsManualDownload

    needsManualDownload?: any

    OptionalneedsUpdate

    needsUpdate?: any

    Optionalobscurity

    obscurity?: any

    Optionalparent

    parent?: any

    OptionalphoneAuthed

    phoneAuthed?: any

    proxyName

    proxyName: string

    OptionalresumeCount

    resumeCount?: any

    OptionaltimeoutEvent

    timeoutEvent?: any

    OptionaluiActive

    uiActive?: any

    OptionalunavailableLogoutTimer

    unavailableLogoutTimer?: any

    OptionalunavailableShiftTimer

    unavailableShiftTimer?: any

    OptionalunobscureShiftTimer

    unobscureShiftTimer?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    logModeChange

    logPageResume

    markAvailable

    markUnavailable

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onAvailableUpdate

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    onPhoneAuthedUpdate

    onSelfUpdate

    onSocketUpdate

    removeAllListeners

    removeListener

    reset

    sendAvailability

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    sendAvailability

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unobscure

    unset

    updateCouldForce

    updateHardExpire

    updateWamLog

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unobscure

    unset

    updateCouldForce

    updateHardExpire

    updateWamLog

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.TemplateButtonCollection.html b/classes/whatsapp.TemplateButtonCollection.html index 7f3c08521c..d688ae0aa7 100644 --- a/classes/whatsapp.TemplateButtonCollection.html +++ b/classes/whatsapp.TemplateButtonCollection.html @@ -1,6 +1,6 @@ -TemplateButtonCollection | @wppconnect/wa-js - v3.10.1

    Class TemplateButtonCollection

    Whatsapp

    82988

    -

    Whatsapp

    682988 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +TemplateButtonCollection | @wppconnect/wa-js - v3.10.1

    Class TemplateButtonCollection

    Whatsapp

    82988

    +

    Whatsapp

    682988 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    findFirst modelClass model @@ -57,10 +57,10 @@

    Whatsapp
  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    • Returns undefined | S

  • (predicate, thisArg?): undefined | TemplateButtonModel

  • Parameters

    Returns undefined | TemplateButtonModel

    • modelClass

    modelClass: TemplateButtonModel

    Staticmodel

    model: TemplateButtonModel

    Accessors

    length

    Methods

    add

    assertGet

    at

    bind

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • eventName: Event
      • listener: Listener
      • Optionalcontext: any

      Returns this

      Alias

      on

      +

    emit

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      Parameters

      • predicate: ((value: TemplateButtonModel, index: number, array: TemplateButtonModel[]) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        @@ -84,33 +84,33 @@

        Whatsapp

      Returns void

    get

    getModelsArray

    head

    includes

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      Parameters

      • searchElement: TemplateButtonModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

        -

      Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

    Returns number

    isListening

    isModel

    last

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      Parameters

      • searchElement: TemplateButtonModel

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    map

    • map<U>(callbackfn, thisArg?): U[]

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((value: TemplateButtonModel, index: number, array: TemplateButtonModel[]) => U)

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

        @@ -122,8 +122,8 @@

        Whatsapp

      Returns U

    remove

    removeAllListeners

    removeListener

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    reorder

    reorderMutate

    replaceId

    reset

    serialize

    set

    slice

    • slice(start?, end?): TemplateButtonModel[]

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      Parameters

      Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Returns boolean

    sort

    stopListening

    toArray

    toJSON

    trigger

    unbind

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    where

    Staticcomparator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/whatsapp.TemplateButtonModel.html b/classes/whatsapp.TemplateButtonModel.html index daf8700c85..bf25c9c887 100644 --- a/classes/whatsapp.TemplateButtonModel.html +++ b/classes/whatsapp.TemplateButtonModel.html @@ -1,6 +1,6 @@ -TemplateButtonModel | @wppconnect/wa-js - v3.10.1

    Class TemplateButtonModel

    Whatsapp

    11897

    -

    Whatsapp

    311897 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +TemplateButtonModel | @wppconnect/wa-js - v3.10.1

    Class TemplateButtonModel

    Whatsapp

    11897

    +

    Whatsapp

    311897 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? displayText? @@ -48,40 +48,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionaldisplayText

    displayText?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:displayText: undefined | number;
        change:id: undefined | number;
        change:phoneNumber: undefined | number;
        change:selected: undefined | number;
        change:selectionId: undefined | number;
        change:stale: undefined | number;
        change:subtype: undefined | number;
        change:url: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalphoneNumber

    phoneNumber?: any

    proxyName

    proxyName: string

    Optionalselected

    selected?: any

    OptionalselectionId

    selectionId?: any

    Optionalstale

    stale?: any

    Optionalsubtype

    subtype?: any

    Optionalurl

    url?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    OptionaldisplayText

    displayText?: any

    Optionalid

    id?: any

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:displayText: undefined | number;
        change:id: undefined | number;
        change:phoneNumber: undefined | number;
        change:selected: undefined | number;
        change:selectionId: undefined | number;
        change:stale: undefined | number;
        change:subtype: undefined | number;
        change:url: undefined | number;
    }

    Optionalparent

    parent?: any

    OptionalphoneNumber

    phoneNumber?: any

    proxyName

    proxyName: string

    Optionalselected

    selected?: any

    OptionalselectionId

    selectionId?: any

    Optionalstale

    stale?: any

    Optionalsubtype

    subtype?: any

    Optionalurl

    url?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.USyncQuery.html b/classes/whatsapp.USyncQuery.html index f15049f12d..64e8c524a0 100644 --- a/classes/whatsapp.USyncQuery.html +++ b/classes/whatsapp.USyncQuery.html @@ -1,5 +1,5 @@ -USyncQuery | @wppconnect/wa-js - v3.10.1

    Class USyncQuery

    Whatsapp

    459857

    -

    Constructors

    constructor +USyncQuery | @wppconnect/wa-js - v3.10.1

    Class USyncQuery

    Whatsapp

    459857

    +

    Constructors

    constructor

    Methods

    $1 execute withBotProfileProtocol diff --git a/classes/whatsapp.USyncUser.html b/classes/whatsapp.USyncUser.html index 2f0caaf053..8d8452c91d 100644 --- a/classes/whatsapp.USyncUser.html +++ b/classes/whatsapp.USyncUser.html @@ -1,5 +1,5 @@ -USyncUser | @wppconnect/wa-js - v3.10.1

    Class USyncUser

    Whatsapp

    459857

    -

    Constructors

    constructor +USyncUser | @wppconnect/wa-js - v3.10.1

    Class USyncUser

    Whatsapp

    459857

    +

    Constructors

    constructor

    Methods

    withId withLid withPhone diff --git a/classes/whatsapp.UnreadMentionModel.html b/classes/whatsapp.UnreadMentionModel.html index e1c33ad29b..db92c99837 100644 --- a/classes/whatsapp.UnreadMentionModel.html +++ b/classes/whatsapp.UnreadMentionModel.html @@ -1,6 +1,6 @@ -UnreadMentionModel | @wppconnect/wa-js - v3.10.1

    Class UnreadMentionModel

    Whatsapp

    41809

    -

    Whatsapp

    441809 >= 2.2222.8

    -

    Hierarchy (view full)

    Constructors

    constructor +UnreadMentionModel | @wppconnect/wa-js - v3.10.1

    Class UnreadMentionModel

    Whatsapp

    41809

    +

    Whatsapp

    441809 >= 2.2222.8

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    attributes collection? id? @@ -43,40 +43,40 @@

    Whatsappunbind unset isIdType -

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState: true

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:stale: undefined | number;
        change:timestamp: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltimestamp

    timestamp?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +

    Constructors

    constructor

    Properties

    Readonlyattributes

    attributes: Props & Session

    Optionalcollection

    collection?: undefined

    Optionalid

    id?: any

    ReadonlyisState

    isState

    ReadonlymirrorMask

    mirrorMask: {
        change:id: undefined | number;
        change:stale: undefined | number;
        change:timestamp: undefined | number;
    }

    Optionalparent

    parent?: any

    proxyName

    proxyName: string

    Optionalstale

    stale?: any

    Optionaltimestamp

    timestamp?: any

    Static OptionalallowedIds

    allowedIds?: any[]

    Static OptionalidClass

    idClass?: any

    StaticProxy

    Proxy: string

    Methods

    addChild

    bind

    clear

    decObservers

    delete

    emit

    get

    getDefault

    hasObservers

    hasUnfiredChanges

    incObservers

    initialize

    isListening

    listenTo

    • listenTo(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToAndRun

    • listenToAndRun(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    listenToOnce

    • listenToOnce(context, eventName, listener?): this

    • Parameters

      • context: any

        The value of this provided for the call to listener

        -
      • eventName: Event

        The name of the event.

        +
      • eventName: Event

        The name of the event.

      • Optionallistener: Listener

        The callback function.

      Returns this

    off

    • off(eventName?, listener?, context?): this

    • Removes the specified listener from the listener array for the event named eventName.

      -

      Parameters

      • OptionaleventName: Event

        The name of the event.

        +

        Parameters

        • OptionaleventName: Event

          The name of the event.

        • Optionallistener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    on

    • on(eventName, listener, context?): this

    • Adds the listener function to the end of the listeners array for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    once

    • once(eventName, listener, context?): this

    • Adds a one-time listener function for the event named eventName.

      -

      Parameters

      • eventName: Event

        The name of the event.

        +

        Parameters

        • eventName: Event

          The name of the event.

        • listener: Listener

          The callback function.

        • Optionalcontext: any

          The value of this provided for the call to listener

        Returns this

        Returns a reference to the EventEmitter, so that calls can be chained.

    removeAllListeners

    removeListener

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      -

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

      +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    reset

    serialize

    set

    stopListening

    toJSON

    trigger

    • trigger(eventName, ...args): this

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      +

      Parameters

      • eventName: Event
      • Rest...args: any[]

      Returns this

      Returns a reference to the EventEmitter, so that calls can be chained.

    unbind

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

    +

    unset

    StaticisIdType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/whatsapp.Wid.html b/classes/whatsapp.Wid.html index 6df1f6de03..de7182ec82 100644 --- a/classes/whatsapp.Wid.html +++ b/classes/whatsapp.Wid.html @@ -1,7 +1,7 @@ -Wid | @wppconnect/wa-js - v3.10.1

    Class Wid

    Whatsapp

    89867

    -

    Whatsapp

    39546 >= 2.2204.13

    -

    Whatsapp

    389867 >= 2.2222.8

    -

    Constructors

    constructor +Wid | @wppconnect/wa-js - v3.10.1

    Class Wid

    Whatsapp

    89867

    +

    Whatsapp

    39546 >= 2.2204.13

    +

    Whatsapp

    389867 >= 2.2222.8

    +

    Constructors

    constructor

    Properties

    _serialized agent? device? diff --git a/classes/whatsapp.websocket.WapNode.html b/classes/whatsapp.websocket.WapNode.html index d6059a17fe..855ea6b8b6 100644 --- a/classes/whatsapp.websocket.WapNode.html +++ b/classes/whatsapp.websocket.WapNode.html @@ -1,5 +1,5 @@ -WapNode | @wppconnect/wa-js - v3.10.1

    Class WapNode

    Whatsapp

    504784 >= 2.2301.6

    -

    Constructors

    constructor +WapNode | @wppconnect/wa-js - v3.10.1

    Class WapNode

    Whatsapp

    504784 >= 2.2301.6

    +

    Constructors

    constructor

    Properties

    attrs content tag diff --git a/enums/group.GroupProperty.html b/enums/group.GroupProperty.html index 1d03fe16e7..05c1bc3e06 100644 --- a/enums/group.GroupProperty.html +++ b/enums/group.GroupProperty.html @@ -1,4 +1,4 @@ GroupProperty | @wppconnect/wa-js - v3.10.1

    Enumeration GroupProperty

    Enumeration Members

    ANNOUNCEMENT EPHEMERAL RESTRICT -

    Enumeration Members

    ANNOUNCEMENT

    ANNOUNCEMENT: "announcement"

    EPHEMERAL

    EPHEMERAL: "ephemeral"

    RESTRICT

    RESTRICT: "restrict"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ANNOUNCEMENT

    ANNOUNCEMENT

    EPHEMERAL

    EPHEMERAL

    RESTRICT

    RESTRICT

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.ACK.html b/enums/whatsapp.enums.ACK.html index 2994f45287..86f28dbc41 100644 --- a/enums/whatsapp.enums.ACK.html +++ b/enums/whatsapp.enums.ACK.html @@ -1,7 +1,7 @@ -ACK | @wppconnect/wa-js - v3.10.1

    Enumeration ACK

    Whatsapp

    35470

    -

    Whatsapp

    69618 >= 2.2204.13

    -

    Whatsapp

    535470 >= 2.2222.8

    -

    Enumeration Members

    CLOCK +ACK | @wppconnect/wa-js - v3.10.1

    Enumeration ACK

    Whatsapp

    35470

    +

    Whatsapp

    69618 >= 2.2204.13

    +

    Whatsapp

    535470 >= 2.2222.8

    +

    Enumeration Members

    CLOCK CONTENT_GONE CONTENT_TOO_BIG CONTENT_UNUPLOADABLE @@ -14,4 +14,4 @@

    WhatsappREAD RECEIVED SENT -

    Enumeration Members

    CLOCK

    CLOCK: 0

    CONTENT_GONE

    CONTENT_GONE: -3

    CONTENT_TOO_BIG

    CONTENT_TOO_BIG: -4

    CONTENT_UNUPLOADABLE

    CONTENT_UNUPLOADABLE: -5

    EXPIRED

    EXPIRED: -2

    FAILED

    FAILED: -1

    INACTIVE

    INACTIVE: -6

    MD_DOWNGRADE

    MD_DOWNGRADE: -7

    PEER

    PEER: 5

    PLAYED

    PLAYED: 4

    READ

    READ: 3

    RECEIVED

    RECEIVED: 2

    SENT

    SENT: 1

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    CLOCK

    CLOCK

    CONTENT_GONE

    CONTENT_GONE

    CONTENT_TOO_BIG

    CONTENT_TOO_BIG

    CONTENT_UNUPLOADABLE

    CONTENT_UNUPLOADABLE

    EXPIRED

    EXPIRED

    FAILED

    FAILED

    INACTIVE

    INACTIVE

    MD_DOWNGRADE

    MD_DOWNGRADE

    PEER

    PEER

    PLAYED

    PLAYED

    READ

    READ

    RECEIVED

    RECEIVED

    SENT

    SENT

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.ACK_STRING.html b/enums/whatsapp.enums.ACK_STRING.html index 1c0bdba8bb..d16c3d77e7 100644 --- a/enums/whatsapp.enums.ACK_STRING.html +++ b/enums/whatsapp.enums.ACK_STRING.html @@ -1,11 +1,11 @@ -ACK_STRING | @wppconnect/wa-js - v3.10.1

    Enumeration ACK_STRING

    Whatsapp

    35470

    -

    Whatsapp

    69618 >= 2.2204.13

    -

    Whatsapp

    535470 >= 2.2222.8

    -

    Enumeration Members

    DELIVERY +ACK_STRING | @wppconnect/wa-js - v3.10.1

    Enumeration ACK_STRING

    Whatsapp

    35470

    +

    Whatsapp

    69618 >= 2.2204.13

    +

    Whatsapp

    535470 >= 2.2222.8

    +

    Enumeration Members

    DELIVERY INACTIVE PLAYED PLAYED_SELF READ READ_SELF SENDER -

    Enumeration Members

    DELIVERY

    DELIVERY: "delivery"

    INACTIVE

    INACTIVE: "inactive"

    PLAYED

    PLAYED: "played"

    PLAYED_SELF

    PLAYED_SELF: "played-self"

    READ

    READ: "read"

    READ_SELF

    READ_SELF: "read-self"

    SENDER

    SENDER: "sender"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    DELIVERY

    DELIVERY

    INACTIVE

    INACTIVE

    PLAYED

    PLAYED

    PLAYED_SELF

    PLAYED_SELF

    READ

    READ

    READ_SELF

    READ_SELF

    SENDER

    SENDER

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.CALL_STATES.html b/enums/whatsapp.enums.CALL_STATES.html index 9ea697e7d3..33eb65b899 100644 --- a/enums/whatsapp.enums.CALL_STATES.html +++ b/enums/whatsapp.enums.CALL_STATES.html @@ -1,7 +1,7 @@ -CALL_STATES | @wppconnect/wa-js - v3.10.1

    Enumeration CALL_STATES

    Whatsapp

    49835

    -

    Whatsapp

    749835 >= 2.2222.8

    -

    Whatsapp

    873297 >= 2.2230.8

    -

    Enumeration Members

    ACTIVE +CALL_STATES | @wppconnect/wa-js - v3.10.1

    Enumeration CALL_STATES

    Whatsapp

    49835

    +

    Whatsapp

    749835 >= 2.2222.8

    +

    Whatsapp

    873297 >= 2.2230.8

    +

    Enumeration Members

    ACTIVE CONNECTING CONNECTION_LOST ENDED @@ -13,4 +13,4 @@

    WhatsappOUTGOING_RING REJECTED REMOTE_CALL_IN_PROGRESS -

    Enumeration Members

    ACTIVE

    ACTIVE: "ACTIVE"

    CONNECTING

    CONNECTING: "CONNECTING"

    CONNECTION_LOST

    CONNECTION_LOST: "CONNECTION_LOST"

    ENDED

    ENDED: "ENDED"

    FAILED

    FAILED: "FAILED"

    HANDLED_REMOTELY

    HANDLED_REMOTELY: "HANDLED_REMOTELY"

    INCOMING_RING

    INCOMING_RING: "INCOMING_RING"

    NOT_ANSWERED

    NOT_ANSWERED: "NOT_ANSWERED"

    OUTGOING_CALLING

    OUTGOING_CALLING: "OUTGOING_CALLING"

    OUTGOING_RING

    OUTGOING_RING: "OUTGOING_RING"

    REJECTED

    REJECTED: "REJECTED"

    REMOTE_CALL_IN_PROGRESS

    REMOTE_CALL_IN_PROGRESS: "REMOTE_CALL_IN_PROGRESS"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ACTIVE

    ACTIVE

    CONNECTING

    CONNECTING

    CONNECTION_LOST

    CONNECTION_LOST

    ENDED

    ENDED

    FAILED

    FAILED

    HANDLED_REMOTELY

    HANDLED_REMOTELY

    INCOMING_RING

    INCOMING_RING

    NOT_ANSWERED

    NOT_ANSWERED

    OUTGOING_CALLING

    OUTGOING_CALLING

    OUTGOING_RING

    OUTGOING_RING

    REJECTED

    REJECTED

    REMOTE_CALL_IN_PROGRESS

    REMOTE_CALL_IN_PROGRESS

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.EDIT_ATTR.html b/enums/whatsapp.enums.EDIT_ATTR.html index e0b69af8c4..082e647083 100644 --- a/enums/whatsapp.enums.EDIT_ATTR.html +++ b/enums/whatsapp.enums.EDIT_ATTR.html @@ -1,6 +1,6 @@ -EDIT_ATTR | @wppconnect/wa-js - v3.10.1

    Enumeration EDIT_ATTR

    Whatsapp

    35470

    -

    Whatsapp

    69618 >= 2.2204.13

    -

    Whatsapp

    535470 >= 2.2222.8

    -

    Enumeration Members

    ADMIN_REVOKE +EDIT_ATTR | @wppconnect/wa-js - v3.10.1

    Enumeration EDIT_ATTR

    Whatsapp

    35470

    +

    Whatsapp

    69618 >= 2.2204.13

    +

    Whatsapp

    535470 >= 2.2222.8

    +

    Enumeration Members

    ADMIN_REVOKE SENDER_REVOKE -

    Enumeration Members

    ADMIN_REVOKE

    ADMIN_REVOKE: 8

    SENDER_REVOKE

    SENDER_REVOKE: 7

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ADMIN_REVOKE

    ADMIN_REVOKE

    SENDER_REVOKE

    SENDER_REVOKE

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.GROUP_SETTING_TYPE.html b/enums/whatsapp.enums.GROUP_SETTING_TYPE.html index 9daab13b5f..94535216d9 100644 --- a/enums/whatsapp.enums.GROUP_SETTING_TYPE.html +++ b/enums/whatsapp.enums.GROUP_SETTING_TYPE.html @@ -1,8 +1,8 @@ -GROUP_SETTING_TYPE | @wppconnect/wa-js - v3.10.1

    Enumeration GROUP_SETTING_TYPE

    Whatsapp

    12380

    -

    Whatsapp

    69618 >= 2.2204.13

    -

    Whatsapp

    312380 >= 2.2222.8

    -

    Enumeration Members

    ANNOUNCEMENT +GROUP_SETTING_TYPE | @wppconnect/wa-js - v3.10.1

    Enumeration GROUP_SETTING_TYPE

    Whatsapp

    12380

    +

    Whatsapp

    69618 >= 2.2204.13

    +

    Whatsapp

    312380 >= 2.2222.8

    +

    Enumeration Members

    ANNOUNCEMENT EPHEMERAL NO_FREQUENTLY_FORWARDED RESTRICT -

    Enumeration Members

    ANNOUNCEMENT

    ANNOUNCEMENT: "announcement"

    EPHEMERAL

    EPHEMERAL: "ephemeral"

    NO_FREQUENTLY_FORWARDED

    NO_FREQUENTLY_FORWARDED: "no_frequently_forwarded"

    RESTRICT

    RESTRICT: "restrict"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ANNOUNCEMENT

    ANNOUNCEMENT

    EPHEMERAL

    EPHEMERAL

    NO_FREQUENTLY_FORWARDED

    NO_FREQUENTLY_FORWARDED

    RESTRICT

    RESTRICT

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.KIC_ENTRY_POINT_TYPE.html b/enums/whatsapp.enums.KIC_ENTRY_POINT_TYPE.html index dda166b86a..ef6729d6fc 100644 --- a/enums/whatsapp.enums.KIC_ENTRY_POINT_TYPE.html +++ b/enums/whatsapp.enums.KIC_ENTRY_POINT_TYPE.html @@ -1,8 +1,8 @@ -KIC_ENTRY_POINT_TYPE | @wppconnect/wa-js - v3.10.1

    Enumeration KIC_ENTRY_POINT_TYPE

    Whatsapp

    982015

    -

    Enumeration Members

    CHAT +KIC_ENTRY_POINT_TYPE | @wppconnect/wa-js - v3.10.1

    Enumeration KIC_ENTRY_POINT_TYPE

    Whatsapp

    982015

    +

    Enumeration Members

    CHAT CHAT_INFO DOCS LINKS MEDIA SEARCH -

    Enumeration Members

    CHAT

    CHAT: 3

    CHAT_INFO

    CHAT_INFO: 1

    DOCS

    DOCS: 5

    LINKS

    LINKS: 6

    MEDIA

    MEDIA: 4

    SEARCH

    SEARCH: 2

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    CHAT

    CHAT

    CHAT_INFO

    CHAT_INFO

    DOCS

    DOCS

    LINKS

    LINKS

    MEDIA

    MEDIA

    SEARCH

    SEARCH

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.LOGOUT_REASON_CODE.html b/enums/whatsapp.enums.LOGOUT_REASON_CODE.html index e0d3e90d2e..340f89652b 100644 --- a/enums/whatsapp.enums.LOGOUT_REASON_CODE.html +++ b/enums/whatsapp.enums.LOGOUT_REASON_CODE.html @@ -2,4 +2,4 @@ CLIENT_FATAL INITIAL_HISTORY_SYNC_TIMEOUT SYNC_FAIL -

    Enumeration Members

    ACCOUNT_LOCKED

    ACCOUNT_LOCKED: "3"

    CLIENT_FATAL

    CLIENT_FATAL: "0"

    INITIAL_HISTORY_SYNC_TIMEOUT

    INITIAL_HISTORY_SYNC_TIMEOUT: "2"

    SYNC_FAIL

    SYNC_FAIL: "1"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ACCOUNT_LOCKED

    ACCOUNT_LOCKED

    CLIENT_FATAL

    CLIENT_FATAL

    INITIAL_HISTORY_SYNC_TIMEOUT

    INITIAL_HISTORY_SYNC_TIMEOUT

    SYNC_FAIL

    SYNC_FAIL

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.LogoutReason.html b/enums/whatsapp.enums.LogoutReason.html index 5306f8582b..b998abbc32 100644 --- a/enums/whatsapp.enums.LogoutReason.html +++ b/enums/whatsapp.enums.LogoutReason.html @@ -1,8 +1,8 @@ -LogoutReason | @wppconnect/wa-js - v3.10.1

    Enumeration LogoutReason

    Whatsapp

    83578

    -

    Whatsapp

    88950 >= 2.2218.4

    -

    Whatsapp

    788950 >= 2.2222.8

    -

    Whatsapp

    WAWebLogoutReasonConstants >= 2.3000.x

    -

    Enumeration Members

    AccountLocked +LogoutReason | @wppconnect/wa-js - v3.10.1

    Enumeration LogoutReason

    Whatsapp

    83578

    +

    Whatsapp

    88950 >= 2.2218.4

    +

    Whatsapp

    788950 >= 2.2222.8

    +

    Whatsapp

    WAWebLogoutReasonConstants >= 2.3000.x

    +

    Enumeration Members

    AccountLocked AccountSyncError AccountSyncTimeout ClientFatalError @@ -21,4 +21,4 @@

    WhatsappUNKNOWN UnknownCompanion UserInitiated -

    Enumeration Members

    AccountLocked

    AccountLocked: "account_locked"

    AccountSyncError

    AccountSyncError: "account_sync_error"

    AccountSyncTimeout

    AccountSyncTimeout: "account_sync_timeout"

    ClientFatalError

    ClientFatalError: "client_fatal_error"

    ClientVersionOutdated

    ClientVersionOutdated: "client_version_outdated"

    CriticalSyncTimeout

    CriticalSyncTimeout: "critical_sync_timeout"

    HistorySyncTimeout

    HistorySyncTimeout: "history_sync_timeout"

    InvalidAdvStatus

    InvalidAdvStatus: "invalid_adv_status"

    MDOptOut

    MDOptOut: "md_opt_out"

    MissingEncSalt

    MissingEncSalt: "missing_enc_salt"

    MissingScreenLockSalt

    MissingScreenLockSalt: "missing_screen_lock_salt"

    PrimaryIdentityKeyChange

    PrimaryIdentityKeyChange: "primary_identity_key_change"

    StorageQuotaExceeded

    StorageQuotaExceeded: "storage_quota_exceeded"

    SyncdErrorDuringBootstrap

    SyncdErrorDuringBootstrap: "syncd_error_during_bootstrap"

    SyncdFailure

    SyncdFailure: "syncd_failure"

    SyncdTimeout

    SyncdTimeout: "syncd_timeout"

    UNKNOWN

    UNKNOWN: "unknown"

    UnknownCompanion

    UnknownCompanion: "unknown_companion"

    UserInitiated

    UserInitiated: "user_initiated"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    AccountLocked

    AccountLocked

    AccountSyncError

    AccountSyncError

    AccountSyncTimeout

    AccountSyncTimeout

    ClientFatalError

    ClientFatalError

    ClientVersionOutdated

    ClientVersionOutdated

    CriticalSyncTimeout

    CriticalSyncTimeout

    HistorySyncTimeout

    HistorySyncTimeout

    InvalidAdvStatus

    InvalidAdvStatus

    MDOptOut

    MDOptOut

    MissingEncSalt

    MissingEncSalt

    MissingScreenLockSalt

    MissingScreenLockSalt

    PrimaryIdentityKeyChange

    PrimaryIdentityKeyChange

    StorageQuotaExceeded

    StorageQuotaExceeded

    SyncdErrorDuringBootstrap

    SyncdErrorDuringBootstrap

    SyncdFailure

    SyncdFailure

    SyncdTimeout

    SyncdTimeout

    UNKNOWN

    UNKNOWN

    UnknownCompanion

    UnknownCompanion

    UserInitiated

    UserInitiated

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.MSG_TYPE.html b/enums/whatsapp.enums.MSG_TYPE.html index 8fe502fcee..8f0ac1c4bc 100644 --- a/enums/whatsapp.enums.MSG_TYPE.html +++ b/enums/whatsapp.enums.MSG_TYPE.html @@ -1,7 +1,7 @@ -MSG_TYPE | @wppconnect/wa-js - v3.10.1

    Enumeration MSG_TYPE

    Whatsapp

    15461

    -

    Whatsapp

    69618 >= 2.2204.13

    -

    Whatsapp

    115461 >= 2.2222.8

    -

    Enumeration Members

    AUDIO +MSG_TYPE | @wppconnect/wa-js - v3.10.1

    Enumeration MSG_TYPE

    Whatsapp

    15461

    +

    Whatsapp

    69618 >= 2.2204.13

    +

    Whatsapp

    115461 >= 2.2222.8

    +

    Enumeration Members

    AUDIO BROADCAST_NOTIFICATION BUTTONS_RESPONSE CALL_LOG @@ -35,4 +35,4 @@

    WhatsappUNKNOWN VCARD VIDEO -

    Enumeration Members

    AUDIO

    AUDIO: "audio"

    BROADCAST_NOTIFICATION

    BROADCAST_NOTIFICATION: "broadcast_notification"

    BUTTONS_RESPONSE

    BUTTONS_RESPONSE: "buttons_response"

    CALL_LOG

    CALL_LOG: "call_log"

    CHAT

    CHAT: "chat"

    CIPHERTEXT

    CIPHERTEXT: "ciphertext"

    DOCUMENT

    DOCUMENT: "document"

    E2E_NOTIFICATION

    E2E_NOTIFICATION: "e2e_notification"

    GP2

    GP2: "gp2"

    GROUP_NOTIFICATION

    GROUP_NOTIFICATION: "group_notification"

    GROUPS_V4_INVITE

    GROUPS_V4_INVITE: "groups_v4_invite"

    HSM

    HSM: "hsm"

    IMAGE

    IMAGE: "image"

    INTERACTIVE

    INTERACTIVE: "interactive"

    LIST

    LIST: "list"

    LIST_RESPONSE

    LIST_RESPONSE: "list_response"

    LOCATION

    LOCATION: "location"

    MULTI_VCARD

    MULTI_VCARD: "multi_vcard"

    NATIVE_FLOW

    NATIVE_FLOW: "native_flow"

    NOTIFICATION

    NOTIFICATION: "notification"

    NOTIFICATION_TEMPLATE

    NOTIFICATION_TEMPLATE: "notification_template"

    ORDER

    ORDER: "order"

    OVERSIZED

    OVERSIZED: "oversized"

    PAYMENT

    PAYMENT: "payment"

    PRODUCT

    PRODUCT: "product"

    PROTOCOL

    PROTOCOL: "protocol"

    PTT

    PTT: "ptt"

    REACTION

    REACTION: "reaction"

    REVOKED

    REVOKED: "revoked"

    STICKER

    STICKER: "sticker"

    TEMPLATE_BUTTON_REPLY

    TEMPLATE_BUTTON_REPLY: "template_button_reply"

    UNKNOWN

    UNKNOWN: "unknown"

    VCARD

    VCARD: "vcard"

    VIDEO

    VIDEO: "video"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    AUDIO

    AUDIO

    BROADCAST_NOTIFICATION

    BROADCAST_NOTIFICATION

    BUTTONS_RESPONSE

    BUTTONS_RESPONSE

    CALL_LOG

    CALL_LOG

    CHAT

    CHAT

    CIPHERTEXT

    CIPHERTEXT

    DOCUMENT

    DOCUMENT

    E2E_NOTIFICATION

    E2E_NOTIFICATION

    GP2

    GP2

    GROUP_NOTIFICATION

    GROUP_NOTIFICATION

    GROUPS_V4_INVITE

    GROUPS_V4_INVITE

    HSM

    HSM

    IMAGE

    IMAGE

    INTERACTIVE

    INTERACTIVE

    LIST

    LIST

    LIST_RESPONSE

    LIST_RESPONSE

    LOCATION

    LOCATION

    MULTI_VCARD

    MULTI_VCARD

    NATIVE_FLOW

    NATIVE_FLOW

    NOTIFICATION

    NOTIFICATION

    NOTIFICATION_TEMPLATE

    NOTIFICATION_TEMPLATE

    ORDER

    ORDER

    OVERSIZED

    OVERSIZED

    PAYMENT

    PAYMENT

    PRODUCT

    PRODUCT

    PROTOCOL

    PROTOCOL

    PTT

    PTT

    REACTION

    REACTION

    REVOKED

    REVOKED

    STICKER

    STICKER

    TEMPLATE_BUTTON_REPLY

    TEMPLATE_BUTTON_REPLY

    UNKNOWN

    UNKNOWN

    VCARD

    VCARD

    VIDEO

    VIDEO

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.OUTWARD_TYPES.html b/enums/whatsapp.enums.OUTWARD_TYPES.html index 92cc0cd1de..8f92332c60 100644 --- a/enums/whatsapp.enums.OUTWARD_TYPES.html +++ b/enums/whatsapp.enums.OUTWARD_TYPES.html @@ -1,5 +1,5 @@ -OUTWARD_TYPES | @wppconnect/wa-js - v3.10.1

    Enumeration OUTWARD_TYPES

    Whatsapp

    58668

    -

    Enumeration Members

    AUDIO +OUTWARD_TYPES | @wppconnect/wa-js - v3.10.1

    Enumeration OUTWARD_TYPES

    Whatsapp

    58668

    +

    Enumeration Members

    AUDIO DOCUMENT IMAGE PRODUCT @@ -8,4 +8,4 @@ STICKER UNKNOWN VIDEO -

    Enumeration Members

    AUDIO

    AUDIO: "audio"

    DOCUMENT

    DOCUMENT: "document"

    IMAGE

    IMAGE: "image"

    PRODUCT

    PRODUCT: "product"

    PTT

    PTT: "ptt"

    PTV

    PTV: "ptv"

    STICKER

    STICKER: "sticker"

    UNKNOWN

    UNKNOWN: "unknown"

    VIDEO

    VIDEO: "video"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    AUDIO

    AUDIO

    DOCUMENT

    DOCUMENT

    IMAGE

    IMAGE

    PRODUCT

    PRODUCT

    PTT

    PTT

    PTV

    PTV

    STICKER

    STICKER

    UNKNOWN

    UNKNOWN

    VIDEO

    VIDEO

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.PIN_STATE.html b/enums/whatsapp.enums.PIN_STATE.html index f7a9606c51..5634aa474d 100644 --- a/enums/whatsapp.enums.PIN_STATE.html +++ b/enums/whatsapp.enums.PIN_STATE.html @@ -1,5 +1,5 @@ -PIN_STATE | @wppconnect/wa-js - v3.10.1

    Enumeration PIN_STATE

    Whatsapp

    WAWebPinMsgConstants >= 2.3000.1012170943

    -

    Enumeration Members

    INVALID +PIN_STATE | @wppconnect/wa-js - v3.10.1

    Enumeration PIN_STATE

    Whatsapp

    WAWebPinMsgConstants >= 2.3000.1012170943

    +

    Enumeration Members

    INVALID PIN UNPIN -

    Enumeration Members

    INVALID

    INVALID: 0

    PIN

    PIN: 1

    UNPIN

    UNPIN: 2

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    INVALID

    INVALID

    PIN

    PIN

    UNPIN

    UNPIN

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/whatsapp.enums.SendMsgResult.html b/enums/whatsapp.enums.SendMsgResult.html index ea91dacc59..2af0032d81 100644 --- a/enums/whatsapp.enums.SendMsgResult.html +++ b/enums/whatsapp.enums.SendMsgResult.html @@ -1,10 +1,10 @@ -SendMsgResult | @wppconnect/wa-js - v3.10.1

    Enumeration SendMsgResult

    Whatsapp

    13705

    -

    Whatsapp

    413705 >= 2.2222.8

    -

    Whatsapp

    20551 >= 2.2228.4

    -

    Enumeration Members

    ERROR_CANCELLED +SendMsgResult | @wppconnect/wa-js - v3.10.1

    Enumeration SendMsgResult

    Whatsapp

    13705

    +

    Whatsapp

    413705 >= 2.2222.8

    +

    Whatsapp

    20551 >= 2.2228.4

    +

    Enumeration Members

    ERROR_CANCELLED ERROR_EXPIRED ERROR_NETWORK ERROR_UNKNOWN ERROR_UPLOAD OK -

    Enumeration Members

    ERROR_CANCELLED

    ERROR_CANCELLED: "ERROR_CANCELLED"

    ERROR_EXPIRED

    ERROR_EXPIRED: "ERROR_EXPIRED"

    ERROR_NETWORK

    ERROR_NETWORK: "ERROR_NETWORK"

    ERROR_UNKNOWN

    ERROR_UNKNOWN: "ERROR_UNKNOWN"

    ERROR_UPLOAD

    ERROR_UPLOAD: "ERROR_UPLOAD"

    OK

    OK: "OK"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ERROR_CANCELLED

    ERROR_CANCELLED

    ERROR_EXPIRED

    ERROR_EXPIRED

    ERROR_NETWORK

    ERROR_NETWORK

    ERROR_UNKNOWN

    ERROR_UNKNOWN

    ERROR_UPLOAD

    ERROR_UPLOAD

    OK

    OK

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/functions/call.accept.html b/functions/call.accept.html index 51d5535867..c49a007889 100644 --- a/functions/call.accept.html +++ b/functions/call.accept.html @@ -1,7 +1,7 @@ accept | @wppconnect/wa-js - v3.10.1

    Function accept

    • accept(callId?): Promise<boolean>

    • Accept a incoming call

      Parameters

      • OptionalcallId: string

        The call ID, empty to accept the first one

      Returns Promise<boolean>

      [return description]

      -

      Example

      // Accept any incoming call
      WPP.call.accept();

      // Accept specific call id
      WPP.call.accept(callId);

      // Accept any incoming call
      WPP.on('call.incoming_call', (call) => {
        setTimeout(() => {
          WPP.call.accept(call.id);
        }, 1000);
      });
+
      Example
      // Accept any incoming call
      WPP.call.accept();

      // Accept specific call id
      WPP.call.accept(callId);

      // Accept any incoming call
      WPP.on('call.incoming_call', (call) => {
        setTimeout(() => {
          WPP.call.accept(call.id);
        }, 1000);
      });
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/call.end.html b/functions/call.end.html index 2d77d83d50..80bb50838a 100644 --- a/functions/call.end.html +++ b/functions/call.end.html @@ -1,7 +1,7 @@ end | @wppconnect/wa-js - v3.10.1

    Function end

    • end(callId?): Promise<boolean>

    • End a call

      Parameters

      • OptionalcallId: string

        The call ID, empty to end the first one

      Returns Promise<boolean>

      [return description]

      -

      Example

      // End any call
      WPP.call.end();

      // End specific call id
      WPP.call.end(callId);

      // End any incoming call
      WPP.on('call.incoming_call', (call) => {
        WPP.call.end(call.id);
      });
+
      Example
      // End any call
      WPP.call.end();

      // End specific call id
      WPP.call.end(callId);

      // End any incoming call
      WPP.on('call.incoming_call', (call) => {
        WPP.call.end(call.id);
      });
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/call.offer.html b/functions/call.offer.html index e53189ef33..9ce5363c25 100644 --- a/functions/call.offer.html +++ b/functions/call.offer.html @@ -1,6 +1,6 @@ offer | @wppconnect/wa-js - v3.10.1

    Function offer

    • offer(to, options?): Promise<any>

    • Send a call offer

      This method only will send a call offer, but there are no audio/video

      -

      Parameters

      • to: string | Wid
      • options: CallOfferOptions = {}

      Returns Promise<any>

      Example

      // Send a call offer
      WPP.call.offer('[number]@c.us');
      // Send a video call offer
      WPP.call.offer('[number]@c.us', {isVideo: true});
+

      Parameters

      • to: string | Wid
      • options: CallOfferOptions = {}

      Returns Promise<any>

      Example

      // Send a call offer
      WPP.call.offer('[number]@c.us');
      // Send a video call offer
      WPP.call.offer('[number]@c.us', {isVideo: true});
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/call.reject.html b/functions/call.reject.html index d2b2bbd6f4..3d7c1534f0 100644 --- a/functions/call.reject.html +++ b/functions/call.reject.html @@ -1,7 +1,7 @@ reject | @wppconnect/wa-js - v3.10.1

    Function reject

    • reject(callId?): Promise<boolean>

    • Reject a incoming call

      Parameters

      • OptionalcallId: string

        The call ID, empty to reject the first one

      Returns Promise<boolean>

      [return description]

      -

      Example

      // Reject any incoming call
      WPP.call.reject();

      // Reject specific call id
      WPP.call.reject(callId);

      // Reject any incoming call
      WPP.on('call.incoming_call', (call) => {
        WPP.call.reject(call.id);
      });
+
      Example
      // Reject any incoming call
      WPP.call.reject();

      // Reject specific call id
      WPP.call.reject(callId);

      // Reject any incoming call
      WPP.on('call.incoming_call', (call) => {
        WPP.call.reject(call.id);
      });
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.addProductImage.html b/functions/catalog.addProductImage.html index 3ba40e50ba..6cbdc77f54 100644 --- a/functions/catalog.addProductImage.html +++ b/functions/catalog.addProductImage.html @@ -1,7 +1,7 @@ addProductImage | @wppconnect/wa-js - v3.10.1

    Function addProductImage

    • addProductImage(productId, content): Promise<any>

    • Add image on product This function include additional images on product for change main image use

      -

      Parameters

      • productId: string
      • content: string

      Returns Promise<any>

      Change Product Image

      Example

      await WPP.catalog.addProductImage('686859858689', 'data:image/jpeg;base64,.....');
+

      Parameters

      • productId: string
      • content: string

      Returns Promise<any>

      Change Product Image

      Example

      await WPP.catalog.addProductImage('686859858689', 'data:image/jpeg;base64,.....');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.changeProductImage.html b/functions/catalog.changeProductImage.html index 48c1f01aad..72eb771c2d 100644 --- a/functions/catalog.changeProductImage.html +++ b/functions/catalog.changeProductImage.html @@ -1,7 +1,7 @@ changeProductImage | @wppconnect/wa-js - v3.10.1

    Function changeProductImage

    • changeProductImage(productId, content): Promise<any>

    • Add image on product This function change main image of product for change additional images use

      -

      Parameters

      • productId: string
      • content: string

      Returns Promise<any>

      Add Product Image

      Example

      await WPP.catalog.changeProductImage('686859858689', 'data:image/jpeg;base64,.....');
+

      Parameters

      • productId: string
      • content: string

      Returns Promise<any>

      Add Product Image

      Example

      await WPP.catalog.changeProductImage('686859858689', 'data:image/jpeg;base64,.....');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.createCollection.html b/functions/catalog.createCollection.html index e6ca310631..576a732f81 100644 --- a/functions/catalog.createCollection.html +++ b/functions/catalog.createCollection.html @@ -1,6 +1,6 @@ createCollection | @wppconnect/wa-js - v3.10.1

    Function createCollection

    • createCollection(collectionName, productsId): Promise<any>

    • Create new collection

      Parameters

      • collectionName: string
      • productsId: string[]

      Returns Promise<any>

      Return collection created

      -

      Example

      const myCatalog = await WPP.catalog.createCollection('Collection Name', ['565656589898']);
+
      Example
      const myCatalog = await WPP.catalog.createCollection('Collection Name', ['565656589898']);
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.delProducts.html b/functions/catalog.delProducts.html index b81d96f823..8f37c2eed3 100644 --- a/functions/catalog.delProducts.html +++ b/functions/catalog.delProducts.html @@ -1,6 +1,6 @@ delProducts | @wppconnect/wa-js - v3.10.1

    Function delProducts

    • delProducts(productsIds): Promise<any>

    • Get your current catalog

      Parameters

      • productsIds: string[]

      Returns Promise<any>

      Return sucess or error of product deleted

      -

      Example

      // Delete product by id
      const myCatalog = await WPP.catalog.delProducts('6104203702939361');

      // Delete various products
      const myCatalog = await WPP.catalog.delProducts(['6104203702939361', '6104289702939361']);
+
      Example
      // Delete product by id
      const myCatalog = await WPP.catalog.delProducts('6104203702939361');

      // Delete various products
      const myCatalog = await WPP.catalog.delProducts(['6104203702939361', '6104289702939361']);
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.deleteCollection.html b/functions/catalog.deleteCollection.html index d89bd9e3fe..91ae67a329 100644 --- a/functions/catalog.deleteCollection.html +++ b/functions/catalog.deleteCollection.html @@ -1,6 +1,6 @@ deleteCollection | @wppconnect/wa-js - v3.10.1

    Function deleteCollection

    • deleteCollection(collectionId): Promise<any>

    • Delete a collection

      Parameters

      • collectionId: string

      Returns Promise<any>

      Return sucess or error

      -

      Example

      const myCatalog = await WPP.catalog.deleteCollection("377095767832354");
+
      Example
      const myCatalog = await WPP.catalog.deleteCollection("377095767832354");
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.getCollections.html b/functions/catalog.getCollections.html index 2f4a02eded..2626c51405 100644 --- a/functions/catalog.getCollections.html +++ b/functions/catalog.getCollections.html @@ -1,6 +1,6 @@ getCollections | @wppconnect/wa-js - v3.10.1

    Function getCollections

    • getCollections(chatId, qnt?, productsCount?): Promise<ProductCollModel[]>

    • Get collections of catalog

      Parameters

      • chatId: string
      • Optionalqnt: number
      • OptionalproductsCount: number

      Returns Promise<ProductCollModel[]>

      Your collections of products

      -

      Example

      // Retrieve 20 collections of chat
      const myCatalog = await WPP.catalog.getCollections('552198554578@c.us', '20');

      // Retrieve 20 collections of chat and products arrays limit with 10 products
      const myCatalog = await WPP.catalog.getCollections('552198554578@c.us', '20', '10');
+
      Example
      // Retrieve 20 collections of chat
      const myCatalog = await WPP.catalog.getCollections('552198554578@c.us', '20');

      // Retrieve 20 collections of chat and products arrays limit with 10 products
      const myCatalog = await WPP.catalog.getCollections('552198554578@c.us', '20', '10');
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.getMyCatalog.html b/functions/catalog.getMyCatalog.html index aefecb3004..9d1e966cdc 100644 --- a/functions/catalog.getMyCatalog.html +++ b/functions/catalog.getMyCatalog.html @@ -1,6 +1,6 @@ getMyCatalog | @wppconnect/wa-js - v3.10.1

    Function getMyCatalog

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.getProductById.html b/functions/catalog.getProductById.html index 8e6243ec81..00736b2a42 100644 --- a/functions/catalog.getProductById.html +++ b/functions/catalog.getProductById.html @@ -1,5 +1,5 @@ getProductById | @wppconnect/wa-js - v3.10.1

    Function getProductById

    • getProductById(chatId, productId): Promise<{
          additional_image_cdn_urls: any[];
          availability: string;
          capability_to_review_status: {
              key: "WHATSAPP";
              value: "APPROVED";
          }[];
          checkmark: boolean;
          currency: string;
          description: string;
          id: string;
          image_cdn_urls: {
              key: "requested" | "full";
              value: string;
          }[];
          image_hashes_for_whatsapp: string[];
          is_hidden: boolean;
          max_available: number;
          name: string;
          price: string;
          retailer_id: string;
          url: string;
          whatsapp_product_can_appeal: boolean;
      }>

    • Retrieves product by id

      -

      Parameters

      • chatId: string
      • productId: number

      Returns Promise<{
          additional_image_cdn_urls: any[];
          availability: string;
          capability_to_review_status: {
              key: "WHATSAPP";
              value: "APPROVED";
          }[];
          checkmark: boolean;
          currency: string;
          description: string;
          id: string;
          image_cdn_urls: {
              key: "requested" | "full";
              value: string;
          }[];
          image_hashes_for_whatsapp: string[];
          is_hidden: boolean;
          max_available: number;
          name: string;
          price: string;
          retailer_id: string;
          url: string;
          whatsapp_product_can_appeal: boolean;
      }>

      Example

      // Retrieve data of product
      await WPP.catalog.getProductById('5521985565656@c.us', '68685985868923');
+

      Parameters

      • chatId: string
      • productId: number

      Returns Promise<{
          additional_image_cdn_urls: any[];
          availability: string;
          capability_to_review_status: {
              key: "WHATSAPP";
              value: "APPROVED";
          }[];
          checkmark: boolean;
          currency: string;
          description: string;
          id: string;
          image_cdn_urls: {
              key: "requested" | "full";
              value: string;
          }[];
          image_hashes_for_whatsapp: string[];
          is_hidden: boolean;
          max_available: number;
          name: string;
          price: string;
          retailer_id: string;
          url: string;
          whatsapp_product_can_appeal: boolean;
      }>

      Example

      // Retrieve data of product
      await WPP.catalog.getProductById('5521985565656@c.us', '68685985868923');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.getProducts.html b/functions/catalog.getProducts.html index 6e3a7011b7..3b0b661424 100644 --- a/functions/catalog.getProducts.html +++ b/functions/catalog.getProducts.html @@ -1,7 +1,7 @@ getProducts | @wppconnect/wa-js - v3.10.1

    Function getProducts

    • getProducts(chatId, qnt): Promise<any[]>

    • Retrieves product by contact id

      Parameters

      • chatId: string
      • qnt: number

      Returns Promise<any[]>

      A array with products

      -

      Example

      Get products of catalogs

      +

      Example

      Get products of catalogs

      await WPP.catalog.getProducts('5521985625689@c.us', 10);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.removeProductImage.html b/functions/catalog.removeProductImage.html index 25afcaa704..4788d6cb05 100644 --- a/functions/catalog.removeProductImage.html +++ b/functions/catalog.removeProductImage.html @@ -2,7 +2,7 @@ This function remove additional images of product for change main image use

    Parameters

    • productId: string
    • index: string

      Index of array additionalImageCdnUrl

      -

    Returns Promise<ProductModel>

    Change Product Image

    Example

    await WPP.catalog.removeProductImage('68685985868923', '0');
+

    Returns Promise<ProductModel>

    Change Product Image

    Example

    await WPP.catalog.removeProductImage('68685985868923', '0');
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.setProductVisibility.html b/functions/catalog.setProductVisibility.html index 0789fec62d..90e99e1044 100644 --- a/functions/catalog.setProductVisibility.html +++ b/functions/catalog.setProductVisibility.html @@ -1,5 +1,5 @@ setProductVisibility | @wppconnect/wa-js - v3.10.1

    Function setProductVisibility

    • setProductVisibility(productId, isHidden): Promise<any>

    • Get your current catalog

      -

      Parameters

      • productId: any
      • isHidden: boolean

      Returns Promise<any>

      Example

      // Set product visibility hidden
      const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, true);
+

      Parameters

      • productId: any
      • isHidden: boolean

      Returns Promise<any>

      Example

      // Set product visibility hidden
      const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, true);

      // Set product visible @@ -7,4 +7,4 @@ 


      @return Return sucess of product visibility
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/catalog.updateCartEnabled.html b/functions/catalog.updateCartEnabled.html index cbb4fb3712..9a8e48328f 100644 --- a/functions/catalog.updateCartEnabled.html +++ b/functions/catalog.updateCartEnabled.html @@ -1,5 +1,5 @@ updateCartEnabled | @wppconnect/wa-js - v3.10.1

    Function updateCartEnabled

    • updateCartEnabled(enabled): Promise<any>

    • Get your current catalog

      -

      Parameters

      • enabled: boolean

      Returns Promise<any>

      Example

      // Set product visibility hidden
      const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, true);
+

      Parameters

      • enabled: boolean

      Returns Promise<any>

      Example

      // Set product visibility hidden
      const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, true);

      // Set product visible @@ -7,4 +7,4 @@ 


      @return Return sucess of product visibility
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.archive.html b/functions/chat.archive.html index fc571364aa..7c3888c3e3 100644 --- a/functions/chat.archive.html +++ b/functions/chat.archive.html @@ -1,5 +1,5 @@ archive | @wppconnect/wa-js - v3.10.1

    Function archive

    • archive(chatId, archive?): Promise<{
          archive: boolean;
          wid: Wid;
      }>

    • Archive a chat

      -

      Parameters

      • chatId: string | Wid
      • archive: boolean = true

      Returns Promise<{
          archive: boolean;
          wid: Wid;
      }>

      Example

      // Archive a chat
      WPP.chat.archive('[number]@c.us');

      // Unarchive a chat
      WPP.chat.archive('[number]@c.us', false);
      // or
      WPP.chat.unarchive('[number]@c.us');
+

      Parameters

      • chatId: string | Wid
      • archive: boolean = true

      Returns Promise<{
          archive: boolean;
          wid: Wid;
      }>

      Example

      // Archive a chat
      WPP.chat.archive('[number]@c.us');

      // Unarchive a chat
      WPP.chat.archive('[number]@c.us', false);
      // or
      WPP.chat.unarchive('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.canMarkPlayed.html b/functions/chat.canMarkPlayed.html index b47cccc1be..446b8305bd 100644 --- a/functions/chat.canMarkPlayed.html +++ b/functions/chat.canMarkPlayed.html @@ -1,5 +1,5 @@ canMarkPlayed | @wppconnect/wa-js - v3.10.1

    Function canMarkPlayed

    • canMarkPlayed(messageId): Promise<any>

    • Get if message can played

      -

      Parameters

      • messageId:
            | string
            | MsgModel
            | MsgKey
            | Stringable

      Returns Promise<any>

      Example

      WPP.chat.canMarkPlayed('[message_id]');
+

      Parameters

      • messageId:
            | string
            | MsgModel
            | MsgKey
            | Stringable

      Returns Promise<any>

      Example

      WPP.chat.canMarkPlayed('[message_id]');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.canMute.html b/functions/chat.canMute.html index 043228240a..485a4c8a3f 100644 --- a/functions/chat.canMute.html +++ b/functions/chat.canMute.html @@ -1,5 +1,5 @@ canMute | @wppconnect/wa-js - v3.10.1

    Function canMute

    • canMute(chatId): boolean

    • Check if is possible to mute this chat

      -

      Parameters

      • chatId: string | Wid

      Returns boolean

      Example

      const canMute = WPP.chat.canMute('[number]@c.us');
+

      Parameters

      • chatId: string | Wid

      Returns boolean

      Example

      const canMute = WPP.chat.canMute('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.canReply.html b/functions/chat.canReply.html index f6bc60ab85..f0c5da6e1f 100644 --- a/functions/chat.canReply.html +++ b/functions/chat.canReply.html @@ -1,5 +1,5 @@ canReply | @wppconnect/wa-js - v3.10.1

    Function canReply

    • canReply(messageId): Promise<boolean>

    • Get if message can reply

      -

      Parameters

      • messageId:
            | string
            | MsgModel
            | MsgKey
            | Stringable

      Returns Promise<boolean>

      Example

      WPP.chat.canReply('[message_id]');
+

      Parameters

      • messageId:
            | string
            | MsgModel
            | MsgKey
            | Stringable

      Returns Promise<boolean>

      Example

      WPP.chat.canReply('[message_id]');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.closeChat.html b/functions/chat.closeChat.html index 261ccf3d38..d4c27e3dd0 100644 --- a/functions/chat.closeChat.html +++ b/functions/chat.closeChat.html @@ -1,5 +1,5 @@ closeChat | @wppconnect/wa-js - v3.10.1

    Function closeChat

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.deleteMessage.html b/functions/chat.deleteMessage.html index 0f3031f840..2e7b23ad4f 100644 --- a/functions/chat.deleteMessage.html +++ b/functions/chat.deleteMessage.html @@ -1,5 +1,5 @@ deleteMessage | @wppconnect/wa-js - v3.10.1

    Function deleteMessage

    • deleteMessage(chatId, ids, deleteMediaInDevice?, revoke?): Promise<DeleteMessageReturn | DeleteMessageReturn[]>

    • Delete a message

      -

      Parameters

      • chatId: string | Wid
      • ids: string | string[]
      • deleteMediaInDevice: boolean = false
      • revoke: boolean = false

      Returns Promise<DeleteMessageReturn | DeleteMessageReturn[]>

      Example

      // Delete a message
      WPP.chat.deleteMessage('[number]@c.us', 'msgid');
      // Delete a list of messages
      WPP.chat.deleteMessage('[number]@c.us', ['msgid1', 'msgid2]);
      // Delete a message and delete media
      WPP.chat.deleteMessage('[number]@c.us', 'msgid', true);
      // Revoke a message
      WPP.chat.deleteMessage('[number]@c.us', 'msgid', true, true);
+

      Parameters

      • chatId: string | Wid
      • ids: string | string[]
      • deleteMediaInDevice: boolean = false
      • revoke: boolean = false

      Returns Promise<DeleteMessageReturn | DeleteMessageReturn[]>

      Example

      // Delete a message
      WPP.chat.deleteMessage('[number]@c.us', 'msgid');
      // Delete a list of messages
      WPP.chat.deleteMessage('[number]@c.us', ['msgid1', 'msgid2]);
      // Delete a message and delete media
      WPP.chat.deleteMessage('[number]@c.us', 'msgid', true);
      // Revoke a message
      WPP.chat.deleteMessage('[number]@c.us', 'msgid', true, true);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.editMessage.html b/functions/chat.editMessage.html index b8f8128b6f..79ccefcca8 100644 --- a/functions/chat.editMessage.html +++ b/functions/chat.editMessage.html @@ -1,9 +1,9 @@ editMessage | @wppconnect/wa-js - v3.10.1

    Function editMessage

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.forwardMessage.html b/functions/chat.forwardMessage.html index 60377e54f7..8d96e43971 100644 --- a/functions/chat.forwardMessage.html +++ b/functions/chat.forwardMessage.html @@ -1,6 +1,6 @@ forwardMessage | @wppconnect/wa-js - v3.10.1

    Function forwardMessage

    • forwardMessage(toChatId, msgId, options?): Promise<boolean>

    • Forward messages to a chat

      Parameters

      Returns Promise<boolean>

      Any

      -

      Example

      // Forward messages
      WPP.chat.forwardMessage('[number]@c.us', 'true_[number]@c.us_ABCDEF');
+
      Example
      // Forward messages
      WPP.chat.forwardMessage('[number]@c.us', 'true_[number]@c.us_ABCDEF');
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.getActiveChat.html b/functions/chat.getActiveChat.html index 02709899a8..d67d3ee366 100644 --- a/functions/chat.getActiveChat.html +++ b/functions/chat.getActiveChat.html @@ -1,6 +1,6 @@ getActiveChat | @wppconnect/wa-js - v3.10.1

    Function getActiveChat

    • getActiveChat(): undefined | ChatModel

    • Return the current active chat

      Returns undefined | ChatModel

      The currenct active chat or undefined for none

      -

      Example

      // Get active chat
      const chat = WPP.chat.getActiveChat();

      WPP.chat.sendTextMessage(chat.id, 'Hi');
+
      Example
      // Get active chat
      const chat = WPP.chat.getActiveChat();

      WPP.chat.sendTextMessage(chat.id, 'Hi');
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.getLastSeen.html b/functions/chat.getLastSeen.html index de7df6e1a6..377530eb17 100644 --- a/functions/chat.getLastSeen.html +++ b/functions/chat.getLastSeen.html @@ -1,5 +1,5 @@ getLastSeen | @wppconnect/wa-js - v3.10.1

    Function getLastSeen

    • getLastSeen(chatId): Promise<number | boolean>

    • Get timestamp of last seen

      -

      Parameters

      • chatId: string | Wid

      Returns Promise<number | boolean>

      Example

      WPP.chat.getLastSeen('[number]@c.us');
+

      Parameters

      • chatId: string | Wid

      Returns Promise<number | boolean>

      Example

      WPP.chat.getLastSeen('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.getMessageACK.html b/functions/chat.getMessageACK.html index 8b5f8bc96a..40acf4cb8e 100644 --- a/functions/chat.getMessageACK.html +++ b/functions/chat.getMessageACK.html @@ -1,6 +1,6 @@ getMessageACK | @wppconnect/wa-js - v3.10.1

    Function getMessageACK

    • getMessageACK(msgId): Promise<{
          ack: ACK;
          deliveryRemaining: number;
          fromMe: boolean;
          participants: ParticipantStatusACK[];
          playedRemaining: number;
          readRemaining: number;
      }>

    • Get message ACK from a message

      Parameters

      Returns Promise<{
          ack: ACK;
          deliveryRemaining: number;
          fromMe: boolean;
          participants: ParticipantStatusACK[];
          playedRemaining: number;
          readRemaining: number;
      }>

      Any

      -

      Example

      // Get message ACK
      const ackInfo = await WPP.chat.getMessageACK('true_[number]@c.us_ABCDEF');

      console.log(ackInfo.deliveryRemaining); // Delivery Remaining
      console.log(ackInfo.readRemaining); // Read Remaining
      console.log(ackInfo.playedRemaining); // PlayedRemaining, for audio(ptt) only

      console.log(ackInfo.participants[0].deliveredAt); // Delivered At, in timestamp format
      console.log(ackInfo.participants[0].readAt); // Read At, in timestamp format
      console.log(ackInfo.participants[0].playedAt); // Played At, in timestamp format, for audio(ptt) only

      //To get only how was received
      const received = ackInfo.participants.filter(p => p.deliveredAt || p.readAt || p.playedAt);

      //To get only how was read
      const read = ackInfo.participants.filter(p => p.readAt || p.playedAt);

      //To get only how was played
      const played = ackInfo.participants.filter(p => p.playedAt);
+
      Example
      // Get message ACK
      const ackInfo = await WPP.chat.getMessageACK('true_[number]@c.us_ABCDEF');

      console.log(ackInfo.deliveryRemaining); // Delivery Remaining
      console.log(ackInfo.readRemaining); // Read Remaining
      console.log(ackInfo.playedRemaining); // PlayedRemaining, for audio(ptt) only

      console.log(ackInfo.participants[0].deliveredAt); // Delivered At, in timestamp format
      console.log(ackInfo.participants[0].readAt); // Read At, in timestamp format
      console.log(ackInfo.participants[0].playedAt); // Played At, in timestamp format, for audio(ptt) only

      //To get only how was received
      const received = ackInfo.participants.filter(p => p.deliveredAt || p.readAt || p.playedAt);

      //To get only how was read
      const read = ackInfo.participants.filter(p => p.readAt || p.playedAt);

      //To get only how was played
      const played = ackInfo.participants.filter(p => p.playedAt);
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.getMessageById.html b/functions/chat.getMessageById.html index e1bc0309a9..393ec139cb 100644 --- a/functions/chat.getMessageById.html +++ b/functions/chat.getMessageById.html @@ -1,6 +1,6 @@ getMessageById | @wppconnect/wa-js - v3.10.1

    Function getMessageById

    Settings

    Member Visibility
    +
  • getMessageById(ids): Promise<MsgModel[]>

  • Parameters

    Returns Promise<MsgModel[]>

    • Settings

    Member Visibility
    diff --git a/functions/chat.getMessages.html b/functions/chat.getMessages.html index 908a737507..2450e05121 100644 --- a/functions/chat.getMessages.html +++ b/functions/chat.getMessages.html @@ -1,6 +1,6 @@ getMessages | @wppconnect/wa-js - v3.10.1

    Function getMessages

    • getMessages(chatId, options?): Promise<RawMessage[]>

    • Fetch messages from a chat

      Parameters

      Returns Promise<RawMessage[]>

      List of raw messages

      -

      Example

      // Some messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
      });

      // All messages
      WPP.chat.getMessages('[number]@c.us', {
        count: -1,
      });

      // Last 20 unread messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        onlyUnread: true,
      });

      // All unread messages
      WPP.chat.getMessages('[number]@c.us', {
        count: -1,
        onlyUnread: true,
      });

      // 20 messages before specific message
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        direction: 'before',
        id: '<full message id>'
      });

      // Only media messages (url, document and links)
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        media: 'all',
      });

      // Only image messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        media: 'image',
      });

      // Only document messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        media: 'document',
      });

      // Only link (url) messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        media: 'url',
      });
+
      Example
      // Some messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
      });

      // All messages
      WPP.chat.getMessages('[number]@c.us', {
        count: -1,
      });

      // Last 20 unread messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        onlyUnread: true,
      });

      // All unread messages
      WPP.chat.getMessages('[number]@c.us', {
        count: -1,
        onlyUnread: true,
      });

      // 20 messages before specific message
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        direction: 'before',
        id: '<full message id>'
      });

      // Only media messages (url, document and links)
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        media: 'all',
      });

      // Only image messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        media: 'image',
      });

      // Only document messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        media: 'document',
      });

      // Only link (url) messages
      WPP.chat.getMessages('[number]@c.us', {
        count: 20,
        media: 'url',
      });
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.getPlatformFromMessage.html b/functions/chat.getPlatformFromMessage.html index 2be4950b6b..4789be042f 100644 --- a/functions/chat.getPlatformFromMessage.html +++ b/functions/chat.getPlatformFromMessage.html @@ -6,7 +6,7 @@
  • web
  • unknown
    • -

    Parameters

    • messageId:
          | string
          | MsgModel
          | MsgKey
          | Stringable

    Returns
        | "android"
        | "iphone"
        | "web"
        | "unknown"

    Example

    // to get platform from a message
    const platform = WPP.chat.getPlatformFromMessage('[message_id]');
+

    Parameters

    • messageId:
          | string
          | MsgModel
          | MsgKey
          | Stringable

    Returns
        | "android"
        | "iphone"
        | "web"
        | "unknown"

    Example

    // to get platform from a message
    const platform = WPP.chat.getPlatformFromMessage('[message_id]');
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.getReactions.html b/functions/chat.getReactions.html index 4d86c55b06..ace8c54241 100644 --- a/functions/chat.getReactions.html +++ b/functions/chat.getReactions.html @@ -1,5 +1,5 @@ getReactions | @wppconnect/wa-js - v3.10.1

    Function getReactions

    • getReactions(msgId): Promise<{
          reactionByMe: {
              id: MsgKey;
              msgId: MsgKey;
              orphan: number;
              reactionText: string;
              read: boolean;
              senderUserJid: string;
              timestamp: number;
          };
          reactions: {
              aggregateEmoji: string;
              hasReactionByMe: boolean;
              senders: {
                  id: MsgKey;
                  msgId: MsgKey;
                  orphan: number;
                  reactionText: string;
                  read: boolean;
                  senderUserJid: string;
                  timestamp: number;
              }[];
          }[];
      }>

    • Get all reactions in a message

      -

      Parameters

      • msgId: string

      Returns Promise<{
          reactionByMe: {
              id: MsgKey;
              msgId: MsgKey;
              orphan: number;
              reactionText: string;
              read: boolean;
              senderUserJid: string;
              timestamp: number;
          };
          reactions: {
              aggregateEmoji: string;
              hasReactionByMe: boolean;
              senders: {
                  id: MsgKey;
                  msgId: MsgKey;
                  orphan: number;
                  reactionText: string;
                  read: boolean;
                  senderUserJid: string;
                  timestamp: number;
              }[];
          }[];
      }>

      Example

      WPP.chat.getReactions('true_[number]@c.us_ABCDEF');
+

      Parameters

      • msgId: string

      Returns Promise<{
          reactionByMe: {
              id: MsgKey;
              msgId: MsgKey;
              orphan: number;
              reactionText: string;
              read: boolean;
              senderUserJid: string;
              timestamp: number;
          };
          reactions: {
              aggregateEmoji: string;
              hasReactionByMe: boolean;
              senders: {
                  id: MsgKey;
                  msgId: MsgKey;
                  orphan: number;
                  reactionText: string;
                  read: boolean;
                  senderUserJid: string;
                  timestamp: number;
              }[];
          }[];
      }>

      Example

      WPP.chat.getReactions('true_[number]@c.us_ABCDEF');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.getVotes.html b/functions/chat.getVotes.html index ea2813f6b2..a75bde58f5 100644 --- a/functions/chat.getVotes.html +++ b/functions/chat.getVotes.html @@ -1,5 +1,5 @@ getVotes | @wppconnect/wa-js - v3.10.1

    Function getVotes

    • getVotes(id): Promise<{
          chatId: Wid;
          msgId: MsgKey;
          votes: {
              selectedOptions: number[];
              sender: Wid;
              timestamp: number;
          }[];
      }>

    • Get votes of a poll

      -

      Parameters

      Returns Promise<{
          chatId: Wid;
          msgId: MsgKey;
          votes: {
              selectedOptions: number[];
              sender: Wid;
              timestamp: number;
          }[];
      }>

      Example

      WPP.chat.getVotes('true_[number]@c.us_ABCDEF');
+

      Parameters

      Returns Promise<{
          chatId: Wid;
          msgId: MsgKey;
          votes: {
              selectedOptions: number[];
              sender: Wid;
              timestamp: number;
          }[];
      }>

      Example

      WPP.chat.getVotes('true_[number]@c.us_ABCDEF');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.keepMessage.html b/functions/chat.keepMessage.html index 522ba7ae1d..08e4d66380 100644 --- a/functions/chat.keepMessage.html +++ b/functions/chat.keepMessage.html @@ -1,5 +1,5 @@ keepMessage | @wppconnect/wa-js - v3.10.1

    Function keepMessage

    • keepMessage(msgId, value?): Promise<MsgModel>

    • Keep or unkeep a message in a group chat with expiration

      -

      Parameters

      • msgId: string | MsgKey
      • value: boolean = true

      Returns Promise<MsgModel>

      Example

      // To keep a message in chat
      WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', true);

      // To unkeep a message in chat
      WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', false);
+

      Parameters

      • msgId: string | MsgKey
      • value: boolean = true

      Returns Promise<MsgModel>

      Example

      // To keep a message in chat
      WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', true);

      // To unkeep a message in chat
      WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.list.html b/functions/chat.list.html index 8cf42ad2bb..041378b08d 100644 --- a/functions/chat.list.html +++ b/functions/chat.list.html @@ -1,5 +1,5 @@ list | @wppconnect/wa-js - v3.10.1

    Function list

    • list(options?): Promise<ChatModel[]>

    • Return a list of chats

      -

      Parameters

      Returns Promise<ChatModel[]>

      Example

      // All chats
      const chats = await WPP.chat.list();

      // Some chats
      const chats = WPP.chat.list({count: 20});

      // 20 chats before specific chat
      const chats = WPP.chat.list({count: 20, direction: 'before', id: '[number]@c.us'});

      // Only users chats
      const chats = await WPP.chat.list({onlyUsers: true});

      // Only groups chats
      const chats = await WPP.chat.list({onlyGroups: true});

      // Only communities chats
      const chats = await WPP.chat.list({onlyCommunities: true});

      // Only Newsletter
      const chats = await WPP.chat.list({onlyNewsletter: true});

      // Only with label Text
      const chats = await WPP.chat.list({withLabels: ['Test']});

      // Only with label id
      const chats = await WPP.chat.list({withLabels: ['1']});

      // Only with label with one of text or id
      const chats = await WPP.chat.list({withLabels: ['Alfa','5']});
+

      Parameters

      Returns Promise<ChatModel[]>

      Example

      // All chats
      const chats = await WPP.chat.list();

      // Some chats
      const chats = WPP.chat.list({count: 20});

      // 20 chats before specific chat
      const chats = WPP.chat.list({count: 20, direction: 'before', id: '[number]@c.us'});

      // Only users chats
      const chats = await WPP.chat.list({onlyUsers: true});

      // Only groups chats
      const chats = await WPP.chat.list({onlyGroups: true});

      // Only communities chats
      const chats = await WPP.chat.list({onlyCommunities: true});

      // Only Newsletter
      const chats = await WPP.chat.list({onlyNewsletter: true});

      // Only with label Text
      const chats = await WPP.chat.list({withLabels: ['Test']});

      // Only with label id
      const chats = await WPP.chat.list({withLabels: ['1']});

      // Only with label with one of text or id
      const chats = await WPP.chat.list({withLabels: ['Alfa','5']});
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.markIsComposing.html b/functions/chat.markIsComposing.html index e8f7f6557e..570fd1a81e 100644 --- a/functions/chat.markIsComposing.html +++ b/functions/chat.markIsComposing.html @@ -1,6 +1,6 @@ markIsComposing | @wppconnect/wa-js - v3.10.1

    Function markIsComposing

    • markIsComposing(chatId, duration?): Promise<void>

    • Mark a chat to composing state and keep sending "is writting a message"

      -

      Parameters

      • chatId: string | Wid
      • Optionalduration: number

      Returns Promise<void>

      Example

      // Mark is composing
      WPP.chat.markIsComposing('[number]@c.us');

      // Mark is composing for 5 seconds
      WPP.chat.markIsComposing('[number]@c.us', 5000);
+

      Parameters

      • chatId: string | Wid
      • Optionalduration: number

      Returns Promise<void>

      Example

      // Mark is composing
      WPP.chat.markIsComposing('[number]@c.us');

      // Mark is composing for 5 seconds
      WPP.chat.markIsComposing('[number]@c.us', 5000);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.markIsPaused.html b/functions/chat.markIsPaused.html index 3cfe12a98f..64f02ade72 100644 --- a/functions/chat.markIsPaused.html +++ b/functions/chat.markIsPaused.html @@ -1,5 +1,5 @@ markIsPaused | @wppconnect/wa-js - v3.10.1

    Function markIsPaused

    • markIsPaused(chatId): Promise<void>

    • Mark a chat is paused state

      -

      Parameters

      • chatId: string | Wid

      Returns Promise<void>

      Example

      // Mark as recording
      WPP.chat.markIsPaused('[number]@c.us');
+

      Parameters

      • chatId: string | Wid

      Returns Promise<void>

      Example

      // Mark as recording
      WPP.chat.markIsPaused('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.markIsRead.html b/functions/chat.markIsRead.html index 5a84b47289..834d4be7c3 100644 --- a/functions/chat.markIsRead.html +++ b/functions/chat.markIsRead.html @@ -1,5 +1,5 @@ markIsRead | @wppconnect/wa-js - v3.10.1

    Function markIsRead

    • markIsRead(chatId): Promise<{
          unreadCount: number;
          wid: Wid;
      }>

    • Mark a chat as read and send SEEN event

      -

      Parameters

      • chatId: string | Wid

      Returns Promise<{
          unreadCount: number;
          wid: Wid;
      }>

      Example

      // Some messages
      WPP.chat.markIsRead('[number]@c.us');
+

      Parameters

      • chatId: string | Wid

      Returns Promise<{
          unreadCount: number;
          wid: Wid;
      }>

      Example

      // Some messages
      WPP.chat.markIsRead('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.markIsRecording.html b/functions/chat.markIsRecording.html index 8424d76c8c..feee31dc6d 100644 --- a/functions/chat.markIsRecording.html +++ b/functions/chat.markIsRecording.html @@ -1,6 +1,6 @@ markIsRecording | @wppconnect/wa-js - v3.10.1

    Function markIsRecording

    • markIsRecording(chatId, duration?): Promise<void>

    • Mark a chat to recording state and keep sending "is recording"

      -

      Parameters

      • chatId: string | Wid
      • Optionalduration: number

      Returns Promise<void>

      Example

      // Mark is recording
      WPP.chat.markIsRecording('[number]@c.us');

      // Mark is recording for 5 seconds
      WPP.chat.markIsRecording('[number]@c.us', 5000);
+

      Parameters

      • chatId: string | Wid
      • Optionalduration: number

      Returns Promise<void>

      Example

      // Mark is recording
      WPP.chat.markIsRecording('[number]@c.us');

      // Mark is recording for 5 seconds
      WPP.chat.markIsRecording('[number]@c.us', 5000);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.markIsUnread.html b/functions/chat.markIsUnread.html index bcd9647c0e..256dbd7e5b 100644 --- a/functions/chat.markIsUnread.html +++ b/functions/chat.markIsUnread.html @@ -1,5 +1,5 @@ markIsUnread | @wppconnect/wa-js - v3.10.1

    Function markIsUnread

    • markIsUnread(chatId): Promise<{
          wid: Wid;
      }>

    • Mark a chat as unread

      -

      Parameters

      • chatId: string | Wid

      Returns Promise<{
          wid: Wid;
      }>

      Example

      // Some messages
      WPP.chat.markIsUnread('[number]@c.us');
+

      Parameters

      • chatId: string | Wid

      Returns Promise<{
          wid: Wid;
      }>

      Example

      // Some messages
      WPP.chat.markIsUnread('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.markPlayed.html b/functions/chat.markPlayed.html index 898be233e2..6dd1fcb187 100644 --- a/functions/chat.markPlayed.html +++ b/functions/chat.markPlayed.html @@ -1,5 +1,5 @@ markPlayed | @wppconnect/wa-js - v3.10.1

    Function markPlayed

    • markPlayed(messageId): Promise<any>

    • Mark message as played

      -

      Parameters

      • messageId:
            | string
            | MsgModel
            | MsgKey
            | Stringable

      Returns Promise<any>

      Example

      WPP.chat.markPlayed('[message_id]');
+

      Parameters

      • messageId:
            | string
            | MsgModel
            | MsgKey
            | Stringable

      Returns Promise<any>

      Example

      WPP.chat.markPlayed('[message_id]');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.mute.html b/functions/chat.mute.html index 37a76b7c82..834d3d350e 100644 --- a/functions/chat.mute.html +++ b/functions/chat.mute.html @@ -1,7 +1,7 @@ mute | @wppconnect/wa-js - v3.10.1

    Function mute

    • mute(chatId, time): Promise<{
          expiration: number;
          isMuted: boolean;
          wid: Wid;
      }>

    • Mute a chat, you can use duration or expiration For expiration, use unix timestamp (seconds only) For duration, use seconds

      -

      Parameters

      • chatId: string | Wid
      • time: {
            expiration: number | Date;
        } | {
            duration: number;
        }

      Returns Promise<{
          expiration: number;
          isMuted: boolean;
          wid: Wid;
      }>

      Example

      // Mute for 60 seconds
      WPP.chat.mute('[number]@c.us', {duration: 60});

      // Mute util 2021-01-01
      WPP.chat.mute('[number]@c.us', {expiration: 1641006000});

      // or using date
      const expiration = new Date('2022-01-01 00:00:00');
      WPP.chat.mute('[number]@c.us', {expiration: expiration});
+

      Parameters

      • chatId: string | Wid
      • time: {
            expiration: number | Date;
        } | {
            duration: number;
        }

      Returns Promise<{
          expiration: number;
          isMuted: boolean;
          wid: Wid;
      }>

      Example

      // Mute for 60 seconds
      WPP.chat.mute('[number]@c.us', {duration: 60});

      // Mute util 2021-01-01
      WPP.chat.mute('[number]@c.us', {expiration: 1641006000});

      // or using date
      const expiration = new Date('2022-01-01 00:00:00');
      WPP.chat.mute('[number]@c.us', {expiration: expiration});
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.openChatAt.html b/functions/chat.openChatAt.html index ba8849bce1..fae659eec9 100644 --- a/functions/chat.openChatAt.html +++ b/functions/chat.openChatAt.html @@ -1,5 +1,5 @@ openChatAt | @wppconnect/wa-js - v3.10.1

    Function openChatAt

    • openChatAt(chatId, messageId): Promise<boolean>

    • Open the chat in the WhatsApp interface in a specific message

      -

      Parameters

      • chatId: string | Wid
      • messageId: string

      Returns Promise<boolean>

      Example

      await WPP.chat.openChatAt('[number]@c.us', <message_id>);
+

      Parameters

      • chatId: string | Wid
      • messageId: string

      Returns Promise<boolean>

      Example

      await WPP.chat.openChatAt('[number]@c.us', <message_id>);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.openChatBottom.html b/functions/chat.openChatBottom.html index 175a14d1e1..406ab475e4 100644 --- a/functions/chat.openChatBottom.html +++ b/functions/chat.openChatBottom.html @@ -1,5 +1,5 @@ openChatBottom | @wppconnect/wa-js - v3.10.1

    Function openChatBottom

    • openChatBottom(chatId): Promise<boolean>

    • Open the chat in the WhatsApp interface in bottom position

      -

      Parameters

      • chatId: string | Wid

      Returns Promise<boolean>

      Example

      await WPP.chat.openChatBottom('[number]@c.us');
+

      Parameters

      • chatId: string | Wid

      Returns Promise<boolean>

      Example

      await WPP.chat.openChatBottom('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.openChatFromUnread.html b/functions/chat.openChatFromUnread.html index 6a0960de45..cb13edf58e 100644 --- a/functions/chat.openChatFromUnread.html +++ b/functions/chat.openChatFromUnread.html @@ -1,5 +1,5 @@ openChatFromUnread | @wppconnect/wa-js - v3.10.1

    Function openChatFromUnread

    • openChatFromUnread(chatId): Promise<boolean>

    • Open the chat in the WhatsApp interface from first unread message

      -

      Parameters

      • chatId: string | Wid

      Returns Promise<boolean>

      Example

      await WPP.chat.openChatFromUnread('[number]@c.us');
+

      Parameters

      • chatId: string | Wid

      Returns Promise<boolean>

      Example

      await WPP.chat.openChatFromUnread('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.pin.html b/functions/chat.pin.html index 8dabd7b8cf..6efead91b9 100644 --- a/functions/chat.pin.html +++ b/functions/chat.pin.html @@ -1,5 +1,5 @@ pin | @wppconnect/wa-js - v3.10.1

    Function pin

    • pin(chatId, pin?): Promise<{
          pin: boolean;
          wid: Wid;
      }>

    • Pin a chat

      -

      Parameters

      • chatId: string | Wid
      • pin: boolean = true

      Returns Promise<{
          pin: boolean;
          wid: Wid;
      }>

      Example

      // Pin a chat
      WPP.chat.pin('[number]@c.us');

      // Unpin a chat
      WPP.chat.pin('[number]@c.us', false);
      // or
      WPP.chat.unpin('[number]@c.us');
+

      Parameters

      • chatId: string | Wid
      • pin: boolean = true

      Returns Promise<{
          pin: boolean;
          wid: Wid;
      }>

      Example

      // Pin a chat
      WPP.chat.pin('[number]@c.us');

      // Unpin a chat
      WPP.chat.pin('[number]@c.us', false);
      // or
      WPP.chat.unpin('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.pinMsg.html b/functions/chat.pinMsg.html index 5467b6ae6d..1688e89a47 100644 --- a/functions/chat.pinMsg.html +++ b/functions/chat.pinMsg.html @@ -1,5 +1,5 @@ pinMsg | @wppconnect/wa-js - v3.10.1

    Function pinMsg

    • pinMsg(msgId, pin?, seconds?): Promise<{
          message: MsgModel;
          pinned: boolean;
          result: SendMsgResult;
      }>

    • Pin a message in chat

      -

      Parameters

      • msgId: string | MsgKey
      • pin: boolean = true
      • seconds: number = 604800

      Returns Promise<{
          message: MsgModel;
          pinned: boolean;
          result: SendMsgResult;
      }>

      Example

      // Pin a message in chat
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF');

      // Pin a message in chat for 30 days
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', 2592000);

      // Unpin a message
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
      // or
      WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');
+

      Parameters

      • msgId: string | MsgKey
      • pin: boolean = true
      • seconds: number = 604800

      Returns Promise<{
          message: MsgModel;
          pinned: boolean;
          result: SendMsgResult;
      }>

      Example

      // Pin a message in chat
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF');

      // Pin a message in chat for 30 days
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', 2592000);

      // Unpin a message
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
      // or
      WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.requestPhoneNumber.html b/functions/chat.requestPhoneNumber.html index 62bf3ed217..9d08a75c15 100644 --- a/functions/chat.requestPhoneNumber.html +++ b/functions/chat.requestPhoneNumber.html @@ -1,5 +1,5 @@ requestPhoneNumber | @wppconnect/wa-js - v3.10.1

    Function requestPhoneNumber

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendChargeMessage.html b/functions/chat.sendChargeMessage.html index 375bcbbebf..888e74099a 100644 --- a/functions/chat.sendChargeMessage.html +++ b/functions/chat.sendChargeMessage.html @@ -1,6 +1,6 @@ sendChargeMessage | @wppconnect/wa-js - v3.10.1

    Function sendChargeMessage

    • sendChargeMessage(chatId, items, options?): Promise<SendMessageReturn>

    • Send a order message To send (prices, tax, shipping or discount), for example: USD 12.90, send them without dots or commas, like: 12900

      -

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      // Send charge with a product
      WPP.chat.sendChargeMessage('[number]@c.us', [
        { type: 'product', id: '67689897878', qnt: 2 },
        { type: 'product', id: '37878774457', qnt: 1 },
      ]

      // Send charge with a custom item
      WPP.chat.sendChargeMessage('[number]@c.us', [
        { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
      ]

      // Send charge with custom options
      WPP.chat.sendChargeMessage('[number]@c.us', [
        { type: 'product', id: '37878774457', qnt: 1 },
        { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
      ],
      { tax: 10000, shipping: 4000, discount: 10000 }

      // Send charge with Pix data (auto generate copy-paste pix code)
      WPP.chat.sendChargeMessage('[number]@c.us', [
        { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
      ],
      {
        tax: 10000,
        shipping: 4000,
        discount: 10000,
        pix: {
          keyType: 'CPF',
          key: '00555095999',
          name: 'Name of seller',
        },
      });
+

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      // Send charge with a product
      WPP.chat.sendChargeMessage('[number]@c.us', [
        { type: 'product', id: '67689897878', qnt: 2 },
        { type: 'product', id: '37878774457', qnt: 1 },
      ]

      // Send charge with a custom item
      WPP.chat.sendChargeMessage('[number]@c.us', [
        { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
      ]

      // Send charge with custom options
      WPP.chat.sendChargeMessage('[number]@c.us', [
        { type: 'product', id: '37878774457', qnt: 1 },
        { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
      ],
      { tax: 10000, shipping: 4000, discount: 10000 }

      // Send charge with Pix data (auto generate copy-paste pix code)
      WPP.chat.sendChargeMessage('[number]@c.us', [
        { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
      ],
      {
        tax: 10000,
        shipping: 4000,
        discount: 10000,
        pix: {
          keyType: 'CPF',
          key: '00555095999',
          name: 'Name of seller',
        },
      });
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendCreatePollMessage.html b/functions/chat.sendCreatePollMessage.html index 8c4e5ca273..5f2f90c471 100644 --- a/functions/chat.sendCreatePollMessage.html +++ b/functions/chat.sendCreatePollMessage.html @@ -1,10 +1,10 @@ sendCreatePollMessage | @wppconnect/wa-js - v3.10.1

    Function sendCreatePollMessage

    • sendCreatePollMessage(chatId, name, choices, options?): Promise<SendMessageReturn>

    • Send a create poll message

      Note: This only works for groups

      -

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      // Single pool
      WPP.chat.sendCreatePollMessage(
       '[number]@g.us',
       'A poll name',
       ['Option 1', 'Option 2', 'Option 3']
      );
+

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      // Single pool
      WPP.chat.sendCreatePollMessage(
       '[number]@g.us',
       'A poll name',
       ['Option 1', 'Option 2', 'Option 3']
      );

      // Selectable Count

      // Single pool
      WPP.chat.sendCreatePollMessage(
       '[number]@g.us',
       'A poll name',
       ['Option 1', 'Option 2', 'Option 3'],
       {
         selectableCount: 1,
       }
      );
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendFileMessage.html b/functions/chat.sendFileMessage.html index c1c8ecf735..0d36ec8741 100644 --- a/functions/chat.sendFileMessage.html +++ b/functions/chat.sendFileMessage.html @@ -1,6 +1,6 @@ sendFileMessage | @wppconnect/wa-js - v3.10.1

    Function sendFileMessage

    • sendFileMessage(chatId, content, options): Promise<SendMessageReturn>

    • Send a file message, that can be an audio, document, image, sticker or video

      Parameters

      Returns Promise<SendMessageReturn>

      The result

      -

      Example

      // Single document
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:application/msword;base64,<a long base64 file...>',
       {
         type: 'document',
         caption: 'My document', // Optional
         filename: 'myfile.doc', // Optional
         mimetype: 'application/msword' // Optional
       }
      );

      // Image with view once
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:image/jpeg;base64,<a long base64 file...>',
       {
         type: 'image',
         caption: 'My image', // Optional
         isViewOnce: true
       }
      );

      // PTT audio
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:audio/mp3;base64,<a long base64 file...>',
       {
         type: 'audio',
         isPtt: true // false for common audio
       }
      );

      // Image with view buttons
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:image/jpeg;base64,<a long base64 file...>',
       {
         type: 'image',
         caption: 'My image'
         buttons: [
           {
             id: 'your custom id 1',
             text: 'Some text'
           },
           {
             id: 'another id 2',
             text: 'Another text'
           }
         ],
         footer: 'Footer text' // Optional
       }
      );

      // Image as Sticker
      WPP.chat.sendFileMessage(
        '[number]@c.us',
        'data:image/png;base64,<a long base64 file...>',
        {
          type: 'sticker'
        }
      );

      // A simple video
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:application/msword;base64,<a long base64 file...>',
       {
         type: 'video',
       }
      );

      // A PTV Video (micro video)
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:application/msword;base64,<a long base64 file...>',
       {
         type: 'video',
         isPtv: true,
       }
      );
+
      Example
      // Single document
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:application/msword;base64,<a long base64 file...>',
       {
         type: 'document',
         caption: 'My document', // Optional
         filename: 'myfile.doc', // Optional
         mimetype: 'application/msword' // Optional
       }
      );

      // Image with view once
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:image/jpeg;base64,<a long base64 file...>',
       {
         type: 'image',
         caption: 'My image', // Optional
         isViewOnce: true
       }
      );

      // PTT audio
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:audio/mp3;base64,<a long base64 file...>',
       {
         type: 'audio',
         isPtt: true // false for common audio
       }
      );

      // Image with view buttons
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:image/jpeg;base64,<a long base64 file...>',
       {
         type: 'image',
         caption: 'My image'
         buttons: [
           {
             id: 'your custom id 1',
             text: 'Some text'
           },
           {
             id: 'another id 2',
             text: 'Another text'
           }
         ],
         footer: 'Footer text' // Optional
       }
      );

      // Image as Sticker
      WPP.chat.sendFileMessage(
        '[number]@c.us',
        'data:image/png;base64,<a long base64 file...>',
        {
          type: 'sticker'
        }
      );

      // A simple video
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:application/msword;base64,<a long base64 file...>',
       {
         type: 'video',
       }
      );

      // A PTV Video (micro video)
      WPP.chat.sendFileMessage(
       '[number]@c.us',
       'data:application/msword;base64,<a long base64 file...>',
       {
         type: 'video',
         isPtv: true,
       }
      );
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendGroupInviteMessage.html b/functions/chat.sendGroupInviteMessage.html index dba0e888af..5299e7f86c 100644 --- a/functions/chat.sendGroupInviteMessage.html +++ b/functions/chat.sendGroupInviteMessage.html @@ -1,5 +1,5 @@ sendGroupInviteMessage | @wppconnect/wa-js - v3.10.1

    Function sendGroupInviteMessage

    • sendGroupInviteMessage(chatId, options): Promise<SendMessageReturn>

    • Send a group invite message

      -

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      WPP.chat.sendGroupInviteMessage(
       '[number]@c.us',
       {
         inviteCode: '123',
         groupId: '789@g.us'
       }
      );

      // After a invite
      const result = await WPP.group.addParticipants('789@g.us', '123@c.us');
      const participant = result['123@c.us'];
      if (participant.invite_code) {
        WPP.chat.sendGroupInviteMessage(
          '123@c.us',
          {
            inviteCode: participant.invite_code,
            inviteCodeExpiration: participant.invite_code_exp,
            groupId: '789@g.us'
          }
        );
      }
+

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      WPP.chat.sendGroupInviteMessage(
       '[number]@c.us',
       {
         inviteCode: '123',
         groupId: '789@g.us'
       }
      );

      // After a invite
      const result = await WPP.group.addParticipants('789@g.us', '123@c.us');
      const participant = result['123@c.us'];
      if (participant.invite_code) {
        WPP.chat.sendGroupInviteMessage(
          '123@c.us',
          {
            inviteCode: participant.invite_code,
            inviteCodeExpiration: participant.invite_code_exp,
            groupId: '789@g.us'
          }
        );
      }
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendListMessage.html b/functions/chat.sendListMessage.html index 9fc5233fa7..7766de5810 100644 --- a/functions/chat.sendListMessage.html +++ b/functions/chat.sendListMessage.html @@ -1,5 +1,5 @@ sendListMessage | @wppconnect/wa-js - v3.10.1

    Function sendListMessage

    • sendListMessage(chatId, options): Promise<SendMessageReturn>

    • Send a list message

      -

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      WPP.chat.sendListMessage('[number]@c.us', {
        buttonText: 'Click Me!', //required
        description: "Hello it's list message", //required
        title: 'Hello user', //optional
        footer: 'Click and choose one', //optional
        sections: [{
          title: 'Section 1',
          rows: [{
            rowId: 'rowid1',
            title: 'Row 1',
            description: "Hello it's description 1",
          },{
            rowId: 'rowid2',
            title: 'Row 2',
            description: "Hello it's description 2",
          }]
        }]
      });
+

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      WPP.chat.sendListMessage('[number]@c.us', {
        buttonText: 'Click Me!', //required
        description: "Hello it's list message", //required
        title: 'Hello user', //optional
        footer: 'Click and choose one', //optional
        sections: [{
          title: 'Section 1',
          rows: [{
            rowId: 'rowid1',
            title: 'Row 1',
            description: "Hello it's description 1",
          },{
            rowId: 'rowid2',
            title: 'Row 2',
            description: "Hello it's description 2",
          }]
        }]
      });
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendLocationMessage.html b/functions/chat.sendLocationMessage.html index 62ecc8da05..ca91cc2c04 100644 --- a/functions/chat.sendLocationMessage.html +++ b/functions/chat.sendLocationMessage.html @@ -1,5 +1,5 @@ sendLocationMessage | @wppconnect/wa-js - v3.10.1

    Function sendLocationMessage

    • sendLocationMessage(chatId, options): Promise<SendMessageReturn>

    • Send a location message

      -

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      // full example
      WPP.chat.sendLocationMessage('[number]@c.us', {
       lat: -22.95201,
       lng: -43.2102601,
       name: 'Cristo Rendentor', // optional
       address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ', // optional
       url: 'https://santuariocristoredentor.com.br/' // optional
      });

      // minimal
      WPP.chat.sendLocationMessage('[number]@c.us', {
       lat: -22.95201,
       lng: -43.2102601,
      });

      // name and address
      WPP.chat.sendLocationMessage('[number]@c.us', {
       lat: -22.95201,
       lng: -43.2102601,
       name: 'Cristo Rendentor',
       address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ'
      });

      // with buttons
      WPP.chat.sendLocationMessage('[number]@c.us', {
       lat: -22.95201,
       lng: -43.2102601,
       name: 'Cristo Rendentor',
       address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ',
       buttons: [
           {
               url: 'https://example.test/',
               text: 'URL example'
           },
           {
               phoneNumber: '+55 12 3456 7777',
               text: 'Phone Number'
           },
           {
               id: 'id1',
               text: 'First'
           },
           {
               id: 'id2',
               text: 'Second'
           },
           {
               id: 'other',
               text: 'Other'
           }
       ],
      });
+

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      // full example
      WPP.chat.sendLocationMessage('[number]@c.us', {
       lat: -22.95201,
       lng: -43.2102601,
       name: 'Cristo Rendentor', // optional
       address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ', // optional
       url: 'https://santuariocristoredentor.com.br/' // optional
      });

      // minimal
      WPP.chat.sendLocationMessage('[number]@c.us', {
       lat: -22.95201,
       lng: -43.2102601,
      });

      // name and address
      WPP.chat.sendLocationMessage('[number]@c.us', {
       lat: -22.95201,
       lng: -43.2102601,
       name: 'Cristo Rendentor',
       address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ'
      });

      // with buttons
      WPP.chat.sendLocationMessage('[number]@c.us', {
       lat: -22.95201,
       lng: -43.2102601,
       name: 'Cristo Rendentor',
       address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ',
       buttons: [
           {
               url: 'https://example.test/',
               text: 'URL example'
           },
           {
               phoneNumber: '+55 12 3456 7777',
               text: 'Phone Number'
           },
           {
               id: 'id1',
               text: 'First'
           },
           {
               id: 'id2',
               text: 'Second'
           },
           {
               id: 'other',
               text: 'Other'
           }
       ],
      });
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendPixKeyMessage.html b/functions/chat.sendPixKeyMessage.html index 3cfd42e0f7..7165653263 100644 --- a/functions/chat.sendPixKeyMessage.html +++ b/functions/chat.sendPixKeyMessage.html @@ -1,6 +1,6 @@ sendPixKeyMessage | @wppconnect/wa-js - v3.10.1

    Function sendPixKeyMessage

    • sendPixKeyMessage(chatId, params, options?): Promise<SendMessageReturn>

    • Send a invoice message To send (prices, tax, shipping or discount), for example: USD 12.90, send them without dots or commas, like: 12900

      -

      Parameters

      • chatId: any
      • params: {
            instructions?: string;
            key: string;
            keyType:
                | "CNPJ"
                | "CPF"
                | "PHONE"
                | "EMAIL"
                | "EVP";
            name: string;
        }
        • Optionalinstructions?: string
        • key: string
        • keyType:
              | "CNPJ"
              | "CPF"
              | "PHONE"
              | "EMAIL"
              | "EVP"
        • name: string
      • Optionaloptions: SendMessageOptions

      Returns Promise<SendMessageReturn>

      Example

      // Send PIX Key Message (Brazil Pix Key)
      WPP.chat.sendPixKeyMessage('[number]@c.us', {
          keyType: 'CNPJ',
          name: 'WPPCONNECT-TEAM',
          key: '33460516000178',
          instructions: 'Pay text for instructions here',
      });
      
+

      Parameters

      • chatId: any
      • params: {
            instructions?: string;
            key: string;
            keyType:
                | "CNPJ"
                | "CPF"
                | "PHONE"
                | "EMAIL"
                | "EVP";
            name: string;
        }
        • Optionalinstructions?: string
        • key: string
        • keyType:
              | "CNPJ"
              | "CPF"
              | "PHONE"
              | "EMAIL"
              | "EVP"
        • name: string
      • Optionaloptions: SendMessageOptions

      Returns Promise<SendMessageReturn>

      Example

      // Send PIX Key Message (Brazil Pix Key)
      WPP.chat.sendPixKeyMessage('[number]@c.us', {
          keyType: 'CNPJ',
          name: 'WPPCONNECT-TEAM',
          key: '33460516000178',
          instructions: 'Pay text for instructions here',
      });
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendReactionToMessage.html b/functions/chat.sendReactionToMessage.html index 1c43d2f679..34b100de01 100644 --- a/functions/chat.sendReactionToMessage.html +++ b/functions/chat.sendReactionToMessage.html @@ -1,6 +1,6 @@ sendReactionToMessage | @wppconnect/wa-js - v3.10.1

    Function sendReactionToMessage

    • sendReactionToMessage(messageId, reaction): Promise<{
          sendMsgResult: string;
      }>

    • Send a reaction to a message

      Full Emoji List: https://unicode.org/emoji/charts/full-emoji-list.html

      -

      Parameters

      • messageId:
            | string
            | MsgModel
            | MsgKey
            | Stringable
      • reaction: null | string | false

      Returns Promise<{
          sendMsgResult: string;
      }>

      Example

      // to react a message
      WPP.chat.sendReactionToMessage('[message_id]', '🤯');

      // to remove
      WPP.chat.sendReactionToMessage('[message_id]', false);
      
+

      Parameters

      • messageId:
            | string
            | MsgModel
            | MsgKey
            | Stringable
      • reaction: null | string | false

      Returns Promise<{
          sendMsgResult: string;
      }>

      Example

      // to react a message
      WPP.chat.sendReactionToMessage('[message_id]', '🤯');

      // to remove
      WPP.chat.sendReactionToMessage('[message_id]', false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendScheduledCallMessage.html b/functions/chat.sendScheduledCallMessage.html index 971469bbf7..71aefca20f 100644 --- a/functions/chat.sendScheduledCallMessage.html +++ b/functions/chat.sendScheduledCallMessage.html @@ -1,5 +1,5 @@ sendScheduledCallMessage | @wppconnect/wa-js - v3.10.1

    Function sendScheduledCallMessage

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendTextMessage.html b/functions/chat.sendTextMessage.html index 098dc05a92..399208f4ca 100644 --- a/functions/chat.sendTextMessage.html +++ b/functions/chat.sendTextMessage.html @@ -1,5 +1,5 @@ sendTextMessage | @wppconnect/wa-js - v3.10.1

    Function sendTextMessage

    • sendTextMessage(chatId, content, options?): Promise<SendMessageReturn>

    • Send a text message

      -

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
        createChat: true
      });

      // With Buttons
      // Attention: The buttons are an alternative solution we found to make it work. There is no guarantee that they will continue functioning, or when they might stop: The only certainty is: They will stop, so use them responsibly.
      WPP.chat.sendTextMessage('[number]@c.us', 'Hello', {
        useInteractiveMessage: true, // False for legacy
        buttons: [
          {
            url: 'https://wppconnect.io/',
            text: 'WPPConnect Site'
          },
          {
            phoneNumber: '+55 11 22334455',
            text: 'Call me'
          },
          {
            id: 'your custom id 1',
            text: 'Some text'
          },
          {
            code: '789890',
            text: 'Another text'
          }
        ],
        title: 'Title text', // Optional
        footer: 'Footer text' // Optional
      });
+

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
        createChat: true
      });

      // With Buttons
      // Attention: The buttons are an alternative solution we found to make it work. There is no guarantee that they will continue functioning, or when they might stop: The only certainty is: They will stop, so use them responsibly.
      WPP.chat.sendTextMessage('[number]@c.us', 'Hello', {
        useInteractiveMessage: true, // False for legacy
        buttons: [
          {
            url: 'https://wppconnect.io/',
            text: 'WPPConnect Site'
          },
          {
            phoneNumber: '+55 11 22334455',
            text: 'Call me'
          },
          {
            id: 'your custom id 1',
            text: 'Some text'
          },
          {
            code: '789890',
            text: 'Another text'
          }
        ],
        title: 'Title text', // Optional
        footer: 'Footer text' // Optional
      });
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.sendVCardContactMessage.html b/functions/chat.sendVCardContactMessage.html index 4c627151bb..f1c350d8c6 100644 --- a/functions/chat.sendVCardContactMessage.html +++ b/functions/chat.sendVCardContactMessage.html @@ -1,5 +1,5 @@ sendVCardContactMessage | @wppconnect/wa-js - v3.10.1

    Function sendVCardContactMessage

    • sendVCardContactMessage(chatId, contacts, options?): Promise<SendMessageReturn>

    • Send a VCard as message

      -

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      // single contact
      WPP.chat.sendVCardContactMessage('[number]@c.us', {
        id: '123456@c.us',
        name: 'The Contact Name'
      });

      // multiple contacts
      WPP.chat.sendVCardContactMessage('[number]@c.us', [
        {
          id: '123456@c.us',
          name: 'The Contact Name'
        },
        {
          id: '456789@c.us',
          name: 'Another Contact'
        },
      ]);
      
+

      Parameters

      Returns Promise<SendMessageReturn>

      Example

      // single contact
      WPP.chat.sendVCardContactMessage('[number]@c.us', {
        id: '123456@c.us',
        name: 'The Contact Name'
      });

      // multiple contacts
      WPP.chat.sendVCardContactMessage('[number]@c.us', [
        {
          id: '123456@c.us',
          name: 'The Contact Name'
        },
        {
          id: '456789@c.us',
          name: 'Another Contact'
        },
      ]);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.starMessage.html b/functions/chat.starMessage.html index cb05f5f1f9..d54833de6f 100644 --- a/functions/chat.starMessage.html +++ b/functions/chat.starMessage.html @@ -1,9 +1,9 @@ starMessage | @wppconnect/wa-js - v3.10.1

    Function starMessage

    • starMessage(id, star): Promise<StarMessageReturn>

    • Star/Unstar a message

      -

      Parameters

      • id: string
      • star: boolean

      Returns Promise<StarMessageReturn>

      Example

      // star a message
      WPP.chat.starMessage('<message id>');

      // unstar a message
      WPP.chat.starMessage('<message id>', false);
+

      Parameters

      • id: string
      • star: boolean

      Returns Promise<StarMessageReturn>

      Example

      // star a message
      WPP.chat.starMessage('<message id>');

      // unstar a message
      WPP.chat.starMessage('<message id>', false);
      -
    • starMessage(ids, star): Promise<StarMessageReturn[]>

    • Star/Unstar messages

      -

      Parameters

      • ids: string[]
      • star: boolean

      Returns Promise<StarMessageReturn[]>

      Example

      // star messages
      WPP.chat.starMessage(['<message id>', '<message id>']);

      // unstar messages
      WPP.chat.starMessage(['<message id>', '<message id>'], false);
+
  • starMessage(ids, star): Promise<StarMessageReturn[]>

  • Star/Unstar messages

    +

    Parameters

    • ids: string[]
    • star: boolean

    Returns Promise<StarMessageReturn[]>

    Example

    // star messages
    WPP.chat.starMessage(['<message id>', '<message id>']);

    // unstar messages
    WPP.chat.starMessage(['<message id>', '<message id>'], false);
    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.unarchive.html b/functions/chat.unarchive.html index 0a71f83224..8f75892d74 100644 --- a/functions/chat.unarchive.html +++ b/functions/chat.unarchive.html @@ -1,6 +1,6 @@ unarchive | @wppconnect/wa-js - v3.10.1

    Function unarchive

    • unarchive(chatId): Promise<{
          archive: boolean;
          wid: Wid;
      }>

    • Unarchive a chat

      -

      Parameters

      • chatId: string | Wid

      Returns Promise<{
          archive: boolean;
          wid: Wid;
      }>

      Alias

      archive

      -

      Example

      // Unarchive a chat
      WPP.chat.unarchive('[number]@c.us');

      // Alias for
      WPP.chat.archive('[number]@c.us', false);
+

      Parameters

      • chatId: string | Wid

      Returns Promise<{
          archive: boolean;
          wid: Wid;
      }>

      Alias

      archive

      +

      Example

      // Unarchive a chat
      WPP.chat.unarchive('[number]@c.us');

      // Alias for
      WPP.chat.archive('[number]@c.us', false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.unmute.html b/functions/chat.unmute.html index d6b33ca9fd..54a54295d6 100644 --- a/functions/chat.unmute.html +++ b/functions/chat.unmute.html @@ -1,5 +1,5 @@ unmute | @wppconnect/wa-js - v3.10.1

    Function unmute

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.unpin.html b/functions/chat.unpin.html index 73dd7c2306..c82c0e17c0 100644 --- a/functions/chat.unpin.html +++ b/functions/chat.unpin.html @@ -1,6 +1,6 @@ unpin | @wppconnect/wa-js - v3.10.1

    Function unpin

    • unpin(chatId): Promise<{
          pin: boolean;
          wid: Wid;
      }>

    • Unpin a chat

      -

      Parameters

      • chatId: string | Wid

      Returns Promise<{
          pin: boolean;
          wid: Wid;
      }>

      Alias

      pin

      -

      Example

      // Unpin a chat
      WPP.chat.unpin('[number]@c.us');

      // Alias for
      WPP.chat.pin('[number]@c.us', false);
+

      Parameters

      • chatId: string | Wid

      Returns Promise<{
          pin: boolean;
          wid: Wid;
      }>

      Alias

      pin

      +

      Example

      // Unpin a chat
      WPP.chat.unpin('[number]@c.us');

      // Alias for
      WPP.chat.pin('[number]@c.us', false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/chat.unpinMsg.html b/functions/chat.unpinMsg.html index 0fb2a04cf0..462e333bde 100644 --- a/functions/chat.unpinMsg.html +++ b/functions/chat.unpinMsg.html @@ -1,6 +1,6 @@ unpinMsg | @wppconnect/wa-js - v3.10.1

    Function unpinMsg

    • unpinMsg(msgId): Promise<{
          message: MsgModel;
          pinned: boolean;
          result: SendMsgResult;
      }>

    • Unpin a message in chat

      -

      Parameters

      Returns Promise<{
          message: MsgModel;
          pinned: boolean;
          result: SendMsgResult;
      }>

      Alias

      pin

      -

      Example

      // Unpin a message
      WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');

      // Alias for
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
+

      Parameters

      Returns Promise<{
          message: MsgModel;
          pinned: boolean;
          result: SendMsgResult;
      }>

      Alias

      pin

      +

      Example

      // Unpin a message
      WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');

      // Alias for
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/community.addSubgroups.html b/functions/community.addSubgroups.html index 93fd4215f3..ef27c6a2f5 100644 --- a/functions/community.addSubgroups.html +++ b/functions/community.addSubgroups.html @@ -1,5 +1,5 @@ addSubgroups | @wppconnect/wa-js - v3.10.1

    Function addSubgroups

    • addSubgroups(parentGroupId, subgroupIds): Promise<{
          failedGroups: {
              error: string;
              jid: string;
          }[];
          linkedGroupJids: string[];
      }>

    • Add groups do community

      -

      Parameters

      • parentGroupId: string | Wid
      • subgroupIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          failedGroups: {
              error: string;
              jid: string;
          }[];
          linkedGroupJids: string[];
      }>

      Example

      await WPP.community.addSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
+

      Parameters

      • parentGroupId: string | Wid
      • subgroupIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          failedGroups: {
              error: string;
              jid: string;
          }[];
          linkedGroupJids: string[];
      }>

      Example

      await WPP.community.addSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/community.create.html b/functions/community.create.html index ccb8767c70..172e0aaaa6 100644 --- a/functions/community.create.html +++ b/functions/community.create.html @@ -1,5 +1,5 @@ create | @wppconnect/wa-js - v3.10.1

    Function create

    • create(name, desc, subGroupsIds): Promise<any>

    • Create a community

      -

      Parameters

      • name: string
      • desc: string
      • subGroupsIds: string | Wid | (string | Wid)[]

      Returns Promise<any>

      Example

      await WPP.community.create('Name for community', 'description for community', ['123456@g.us', '123456@g.us']);
+

      Parameters

      • name: string
      • desc: string
      • subGroupsIds: string | Wid | (string | Wid)[]

      Returns Promise<any>

      Example

      await WPP.community.create('Name for community', 'description for community', ['123456@g.us', '123456@g.us']);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/community.deactivate.html b/functions/community.deactivate.html index 2e03470ffa..748a06269e 100644 --- a/functions/community.deactivate.html +++ b/functions/community.deactivate.html @@ -1,5 +1,5 @@ deactivate | @wppconnect/wa-js - v3.10.1

    Function deactivate

    • deactivate(communityId): Promise<any>

    • Deactivated a community

      -

      Parameters

      • communityId: string | Wid

      Returns Promise<any>

      Example

      await WPP.community.deactivate('123456@g.us');
+

      Parameters

      • communityId: string | Wid

      Returns Promise<any>

      Example

      await WPP.community.deactivate('123456@g.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/community.demoteParticipants.html b/functions/community.demoteParticipants.html index 7629341dfd..936919faa6 100644 --- a/functions/community.demoteParticipants.html +++ b/functions/community.demoteParticipants.html @@ -1,5 +1,5 @@ demoteParticipants | @wppconnect/wa-js - v3.10.1

    Function demoteParticipants

    • demoteParticipants(communityId, participantsIds): Promise<any>

    • Remove admin of community participant

      -

      Parameters

      • communityId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<any>

      Example

      await WPP.community.demoteParticipants('123456@g.us', '123456@c.us');
+

      Parameters

      • communityId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<any>

      Example

      await WPP.community.demoteParticipants('123456@g.us', '123456@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/community.getParticipants.html b/functions/community.getParticipants.html index 93485f746a..22c6a91865 100644 --- a/functions/community.getParticipants.html +++ b/functions/community.getParticipants.html @@ -1,5 +1,5 @@ getParticipants | @wppconnect/wa-js - v3.10.1

    Function getParticipants

    • getParticipants(communityId): Promise<any>

    • Get all participants of a community

      -

      Parameters

      • communityId: string | Wid

      Returns Promise<any>

      Example

      await WPP.community.getParticipants('123456@g.us');
+

      Parameters

      • communityId: string | Wid

      Returns Promise<any>

      Example

      await WPP.community.getParticipants('123456@g.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/community.promoteParticipants.html b/functions/community.promoteParticipants.html index efe5bb43bd..4355e26b31 100644 --- a/functions/community.promoteParticipants.html +++ b/functions/community.promoteParticipants.html @@ -1,5 +1,5 @@ promoteParticipants | @wppconnect/wa-js - v3.10.1

    Function promoteParticipants

    • promoteParticipants(communityId, participantsIds): Promise<any>

    • Promote participant of community to admin

      -

      Parameters

      • communityId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<any>

      Example

      await WPP.community.promoteParticipants('123456@g.us', '123456@c.us');
+

      Parameters

      • communityId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<any>

      Example

      await WPP.community.promoteParticipants('123456@g.us', '123456@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/community.removeSubgroups.html b/functions/community.removeSubgroups.html index 94d04f58cc..ac392e1341 100644 --- a/functions/community.removeSubgroups.html +++ b/functions/community.removeSubgroups.html @@ -1,5 +1,5 @@ removeSubgroups | @wppconnect/wa-js - v3.10.1

    Function removeSubgroups

    • removeSubgroups(parentGroupId, subgroupIds): Promise<{
          failedGroups: {
              error: string;
              jid: string;
          }[];
          linkedGroupJids: string[];
      }>

    • Remove groups from community

      -

      Parameters

      • parentGroupId: string | Wid
      • subgroupIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          failedGroups: {
              error: string;
              jid: string;
          }[];
          linkedGroupJids: string[];
      }>

      Example

      await WPP.community.sendUnlinkSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
+

      Parameters

      • parentGroupId: string | Wid
      • subgroupIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          failedGroups: {
              error: string;
              jid: string;
          }[];
          linkedGroupJids: string[];
      }>

      Example

      await WPP.community.sendUnlinkSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.genLinkDeviceCodeForPhoneNumber.html b/functions/conn.genLinkDeviceCodeForPhoneNumber.html index 70cd90ebc9..0f97538abd 100644 --- a/functions/conn.genLinkDeviceCodeForPhoneNumber.html +++ b/functions/conn.genLinkDeviceCodeForPhoneNumber.html @@ -1,6 +1,6 @@ genLinkDeviceCodeForPhoneNumber | @wppconnect/wa-js - v3.10.1

    Function genLinkDeviceCodeForPhoneNumber

    • genLinkDeviceCodeForPhoneNumber(phone, sendPushNotification?): Promise<string>

    • Alternative login method using code Get the Link Device Code for Authentication using the phone number

      -

      Parameters

      • phone: string
      • sendPushNotification: boolean = true

      Returns Promise<string>

      Example

      const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]');

      // Disable push notification
      const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]', false);
+

      Parameters

      • phone: string
      • sendPushNotification: boolean = true

      Returns Promise<string>

      Example

      const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]');

      // Disable push notification
      const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]', false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.getAuthCode.html b/functions/conn.getAuthCode.html index fe3efb1c39..bb0137bb13 100644 --- a/functions/conn.getAuthCode.html +++ b/functions/conn.getAuthCode.html @@ -1,6 +1,6 @@ getAuthCode | @wppconnect/wa-js - v3.10.1

    Function getAuthCode

    • getAuthCode(): Promise<AuthCode | null>

    • Return the current auth code

      Returns Promise<AuthCode | null>

      [return description]

      -

      Example

      const authCode = await WPP.conn.getAuthCode();
      console.log(authCode.fullCode); // Output: a long string to generate a QRCode
+
      Example
      const authCode = await WPP.conn.getAuthCode();
      console.log(authCode.fullCode); // Output: a long string to generate a QRCode
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.getHistorySyncProgress.html b/functions/conn.getHistorySyncProgress.html index 2ad90a24f4..580588b487 100644 --- a/functions/conn.getHistorySyncProgress.html +++ b/functions/conn.getHistorySyncProgress.html @@ -1,5 +1,5 @@ getHistorySyncProgress | @wppconnect/wa-js - v3.10.1

    Function getHistorySyncProgress

    • getHistorySyncProgress(): HistorySyncProgress

    • Return the current state of syncing old messages progress

      -

      Returns HistorySyncProgress

      Example

      const info = WPP.conn.getHistorySyncProgress();
      console.log(info.progress); // Output: 50
      console.log(info.paused); // Output: false0
      console.log(info.inProgress); // Output: true
+

      Returns HistorySyncProgress

      Example

      const info = WPP.conn.getHistorySyncProgress();
      console.log(info.progress); // Output: 50
      console.log(info.paused); // Output: false0
      console.log(info.inProgress); // Output: true
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.getMyDeviceId.html b/functions/conn.getMyDeviceId.html index 13f878b5c5..c140eb5023 100644 --- a/functions/conn.getMyDeviceId.html +++ b/functions/conn.getMyDeviceId.html @@ -1,5 +1,5 @@ getMyDeviceId | @wppconnect/wa-js - v3.10.1

    Function getMyDeviceId

    • getMyDeviceId(): Wid | undefined

    • Return the current logged user ID with device id

      -

      Returns Wid | undefined

      Example

      const wid = WPP.conn.getMyDeviceId();
      console.log(wid.toString()); // Output: 123:4@c.us
+

      Returns Wid | undefined

      Example

      const wid = WPP.conn.getMyDeviceId();
      console.log(wid.toString()); // Output: 123:4@c.us
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.getMyUserId.html b/functions/conn.getMyUserId.html index 06b9f6db54..f9bcfaf290 100644 --- a/functions/conn.getMyUserId.html +++ b/functions/conn.getMyUserId.html @@ -1,5 +1,5 @@ getMyUserId | @wppconnect/wa-js - v3.10.1

    Function getMyUserId

    • getMyUserId(): Wid | undefined

    • Return the current logged user ID without device id

      -

      Returns Wid | undefined

      Example

      const wid = WPP.conn.getMyUserId();
      console.log(wid.toString()); // Output: 123@c.us
+

      Returns Wid | undefined

      Example

      const wid = WPP.conn.getMyUserId();
      console.log(wid.toString()); // Output: 123@c.us
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.getPlatform.html b/functions/conn.getPlatform.html index 286697b6c4..fee582a4da 100644 --- a/functions/conn.getPlatform.html +++ b/functions/conn.getPlatform.html @@ -1,6 +1,6 @@ getPlatform | @wppconnect/wa-js - v3.10.1

    Function getPlatform

    • getPlatform(): any

    • Check what's device platform is connected

      Returns any

      android | iphone | wp

      -

      Example

      const getPlatform = WPP.conn.getPlatform();
+
      Example
      const getPlatform = WPP.conn.getPlatform();
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.isMainInit.html b/functions/conn.isMainInit.html index 7a50fb204c..83bc153c54 100644 --- a/functions/conn.isMainInit.html +++ b/functions/conn.isMainInit.html @@ -1,5 +1,5 @@ isMainInit | @wppconnect/wa-js - v3.10.1

    Function isMainInit

    • isMainInit(): boolean

    • Check is main interface is initializing

      -

      Returns boolean

      Example

      const isMainInit = WPP.conn.isMainInit();
+

      Returns boolean

      Example

      const isMainInit = WPP.conn.isMainInit();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.isMainLoaded.html b/functions/conn.isMainLoaded.html index 57fc5c5cf0..a75dc71899 100644 --- a/functions/conn.isMainLoaded.html +++ b/functions/conn.isMainLoaded.html @@ -1,5 +1,5 @@ isMainLoaded | @wppconnect/wa-js - v3.10.1

    Function isMainLoaded

    • isMainLoaded(): boolean

    • Check is main interface is authenticated and loaded, bot not synced

      -

      Returns boolean

      Example

      const isMainLoaded = WPP.conn.isMainLoaded();
+

      Returns boolean

      Example

      const isMainLoaded = WPP.conn.isMainLoaded();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.isMainReady.html b/functions/conn.isMainReady.html index 78d71e0cf5..3c76b70d5a 100644 --- a/functions/conn.isMainReady.html +++ b/functions/conn.isMainReady.html @@ -1,5 +1,5 @@ isMainReady | @wppconnect/wa-js - v3.10.1

    Function isMainReady

    • isMainReady(): boolean

    • Check is main interface is authenticated, loaded and synced

      -

      Returns boolean

      Example

      const isMainReady = WPP.conn.isMainReady();
+

      Returns boolean

      Example

      const isMainReady = WPP.conn.isMainReady();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.isOnline.html b/functions/conn.isOnline.html index 1daf84db5f..104270881d 100644 --- a/functions/conn.isOnline.html +++ b/functions/conn.isOnline.html @@ -1,5 +1,5 @@ isOnline | @wppconnect/wa-js - v3.10.1

    Function isOnline

    • isOnline(): boolean

    • Check is online

      -

      Returns boolean

      Example

      const isOnline = WPP.conn.isOnline();
+

      Returns boolean

      Example

      const isOnline = WPP.conn.isOnline();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.isRegistered.html b/functions/conn.isRegistered.html index 217e455533..1ab3c7df47 100644 --- a/functions/conn.isRegistered.html +++ b/functions/conn.isRegistered.html @@ -1,5 +1,5 @@ isRegistered | @wppconnect/wa-js - v3.10.1

    Function isRegistered

    • isRegistered(): boolean

    • Check is the current browser is logged before loading

      -

      Returns boolean

      Example

      const isRegistered = WPP.conn.isRegistered();
+

      Returns boolean

      Example

      const isRegistered = WPP.conn.isRegistered();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.joinWebBeta.html b/functions/conn.joinWebBeta.html index 5e18ab2f16..bda8fbb767 100644 --- a/functions/conn.joinWebBeta.html +++ b/functions/conn.joinWebBeta.html @@ -1,6 +1,6 @@ joinWebBeta | @wppconnect/wa-js - v3.10.1

    Function joinWebBeta

    • joinWebBeta(value): Promise<boolean>

    • Join or leave of WhatsApp Web beta program. Will return the value seted

      -

      Parameters

      • value: boolean

      Returns Promise<boolean>

      Example

      // For join on Beta
      WPP.conn.joinWebBeta(true);

      // For leave of Beta
      WPP.conn.joinWebBeta(true);
+

      Parameters

      • value: boolean

      Returns Promise<boolean>

      Example

      // For join on Beta
      WPP.conn.joinWebBeta(true);

      // For leave of Beta
      WPP.conn.joinWebBeta(true);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.markAvailable.html b/functions/conn.markAvailable.html index 72b441bbe8..0ce5361052 100644 --- a/functions/conn.markAvailable.html +++ b/functions/conn.markAvailable.html @@ -1,5 +1,5 @@ markAvailable | @wppconnect/wa-js - v3.10.1

    Function markAvailable

    • markAvailable(available?): Promise<boolean>

    • Set the online state to online

      -

      Parameters

      • available: boolean = true

      Returns Promise<boolean>

      Example

      await WPP.conn.markAvailable();
+

      Parameters

      • available: boolean = true

      Returns Promise<boolean>

      Example

      await WPP.conn.markAvailable();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.markUnavailable.html b/functions/conn.markUnavailable.html index 4e8feecbd6..c6798499b4 100644 --- a/functions/conn.markUnavailable.html +++ b/functions/conn.markUnavailable.html @@ -1,5 +1,5 @@ markUnavailable | @wppconnect/wa-js - v3.10.1

    Function markUnavailable

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.needsUpdate.html b/functions/conn.needsUpdate.html index a15463dae4..d603dd2419 100644 --- a/functions/conn.needsUpdate.html +++ b/functions/conn.needsUpdate.html @@ -1,5 +1,5 @@ needsUpdate | @wppconnect/wa-js - v3.10.1

    Function needsUpdate

    • needsUpdate(): boolean

    • Check if whatsapp web is asking for update

      -

      Returns boolean

      Example

      const needsUpdate = WPP.conn.needsUpdate();
+

      Returns boolean

      Example

      const needsUpdate = WPP.conn.needsUpdate();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.refreshQR.html b/functions/conn.refreshQR.html index 9e90fe53a8..f15918c84e 100644 --- a/functions/conn.refreshQR.html +++ b/functions/conn.refreshQR.html @@ -1,7 +1,7 @@ refreshQR | @wppconnect/wa-js - v3.10.1

    Function refreshQR

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.setKeepAlive.html b/functions/conn.setKeepAlive.html index 57e959fb70..809171a63b 100644 --- a/functions/conn.setKeepAlive.html +++ b/functions/conn.setKeepAlive.html @@ -1,5 +1,5 @@ setKeepAlive | @wppconnect/wa-js - v3.10.1

    Function setKeepAlive

    • setKeepAlive(enable?): boolean

    • Set keep alive state, that will force the focused and online state

      -

      Parameters

      • enable: boolean = true

      Returns boolean

      Example

      // To enable
      await WPP.conn.setKeepAlive();

      // To disable
      await WPP.conn.setKeepAlive(false);
+

      Parameters

      • enable: boolean = true

      Returns boolean

      Example

      // To enable
      await WPP.conn.setKeepAlive();

      // To disable
      await WPP.conn.setKeepAlive(false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.setLimit.html b/functions/conn.setLimit.html index 6af80492af..321d3d8ec3 100644 --- a/functions/conn.setLimit.html +++ b/functions/conn.setLimit.html @@ -1,25 +1,25 @@ setLimit | @wppconnect/wa-js - v3.10.1

    Function setLimit

    Change the limits

    -

    Example

     //Change the maximum size (bytes) for uploading media (max 70MB)
     WPP.conn.setLimit('maxMediaSize',16777216);

     //Change the maximum size (bytes) for uploading files (max 1GB)
     WPP.conn.setLimit('maxFileSize',104857600);

     //Change the maximum number of contacts that can be selected when sharing (Default 5)
     WPP.conn.setLimit('maxShare',100);

     //Change the maximum time (seconds) of a video status
     WPP.conn.setLimit('statusVideoMaxDuration',120);

     //Remove pinned conversation limit (only whatsapp web) (Default 3)
     WPP.conn.setLimit('unlimitedPin',true);
+

    Example

     //Change the maximum size (bytes) for uploading media (max 70MB)
     WPP.conn.setLimit('maxMediaSize',16777216);

     //Change the maximum size (bytes) for uploading files (max 1GB)
     WPP.conn.setLimit('maxFileSize',104857600);

     //Change the maximum number of contacts that can be selected when sharing (Default 5)
     WPP.conn.setLimit('maxShare',100);

     //Change the maximum time (seconds) of a video status
     WPP.conn.setLimit('statusVideoMaxDuration',120);

     //Remove pinned conversation limit (only whatsapp web) (Default 3)
     WPP.conn.setLimit('unlimitedPin',true);
    -
    • setLimit(key, value): number

    • Change the limit of MediaSize

      -

      Parameters

      • key: "maxMediaSize"
      • value: number

      Returns number

      Example

       //Change the maximum size (bytes) for uploading media (max 70MB)
       WPP.conn.setLimit('maxMediaSize',16777216);
+
    • setLimit(key, value): number

    • Change the limit of MediaSize

      +

      Parameters

      • key: "maxMediaSize"
      • value: number

      Returns number

      Example

       //Change the maximum size (bytes) for uploading media (max 70MB)
       WPP.conn.setLimit('maxMediaSize',16777216);
      -
    • setLimit(key, value): number

    • Change the limit of FileSize

      -

      Parameters

      • key: "maxFileSize"
      • value: number

      Returns number

      Example

       //Change the maximum size (bytes) for uploading files (max 1GB)
       WPP.conn.setLimit('maxFileSize',104857600);
+
  • setLimit(key, value): number

  • Change the limit of FileSize

    +

    Parameters

    • key: "maxFileSize"
    • value: number

    Returns number

    Example

     //Change the maximum size (bytes) for uploading files (max 1GB)
     WPP.conn.setLimit('maxFileSize',104857600);
    -
  • setLimit(key, value): number

  • Change the limit of Share

    -

    Parameters

    • key: "maxShare"
    • value: number

    Returns number

    Example

     //Change the maximum number of contacts that can be selected when sharing (Default 5)
     WPP.conn.setLimit('maxShare',100);
+
  • setLimit(key, value): number

  • Change the limit of Share

    +

    Parameters

    • key: "maxShare"
    • value: number

    Returns number

    Example

     //Change the maximum number of contacts that can be selected when sharing (Default 5)
     WPP.conn.setLimit('maxShare',100);
    -
  • setLimit(key, value): number

  • Change the limit of Status Video Duration

    -

    Parameters

    • key: "statusVideoMaxDuration"
    • value: number

    Returns number

    Example

     //Change the maximum time (seconds) of a video status
     WPP.conn.setLimit('statusVideoMaxDuration',120);
+
  • setLimit(key, value): number

  • Change the limit of Status Video Duration

    +

    Parameters

    • key: "statusVideoMaxDuration"
    • value: number

    Returns number

    Example

     //Change the maximum time (seconds) of a video status
     WPP.conn.setLimit('statusVideoMaxDuration',120);
    -
  • setLimit(key, value): boolean

  • Change the limit of Pin

    -

    Parameters

    • key: "unlimitedPin"
    • value: boolean

    Returns boolean

    Example

     //Remove pinned conversation limit (only whatsapp web) (Default 3)
     WPP.conn.setLimit('unlimitedPin',true);
+
  • setLimit(key, value): boolean

  • Change the limit of Pin

    +

    Parameters

    • key: "unlimitedPin"
    • value: boolean

    Returns boolean

    Example

     //Remove pinned conversation limit (only whatsapp web) (Default 3)
     WPP.conn.setLimit('unlimitedPin',true);
    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/conn.setMultiDevice.html b/functions/conn.setMultiDevice.html index b022f44c93..3f09155591 100644 --- a/functions/conn.setMultiDevice.html +++ b/functions/conn.setMultiDevice.html @@ -1,5 +1,5 @@ setMultiDevice | @wppconnect/wa-js - v3.10.1

    Function setMultiDevice

    • setMultiDevice(md?): boolean

    • Parameters

      • md: boolean = true

        If it's true, WhatsApp WEB will switch to MD. If it's false, WhatsApp WEB will switch to Legacy.

        -

      Returns boolean

      Example

      WPP.conn.setMultiDevice(true)
+

    Returns boolean

    Example

    WPP.conn.setMultiDevice(true)
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/contact.get.html b/functions/contact.get.html index e066feb2d0..a1dd8ef01a 100644 --- a/functions/contact.get.html +++ b/functions/contact.get.html @@ -1,5 +1,5 @@ get | @wppconnect/wa-js - v3.10.1

    Function get

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/contact.getBusinessProfile.html b/functions/contact.getBusinessProfile.html index 5befdd5a5a..2c52531ca3 100644 --- a/functions/contact.getBusinessProfile.html +++ b/functions/contact.getBusinessProfile.html @@ -1,5 +1,5 @@ getBusinessProfile | @wppconnect/wa-js - v3.10.1

    Function getBusinessProfile

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/contact.getCommonGroups.html b/functions/contact.getCommonGroups.html index f325e062c7..9e51abbb75 100644 --- a/functions/contact.getCommonGroups.html +++ b/functions/contact.getCommonGroups.html @@ -1,5 +1,5 @@ getCommonGroups | @wppconnect/wa-js - v3.10.1

    Function getCommonGroups

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/contact.getProfilePictureUrl.html b/functions/contact.getProfilePictureUrl.html index da5f977ab6..12b83c6dcc 100644 --- a/functions/contact.getProfilePictureUrl.html +++ b/functions/contact.getProfilePictureUrl.html @@ -1,5 +1,5 @@ getProfilePictureUrl | @wppconnect/wa-js - v3.10.1

    Function getProfilePictureUrl

    • getProfilePictureUrl(contactId, full?): Promise<undefined | null | string>

    • Get the current text status

      -

      Parameters

      • contactId: string | Wid
      • full: boolean = true

      Returns Promise<undefined | null | string>

      Example

      const url = await WPP.contact.getProfilePictureUrl('[number]@c.us');
+

      Parameters

      • contactId: string | Wid
      • full: boolean = true

      Returns Promise<undefined | null | string>

      Example

      const url = await WPP.contact.getProfilePictureUrl('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/contact.getStatus.html b/functions/contact.getStatus.html index 2cd0ca7fc0..5da42520f7 100644 --- a/functions/contact.getStatus.html +++ b/functions/contact.getStatus.html @@ -1,5 +1,5 @@ getStatus | @wppconnect/wa-js - v3.10.1

    Function getStatus

    • getStatus(contactId): Promise<null | string>

    • Get the current text status

      -

      Parameters

      • contactId: string | Wid

      Returns Promise<null | string>

      Example

      await WPP.contact.getStatus('[number]@c.us');
+

      Parameters

      • contactId: string | Wid

      Returns Promise<null | string>

      Example

      await WPP.contact.getStatus('[number]@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/contact.list.html b/functions/contact.list.html index 3fa2d06a0b..d4e3422a78 100644 --- a/functions/contact.list.html +++ b/functions/contact.list.html @@ -1,5 +1,5 @@ list | @wppconnect/wa-js - v3.10.1

    Function list

    • list(options?): Promise<ContactModel[]>

    • Return a list of contacts

      -

      Parameters

      Returns Promise<ContactModel[]>

      Example

      // All contacts
      const contats = await WPP.contact.list();

      // Only my contacts
      const contacts = await WPP.contact.list({onlyMyContacts: true});

      // Only with label Text
      const contacts = await WPP.contact.list({withLabels: ['Test']});

      // Only with label id
      const contacts = await WPP.contact.list({withLabels: ['1']});

      // Only with label with one of text or id
      const contacts = await WPP.contact.list({withLabels: ['Alfa','5']});
+

      Parameters

      Returns Promise<ContactModel[]>

      Example

      // All contacts
      const contats = await WPP.contact.list();

      // Only my contacts
      const contacts = await WPP.contact.list({onlyMyContacts: true});

      // Only with label Text
      const contacts = await WPP.contact.list({withLabels: ['Test']});

      // Only with label id
      const contacts = await WPP.contact.list({withLabels: ['1']});

      // Only with label with one of text or id
      const contacts = await WPP.contact.list({withLabels: ['Alfa','5']});
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/contact.queryExists.html b/functions/contact.queryExists.html index 260f71f27c..97c8909ab2 100644 --- a/functions/contact.queryExists.html +++ b/functions/contact.queryExists.html @@ -1,6 +1,6 @@ queryExists | @wppconnect/wa-js - v3.10.1

    Function queryExists

    • queryExists(contactId): Promise<QueryExistsResult | null>

    • Check if the number exists and what is correct ID

      This help to identify numbers with nine digit in Brazil

      -

      Parameters

      • contactId: string | Wid

      Returns Promise<QueryExistsResult | null>

      Example

      const result = await WPP.contact.queryExists('[number]@c.us');
      console.log(result.wid); // Correct ID
+

      Parameters

      • contactId: string | Wid

      Returns Promise<QueryExistsResult | null>

      Example

      const result = await WPP.contact.queryExists('[number]@c.us');
      console.log(result.wid); // Correct ID
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.addParticipants.html b/functions/group.addParticipants.html index edba287bbf..c1814b51b9 100644 --- a/functions/group.addParticipants.html +++ b/functions/group.addParticipants.html @@ -1,6 +1,6 @@ addParticipants | @wppconnect/wa-js - v3.10.1

    Function addParticipants

    • addParticipants(groupId, participantsIds): Promise<{
          [key: `${number}@c.us`]: {
              code: number;
              invite_code: string | null;
              invite_code_exp: number | null;
              message: string;
              wid: string;
          };
      }>

    • Add one or more participants to a group

      The method return a object with the result of each participant as the key

      -

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          [key: `${number}@c.us`]: {
              code: number;
              invite_code: string | null;
              invite_code_exp: number | null;
              message: string;
              wid: string;
          };
      }>

      Example

      const result = await WPP.group.addParticipants('[group@g.us]', [number@c.us]);

      // Get participant result:
      console.log(result['123@c.us'].code);
      console.log(result['123@c.us'].invite_code);
      console.log(result['123@c.us'].invite_code_exp);
      console.log(result['123@c.us'].message);
      console.log(result['123@c.us'].wid);

      const memberResult = result['123@c.us']; // To a variable
      // or
      const memberResult = Object.values(result)[0]; // Always the first member result

      // How to send a custom invite link
      const link = 'https://chat.whatsapp.com/' + result['123@c.us'].invite_code;
      console.log(link);
+

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          [key: `${number}@c.us`]: {
              code: number;
              invite_code: string | null;
              invite_code_exp: number | null;
              message: string;
              wid: string;
          };
      }>

      Example

      const result = await WPP.group.addParticipants('[group@g.us]', [number@c.us]);

      // Get participant result:
      console.log(result['123@c.us'].code);
      console.log(result['123@c.us'].invite_code);
      console.log(result['123@c.us'].invite_code_exp);
      console.log(result['123@c.us'].message);
      console.log(result['123@c.us'].wid);

      const memberResult = result['123@c.us']; // To a variable
      // or
      const memberResult = Object.values(result)[0]; // Always the first member result

      // How to send a custom invite link
      const link = 'https://chat.whatsapp.com/' + result['123@c.us'].invite_code;
      console.log(link);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.approve.html b/functions/group.approve.html index 08dd993df5..44955a0f1a 100644 --- a/functions/group.approve.html +++ b/functions/group.approve.html @@ -1,5 +1,5 @@ approve | @wppconnect/wa-js - v3.10.1

    Function approve

    • approve(groupId, membershipIds): Promise<{
          error: any;
          wid: Wid;
      }[]>

    • Approve a membership request to group

      -

      Parameters

      • groupId: string | Wid
      • membershipIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          error: any;
          wid: Wid;
      }[]>

      Example

      await WPP.group.approve(12345645@g.us, 5554999999999@c.us);
+

      Parameters

      • groupId: string | Wid
      • membershipIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          error: any;
          wid: Wid;
      }[]>

      Example

      await WPP.group.approve(12345645@g.us, 5554999999999@c.us);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.canAdd.html b/functions/group.canAdd.html index 1966d5947f..3c3ac762f6 100644 --- a/functions/group.canAdd.html +++ b/functions/group.canAdd.html @@ -1,5 +1,5 @@ canAdd | @wppconnect/wa-js - v3.10.1

    Function canAdd

    • canAdd(groupId): Promise<boolean>

    • Check if your account is allowed to add new participants

      -

      Parameters

      • groupId: string | Wid

      Returns Promise<boolean>

      Example

      const result = await WPP.group.canAdd('group@g.us');
      console.log(result);
+

      Parameters

      • groupId: string | Wid

      Returns Promise<boolean>

      Example

      const result = await WPP.group.canAdd('group@g.us');
      console.log(result);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.canDemote.html b/functions/group.canDemote.html index 37b0370f14..5c2189d4b1 100644 --- a/functions/group.canDemote.html +++ b/functions/group.canDemote.html @@ -1,5 +1,5 @@ canDemote | @wppconnect/wa-js - v3.10.1

    Function canDemote

    • canDemote(groupId, participantsIds): Promise<boolean>

    • Check if your account is allowed to demote participants

      -

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<boolean>

      Example

      await WPP.group.canDemote('group@g.us');
      console.log(result);
+

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<boolean>

      Example

      await WPP.group.canDemote('group@g.us');
      console.log(result);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.canPromote.html b/functions/group.canPromote.html index e1c95c0cf4..de275a9fda 100644 --- a/functions/group.canPromote.html +++ b/functions/group.canPromote.html @@ -1,5 +1,5 @@ canPromote | @wppconnect/wa-js - v3.10.1

    Function canPromote

    • canPromote(groupId, participantsIds): Promise<boolean>

    • Check if your account is allowed to promote participants

      -

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<boolean>

      Example

      await WPP.group.canPromote('group@g.us');
      console.log(result);
+

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<boolean>

      Example

      await WPP.group.canPromote('group@g.us');
      console.log(result);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.canRemove.html b/functions/group.canRemove.html index 001c574b0c..074f75fb49 100644 --- a/functions/group.canRemove.html +++ b/functions/group.canRemove.html @@ -1,5 +1,5 @@ canRemove | @wppconnect/wa-js - v3.10.1

    Function canRemove

    • canRemove(groupId, participantsIds): Promise<boolean>

    • Check if your account is allowed to remove participants

      -

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<boolean>

      Example

      const result = await WPP.group.canRemove('group@g.us');
      console.log(result);
+

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<boolean>

      Example

      const result = await WPP.group.canRemove('group@g.us');
      console.log(result);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.create.html b/functions/group.create.html index e24cd4fb81..fa29cb298d 100644 --- a/functions/group.create.html +++ b/functions/group.create.html @@ -1,6 +1,6 @@ create | @wppconnect/wa-js - v3.10.1

    Function create

    • create(groupName, participantsIds, parentGroup): Promise<{
          gid: Wid;
          participants: {
              [key: `${number}@c.us`]: {
                  code: number;
                  invite_code: string | null;
                  invite_code_exp: number | null;
                  wid: string;
              };
          };
      }>

    • Create a new group

      The method return a object with the result of each participant as the key

      -

      Parameters

      • groupName: string
      • participantsIds: string | Wid | (string | Wid)[]
      • parentGroup: string | Wid

      Returns Promise<{
          gid: Wid;
          participants: {
              [key: `${number}@c.us`]: {
                  code: number;
                  invite_code: string | null;
                  invite_code_exp: number | null;
                  wid: string;
              };
          };
      }>

      Example

      const result = await WPP.group.create('Test Group', ['number@c.us']);

      console.log(result.gid.toString()); // Get the group ID

      // Get participant result:
      console.log(result['number@c.us'].code);
      console.log(result['number@c.us'].invite_code);
      console.log(result['number@c.us'].invite_code_exp);
      console.log(result['number@c.us'].message);
      console.log(result['number@c.us'].wid);

      const memberResult = result['number@c.us']; // To a variable
      // or
      const memberResult = Object.values(result)[0]; // Always the first member result

      // How to send a custom invite link
      const link = 'https://chat.whatsapp.com/' + result['number@c.us'].invite_code;
      console.log(link);

      // Create a Subgroup for a community
      const result = await WPP.group.create('Test Group', ['number@c.us'], 'communit@g.us');
+

      Parameters

      • groupName: string
      • participantsIds: string | Wid | (string | Wid)[]
      • parentGroup: string | Wid

      Returns Promise<{
          gid: Wid;
          participants: {
              [key: `${number}@c.us`]: {
                  code: number;
                  invite_code: string | null;
                  invite_code_exp: number | null;
                  wid: string;
              };
          };
      }>

      Example

      const result = await WPP.group.create('Test Group', ['number@c.us']);

      console.log(result.gid.toString()); // Get the group ID

      // Get participant result:
      console.log(result['number@c.us'].code);
      console.log(result['number@c.us'].invite_code);
      console.log(result['number@c.us'].invite_code_exp);
      console.log(result['number@c.us'].message);
      console.log(result['number@c.us'].wid);

      const memberResult = result['number@c.us']; // To a variable
      // or
      const memberResult = Object.values(result)[0]; // Always the first member result

      // How to send a custom invite link
      const link = 'https://chat.whatsapp.com/' + result['number@c.us'].invite_code;
      console.log(link);

      // Create a Subgroup for a community
      const result = await WPP.group.create('Test Group', ['number@c.us'], 'communit@g.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.demoteParticipants.html b/functions/group.demoteParticipants.html index 87b9e2cd90..f088b45b4a 100644 --- a/functions/group.demoteParticipants.html +++ b/functions/group.demoteParticipants.html @@ -1,5 +1,5 @@ demoteParticipants | @wppconnect/wa-js - v3.10.1

    Function demoteParticipants

    • demoteParticipants(groupId, participantsIds): Promise<void>

    • Remove admin of a group

      -

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<void>

      Example

      // One member
      await WPP.group.demoteParticipants('123456@g.us', '123456@c.us');

      // More than one member
      await WPP.group.demoteParticipants('123456@g.us', ['123456@c.us','123456@c.us']);
+

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<void>

      Example

      // One member
      await WPP.group.demoteParticipants('123456@g.us', '123456@c.us');

      // More than one member
      await WPP.group.demoteParticipants('123456@g.us', ['123456@c.us','123456@c.us']);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.getAllGroups.html b/functions/group.getAllGroups.html index 2b21bdc4da..d5b0ea187d 100644 --- a/functions/group.getAllGroups.html +++ b/functions/group.getAllGroups.html @@ -1,5 +1,5 @@ getAllGroups | @wppconnect/wa-js - v3.10.1

    Function getAllGroups

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.getGroupInfoFromInviteCode.html b/functions/group.getGroupInfoFromInviteCode.html index f6072cc2a0..aee7bc62ed 100644 --- a/functions/group.getGroupInfoFromInviteCode.html +++ b/functions/group.getGroupInfoFromInviteCode.html @@ -1,5 +1,5 @@ getGroupInfoFromInviteCode | @wppconnect/wa-js - v3.10.1

    Function getGroupInfoFromInviteCode

    • getGroupInfoFromInviteCode(inviteCode): Promise<{
          announce: boolean;
          creation: number;
          desc: string;
          descId: string;
          descOwner: undefined | string;
          descTime: number;
          id: string;
          noFrequentlyForwarded: boolean;
          owner: undefined | string;
          parent: boolean;
          participants: {
              id: string;
              isAdmin: boolean;
              isSuperAdmin: boolean;
          }[];
          pvId?: string;
          restrict: boolean;
          size: number;
          status: number;
          subject: string;
          subjectOwner: undefined | string;
          subjectTime: number;
          support: boolean;
          suspended: boolean;
      }>

    • Get group info from an inviteCode

      -

      Parameters

      • inviteCode: string

      Returns Promise<{
          announce: boolean;
          creation: number;
          desc: string;
          descId: string;
          descOwner: undefined | string;
          descTime: number;
          id: string;
          noFrequentlyForwarded: boolean;
          owner: undefined | string;
          parent: boolean;
          participants: {
              id: string;
              isAdmin: boolean;
              isSuperAdmin: boolean;
          }[];
          pvId?: string;
          restrict: boolean;
          size: number;
          status: number;
          subject: string;
          subjectOwner: undefined | string;
          subjectTime: number;
          support: boolean;
          suspended: boolean;
      }>

      Example

      await WPP.group.getGroupInfoFromInviteCode('<inviteCode>');
+

      Parameters

      • inviteCode: string

      Returns Promise<{
          announce: boolean;
          creation: number;
          desc: string;
          descId: string;
          descOwner: undefined | string;
          descTime: number;
          id: string;
          noFrequentlyForwarded: boolean;
          owner: undefined | string;
          parent: boolean;
          participants: {
              id: string;
              isAdmin: boolean;
              isSuperAdmin: boolean;
          }[];
          pvId?: string;
          restrict: boolean;
          size: number;
          status: number;
          subject: string;
          subjectOwner: undefined | string;
          subjectTime: number;
          support: boolean;
          suspended: boolean;
      }>

      Example

      await WPP.group.getGroupInfoFromInviteCode('<inviteCode>');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.getGroupSizeLimit.html b/functions/group.getGroupSizeLimit.html index 239a9b594f..04e0d6b4a6 100644 --- a/functions/group.getGroupSizeLimit.html +++ b/functions/group.getGroupSizeLimit.html @@ -1,5 +1,5 @@ getGroupSizeLimit | @wppconnect/wa-js - v3.10.1

    Function getGroupSizeLimit

    • getGroupSizeLimit(): Promise<number>

    • Get the max number of participants for a group

      -

      Returns Promise<number>

      Example

      const limit = await WPP.group.getGroupSizeLimit();
      console.log(limit);
+

      Returns Promise<number>

      Example

      const limit = await WPP.group.getGroupSizeLimit();
      console.log(limit);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.getInviteCode.html b/functions/group.getInviteCode.html index 726833aba1..b0cc2248fa 100644 --- a/functions/group.getInviteCode.html +++ b/functions/group.getInviteCode.html @@ -1,5 +1,5 @@ getInviteCode | @wppconnect/wa-js - v3.10.1

    Function getInviteCode

    • getInviteCode(groupId): Promise<string>

    • Get the currend invite code of the group

      -

      Parameters

      • groupId: string | Wid

      Returns Promise<string>

      Example

      const code = WPP.group.getInviteCode('[group-id]@g.us');
      const link = 'https://chat.whatsapp.com/' + code;
+

      Parameters

      • groupId: string | Wid

      Returns Promise<string>

      Example

      const code = WPP.group.getInviteCode('[group-id]@g.us');
      const link = 'https://chat.whatsapp.com/' + code;
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.getMembershipRequests.html b/functions/group.getMembershipRequests.html index a817063153..6672f4d060 100644 --- a/functions/group.getMembershipRequests.html +++ b/functions/group.getMembershipRequests.html @@ -1,5 +1,5 @@ getMembershipRequests | @wppconnect/wa-js - v3.10.1

    Function getMembershipRequests

    • getMembershipRequests(groupId): Promise<{
          addedBy: Wid;
          id: Wid;
          parentGroupId?: Wid;
          requestMethod: "InviteLink" | "LinkedGroupJoin" | "NonAdminAdd";
          t: number;
      }[]>

    • Retrieve a lista of a membership approval requests

      -

      Parameters

      • groupId: string | Wid

      Returns Promise<{
          addedBy: Wid;
          id: Wid;
          parentGroupId?: Wid;
          requestMethod: "InviteLink" | "LinkedGroupJoin" | "NonAdminAdd";
          t: number;
      }[]>

      Example

      await WPP.group.getMembershipRequests(12345645@g.us);
+

      Parameters

      • groupId: string | Wid

      Returns Promise<{
          addedBy: Wid;
          id: Wid;
          parentGroupId?: Wid;
          requestMethod: "InviteLink" | "LinkedGroupJoin" | "NonAdminAdd";
          t: number;
      }[]>

      Example

      await WPP.group.getMembershipRequests(12345645@g.us);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.getParticipants.html b/functions/group.getParticipants.html index c56abb0f23..307318b8a5 100644 --- a/functions/group.getParticipants.html +++ b/functions/group.getParticipants.html @@ -1,5 +1,5 @@ getParticipants | @wppconnect/wa-js - v3.10.1

    Function getParticipants

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.getPastParticipants.html b/functions/group.getPastParticipants.html index dcfe58040a..ad51dae835 100644 --- a/functions/group.getPastParticipants.html +++ b/functions/group.getPastParticipants.html @@ -1,5 +1,5 @@ getPastParticipants | @wppconnect/wa-js - v3.10.1

    Function getPastParticipants

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.join.html b/functions/group.join.html index 63b68a732d..7e5b9dbec3 100644 --- a/functions/group.join.html +++ b/functions/group.join.html @@ -1,5 +1,5 @@ join | @wppconnect/wa-js - v3.10.1

    Function join

    • join(inviteCode): Promise<{
          id: string;
      }>

    • Join in a group from an invite code.

      -

      Parameters

      • inviteCode: string

      Returns Promise<{
          id: string;
      }>

      Example

      await WPP.group.join('abcde....');
+

      Parameters

      • inviteCode: string

      Returns Promise<{
          id: string;
      }>

      Example

      await WPP.group.join('abcde....');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.leave.html b/functions/group.leave.html index ae0bb25b55..b304f9d32d 100644 --- a/functions/group.leave.html +++ b/functions/group.leave.html @@ -1,5 +1,5 @@ leave | @wppconnect/wa-js - v3.10.1

    Function leave

    • leave(groupId): Promise<void>

    • Leave from a group.

      -

      Parameters

      • groupId: string | Wid

      Returns Promise<void>

      Example

      await WPP.group.leave('[number]@g.us');
+

      Parameters

      • groupId: string | Wid

      Returns Promise<void>

      Example

      await WPP.group.leave('[number]@g.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.promoteParticipants.html b/functions/group.promoteParticipants.html index c0dac5fcbc..5a9ba8a627 100644 --- a/functions/group.promoteParticipants.html +++ b/functions/group.promoteParticipants.html @@ -1,5 +1,5 @@ promoteParticipants | @wppconnect/wa-js - v3.10.1

    Function promoteParticipants

    • promoteParticipants(groupId, participantsIds): Promise<void>

    • Promote group member to admin

      -

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<void>

      Example

      // One member
      await WPP.group.promoteParticipants('123456@g.us', '123456@c.us');

      // More than one member
      await WPP.group.promoteParticipants('123456@g.us', ['123456@c.us','123456@c.us']);
+

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<void>

      Example

      // One member
      await WPP.group.promoteParticipants('123456@g.us', '123456@c.us');

      // More than one member
      await WPP.group.promoteParticipants('123456@g.us', ['123456@c.us','123456@c.us']);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.reject.html b/functions/group.reject.html index dfcec62ae6..0843b635fd 100644 --- a/functions/group.reject.html +++ b/functions/group.reject.html @@ -1,5 +1,5 @@ reject | @wppconnect/wa-js - v3.10.1

    Function reject

    • reject(groupId, membershipIds): Promise<{
          error: any;
          wid: Wid;
      }[]>

    • Reject a membership request to group

      -

      Parameters

      • groupId: string | Wid
      • membershipIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          error: any;
          wid: Wid;
      }[]>

      Example

      await WPP.group.reject(12345645@g.us, 5554999999999@c.us);
+

      Parameters

      • groupId: string | Wid
      • membershipIds: string | Wid | (string | Wid)[]

      Returns Promise<{
          error: any;
          wid: Wid;
      }[]>

      Example

      await WPP.group.reject(12345645@g.us, 5554999999999@c.us);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.removeIcon.html b/functions/group.removeIcon.html index 2965bf5106..47cf047e89 100644 --- a/functions/group.removeIcon.html +++ b/functions/group.removeIcon.html @@ -1,5 +1,5 @@ removeIcon | @wppconnect/wa-js - v3.10.1

    Function removeIcon

    • removeIcon(groupId): Promise<boolean>

    • Remove the group icon (group profile picture)

      -

      Parameters

      • groupId: string | Wid

      Returns Promise<boolean>

      Example

      await WPP.group.removeIcon('[group@g.us]');
+

      Parameters

      • groupId: string | Wid

      Returns Promise<boolean>

      Example

      await WPP.group.removeIcon('[group@g.us]');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.removeParticipants.html b/functions/group.removeParticipants.html index ef9240ee9d..96d3a8e05c 100644 --- a/functions/group.removeParticipants.html +++ b/functions/group.removeParticipants.html @@ -1,5 +1,5 @@ removeParticipants | @wppconnect/wa-js - v3.10.1

    Function removeParticipants

    • removeParticipants(groupId, participantsIds): Promise<void>

    • Remove participants of a group

      -

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<void>

      Example

      // One member
      await WPP.group.removeParticipants('123456@g.us', '123456@c.us');

      // More than one member
      await WPP.group.removeParticipants('123456@g.us', ['123456@c.us','123456@c.us']);
+

      Parameters

      • groupId: string | Wid
      • participantsIds: string | Wid | (string | Wid)[]

      Returns Promise<void>

      Example

      // One member
      await WPP.group.removeParticipants('123456@g.us', '123456@c.us');

      // More than one member
      await WPP.group.removeParticipants('123456@g.us', ['123456@c.us','123456@c.us']);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.revokeInviteCode.html b/functions/group.revokeInviteCode.html index 31a028d93b..e119c5ee21 100644 --- a/functions/group.revokeInviteCode.html +++ b/functions/group.revokeInviteCode.html @@ -1,5 +1,5 @@ revokeInviteCode | @wppconnect/wa-js - v3.10.1

    Function revokeInviteCode

    • revokeInviteCode(groupId): Promise<string>

    • Revoke the current invite code and generate new one.

      -

      Parameters

      • groupId: string | Wid

      Returns Promise<string>

      Example

      const code = WPP.group.revokeInviteCode('[group-id]@g.us');
      const link = 'https://chat.whatsapp.com/' + code;
+

      Parameters

      • groupId: string | Wid

      Returns Promise<string>

      Example

      const code = WPP.group.revokeInviteCode('[group-id]@g.us');
      const link = 'https://chat.whatsapp.com/' + code;
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.setDescription.html b/functions/group.setDescription.html index 1d0bef2925..3155829db2 100644 --- a/functions/group.setDescription.html +++ b/functions/group.setDescription.html @@ -1,5 +1,5 @@ setDescription | @wppconnect/wa-js - v3.10.1

    Function setDescription

    • setDescription(groupId, description): Promise<boolean>

    • Define the group description

      -

      Parameters

      • groupId: string | Wid
      • description: string

      Returns Promise<boolean>

      Example

      await WPP.group.setDescription('[group-id]@g.us', 'new group description');
+

      Parameters

      • groupId: string | Wid
      • description: string

      Returns Promise<boolean>

      Example

      await WPP.group.setDescription('[group-id]@g.us', 'new group description');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.setIcon.html b/functions/group.setIcon.html index 9e486a1920..2a25e1b7d5 100644 --- a/functions/group.setIcon.html +++ b/functions/group.setIcon.html @@ -1,5 +1,5 @@ setIcon | @wppconnect/wa-js - v3.10.1

    Function setIcon

    • setIcon(groupId, content): Promise<{
          _duplicate: boolean;
          eurl: string;
          status: number;
          tag: string;
          token: string;
      }>

    • Set the group icon (group profile picture)

      -

      Parameters

      • groupId: string | Wid
      • content: string

      Returns Promise<{
          _duplicate: boolean;
          eurl: string;
          status: number;
          tag: string;
          token: string;
      }>

      Example

      await WPP.group.setIcon('[group@g.us]', 'data:image/jpeg;base64,.....');
+

      Parameters

      • groupId: string | Wid
      • content: string

      Returns Promise<{
          _duplicate: boolean;
          eurl: string;
          status: number;
          tag: string;
          token: string;
      }>

      Example

      await WPP.group.setIcon('[group@g.us]', 'data:image/jpeg;base64,.....');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.setProperty.html b/functions/group.setProperty.html index 2256ca5f84..8b4bbccc98 100644 --- a/functions/group.setProperty.html +++ b/functions/group.setProperty.html @@ -1,5 +1,5 @@ setProperty | @wppconnect/wa-js - v3.10.1

    Function setProperty

    • setProperty(groupId, property, value): Promise<boolean>

    • Set the group property

      -

      Parameters

      • groupId: string | Wid
      • property: GroupProperty
      • value:
            | boolean
            | 0
            | 1
            | 86400
            | 604800
            | 7776000

      Returns Promise<boolean>

      Example

      // Only admins can send message
      await WPP.group.setProperty('[group-id]@g.us', 'announcement', true);

      // All can send message
      await WPP.group.setProperty('[group-id]@g.us', 'announcement', false);

      // Disatble temporary messages
      await WPP.group.setProperty('[group-id]@g.us', 'ephemeral', 0);

      // Enable temporary messages for 24 hours
      await WPP.group.setProperty('[group-id]@g.us', 'ephemeral', 86400);

      // Enable temporary messages for 7 days
      await WPP.group.setProperty('[group-id]@g.us', 'ephemeral', 604800);

      // Enable temporary messages for 90 days
      await WPP.group.setProperty('[group-id]@g.us', 'ephemeral', 7776000);

      // Only admins can edit group properties
      await WPP.group.setProperty('[group-id]@g.us', 'restrict', true);

      // All can edit group properties
      await WPP.group.setProperty('[group-id]@g.us', 'restrict', false);
+

      Parameters

      • groupId: string | Wid
      • property: GroupProperty
      • value:
            | boolean
            | 0
            | 1
            | 86400
            | 604800
            | 7776000

      Returns Promise<boolean>

      Example

      // Only admins can send message
      await WPP.group.setProperty('[group-id]@g.us', 'announcement', true);

      // All can send message
      await WPP.group.setProperty('[group-id]@g.us', 'announcement', false);

      // Disatble temporary messages
      await WPP.group.setProperty('[group-id]@g.us', 'ephemeral', 0);

      // Enable temporary messages for 24 hours
      await WPP.group.setProperty('[group-id]@g.us', 'ephemeral', 86400);

      // Enable temporary messages for 7 days
      await WPP.group.setProperty('[group-id]@g.us', 'ephemeral', 604800);

      // Enable temporary messages for 90 days
      await WPP.group.setProperty('[group-id]@g.us', 'ephemeral', 7776000);

      // Only admins can edit group properties
      await WPP.group.setProperty('[group-id]@g.us', 'restrict', true);

      // All can edit group properties
      await WPP.group.setProperty('[group-id]@g.us', 'restrict', false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/group.setSubject.html b/functions/group.setSubject.html index 4327f04e20..8f246cbca1 100644 --- a/functions/group.setSubject.html +++ b/functions/group.setSubject.html @@ -1,5 +1,5 @@ setSubject | @wppconnect/wa-js - v3.10.1

    Function setSubject

    • setSubject(groupId, subject): Promise<boolean>

    • Define the group subject

      -

      Parameters

      • groupId: string | Wid
      • subject: string

      Returns Promise<boolean>

      Example

      await WPP.group.setSubject('[group-id]@g.us', 'new group subject');
+

      Parameters

      • groupId: string | Wid
      • subject: string

      Returns Promise<boolean>

      Example

      await WPP.group.setSubject('[group-id]@g.us', 'new group subject');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/labels.addNewLabel.html b/functions/labels.addNewLabel.html index e60455e856..7e66a1a184 100644 --- a/functions/labels.addNewLabel.html +++ b/functions/labels.addNewLabel.html @@ -1,6 +1,6 @@ addNewLabel | @wppconnect/wa-js - v3.10.1

    Function addNewLabel

    • addNewLabel(labelName, options?): Promise<Label>

    • Add a new label Use await WPP.labels.getLabelColorPalette() to get the list of available colors

      -

      Parameters

      • labelName: string
      • options: NewLabelOptions = {}

      Returns Promise<Label>

      Example

      await WPP.labels.addNewLabel(`Name of label`);
      //or
      await WPP.labels.addNewLabel(`Name of label`, { labelColor: '#dfaef0' });
+

      Parameters

      • labelName: string
      • options: NewLabelOptions = {}

      Returns Promise<Label>

      Example

      await WPP.labels.addNewLabel(`Name of label`);
      //or
      await WPP.labels.addNewLabel(`Name of label`, { labelColor: '#dfaef0' });

      //or with color index @@ -8,4 +8,4 @@
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/labels.addOrRemoveLabels.html b/functions/labels.addOrRemoveLabels.html index 67fbc8e091..61d526e8d3 100644 --- a/functions/labels.addOrRemoveLabels.html +++ b/functions/labels.addOrRemoveLabels.html @@ -1,5 +1,5 @@ addOrRemoveLabels | @wppconnect/wa-js - v3.10.1

    Function addOrRemoveLabels

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/labels.colorIsInLabelPalette.html b/functions/labels.colorIsInLabelPalette.html index 77721bf3c5..772f7376dd 100644 --- a/functions/labels.colorIsInLabelPalette.html +++ b/functions/labels.colorIsInLabelPalette.html @@ -1,6 +1,6 @@ colorIsInLabelPalette | @wppconnect/wa-js - v3.10.1

    Function colorIsInLabelPalette

    • colorIsInLabelPalette(color): Promise<boolean>

    • Check if color is in label palette

      Parameters

      • color: string | number

        If it's decimal, send it as a number. If it's hexadecimal, send it as a string

        -

      Returns Promise<boolean>

      Example

      await WPP.labels.colorIsInLabelPalette('#ffd429');
      //or
      await WPP.labels.colorIsInLabelPalette(4284794111);
+

    Returns Promise<boolean>

    Example

    await WPP.labels.colorIsInLabelPalette('#ffd429');
    //or
    await WPP.labels.colorIsInLabelPalette(4284794111);
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/labels.editLabel.html b/functions/labels.editLabel.html index f5917528f2..5169a1670c 100644 --- a/functions/labels.editLabel.html +++ b/functions/labels.editLabel.html @@ -1,6 +1,6 @@ editLabel | @wppconnect/wa-js - v3.10.1

    Function editLabel

    • editLabel(id, options?): Promise<Label>

    • Edit a label For get a new color, use await WPP.labels.getLabelColorPalette() to get the list of available colors

      -

      Parameters

      • id: string
      • options: EditLabelOptions = {}

      Returns Promise<Label>

      Example

      await WPP.labels.editLabel(`Name of label`);
      //or
      await WPP.labels.editLabel(`Name of label`, { labelColor: '#dfaef0' });
+

      Parameters

      • id: string
      • options: EditLabelOptions = {}

      Returns Promise<Label>

      Example

      await WPP.labels.editLabel(`Name of label`);
      //or
      await WPP.labels.editLabel(`Name of label`, { labelColor: '#dfaef0' });

      //or with color index @@ -8,4 +8,4 @@
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/newsletter.create.html b/functions/newsletter.create.html index 05067a86d2..56c901822c 100644 --- a/functions/newsletter.create.html +++ b/functions/newsletter.create.html @@ -1,5 +1,5 @@ create | @wppconnect/wa-js - v3.10.1

    Function create

    • create(name, opts): Promise<ResultCreateNewsletter>

    • Create a newsletter

      -

      Parameters

      • name: string
      • opts: {
            description?: string;
            picture?: string;
        }
        • Optionaldescription?: string
        • Optionalpicture?: string

      Returns Promise<ResultCreateNewsletter>

      Example

      // To edit name
      WPP.newsletter.create('Name for your newsletter', {
      description: 'Description for that',
      picture: '<base64_string',
      });
+

      Parameters

      • name: string
      • opts: {
            description?: string;
            picture?: string;
        }
        • Optionaldescription?: string
        • Optionalpicture?: string

      Returns Promise<ResultCreateNewsletter>

      Example

      // To edit name
      WPP.newsletter.create('Name for your newsletter', {
      description: 'Description for that',
      picture: '<base64_string',
      });
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/newsletter.destroy.html b/functions/newsletter.destroy.html index 440d27dbfe..1461af78fb 100644 --- a/functions/newsletter.destroy.html +++ b/functions/newsletter.destroy.html @@ -1,5 +1,5 @@ destroy | @wppconnect/wa-js - v3.10.1

    Function destroy

    • destroy(id): Promise<boolean>

    • Delete a newsletter

      -

      Parameters

      • id: string

      Returns Promise<boolean>

      Example

      const code = WPP.newsletter.destroy('[newsletter-id]@newsletter');
+

      Parameters

      • id: string

      Returns Promise<boolean>

      Example

      const code = WPP.newsletter.destroy('[newsletter-id]@newsletter');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/newsletter.edit.html b/functions/newsletter.edit.html index 4c3d37b914..cd51f91b70 100644 --- a/functions/newsletter.edit.html +++ b/functions/newsletter.edit.html @@ -1,5 +1,5 @@ edit | @wppconnect/wa-js - v3.10.1

    Function edit

    • edit(newsletterId, opts): Promise<ResultCreateNewsletter>

    • Edit the newsletter data

      -

      Parameters

      • newsletterId: string
      • opts: {
            description?: string;
            name?: string;
            picture?: string;
        }
        • Optionaldescription?: string
        • Optionalname?: string
        • Optionalpicture?: string

      Returns Promise<ResultCreateNewsletter>

      Example

      // To edit name
      const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
      name: 'New Name'
      });

      // To edit description
      const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
      description: 'New description'
      });

      // To change picture
      const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
      picture: '<base64_image>'
      });

      // To remove picture
      const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
      picture: null
      });
+

      Parameters

      • newsletterId: string
      • opts: {
            description?: string;
            name?: string;
            picture?: string;
        }
        • Optionaldescription?: string
        • Optionalname?: string
        • Optionalpicture?: string

      Returns Promise<ResultCreateNewsletter>

      Example

      // To edit name
      const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
      name: 'New Name'
      });

      // To edit description
      const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
      description: 'New description'
      });

      // To change picture
      const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
      picture: '<base64_image>'
      });

      // To remove picture
      const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
      picture: null
      });
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/newsletter.getSubscribers.html b/functions/newsletter.getSubscribers.html index f72efb1e1c..ef25140a69 100644 --- a/functions/newsletter.getSubscribers.html +++ b/functions/newsletter.getSubscribers.html @@ -1,5 +1,5 @@ getSubscribers | @wppconnect/wa-js - v3.10.1

    Function getSubscribers

    • getSubscribers(id): Promise<any>

    • Get subscribers of a newsletters

      -

      Parameters

      • id: string

      Returns Promise<any>

      Example

      const code = WPP.newsletter.getSubscribers('[newsletter-id]@newsletter');
+

      Parameters

      • id: string

      Returns Promise<any>

      Example

      const code = WPP.newsletter.getSubscribers('[newsletter-id]@newsletter');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/newsletter.mute.html b/functions/newsletter.mute.html index d232f42db3..8002d808e6 100644 --- a/functions/newsletter.mute.html +++ b/functions/newsletter.mute.html @@ -1,5 +1,5 @@ mute | @wppconnect/wa-js - v3.10.1

    Function mute

    • mute(newsletterId, value?): Promise<ChatModel>

    • Mute and unmute a newsletter

      -

      Parameters

      • newsletterId: string
      • Optionalvalue: boolean

      Returns Promise<ChatModel>

      Example

      // Mute

      +

      Parameters

      • newsletterId: string
      • Optionalvalue: boolean

      Returns Promise<ChatModel>

      Example

      // Mute

      WPP.newsletter.mute('[newsletter-id]@newsletter', true);
      @@ -7,4 +7,4 @@ 
      WPP.newsletter.mute('[newsletter-id]@newsletter', false);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/order.get.html b/functions/order.get.html index b7b6e864a9..840d86f3bf 100644 --- a/functions/order.get.html +++ b/functions/order.get.html @@ -1,6 +1,6 @@ get | @wppconnect/wa-js - v3.10.1

    Function get

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/profile.editBusinessProfile.html b/functions/profile.editBusinessProfile.html index 52d98332f9..92a4e2e48e 100644 --- a/functions/profile.editBusinessProfile.html +++ b/functions/profile.editBusinessProfile.html @@ -1,5 +1,5 @@ editBusinessProfile | @wppconnect/wa-js - v3.10.1

    Function editBusinessProfile

    • editBusinessProfile(params): Promise<any>

    • Update your business profile

      -

      Parameters

      Returns Promise<any>

      Example

      await WPP.profile.editBusinessProfile({description: 'New description for profile'});
+

      Parameters

      Returns Promise<any>

      Example

      await WPP.profile.editBusinessProfile({description: 'New description for profile'});
 
      await WPP.profile.editBusinessProfile({categories: {
         id: "133436743388217",
         localized_display_name: "Artes e entretenimento",
         not_a_biz: false,
       }});
@@ -22,4 +22,4 @@
 
      await WPP.profile.editBusinessProfile({ businessHours: { 
      {
           tue: {
             mode: "specific_hours",
             hours: [
               [
                 540,
                 1080,
               ],
             ],
           },
           wed: {
             mode: "specific_hours",
             hours: [
               [
                 540,
                 1080,
               ],
             ],
           },
           thu: {
             mode: "specific_hours",
             hours: [
               [
                 540,
                 1080,
               ],
             ],
           },
           fri: {
             mode: "specific_hours",
             hours: [
               [
                 540,
                 1080,
               ],
             ],
           },
           sat: {
             mode: "specific_hours",
             hours: [
               [
                 540,
                 1080,
               ],
             ],
           },
           sun: {
             mode: "specific_hours",
             hours: [
               [
                 540,
                 1080,
               ],
             ],
           },
         }
       },
       timezone: "America/Sao_Paulo"
       });

      Change businessHours for Always Opened
      ```javascript
      await WPP.profile.editBusinessProfile({ businessHours: { 
         {
           mon: {
             mode: "open_24h",
           },
           tue: {
             mode: "open_24h",
           },
           wed: {
             mode: "open_24h",
           },
           thu: {
             mode: "open_24h",
           },
           fri: {
             mode: "open_24h",
           },
           sat: {
             mode: "open_24h",
           },
           sun: {
             mode: "open_24h",
           },
         }
         timezone: "America/Sao_Paulo"
       });

      Change businessHours for Appointment Only
      ```javascript
      await WPP.profile.editBusinessProfile({ businessHours: { {
         mon: {
           mode: "appointment_only",
         },
         tue: {
           mode: "appointment_only",
         },
         wed: {
           mode: "appointment_only",
         },
         thu: {
           mode: "appointment_only",
         },
         fri: {
           mode: "appointment_only",
         },
         sat: {
           mode: "appointment_only",
         },
         sun: {
           mode: "appointment_only",
         },
       }
         timezone: "America/Sao_Paulo"
       });

      
 
      
 
-

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/profile.getMyProfileName.html b/functions/profile.getMyProfileName.html index 224922733c..86e2f91d25 100644 --- a/functions/profile.getMyProfileName.html +++ b/functions/profile.getMyProfileName.html @@ -1,5 +1,5 @@ getMyProfileName | @wppconnect/wa-js - v3.10.1

    Function getMyProfileName

    • getMyProfileName(): string

    • Get your current profile name

      -

      Returns string

      Example

      const myProfileName = WPP.profile.getMyProfileName();
+

      Returns string

      Example

      const myProfileName = WPP.profile.getMyProfileName();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/profile.getMyStatus.html b/functions/profile.getMyStatus.html index 6d5635de26..efc6d83106 100644 --- a/functions/profile.getMyStatus.html +++ b/functions/profile.getMyStatus.html @@ -1,5 +1,5 @@ getMyStatus | @wppconnect/wa-js - v3.10.1

    Function getMyStatus

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/profile.isBusiness.html b/functions/profile.isBusiness.html index 95340207df..5e31dc473f 100644 --- a/functions/profile.isBusiness.html +++ b/functions/profile.isBusiness.html @@ -1,5 +1,5 @@ isBusiness | @wppconnect/wa-js - v3.10.1

    Function isBusiness

    • isBusiness(): boolean | undefined

    • Return the current logged user is Bussiness or not

      -

      Returns boolean | undefined

      Example

      WPP.profile.isBusiness();
+

      Returns boolean | undefined

      Example

      WPP.profile.isBusiness();
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/profile.removeMyProfilePicture.html b/functions/profile.removeMyProfilePicture.html index aec6627585..bd0d8ee5c8 100644 --- a/functions/profile.removeMyProfilePicture.html +++ b/functions/profile.removeMyProfilePicture.html @@ -1,5 +1,5 @@ removeMyProfilePicture | @wppconnect/wa-js - v3.10.1

    Function removeMyProfilePicture

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/profile.setMyProfileName.html b/functions/profile.setMyProfileName.html index ede06ce78c..9e9c4a3bb3 100644 --- a/functions/profile.setMyProfileName.html +++ b/functions/profile.setMyProfileName.html @@ -1,5 +1,5 @@ setMyProfileName | @wppconnect/wa-js - v3.10.1

    Function setMyProfileName

    • setMyProfileName(name): Promise<boolean>

    • Update your current profile name

      -

      Parameters

      • name: string

      Returns Promise<boolean>

      Example

      await WPP.profile.setMyProfileName('My new name');
+

      Parameters

      • name: string

      Returns Promise<boolean>

      Example

      await WPP.profile.setMyProfileName('My new name');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/profile.setMyProfilePicture.html b/functions/profile.setMyProfilePicture.html index 2713a1cdd9..db75a3815d 100644 --- a/functions/profile.setMyProfilePicture.html +++ b/functions/profile.setMyProfilePicture.html @@ -1,5 +1,5 @@ setMyProfilePicture | @wppconnect/wa-js - v3.10.1

    Function setMyProfilePicture

    • setMyProfilePicture(content): Promise<{
          _duplicate: boolean;
          eurl: string;
          status: number;
          tag: string;
          token: string;
      }>

    • Update your profile picture

      -

      Parameters

      • content: string

      Returns Promise<{
          _duplicate: boolean;
          eurl: string;
          status: number;
          tag: string;
          token: string;
      }>

      Example

      await WPP.profile.setMyProfilePicture('data:image/jpeg;base64,.....');
+

      Parameters

      • content: string

      Returns Promise<{
          _duplicate: boolean;
          eurl: string;
          status: number;
          tag: string;
          token: string;
      }>

      Example

      await WPP.profile.setMyProfilePicture('data:image/jpeg;base64,.....');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/profile.setMyStatus.html b/functions/profile.setMyStatus.html index 836c2fe40e..1b96481d4b 100644 --- a/functions/profile.setMyStatus.html +++ b/functions/profile.setMyStatus.html @@ -1,5 +1,5 @@ setMyStatus | @wppconnect/wa-js - v3.10.1

    Function setMyStatus

    • setMyStatus(statusText): Promise<boolean>

    • Update your current text status

      -

      Parameters

      • statusText: string

      Returns Promise<boolean>

      Example

      await WPP.profile.setMyStatus('Example text');
+

      Parameters

      • statusText: string

      Returns Promise<boolean>

      Example

      await WPP.profile.setMyStatus('Example text');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/status.sendImageStatus.html b/functions/status.sendImageStatus.html index 8ec39352f8..bc784d9d3d 100644 --- a/functions/status.sendImageStatus.html +++ b/functions/status.sendImageStatus.html @@ -1,5 +1,5 @@ sendImageStatus | @wppconnect/wa-js - v3.10.1

    Function sendImageStatus

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/status.sendReadStatus.html b/functions/status.sendReadStatus.html index 5b2956435e..0f4b0f1db5 100644 --- a/functions/status.sendReadStatus.html +++ b/functions/status.sendReadStatus.html @@ -1,5 +1,5 @@ sendReadStatus | @wppconnect/wa-js - v3.10.1

    Function sendReadStatus

    • sendReadStatus(chatId, statusId): Promise<any>

    • Mark status as read/seen

      -

      Parameters

      • chatId: string | Wid
      • statusId: string

      Returns Promise<any>

      Example

      WPP.status.sendReadStatus('[phone_number]@c.us', 'false_status@broadcast_3A169E0FD4BC6E92212F_5521526232927@c.us');
+

      Parameters

      • chatId: string | Wid
      • statusId: string

      Returns Promise<any>

      Example

      WPP.status.sendReadStatus('[phone_number]@c.us', 'false_status@broadcast_3A169E0FD4BC6E92212F_5521526232927@c.us');
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/status.sendTextStatus.html b/functions/status.sendTextStatus.html index fa294c86cb..946ca6bb97 100644 --- a/functions/status.sendTextStatus.html +++ b/functions/status.sendTextStatus.html @@ -1,5 +1,5 @@ sendTextStatus | @wppconnect/wa-js - v3.10.1

    Function sendTextStatus

    • sendTextStatus(content, options?): Promise<any>

    • Send a text message to status stories

      -

      Parameters

      Returns Promise<any>

      Example

      WPP.status.sendTextStatus(`Bootstrap primary color: #0275d8`, { backgroundColor: '#0275d8', font: 2});
+

      Parameters

      Returns Promise<any>

      Example

      WPP.status.sendTextStatus(`Bootstrap primary color: #0275d8`, { backgroundColor: '#0275d8', font: 2});
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/status.sendVideoStatus.html b/functions/status.sendVideoStatus.html index 0861031dc3..d65eddc41a 100644 --- a/functions/status.sendVideoStatus.html +++ b/functions/status.sendVideoStatus.html @@ -1,5 +1,5 @@ sendVideoStatus | @wppconnect/wa-js - v3.10.1

    Function sendVideoStatus

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/status.updateParticipants.html b/functions/status.updateParticipants.html index e647c7d435..34549f4630 100644 --- a/functions/status.updateParticipants.html +++ b/functions/status.updateParticipants.html @@ -1,5 +1,5 @@ updateParticipants | @wppconnect/wa-js - v3.10.1

    Function updateParticipants

    • updateParticipants(ids?): Promise<void>

    • Define a custom list of participants to send the status message

      -

      Parameters

      • Optionalids: null | (string | Wid)[]

      Returns Promise<void>

      Example

      // Use a custom list
      await WPP.status.updateParticipants(['123@c.us', '456@c.us']);
      // Use the contacts by default
      await WPP.status.updateParticipants(null);
+

      Parameters

      • Optionalids: null | (string | Wid)[]

      Returns Promise<void>

      Example

      // Use a custom list
      await WPP.status.updateParticipants(['123@c.us', '456@c.us']);
      // Use the contacts by default
      await WPP.status.updateParticipants(null);
      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/util.getVideoInfoFromBuffer.html b/functions/util.getVideoInfoFromBuffer.html index c9665dbe99..0e8e8c7aec 100644 --- a/functions/util.getVideoInfoFromBuffer.html +++ b/functions/util.getVideoInfoFromBuffer.html @@ -1,6 +1,6 @@ getVideoInfoFromBuffer | @wppconnect/wa-js - v3.10.1

    Function getVideoInfoFromBuffer

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.GROUP_JID.html b/functions/whatsapp.functions.GROUP_JID.html index f47adf156e..c9466906f3 100644 --- a/functions/whatsapp.functions.GROUP_JID.html +++ b/functions/whatsapp.functions.GROUP_JID.html @@ -1,2 +1,2 @@ -GROUP_JID | @wppconnect/wa-js - v3.10.1

    Function GROUP_JID

    Settings

    Member Visibility
    +GROUP_JID | @wppconnect/wa-js - v3.10.1

    Function GROUP_JID

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.addAndSendMessageEdit.html b/functions/whatsapp.functions.addAndSendMessageEdit.html index 879865a069..112666c119 100644 --- a/functions/whatsapp.functions.addAndSendMessageEdit.html +++ b/functions/whatsapp.functions.addAndSendMessageEdit.html @@ -1,2 +1,2 @@ -addAndSendMessageEdit | @wppconnect/wa-js - v3.10.1

    Function addAndSendMessageEdit

    Settings

    Member Visibility
    +addAndSendMessageEdit | @wppconnect/wa-js - v3.10.1

    Function addAndSendMessageEdit

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.addAndSendMsgToChat.html b/functions/whatsapp.functions.addAndSendMsgToChat.html index f30967bda7..f819321239 100644 --- a/functions/whatsapp.functions.addAndSendMsgToChat.html +++ b/functions/whatsapp.functions.addAndSendMsgToChat.html @@ -1,4 +1,4 @@ -addAndSendMsgToChat | @wppconnect/wa-js - v3.10.1

    Function addAndSendMsgToChat

    Settings

    Member Visibility
    +addAndSendMsgToChat | @wppconnect/wa-js - v3.10.1

    Function addAndSendMsgToChat

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.addParticipants.html b/functions/whatsapp.functions.addParticipants.html index c0a50e849b..9f174ff70f 100644 --- a/functions/whatsapp.functions.addParticipants.html +++ b/functions/whatsapp.functions.addParticipants.html @@ -1,4 +1,4 @@ -addParticipants | @wppconnect/wa-js - v3.10.1

    Function addParticipants

    Settings

    Member Visibility
    +addParticipants | @wppconnect/wa-js - v3.10.1

    Function addParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.addProduct.html b/functions/whatsapp.functions.addProduct.html index eab181fef1..a810267ee4 100644 --- a/functions/whatsapp.functions.addProduct.html +++ b/functions/whatsapp.functions.addProduct.html @@ -1,4 +1,4 @@ -addProduct | @wppconnect/wa-js - v3.10.1

    Function addProduct

    Settings

    Member Visibility
    +addProduct | @wppconnect/wa-js - v3.10.1

    Function addProduct

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.addToLabelCollection.html b/functions/whatsapp.functions.addToLabelCollection.html index af9b2c5b50..0893f874ac 100644 --- a/functions/whatsapp.functions.addToLabelCollection.html +++ b/functions/whatsapp.functions.addToLabelCollection.html @@ -1,2 +1,2 @@ -addToLabelCollection | @wppconnect/wa-js - v3.10.1

    Function addToLabelCollection

    Settings

    Member Visibility
    +addToLabelCollection | @wppconnect/wa-js - v3.10.1

    Function addToLabelCollection

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.blockContact.html b/functions/whatsapp.functions.blockContact.html index 6ad15029e3..8a391d2302 100644 --- a/functions/whatsapp.functions.blockContact.html +++ b/functions/whatsapp.functions.blockContact.html @@ -1,4 +1,4 @@ -blockContact | @wppconnect/wa-js - v3.10.1

    Function blockContact

    Settings

    Member Visibility
    +blockContact | @wppconnect/wa-js - v3.10.1

    Function blockContact

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.calculateFilehashFromBlob.html b/functions/whatsapp.functions.calculateFilehashFromBlob.html index d65ce3656e..7971c160e7 100644 --- a/functions/whatsapp.functions.calculateFilehashFromBlob.html +++ b/functions/whatsapp.functions.calculateFilehashFromBlob.html @@ -1,2 +1,2 @@ -calculateFilehashFromBlob | @wppconnect/wa-js - v3.10.1

    Function calculateFilehashFromBlob

    Settings

    Member Visibility
    +calculateFilehashFromBlob | @wppconnect/wa-js - v3.10.1

    Function calculateFilehashFromBlob

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.canEditCaption.html b/functions/whatsapp.functions.canEditCaption.html index ad0d755985..c8aad3e9ec 100644 --- a/functions/whatsapp.functions.canEditCaption.html +++ b/functions/whatsapp.functions.canEditCaption.html @@ -1,2 +1,2 @@ -canEditCaption | @wppconnect/wa-js - v3.10.1

    Function canEditCaption

    Settings

    Member Visibility
    +canEditCaption | @wppconnect/wa-js - v3.10.1

    Function canEditCaption

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.canEditMsg.html b/functions/whatsapp.functions.canEditMsg.html index b0588f2b3c..7f085abab2 100644 --- a/functions/whatsapp.functions.canEditMsg.html +++ b/functions/whatsapp.functions.canEditMsg.html @@ -1,2 +1,2 @@ -canEditMsg | @wppconnect/wa-js - v3.10.1

    Function canEditMsg

    Settings

    Member Visibility
    +canEditMsg | @wppconnect/wa-js - v3.10.1

    Function canEditMsg

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.canMarkPlayed.html b/functions/whatsapp.functions.canMarkPlayed.html index 90cf5e2357..401b3a7aaf 100644 --- a/functions/whatsapp.functions.canMarkPlayed.html +++ b/functions/whatsapp.functions.canMarkPlayed.html @@ -1,3 +1,3 @@ -canMarkPlayed | @wppconnect/wa-js - v3.10.1

    Function canMarkPlayed

    Settings

    Member Visibility
    +canMarkPlayed | @wppconnect/wa-js - v3.10.1

    Function canMarkPlayed

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.canReplyMsg.html b/functions/whatsapp.functions.canReplyMsg.html index 9dedaa03a6..7362d60ea9 100644 --- a/functions/whatsapp.functions.canReplyMsg.html +++ b/functions/whatsapp.functions.canReplyMsg.html @@ -1,2 +1,2 @@ -canReplyMsg | @wppconnect/wa-js - v3.10.1

    Function canReplyMsg

    Settings

    Member Visibility
    +canReplyMsg | @wppconnect/wa-js - v3.10.1

    Function canReplyMsg

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.changeOptInStatusForExternalWebBeta.html b/functions/whatsapp.functions.changeOptInStatusForExternalWebBeta.html index 35d38758ea..220f9dc3b9 100644 --- a/functions/whatsapp.functions.changeOptInStatusForExternalWebBeta.html +++ b/functions/whatsapp.functions.changeOptInStatusForExternalWebBeta.html @@ -1,2 +1,2 @@ -changeOptInStatusForExternalWebBeta | @wppconnect/wa-js - v3.10.1

    Function changeOptInStatusForExternalWebBeta

    Settings

    Member Visibility
    +changeOptInStatusForExternalWebBeta | @wppconnect/wa-js - v3.10.1

    Function changeOptInStatusForExternalWebBeta

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.colorIndexToHex.html b/functions/whatsapp.functions.colorIndexToHex.html index a0f28db0e1..06c1e7c29b 100644 --- a/functions/whatsapp.functions.colorIndexToHex.html +++ b/functions/whatsapp.functions.colorIndexToHex.html @@ -1,2 +1,2 @@ -colorIndexToHex | @wppconnect/wa-js - v3.10.1

    Function colorIndexToHex

    Settings

    Member Visibility
    +colorIndexToHex | @wppconnect/wa-js - v3.10.1

    Function colorIndexToHex

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.createBusinessCatalog.html b/functions/whatsapp.functions.createBusinessCatalog.html index bef9850b86..5e7d45e802 100644 --- a/functions/whatsapp.functions.createBusinessCatalog.html +++ b/functions/whatsapp.functions.createBusinessCatalog.html @@ -1,2 +1,2 @@ -createBusinessCatalog | @wppconnect/wa-js - v3.10.1

    Function createBusinessCatalog

    Settings

    Member Visibility
    +createBusinessCatalog | @wppconnect/wa-js - v3.10.1

    Function createBusinessCatalog

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.createCollection.html b/functions/whatsapp.functions.createCollection.html index d0ea75fde4..ab26714564 100644 --- a/functions/whatsapp.functions.createCollection.html +++ b/functions/whatsapp.functions.createCollection.html @@ -1,2 +1,2 @@ -createCollection | @wppconnect/wa-js - v3.10.1

    Function createCollection

    Settings

    Member Visibility
    +createCollection | @wppconnect/wa-js - v3.10.1

    Function createCollection

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.createGroup.html b/functions/whatsapp.functions.createGroup.html index 1c8f4750e0..53107db8a0 100644 --- a/functions/whatsapp.functions.createGroup.html +++ b/functions/whatsapp.functions.createGroup.html @@ -1,2 +1,2 @@ -createGroup | @wppconnect/wa-js - v3.10.1

    Function createGroup

    • createGroup(groupName, participants, ephemeral?, parentGroup?): Promise<{
          participants: {
              error: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              wid: Wid;
          }[];
          wid: Wid;
      }>

    • Parameters

      • groupName: string
      • participants: Wid[]
      • Optionalephemeral: number
      • OptionalparentGroup: Wid

      Returns Promise<{
          participants: {
              error: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              wid: Wid;
          }[];
          wid: Wid;
      }>

      Whatsapp

      247355

      -
    • createGroup(options, participants): Promise<{
          participants: {
              error: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              wid: Wid;
          }[];
          wid: Wid;
      }>

    • Parameters

      • options: {
            announce: boolean;
            ephemeralDuration: number;
            memberAddMode: boolean;
            membershipApprovalMode: boolean;
            parentGroupId?: Wid;
            restrict: boolean;
            title: string;
        }
        • announce: boolean
        • ephemeralDuration: number
        • memberAddMode: boolean
        • membershipApprovalMode: boolean
        • OptionalparentGroupId?: Wid
        • restrict: boolean
        • title: string
      • participants: Wid[]

      Returns Promise<{
          participants: {
              error: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              wid: Wid;
          }[];
          wid: Wid;
      }>

    Settings

    Member Visibility
    +createGroup | @wppconnect/wa-js - v3.10.1

    Function createGroup

    • createGroup(groupName, participants, ephemeral?, parentGroup?): Promise<{
          participants: {
              error: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              wid: Wid;
          }[];
          wid: Wid;
      }>

    • Parameters

      • groupName: string
      • participants: Wid[]
      • Optionalephemeral: number
      • OptionalparentGroup: Wid

      Returns Promise<{
          participants: {
              error: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              wid: Wid;
          }[];
          wid: Wid;
      }>

      Whatsapp

      247355

      +
    • createGroup(options, participants): Promise<{
          participants: {
              error: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              wid: Wid;
          }[];
          wid: Wid;
      }>

    • Parameters

      • options: {
            announce: boolean;
            ephemeralDuration: number;
            memberAddMode: boolean;
            membershipApprovalMode: boolean;
            parentGroupId?: Wid;
            restrict: boolean;
            title: string;
        }
        • announce: boolean
        • ephemeralDuration: number
        • memberAddMode: boolean
        • membershipApprovalMode: boolean
        • OptionalparentGroupId?: Wid
        • restrict: boolean
        • title: string
      • participants: Wid[]

      Returns Promise<{
          participants: {
              error: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              wid: Wid;
          }[];
          wid: Wid;
      }>

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.createMsgProtobuf.html b/functions/whatsapp.functions.createMsgProtobuf.html index f04aa2507b..59fa6166c2 100644 --- a/functions/whatsapp.functions.createMsgProtobuf.html +++ b/functions/whatsapp.functions.createMsgProtobuf.html @@ -1,4 +1,4 @@ -createMsgProtobuf | @wppconnect/wa-js - v3.10.1

    Function createMsgProtobuf

    • createMsgProtobuf(e, t?): {
          [key: string]: any;
      }

    • Parameters

      • e: MsgModel
      • Optionalt: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns {
          [key: string]: any;
      }

      • [key: string]: any

      Whatsapp

      6565

      -

      Whatsapp

      606565 >= 2.2222.8

      -

      Whatsapp

      615947 >= 2.2228.4

      -

    Settings

    Member Visibility
    +createMsgProtobuf | @wppconnect/wa-js - v3.10.1

    Function createMsgProtobuf

    • createMsgProtobuf(e, t?): {
          [key: string]: any;
      }

    • Parameters

      • e: MsgModel
      • Optionalt: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns {
          [key: string]: any;
      }

      • [key: string]: any

      Whatsapp

      6565

      +

      Whatsapp

      606565 >= 2.2222.8

      +

      Whatsapp

      615947 >= 2.2228.4

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.createNewsletterQuery.html b/functions/whatsapp.functions.createNewsletterQuery.html index a2a51a051d..6ff1ac7496 100644 --- a/functions/whatsapp.functions.createNewsletterQuery.html +++ b/functions/whatsapp.functions.createNewsletterQuery.html @@ -1,2 +1,2 @@ -createNewsletterQuery | @wppconnect/wa-js - v3.10.1

    Function createNewsletterQuery

    • createNewsletterQuery(opts): any

    • Parameters

      • opts: {
            description: null | string;
            name: string;
            picture: null | string;
        }
        • description: null | string
        • name: string
        • picture: null | string

      Returns any

      Whatsapp

      874705

      -

    Settings

    Member Visibility
    +createNewsletterQuery | @wppconnect/wa-js - v3.10.1

    Function createNewsletterQuery

    • createNewsletterQuery(opts): any

    • Parameters

      • opts: {
            description: null | string;
            name: string;
            picture: null | string;
        }
        • description: null | string
        • name: string
        • picture: null | string

      Returns any

      Whatsapp

      874705

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.createOrUpdateReactions.html b/functions/whatsapp.functions.createOrUpdateReactions.html index bd5953fc0a..1e9096056d 100644 --- a/functions/whatsapp.functions.createOrUpdateReactions.html +++ b/functions/whatsapp.functions.createOrUpdateReactions.html @@ -1,4 +1,4 @@ -createOrUpdateReactions | @wppconnect/wa-js - v3.10.1

    Function createOrUpdateReactions

    Settings

    Member Visibility
    +createOrUpdateReactions | @wppconnect/wa-js - v3.10.1

    Function createOrUpdateReactions

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.createOrder.html b/functions/whatsapp.functions.createOrder.html index 2a161fe2cd..767d18b0a7 100644 --- a/functions/whatsapp.functions.createOrder.html +++ b/functions/whatsapp.functions.createOrder.html @@ -1,2 +1,2 @@ -createOrder | @wppconnect/wa-js - v3.10.1

    Function createOrder

    • createOrder(wid, cartItems?): Promise<{
          id: number;
          price?: any;
          token: any;
      }>

    • Parameters

      • wid: Wid
      • OptionalcartItems: any

      Returns Promise<{
          id: number;
          price?: any;
          token: any;
      }>

      Whatsapp

      990553

      -

    Settings

    Member Visibility
    +createOrder | @wppconnect/wa-js - v3.10.1

    Function createOrder

    • createOrder(wid, cartItems?): Promise<{
          id: number;
          price?: any;
          token: any;
      }>

    • Parameters

      • wid: Wid
      • OptionalcartItems: any

      Returns Promise<{
          id: number;
          price?: any;
          token: any;
      }>

      Whatsapp

      990553

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.currencyForCountryShortcode.html b/functions/whatsapp.functions.currencyForCountryShortcode.html index 2c2d20f74a..582692b565 100644 --- a/functions/whatsapp.functions.currencyForCountryShortcode.html +++ b/functions/whatsapp.functions.currencyForCountryShortcode.html @@ -1,2 +1,2 @@ -currencyForCountryShortcode | @wppconnect/wa-js - v3.10.1

    Function currencyForCountryShortcode

    Settings

    Member Visibility
    +currencyForCountryShortcode | @wppconnect/wa-js - v3.10.1

    Function currencyForCountryShortcode

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.deleteCollection.html b/functions/whatsapp.functions.deleteCollection.html index caab7dc945..3d17a5eb06 100644 --- a/functions/whatsapp.functions.deleteCollection.html +++ b/functions/whatsapp.functions.deleteCollection.html @@ -1,2 +1,2 @@ -deleteCollection | @wppconnect/wa-js - v3.10.1

    Function deleteCollection

    Settings

    Member Visibility
    +deleteCollection | @wppconnect/wa-js - v3.10.1

    Function deleteCollection

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.deleteNewsletter.html b/functions/whatsapp.functions.deleteNewsletter.html index d599117674..c2ab5f106a 100644 --- a/functions/whatsapp.functions.deleteNewsletter.html +++ b/functions/whatsapp.functions.deleteNewsletter.html @@ -1,2 +1,2 @@ -deleteNewsletter | @wppconnect/wa-js - v3.10.1

    Function deleteNewsletter

    Settings

    Member Visibility
    +deleteNewsletter | @wppconnect/wa-js - v3.10.1

    Function deleteNewsletter

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.deleteProducts.html b/functions/whatsapp.functions.deleteProducts.html index 62a8a8a390..1b5b565cb0 100644 --- a/functions/whatsapp.functions.deleteProducts.html +++ b/functions/whatsapp.functions.deleteProducts.html @@ -1,4 +1,4 @@ -deleteProducts | @wppconnect/wa-js - v3.10.1

    Function deleteProducts

    Settings

    Member Visibility
    +deleteProducts | @wppconnect/wa-js - v3.10.1

    Function deleteProducts

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.demoteCommunityParticipants.html b/functions/whatsapp.functions.demoteCommunityParticipants.html index b5567af0de..5f4106d9e2 100644 --- a/functions/whatsapp.functions.demoteCommunityParticipants.html +++ b/functions/whatsapp.functions.demoteCommunityParticipants.html @@ -1,2 +1,2 @@ -demoteCommunityParticipants | @wppconnect/wa-js - v3.10.1

    Function demoteCommunityParticipants

    Settings

    Member Visibility
    +demoteCommunityParticipants | @wppconnect/wa-js - v3.10.1

    Function demoteCommunityParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.demoteParticipants.html b/functions/whatsapp.functions.demoteParticipants.html index b08a5910df..8372cd7862 100644 --- a/functions/whatsapp.functions.demoteParticipants.html +++ b/functions/whatsapp.functions.demoteParticipants.html @@ -1,4 +1,4 @@ -demoteParticipants | @wppconnect/wa-js - v3.10.1

    Function demoteParticipants

    Settings

    Member Visibility
    +demoteParticipants | @wppconnect/wa-js - v3.10.1

    Function demoteParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.editBusinessProfile.html b/functions/whatsapp.functions.editBusinessProfile.html index 060cf291fd..fa11159991 100644 --- a/functions/whatsapp.functions.editBusinessProfile.html +++ b/functions/whatsapp.functions.editBusinessProfile.html @@ -1,2 +1,2 @@ -editBusinessProfile | @wppconnect/wa-js - v3.10.1

    Function editBusinessProfile

    Settings

    Member Visibility
    +editBusinessProfile | @wppconnect/wa-js - v3.10.1

    Function editBusinessProfile

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.editCollection.html b/functions/whatsapp.functions.editCollection.html index fbc79ebfff..92e575549c 100644 --- a/functions/whatsapp.functions.editCollection.html +++ b/functions/whatsapp.functions.editCollection.html @@ -1,2 +1,2 @@ -editCollection | @wppconnect/wa-js - v3.10.1

    Function editCollection

    • editCollection(collectionId, collectionName, collectionBoolea, productsToAdd, productsToRemove, sessionId): Promise<any>

    • Parameters

      • collectionId: string
      • collectionName: undefined | string
      • collectionBoolea: boolean
      • productsToAdd: string[]
      • productsToRemove: string[]
      • sessionId: string

      Returns Promise<any>

      Whatsapp

      409465 >= 2.2228.14

      -

    Settings

    Member Visibility
    +editCollection | @wppconnect/wa-js - v3.10.1

    Function editCollection

    • editCollection(collectionId, collectionName, collectionBoolea, productsToAdd, productsToRemove, sessionId): Promise<any>

    • Parameters

      • collectionId: string
      • collectionName: undefined | string
      • collectionBoolea: boolean
      • productsToAdd: string[]
      • productsToRemove: string[]
      • sessionId: string

      Returns Promise<any>

      Whatsapp

      409465 >= 2.2228.14

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.editNewsletterMetadataAction.html b/functions/whatsapp.functions.editNewsletterMetadataAction.html index 84b8f1e270..e62f2e01d1 100644 --- a/functions/whatsapp.functions.editNewsletterMetadataAction.html +++ b/functions/whatsapp.functions.editNewsletterMetadataAction.html @@ -1,2 +1,2 @@ -editNewsletterMetadataAction | @wppconnect/wa-js - v3.10.1

    Function editNewsletterMetadataAction

    • editNewsletterMetadataAction(newsletter, editAtts, data): any

    • Parameters

      • newsletter: ChatModel
      • editAtts: {
            editDescription?: boolean;
            editName?: boolean;
            editPicture?: boolean;
        }
        • OptionaleditDescription?: boolean
        • OptionaleditName?: boolean
        • OptionaleditPicture?: boolean
      • data: {
            description?: string;
            name?: string;
            picture?: null | string;
        }
        • Optionaldescription?: string
        • Optionalname?: string
        • Optionalpicture?: null | string

      Returns any

      Whatsapp

      172365

      -

    Settings

    Member Visibility
    +editNewsletterMetadataAction | @wppconnect/wa-js - v3.10.1

    Function editNewsletterMetadataAction

    • editNewsletterMetadataAction(newsletter, editAtts, data): any

    • Parameters

      • newsletter: ChatModel
      • editAtts: {
            editDescription?: boolean;
            editName?: boolean;
            editPicture?: boolean;
        }
        • OptionaleditDescription?: boolean
        • OptionaleditName?: boolean
        • OptionaleditPicture?: boolean
      • data: {
            description?: string;
            name?: string;
            picture?: null | string;
        }
        • Optionaldescription?: string
        • Optionalname?: string
        • Optionalpicture?: null | string

      Returns any

      Whatsapp

      172365

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.editProduct.html b/functions/whatsapp.functions.editProduct.html index f64d717ed4..53c0d55171 100644 --- a/functions/whatsapp.functions.editProduct.html +++ b/functions/whatsapp.functions.editProduct.html @@ -1,4 +1,4 @@ -editProduct | @wppconnect/wa-js - v3.10.1

    Function editProduct

    Settings

    Member Visibility
    +editProduct | @wppconnect/wa-js - v3.10.1

    Function editProduct

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.encodeMaybeMediaType.html b/functions/whatsapp.functions.encodeMaybeMediaType.html index 5f269b6e22..c2a3529bd9 100644 --- a/functions/whatsapp.functions.encodeMaybeMediaType.html +++ b/functions/whatsapp.functions.encodeMaybeMediaType.html @@ -1,2 +1,2 @@ -encodeMaybeMediaType | @wppconnect/wa-js - v3.10.1

    Function encodeMaybeMediaType

    Settings

    Member Visibility
    +encodeMaybeMediaType | @wppconnect/wa-js - v3.10.1

    Function encodeMaybeMediaType

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.encryptAndSendGroupMsg.html b/functions/whatsapp.functions.encryptAndSendGroupMsg.html index 941c378dd7..144adf6920 100644 --- a/functions/whatsapp.functions.encryptAndSendGroupMsg.html +++ b/functions/whatsapp.functions.encryptAndSendGroupMsg.html @@ -1,4 +1,4 @@ -encryptAndSendGroupMsg | @wppconnect/wa-js - v3.10.1

    Function encryptAndSendGroupMsg

    Settings

    Member Visibility
    +encryptAndSendGroupMsg | @wppconnect/wa-js - v3.10.1

    Function encryptAndSendGroupMsg

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.encryptAndSendMsg.html b/functions/whatsapp.functions.encryptAndSendMsg.html index 7cc23c7efa..8a1624dedf 100644 --- a/functions/whatsapp.functions.encryptAndSendMsg.html +++ b/functions/whatsapp.functions.encryptAndSendMsg.html @@ -1,4 +1,4 @@ -encryptAndSendMsg | @wppconnect/wa-js - v3.10.1

    Function encryptAndSendMsg

    • encryptAndSendMsg(msg, data, report): Promise<any>

    • Parameters

      • msg: {
            data: MsgModel;
            type: string;
        }
      • data: {
            ack: number;
            author?: Wid;
            from: Wid;
            id: MsgKey;
            subtype?: string;
            to: Wid;
            type: string;
        }
        • ack: number
        • Optionalauthor?: Wid
        • from: Wid
        • id: MsgKey
        • Optionalsubtype?: string
        • to: Wid
        • type: string
      • report: any

      Returns Promise<any>

      Whatsapp

      95547

      -

      Whatsapp

      695547 >= 2.2222.8

      -

      Whatsapp

      925080 >= 2.2228.4

      -

    Settings

    Member Visibility
    +encryptAndSendMsg | @wppconnect/wa-js - v3.10.1

    Function encryptAndSendMsg

    • encryptAndSendMsg(msg, data, report): Promise<any>

    • Parameters

      • msg: {
            data: MsgModel;
            type: string;
        }
      • data: {
            ack: number;
            author?: Wid;
            from: Wid;
            id: MsgKey;
            subtype?: string;
            to: Wid;
            type: string;
        }
        • ack: number
        • Optionalauthor?: Wid
        • from: Wid
        • id: MsgKey
        • Optionalsubtype?: string
        • to: Wid
        • type: string
      • report: any

      Returns Promise<any>

      Whatsapp

      95547

      +

      Whatsapp

      695547 >= 2.2222.8

      +

      Whatsapp

      925080 >= 2.2228.4

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.encryptAndSendSenderKeyMsg.html b/functions/whatsapp.functions.encryptAndSendSenderKeyMsg.html index 06212142dc..7e7ab60fb5 100644 --- a/functions/whatsapp.functions.encryptAndSendSenderKeyMsg.html +++ b/functions/whatsapp.functions.encryptAndSendSenderKeyMsg.html @@ -1,4 +1,4 @@ -encryptAndSendSenderKeyMsg | @wppconnect/wa-js - v3.10.1

    Function encryptAndSendSenderKeyMsg

    • encryptAndSendSenderKeyMsg(msg, data, proto, skGroup, options, report, other): Promise<any>

    • Parameters

      • msg: {
            data: MsgModel;
            type: string;
        }
      • data: {
            ack: number;
            author?: Wid;
            from: Wid;
            id: MsgKey;
            subtype?: string;
            to: Wid;
            type: string;
        }
        • ack: number
        • Optionalauthor?: Wid
        • from: Wid
        • id: MsgKey
        • Optionalsubtype?: string
        • to: Wid
        • type: string
      • proto: any
      • skGroup: any
      • options: any
      • report: any
      • other: any

      Returns Promise<any>

      Whatsapp

      95547

      -

      Whatsapp

      695547 >= 2.2222.8

      -

      Whatsapp

      925080 >= 2.2228.4

      -

    Settings

    Member Visibility
    +encryptAndSendSenderKeyMsg | @wppconnect/wa-js - v3.10.1

    Function encryptAndSendSenderKeyMsg

    • encryptAndSendSenderKeyMsg(msg, data, proto, skGroup, options, report, other): Promise<any>

    • Parameters

      • msg: {
            data: MsgModel;
            type: string;
        }
      • data: {
            ack: number;
            author?: Wid;
            from: Wid;
            id: MsgKey;
            subtype?: string;
            to: Wid;
            type: string;
        }
        • ack: number
        • Optionalauthor?: Wid
        • from: Wid
        • id: MsgKey
        • Optionalsubtype?: string
        • to: Wid
        • type: string
      • proto: any
      • skGroup: any
      • options: any
      • report: any
      • other: any

      Returns Promise<any>

      Whatsapp

      95547

      +

      Whatsapp

      695547 >= 2.2222.8

      +

      Whatsapp

      925080 >= 2.2228.4

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.encryptAndSendStatusMsg.html b/functions/whatsapp.functions.encryptAndSendStatusMsg.html index f201a9bbb3..1d4457cca1 100644 --- a/functions/whatsapp.functions.encryptAndSendStatusMsg.html +++ b/functions/whatsapp.functions.encryptAndSendStatusMsg.html @@ -1,2 +1,2 @@ -encryptAndSendStatusMsg | @wppconnect/wa-js - v3.10.1

    Function encryptAndSendStatusMsg

    • encryptAndSendStatusMsg(msg, proto, report): Promise<any>

    • Parameters

      • msg: {
            data: {
                ack: number;
                author?: Wid;
                from: Wid;
                id: MsgKey;
                subtype?: string;
                to: Wid;
                type: string;
            };
            msg: {
                data: MsgModel;
                type: string;
            };
        }
        • data: {
              ack: number;
              author?: Wid;
              from: Wid;
              id: MsgKey;
              subtype?: string;
              to: Wid;
              type: string;
          }
          • ack: number
          • Optionalauthor?: Wid
          • from: Wid
          • id: MsgKey
          • Optionalsubtype?: string
          • to: Wid
          • type: string
        • msg: {
              data: MsgModel;
              type: string;
          }
      • proto: any
      • report: any

      Returns Promise<any>

      Whatsapp

      WAWebEncryptAndSendStatusMsg

      -

    Settings

    Member Visibility
    +encryptAndSendStatusMsg | @wppconnect/wa-js - v3.10.1

    Function encryptAndSendStatusMsg

    • encryptAndSendStatusMsg(msg, proto, report): Promise<any>

    • Parameters

      • msg: {
            data: {
                ack: number;
                author?: Wid;
                from: Wid;
                id: MsgKey;
                subtype?: string;
                to: Wid;
                type: string;
            };
            msg: {
                data: MsgModel;
                type: string;
            };
        }
        • data: {
              ack: number;
              author?: Wid;
              from: Wid;
              id: MsgKey;
              subtype?: string;
              to: Wid;
              type: string;
          }
          • ack: number
          • Optionalauthor?: Wid
          • from: Wid
          • id: MsgKey
          • Optionalsubtype?: string
          • to: Wid
          • type: string
        • msg: {
              data: MsgModel;
              type: string;
          }
      • proto: any
      • report: any

      Returns Promise<any>

      Whatsapp

      WAWebEncryptAndSendStatusMsg

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.encryptMsgProtobuf.html b/functions/whatsapp.functions.encryptMsgProtobuf.html index 0cd4209cd8..d0a942534c 100644 --- a/functions/whatsapp.functions.encryptMsgProtobuf.html +++ b/functions/whatsapp.functions.encryptMsgProtobuf.html @@ -1,2 +1,2 @@ -encryptMsgProtobuf | @wppconnect/wa-js - v3.10.1

    Function encryptMsgProtobuf

    Settings

    Member Visibility
    +encryptMsgProtobuf | @wppconnect/wa-js - v3.10.1

    Function encryptMsgProtobuf

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.fetchLinkPreview.html b/functions/whatsapp.functions.fetchLinkPreview.html index c159898592..a81022c4fe 100644 --- a/functions/whatsapp.functions.fetchLinkPreview.html +++ b/functions/whatsapp.functions.fetchLinkPreview.html @@ -1,5 +1,5 @@ -fetchLinkPreview | @wppconnect/wa-js - v3.10.1

    Function fetchLinkPreview

    Settings

    Member Visibility
    +fetchLinkPreview | @wppconnect/wa-js - v3.10.1

    Function fetchLinkPreview

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.findChat.html b/functions/whatsapp.functions.findChat.html index 201e0763f5..d014e5c426 100644 --- a/functions/whatsapp.functions.findChat.html +++ b/functions/whatsapp.functions.findChat.html @@ -1,4 +1,4 @@ -findChat | @wppconnect/wa-js - v3.10.1

    Function findChat

    Settings

    Member Visibility
    +findChat | @wppconnect/wa-js - v3.10.1

    Function findChat

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.findCommonGroups.html b/functions/whatsapp.functions.findCommonGroups.html index c6e3e3287a..4950bfd28f 100644 --- a/functions/whatsapp.functions.findCommonGroups.html +++ b/functions/whatsapp.functions.findCommonGroups.html @@ -1,2 +1,2 @@ -findCommonGroups | @wppconnect/wa-js - v3.10.1

    Function findCommonGroups

    Settings

    Member Visibility
    +findCommonGroups | @wppconnect/wa-js - v3.10.1

    Function findCommonGroups

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.findFirstWebLink.html b/functions/whatsapp.functions.findFirstWebLink.html index fa657e8745..c50028422d 100644 --- a/functions/whatsapp.functions.findFirstWebLink.html +++ b/functions/whatsapp.functions.findFirstWebLink.html @@ -1,4 +1,4 @@ -findFirstWebLink | @wppconnect/wa-js - v3.10.1

    Function findFirstWebLink

    Settings

    Member Visibility
    +findFirstWebLink | @wppconnect/wa-js - v3.10.1

    Function findFirstWebLink

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.forwardMessagesToChats.html b/functions/whatsapp.functions.forwardMessagesToChats.html index 289a897fab..e30fdea22e 100644 --- a/functions/whatsapp.functions.forwardMessagesToChats.html +++ b/functions/whatsapp.functions.forwardMessagesToChats.html @@ -1,3 +1,3 @@ -forwardMessagesToChats | @wppconnect/wa-js - v3.10.1

    Function forwardMessagesToChats

    Settings

    Member Visibility
    +forwardMessagesToChats | @wppconnect/wa-js - v3.10.1

    Function forwardMessagesToChats

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.frontendFireAndForget.html b/functions/whatsapp.functions.frontendFireAndForget.html index 66a7775a14..a568bef5c6 100644 --- a/functions/whatsapp.functions.frontendFireAndForget.html +++ b/functions/whatsapp.functions.frontendFireAndForget.html @@ -1,2 +1,2 @@ -frontendFireAndForget | @wppconnect/wa-js - v3.10.1

    Function frontendFireAndForget

    Settings

    Member Visibility
    +frontendFireAndForget | @wppconnect/wa-js - v3.10.1

    Function frontendFireAndForget

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.genLinkDeviceCodeForPhoneNumber.html b/functions/whatsapp.functions.genLinkDeviceCodeForPhoneNumber.html index 607bd55ca0..ebb38f82ff 100644 --- a/functions/whatsapp.functions.genLinkDeviceCodeForPhoneNumber.html +++ b/functions/whatsapp.functions.genLinkDeviceCodeForPhoneNumber.html @@ -1,2 +1,2 @@ -genLinkDeviceCodeForPhoneNumber | @wppconnect/wa-js - v3.10.1

    Function genLinkDeviceCodeForPhoneNumber

    Settings

    Member Visibility
    +genLinkDeviceCodeForPhoneNumber | @wppconnect/wa-js - v3.10.1

    Function genLinkDeviceCodeForPhoneNumber

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.genMinimalLinkPreview.html b/functions/whatsapp.functions.genMinimalLinkPreview.html index 16f50d328d..b886d07f43 100644 --- a/functions/whatsapp.functions.genMinimalLinkPreview.html +++ b/functions/whatsapp.functions.genMinimalLinkPreview.html @@ -1,4 +1,4 @@ -genMinimalLinkPreview | @wppconnect/wa-js - v3.10.1

    Function genMinimalLinkPreview

    Settings

    Member Visibility
    +genMinimalLinkPreview | @wppconnect/wa-js - v3.10.1

    Function genMinimalLinkPreview

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.generateVideoThumbsAndDuration.html b/functions/whatsapp.functions.generateVideoThumbsAndDuration.html index b51f3cb0d5..182a62def1 100644 --- a/functions/whatsapp.functions.generateVideoThumbsAndDuration.html +++ b/functions/whatsapp.functions.generateVideoThumbsAndDuration.html @@ -1,3 +1,3 @@ -generateVideoThumbsAndDuration | @wppconnect/wa-js - v3.10.1

    Function generateVideoThumbsAndDuration

    • generateVideoThumbsAndDuration(data): Promise<{
          duration: number;
          thumbs: {
              fullHeight: number;
              fullWidth: number;
              height: number;
              url: string;
              width: number;
          }[];
      }>

    • Parameters

      • data: {
            debugHint: string;
            file: Blob;
            maxDimensions: number[];
            throwOnBlack: boolean;
        }
        • debugHint: string
        • file: Blob
        • maxDimensions: number[]
        • throwOnBlack: boolean

      Returns Promise<{
          duration: number;
          thumbs: {
              fullHeight: number;
              fullWidth: number;
              height: number;
              url: string;
              width: number;
          }[];
      }>

      Whatsapp

      51428

      -

      Whatsapp

      551428 >= 2.2222.8

      -

    Settings

    Member Visibility
    +generateVideoThumbsAndDuration | @wppconnect/wa-js - v3.10.1

    Function generateVideoThumbsAndDuration

    • generateVideoThumbsAndDuration(data): Promise<{
          duration: number;
          thumbs: {
              fullHeight: number;
              fullWidth: number;
              height: number;
              url: string;
              width: number;
          }[];
      }>

    • Parameters

      • data: {
            debugHint: string;
            file: Blob;
            maxDimensions: number[];
            throwOnBlack: boolean;
        }
        • debugHint: string
        • file: Blob
        • maxDimensions: number[]
        • throwOnBlack: boolean

      Returns Promise<{
          duration: number;
          thumbs: {
              fullHeight: number;
              fullWidth: number;
              height: number;
              url: string;
              width: number;
          }[];
      }>

      Whatsapp

      51428

      +

      Whatsapp

      551428 >= 2.2222.8

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getABPropConfigValue.html b/functions/whatsapp.functions.getABPropConfigValue.html index 98f900d04e..53c137bfe9 100644 --- a/functions/whatsapp.functions.getABPropConfigValue.html +++ b/functions/whatsapp.functions.getABPropConfigValue.html @@ -1,4 +1,4 @@ -getABPropConfigValue | @wppconnect/wa-js - v3.10.1

    Function getABPropConfigValue

    Settings

    Member Visibility
    +getABPropConfigValue | @wppconnect/wa-js - v3.10.1

    Function getABPropConfigValue

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getAsMms.html b/functions/whatsapp.functions.getAsMms.html index bd4b4ca9ba..14bd87b167 100644 --- a/functions/whatsapp.functions.getAsMms.html +++ b/functions/whatsapp.functions.getAsMms.html @@ -1,2 +1,2 @@ -getAsMms | @wppconnect/wa-js - v3.10.1

    Function getAsMms

    Settings

    Member Visibility
    +getAsMms | @wppconnect/wa-js - v3.10.1

    Function getAsMms

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getCanRequestPhoneNumber.html b/functions/whatsapp.functions.getCanRequestPhoneNumber.html index 605d52fb35..3ebdd1c80e 100644 --- a/functions/whatsapp.functions.getCanRequestPhoneNumber.html +++ b/functions/whatsapp.functions.getCanRequestPhoneNumber.html @@ -1,2 +1,2 @@ -getCanRequestPhoneNumber | @wppconnect/wa-js - v3.10.1

    Function getCanRequestPhoneNumber

    Settings

    Member Visibility
    +getCanRequestPhoneNumber | @wppconnect/wa-js - v3.10.1

    Function getCanRequestPhoneNumber

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getCommunityParticipants.html b/functions/whatsapp.functions.getCommunityParticipants.html index ac46ba4025..8a880596ea 100644 --- a/functions/whatsapp.functions.getCommunityParticipants.html +++ b/functions/whatsapp.functions.getCommunityParticipants.html @@ -1,2 +1,2 @@ -getCommunityParticipants | @wppconnect/wa-js - v3.10.1

    Function getCommunityParticipants

    Settings

    Member Visibility
    +getCommunityParticipants | @wppconnect/wa-js - v3.10.1

    Function getCommunityParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getCountryShortcodeByPhone.html b/functions/whatsapp.functions.getCountryShortcodeByPhone.html index b4c9a92149..35e4692afa 100644 --- a/functions/whatsapp.functions.getCountryShortcodeByPhone.html +++ b/functions/whatsapp.functions.getCountryShortcodeByPhone.html @@ -1,2 +1,2 @@ -getCountryShortcodeByPhone | @wppconnect/wa-js - v3.10.1

    Function getCountryShortcodeByPhone

    Settings

    Member Visibility
    +getCountryShortcodeByPhone | @wppconnect/wa-js - v3.10.1

    Function getCountryShortcodeByPhone

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getCurrentLid.html b/functions/whatsapp.functions.getCurrentLid.html index 088d2ee07c..4888c0e608 100644 --- a/functions/whatsapp.functions.getCurrentLid.html +++ b/functions/whatsapp.functions.getCurrentLid.html @@ -1,3 +1,3 @@ -getCurrentLid | @wppconnect/wa-js - v3.10.1

    Function getCurrentLid

    Settings

    Member Visibility
    +getCurrentLid | @wppconnect/wa-js - v3.10.1

    Function getCurrentLid

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getDisplayName.html b/functions/whatsapp.functions.getDisplayName.html index 5bd69a3f9b..7a05812490 100644 --- a/functions/whatsapp.functions.getDisplayName.html +++ b/functions/whatsapp.functions.getDisplayName.html @@ -1,2 +1,2 @@ -getDisplayName | @wppconnect/wa-js - v3.10.1

    Function getDisplayName

    Settings

    Member Visibility
    +getDisplayName | @wppconnect/wa-js - v3.10.1

    Function getDisplayName

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getDisplayNameOrPnForLid.html b/functions/whatsapp.functions.getDisplayNameOrPnForLid.html index 7ad840d081..30d4a9f8c7 100644 --- a/functions/whatsapp.functions.getDisplayNameOrPnForLid.html +++ b/functions/whatsapp.functions.getDisplayNameOrPnForLid.html @@ -1,2 +1,2 @@ -getDisplayNameOrPnForLid | @wppconnect/wa-js - v3.10.1

    Function getDisplayNameOrPnForLid

    Settings

    Member Visibility
    +getDisplayNameOrPnForLid | @wppconnect/wa-js - v3.10.1

    Function getDisplayNameOrPnForLid

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getEphemeralFields.html b/functions/whatsapp.functions.getEphemeralFields.html index 97fbbdf570..343f71f7e7 100644 --- a/functions/whatsapp.functions.getEphemeralFields.html +++ b/functions/whatsapp.functions.getEphemeralFields.html @@ -1,2 +1,2 @@ -getEphemeralFields | @wppconnect/wa-js - v3.10.1

    Function getEphemeralFields

    • getEphemeralFields(chat): {
          disappearingModeInitiator?: number;
          ephemeralDuration?: number;
          ephemeralSettingTimestamp?: number;
      }

    • Parameters

      Returns {
          disappearingModeInitiator?: number;
          ephemeralDuration?: number;
          ephemeralSettingTimestamp?: number;
      }

      • OptionaldisappearingModeInitiator?: number
      • OptionalephemeralDuration?: number
      • OptionalephemeralSettingTimestamp?: number

      Whatsapp

      700154 >= 2.2318.11

      -

    Settings

    Member Visibility
    +getEphemeralFields | @wppconnect/wa-js - v3.10.1

    Function getEphemeralFields

    • getEphemeralFields(chat): {
          disappearingModeInitiator?: number;
          ephemeralDuration?: number;
          ephemeralSettingTimestamp?: number;
      }

    • Parameters

      Returns {
          disappearingModeInitiator?: number;
          ephemeralDuration?: number;
          ephemeralSettingTimestamp?: number;
      }

      • OptionaldisappearingModeInitiator?: number
      • OptionalephemeralDuration?: number
      • OptionalephemeralSettingTimestamp?: number

      Whatsapp

      700154 >= 2.2318.11

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getErrorCodeFromLogoutReason.html b/functions/whatsapp.functions.getErrorCodeFromLogoutReason.html index 3346921da3..3eae713f30 100644 --- a/functions/whatsapp.functions.getErrorCodeFromLogoutReason.html +++ b/functions/whatsapp.functions.getErrorCodeFromLogoutReason.html @@ -1,2 +1,2 @@ -getErrorCodeFromLogoutReason | @wppconnect/wa-js - v3.10.1

    Function getErrorCodeFromLogoutReason

    Settings

    Member Visibility
    +getErrorCodeFromLogoutReason | @wppconnect/wa-js - v3.10.1

    Function getErrorCodeFromLogoutReason

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getFanOutList.html b/functions/whatsapp.functions.getFanOutList.html index a674f6f37f..ae471e8360 100644 --- a/functions/whatsapp.functions.getFanOutList.html +++ b/functions/whatsapp.functions.getFanOutList.html @@ -1,4 +1,4 @@ -getFanOutList | @wppconnect/wa-js - v3.10.1

    Function getFanOutList

    Settings

    Member Visibility
    +getFanOutList | @wppconnect/wa-js - v3.10.1

    Function getFanOutList

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getFormattedName.html b/functions/whatsapp.functions.getFormattedName.html index ea3aeddc07..7379a7630a 100644 --- a/functions/whatsapp.functions.getFormattedName.html +++ b/functions/whatsapp.functions.getFormattedName.html @@ -1,2 +1,2 @@ -getFormattedName | @wppconnect/wa-js - v3.10.1

    Function getFormattedName

    Settings

    Member Visibility
    +getFormattedName | @wppconnect/wa-js - v3.10.1

    Function getFormattedName

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getFormattedPhone.html b/functions/whatsapp.functions.getFormattedPhone.html index f0458b5a8b..e0d8e7855c 100644 --- a/functions/whatsapp.functions.getFormattedPhone.html +++ b/functions/whatsapp.functions.getFormattedPhone.html @@ -1,2 +1,2 @@ -getFormattedPhone | @wppconnect/wa-js - v3.10.1

    Function getFormattedPhone

    Settings

    Member Visibility
    +getFormattedPhone | @wppconnect/wa-js - v3.10.1

    Function getFormattedPhone

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getFormattedShortName.html b/functions/whatsapp.functions.getFormattedShortName.html index 4b888112cb..7d4126ee25 100644 --- a/functions/whatsapp.functions.getFormattedShortName.html +++ b/functions/whatsapp.functions.getFormattedShortName.html @@ -1,2 +1,2 @@ -getFormattedShortName | @wppconnect/wa-js - v3.10.1

    Function getFormattedShortName

    Settings

    Member Visibility
    +getFormattedShortName | @wppconnect/wa-js - v3.10.1

    Function getFormattedShortName

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getFormattedShortNameWithNonBreakingSpaces.html b/functions/whatsapp.functions.getFormattedShortNameWithNonBreakingSpaces.html index 1a5ae14452..711d076de0 100644 --- a/functions/whatsapp.functions.getFormattedShortNameWithNonBreakingSpaces.html +++ b/functions/whatsapp.functions.getFormattedShortNameWithNonBreakingSpaces.html @@ -1,2 +1,2 @@ -getFormattedShortNameWithNonBreakingSpaces | @wppconnect/wa-js - v3.10.1

    Function getFormattedShortNameWithNonBreakingSpaces

    Settings

    Member Visibility
    +getFormattedShortNameWithNonBreakingSpaces | @wppconnect/wa-js - v3.10.1

    Function getFormattedShortNameWithNonBreakingSpaces

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getFormattedUser.html b/functions/whatsapp.functions.getFormattedUser.html index d179e9c9d5..547425beb2 100644 --- a/functions/whatsapp.functions.getFormattedUser.html +++ b/functions/whatsapp.functions.getFormattedUser.html @@ -1,2 +1,2 @@ -getFormattedUser | @wppconnect/wa-js - v3.10.1

    Function getFormattedUser

    Settings

    Member Visibility
    +getFormattedUser | @wppconnect/wa-js - v3.10.1

    Function getFormattedUser

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getGroupSenderKeyList.html b/functions/whatsapp.functions.getGroupSenderKeyList.html index 677f945fa1..17f7905c27 100644 --- a/functions/whatsapp.functions.getGroupSenderKeyList.html +++ b/functions/whatsapp.functions.getGroupSenderKeyList.html @@ -1,3 +1,3 @@ -getGroupSenderKeyList | @wppconnect/wa-js - v3.10.1

    Function getGroupSenderKeyList

    Settings

    Member Visibility
    +getGroupSenderKeyList | @wppconnect/wa-js - v3.10.1

    Function getGroupSenderKeyList

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getGroupSizeLimit.html b/functions/whatsapp.functions.getGroupSizeLimit.html index 3e9dcfded1..07311b8c2e 100644 --- a/functions/whatsapp.functions.getGroupSizeLimit.html +++ b/functions/whatsapp.functions.getGroupSizeLimit.html @@ -1,2 +1,2 @@ -getGroupSizeLimit | @wppconnect/wa-js - v3.10.1

    Function getGroupSizeLimit

    Settings

    Member Visibility
    +getGroupSizeLimit | @wppconnect/wa-js - v3.10.1

    Function getGroupSizeLimit

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getHeader.html b/functions/whatsapp.functions.getHeader.html index 36396d2e4c..9c641a8813 100644 --- a/functions/whatsapp.functions.getHeader.html +++ b/functions/whatsapp.functions.getHeader.html @@ -1,2 +1,2 @@ -getHeader | @wppconnect/wa-js - v3.10.1

    Function getHeader

    Settings

    Member Visibility
    +getHeader | @wppconnect/wa-js - v3.10.1

    Function getHeader

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getHistorySyncProgress.html b/functions/whatsapp.functions.getHistorySyncProgress.html index 6f36f7b8e9..417a6ff19f 100644 --- a/functions/whatsapp.functions.getHistorySyncProgress.html +++ b/functions/whatsapp.functions.getHistorySyncProgress.html @@ -1,2 +1,2 @@ -getHistorySyncProgress | @wppconnect/wa-js - v3.10.1

    Function getHistorySyncProgress

    Settings

    Member Visibility
    +getHistorySyncProgress | @wppconnect/wa-js - v3.10.1

    Function getHistorySyncProgress

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsBroadcast.html b/functions/whatsapp.functions.getIsBroadcast.html index 0f87422933..fa9d90b690 100644 --- a/functions/whatsapp.functions.getIsBroadcast.html +++ b/functions/whatsapp.functions.getIsBroadcast.html @@ -1,2 +1,2 @@ -getIsBroadcast | @wppconnect/wa-js - v3.10.1

    Function getIsBroadcast

    Settings

    Member Visibility
    +getIsBroadcast | @wppconnect/wa-js - v3.10.1

    Function getIsBroadcast

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsDisplayNameApproved.html b/functions/whatsapp.functions.getIsDisplayNameApproved.html index 7a461bdbef..b09038cec9 100644 --- a/functions/whatsapp.functions.getIsDisplayNameApproved.html +++ b/functions/whatsapp.functions.getIsDisplayNameApproved.html @@ -1,2 +1,2 @@ -getIsDisplayNameApproved | @wppconnect/wa-js - v3.10.1

    Function getIsDisplayNameApproved

    Settings

    Member Visibility
    +getIsDisplayNameApproved | @wppconnect/wa-js - v3.10.1

    Function getIsDisplayNameApproved

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsGroup.html b/functions/whatsapp.functions.getIsGroup.html index b949faf341..f1e1a4f876 100644 --- a/functions/whatsapp.functions.getIsGroup.html +++ b/functions/whatsapp.functions.getIsGroup.html @@ -1,2 +1,2 @@ -getIsGroup | @wppconnect/wa-js - v3.10.1

    Function getIsGroup

    Settings

    Member Visibility
    +getIsGroup | @wppconnect/wa-js - v3.10.1

    Function getIsGroup

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsIAS.html b/functions/whatsapp.functions.getIsIAS.html index 3c8dee9350..c0012f9c95 100644 --- a/functions/whatsapp.functions.getIsIAS.html +++ b/functions/whatsapp.functions.getIsIAS.html @@ -1,2 +1,2 @@ -getIsIAS | @wppconnect/wa-js - v3.10.1

    Function getIsIAS

    Settings

    Member Visibility
    +getIsIAS | @wppconnect/wa-js - v3.10.1

    Function getIsIAS

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsMe.html b/functions/whatsapp.functions.getIsMe.html index 861785c581..d2cf62e020 100644 --- a/functions/whatsapp.functions.getIsMe.html +++ b/functions/whatsapp.functions.getIsMe.html @@ -1,2 +1,2 @@ -getIsMe | @wppconnect/wa-js - v3.10.1

    Function getIsMe

    Settings

    Member Visibility
    +getIsMe | @wppconnect/wa-js - v3.10.1

    Function getIsMe

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsMyContact.html b/functions/whatsapp.functions.getIsMyContact.html index 292ff95fde..ac29c4ffd3 100644 --- a/functions/whatsapp.functions.getIsMyContact.html +++ b/functions/whatsapp.functions.getIsMyContact.html @@ -1,2 +1,2 @@ -getIsMyContact | @wppconnect/wa-js - v3.10.1

    Function getIsMyContact

    Settings

    Member Visibility
    +getIsMyContact | @wppconnect/wa-js - v3.10.1

    Function getIsMyContact

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsPSA.html b/functions/whatsapp.functions.getIsPSA.html index 4ad708b830..20a0cdb66c 100644 --- a/functions/whatsapp.functions.getIsPSA.html +++ b/functions/whatsapp.functions.getIsPSA.html @@ -1,2 +1,2 @@ -getIsPSA | @wppconnect/wa-js - v3.10.1

    Function getIsPSA

    Settings

    Member Visibility
    +getIsPSA | @wppconnect/wa-js - v3.10.1

    Function getIsPSA

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsSupportAccount.html b/functions/whatsapp.functions.getIsSupportAccount.html index f33c8048db..bd52a93f92 100644 --- a/functions/whatsapp.functions.getIsSupportAccount.html +++ b/functions/whatsapp.functions.getIsSupportAccount.html @@ -1,2 +1,2 @@ -getIsSupportAccount | @wppconnect/wa-js - v3.10.1

    Function getIsSupportAccount

    Settings

    Member Visibility
    +getIsSupportAccount | @wppconnect/wa-js - v3.10.1

    Function getIsSupportAccount

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsUser.html b/functions/whatsapp.functions.getIsUser.html index 3467be548c..e88593d6a5 100644 --- a/functions/whatsapp.functions.getIsUser.html +++ b/functions/whatsapp.functions.getIsUser.html @@ -1,2 +1,2 @@ -getIsUser | @wppconnect/wa-js - v3.10.1

    Function getIsUser

    Settings

    Member Visibility
    +getIsUser | @wppconnect/wa-js - v3.10.1

    Function getIsUser

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getIsWAContact.html b/functions/whatsapp.functions.getIsWAContact.html index 7362e352fd..24e31f5077 100644 --- a/functions/whatsapp.functions.getIsWAContact.html +++ b/functions/whatsapp.functions.getIsWAContact.html @@ -1,2 +1,2 @@ -getIsWAContact | @wppconnect/wa-js - v3.10.1

    Function getIsWAContact

    Settings

    Member Visibility
    +getIsWAContact | @wppconnect/wa-js - v3.10.1

    Function getIsWAContact

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getMembershipApprovalRequests.html b/functions/whatsapp.functions.getMembershipApprovalRequests.html index 4d2eb8620d..576e32b83d 100644 --- a/functions/whatsapp.functions.getMembershipApprovalRequests.html +++ b/functions/whatsapp.functions.getMembershipApprovalRequests.html @@ -1,2 +1,2 @@ -getMembershipApprovalRequests | @wppconnect/wa-js - v3.10.1

    Function getMembershipApprovalRequests

    Settings

    Member Visibility
    +getMembershipApprovalRequests | @wppconnect/wa-js - v3.10.1

    Function getMembershipApprovalRequests

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getMentionName.html b/functions/whatsapp.functions.getMentionName.html index a8e2db2205..0b4ce30c9e 100644 --- a/functions/whatsapp.functions.getMentionName.html +++ b/functions/whatsapp.functions.getMentionName.html @@ -1,2 +1,2 @@ -getMentionName | @wppconnect/wa-js - v3.10.1

    Function getMentionName

    Settings

    Member Visibility
    +getMentionName | @wppconnect/wa-js - v3.10.1

    Function getMentionName

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getNewsletterSubscribers.html b/functions/whatsapp.functions.getNewsletterSubscribers.html index 52bd5da4c5..ab0049a382 100644 --- a/functions/whatsapp.functions.getNewsletterSubscribers.html +++ b/functions/whatsapp.functions.getNewsletterSubscribers.html @@ -1,2 +1,2 @@ -getNewsletterSubscribers | @wppconnect/wa-js - v3.10.1

    Function getNewsletterSubscribers

    • getNewsletterSubscribers(jid, param2, view): Promise<{
          subscribers: {
              displayName?: string;
              id: Wid;
              isContact?: boolean;
              isGroup?: boolean;
              isOnline?: boolean;
              isUser?: boolean;
              phoneNumber?: string;
              shortname?: string;
              state?: string;
              subscribeTime?: number;
              t: number;
          }[];
      }>

    • Parameters

      • jid: string
      • param2: number
      • view: "LIMITED"

      Returns Promise<{
          subscribers: {
              displayName?: string;
              id: Wid;
              isContact?: boolean;
              isGroup?: boolean;
              isOnline?: boolean;
              isUser?: boolean;
              phoneNumber?: string;
              shortname?: string;
              state?: string;
              subscribeTime?: number;
              t: number;
          }[];
      }>

      Whatsapp

      276084

      -

    Settings

    Member Visibility
    +getNewsletterSubscribers | @wppconnect/wa-js - v3.10.1

    Function getNewsletterSubscribers

    • getNewsletterSubscribers(jid, param2, view): Promise<{
          subscribers: {
              displayName?: string;
              id: Wid;
              isContact?: boolean;
              isGroup?: boolean;
              isOnline?: boolean;
              isUser?: boolean;
              phoneNumber?: string;
              shortname?: string;
              state?: string;
              subscribeTime?: number;
              t: number;
          }[];
      }>

    • Parameters

      • jid: string
      • param2: number
      • view: "LIMITED"

      Returns Promise<{
          subscribers: {
              displayName?: string;
              id: Wid;
              isContact?: boolean;
              isGroup?: boolean;
              isOnline?: boolean;
              isUser?: boolean;
              phoneNumber?: string;
              shortname?: string;
              state?: string;
              subscribeTime?: number;
              t: number;
          }[];
      }>

      Whatsapp

      276084

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getNextLabelId.html b/functions/whatsapp.functions.getNextLabelId.html index 6c3efa18c0..a69f60c6f5 100644 --- a/functions/whatsapp.functions.getNextLabelId.html +++ b/functions/whatsapp.functions.getNextLabelId.html @@ -1,2 +1,2 @@ -getNextLabelId | @wppconnect/wa-js - v3.10.1

    Function getNextLabelId

    Settings

    Member Visibility
    +getNextLabelId | @wppconnect/wa-js - v3.10.1

    Function getNextLabelId

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getNotifyName.html b/functions/whatsapp.functions.getNotifyName.html index d6e67ce5eb..990037592b 100644 --- a/functions/whatsapp.functions.getNotifyName.html +++ b/functions/whatsapp.functions.getNotifyName.html @@ -1,2 +1,2 @@ -getNotifyName | @wppconnect/wa-js - v3.10.1

    Function getNotifyName

    Settings

    Member Visibility
    +getNotifyName | @wppconnect/wa-js - v3.10.1

    Function getNotifyName

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getNumChatsPinned.html b/functions/whatsapp.functions.getNumChatsPinned.html index 9bac07b51d..3b13531a8f 100644 --- a/functions/whatsapp.functions.getNumChatsPinned.html +++ b/functions/whatsapp.functions.getNumChatsPinned.html @@ -1,4 +1,4 @@ -getNumChatsPinned | @wppconnect/wa-js - v3.10.1

    Function getNumChatsPinned

    Settings

    Member Visibility
    +getNumChatsPinned | @wppconnect/wa-js - v3.10.1

    Function getNumChatsPinned

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getOrderInfo.html b/functions/whatsapp.functions.getOrderInfo.html index e855cfcd53..c691bbde91 100644 --- a/functions/whatsapp.functions.getOrderInfo.html +++ b/functions/whatsapp.functions.getOrderInfo.html @@ -1,2 +1,2 @@ -getOrderInfo | @wppconnect/wa-js - v3.10.1

    Function getOrderInfo

    Settings

    Member Visibility
    +getOrderInfo | @wppconnect/wa-js - v3.10.1

    Function getOrderInfo

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getParticipants.html b/functions/whatsapp.functions.getParticipants.html index df72e346e9..ebf640aeb5 100644 --- a/functions/whatsapp.functions.getParticipants.html +++ b/functions/whatsapp.functions.getParticipants.html @@ -1,3 +1,3 @@ -getParticipants | @wppconnect/wa-js - v3.10.1

    Function getParticipants

    • getParticipants(group): Promise<null | {
          admins: string[];
          deviceSyncComplete?: any;
          groupId: string;
          participants: string[];
          pastParticipants: string[];
          rotateKey: boolean;
          senderKey: Map<string, boolean>;
      }>

    • Parameters

      Returns Promise<null | {
          admins: string[];
          deviceSyncComplete?: any;
          groupId: string;
          participants: string[];
          pastParticipants: string[];
          rotateKey: boolean;
          senderKey: Map<string, boolean>;
      }>

      Whatsapp

      951974 >= 2.2222.8

      -

      Whatsapp

      318615 >= 2.2224.7

      -

    Settings

    Member Visibility
    +getParticipants | @wppconnect/wa-js - v3.10.1

    Function getParticipants

    • getParticipants(group): Promise<null | {
          admins: string[];
          deviceSyncComplete?: any;
          groupId: string;
          participants: string[];
          pastParticipants: string[];
          rotateKey: boolean;
          senderKey: Map<string, boolean>;
      }>

    • Parameters

      Returns Promise<null | {
          admins: string[];
          deviceSyncComplete?: any;
          groupId: string;
          participants: string[];
          pastParticipants: string[];
          rotateKey: boolean;
          senderKey: Map<string, boolean>;
      }>

      Whatsapp

      951974 >= 2.2222.8

      +

      Whatsapp

      318615 >= 2.2224.7

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getPnForLid.html b/functions/whatsapp.functions.getPnForLid.html index d47baf817d..8ea046b5ef 100644 --- a/functions/whatsapp.functions.getPnForLid.html +++ b/functions/whatsapp.functions.getPnForLid.html @@ -1,2 +1,2 @@ -getPnForLid | @wppconnect/wa-js - v3.10.1

    Function getPnForLid

    Settings

    Member Visibility
    +getPnForLid | @wppconnect/wa-js - v3.10.1

    Function getPnForLid

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getPremiumMessageName.html b/functions/whatsapp.functions.getPremiumMessageName.html index c3755788d7..a569f6632b 100644 --- a/functions/whatsapp.functions.getPremiumMessageName.html +++ b/functions/whatsapp.functions.getPremiumMessageName.html @@ -1,2 +1,2 @@ -getPremiumMessageName | @wppconnect/wa-js - v3.10.1

    Function getPremiumMessageName

    Settings

    Member Visibility
    +getPremiumMessageName | @wppconnect/wa-js - v3.10.1

    Function getPremiumMessageName

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getPrivacyDisallowedListTable.html b/functions/whatsapp.functions.getPrivacyDisallowedListTable.html index b620b45dc5..9988510f1a 100644 --- a/functions/whatsapp.functions.getPrivacyDisallowedListTable.html +++ b/functions/whatsapp.functions.getPrivacyDisallowedListTable.html @@ -1,2 +1,2 @@ -getPrivacyDisallowedListTable | @wppconnect/wa-js - v3.10.1

    Function getPrivacyDisallowedListTable

    Settings

    Member Visibility
    +getPrivacyDisallowedListTable | @wppconnect/wa-js - v3.10.1

    Function getPrivacyDisallowedListTable

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getPushname.html b/functions/whatsapp.functions.getPushname.html index 915cebb2b3..905df9da3a 100644 --- a/functions/whatsapp.functions.getPushname.html +++ b/functions/whatsapp.functions.getPushname.html @@ -1,3 +1,3 @@ -getPushname | @wppconnect/wa-js - v3.10.1

    Function getPushname

    Settings

    Member Visibility
    +getPushname | @wppconnect/wa-js - v3.10.1

    Function getPushname

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getQuotedMsgObj.html b/functions/whatsapp.functions.getQuotedMsgObj.html index 1437a0aa40..57bf0671dd 100644 --- a/functions/whatsapp.functions.getQuotedMsgObj.html +++ b/functions/whatsapp.functions.getQuotedMsgObj.html @@ -1,2 +1,2 @@ -getQuotedMsgObj | @wppconnect/wa-js - v3.10.1

    Function getQuotedMsgObj

    Settings

    Member Visibility
    +getQuotedMsgObj | @wppconnect/wa-js - v3.10.1

    Function getQuotedMsgObj

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getSearchContext.html b/functions/whatsapp.functions.getSearchContext.html index 808ebd828d..73a471511d 100644 --- a/functions/whatsapp.functions.getSearchContext.html +++ b/functions/whatsapp.functions.getSearchContext.html @@ -1,2 +1,2 @@ -getSearchContext | @wppconnect/wa-js - v3.10.1

    Function getSearchContext

    Settings

    Member Visibility
    +getSearchContext | @wppconnect/wa-js - v3.10.1

    Function getSearchContext

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getSearchName.html b/functions/whatsapp.functions.getSearchName.html index c89fba98d4..53419f990b 100644 --- a/functions/whatsapp.functions.getSearchName.html +++ b/functions/whatsapp.functions.getSearchName.html @@ -1,2 +1,2 @@ -getSearchName | @wppconnect/wa-js - v3.10.1

    Function getSearchName

    Settings

    Member Visibility
    +getSearchName | @wppconnect/wa-js - v3.10.1

    Function getSearchName

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getSearchVerifiedName.html b/functions/whatsapp.functions.getSearchVerifiedName.html index 5ad7971d01..66ce517e2e 100644 --- a/functions/whatsapp.functions.getSearchVerifiedName.html +++ b/functions/whatsapp.functions.getSearchVerifiedName.html @@ -1,2 +1,2 @@ -getSearchVerifiedName | @wppconnect/wa-js - v3.10.1

    Function getSearchVerifiedName

    Settings

    Member Visibility
    +getSearchVerifiedName | @wppconnect/wa-js - v3.10.1

    Function getSearchVerifiedName

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getShouldForceBusinessUpdate.html b/functions/whatsapp.functions.getShouldForceBusinessUpdate.html index 7e3ed49ded..60b94dd75e 100644 --- a/functions/whatsapp.functions.getShouldForceBusinessUpdate.html +++ b/functions/whatsapp.functions.getShouldForceBusinessUpdate.html @@ -1,2 +1,2 @@ -getShouldForceBusinessUpdate | @wppconnect/wa-js - v3.10.1

    Function getShouldForceBusinessUpdate

    Settings

    Member Visibility
    +getShouldForceBusinessUpdate | @wppconnect/wa-js - v3.10.1

    Function getShouldForceBusinessUpdate

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getShowBusinessCheckmarkAsPrimary.html b/functions/whatsapp.functions.getShowBusinessCheckmarkAsPrimary.html index 36915e079b..f98bf24b7c 100644 --- a/functions/whatsapp.functions.getShowBusinessCheckmarkAsPrimary.html +++ b/functions/whatsapp.functions.getShowBusinessCheckmarkAsPrimary.html @@ -1,2 +1,2 @@ -getShowBusinessCheckmarkAsPrimary | @wppconnect/wa-js - v3.10.1

    Function getShowBusinessCheckmarkAsPrimary

    Settings

    Member Visibility
    +getShowBusinessCheckmarkAsPrimary | @wppconnect/wa-js - v3.10.1

    Function getShowBusinessCheckmarkAsPrimary

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getShowBusinessCheckmarkAsSecondary.html b/functions/whatsapp.functions.getShowBusinessCheckmarkAsSecondary.html index 6d1e0c6264..46edc92476 100644 --- a/functions/whatsapp.functions.getShowBusinessCheckmarkAsSecondary.html +++ b/functions/whatsapp.functions.getShowBusinessCheckmarkAsSecondary.html @@ -1,2 +1,2 @@ -getShowBusinessCheckmarkAsSecondary | @wppconnect/wa-js - v3.10.1

    Function getShowBusinessCheckmarkAsSecondary

    Settings

    Member Visibility
    +getShowBusinessCheckmarkAsSecondary | @wppconnect/wa-js - v3.10.1

    Function getShowBusinessCheckmarkAsSecondary

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getShowBusinessCheckmarkInChatlist.html b/functions/whatsapp.functions.getShowBusinessCheckmarkInChatlist.html index cb879bc76f..a7f5d5e2aa 100644 --- a/functions/whatsapp.functions.getShowBusinessCheckmarkInChatlist.html +++ b/functions/whatsapp.functions.getShowBusinessCheckmarkInChatlist.html @@ -1,2 +1,2 @@ -getShowBusinessCheckmarkInChatlist | @wppconnect/wa-js - v3.10.1

    Function getShowBusinessCheckmarkInChatlist

    Settings

    Member Visibility
    +getShowBusinessCheckmarkInChatlist | @wppconnect/wa-js - v3.10.1

    Function getShowBusinessCheckmarkInChatlist

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getStatus.html b/functions/whatsapp.functions.getStatus.html index 9dcd04df35..a183400bf7 100644 --- a/functions/whatsapp.functions.getStatus.html +++ b/functions/whatsapp.functions.getStatus.html @@ -1,4 +1,4 @@ -getStatus | @wppconnect/wa-js - v3.10.1

    Function getStatus

    Settings

    Member Visibility
    +getStatus | @wppconnect/wa-js - v3.10.1

    Function getStatus

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getStatusAllowList.html b/functions/whatsapp.functions.getStatusAllowList.html index 9afaca29a2..4c63db4280 100644 --- a/functions/whatsapp.functions.getStatusAllowList.html +++ b/functions/whatsapp.functions.getStatusAllowList.html @@ -1,2 +1,2 @@ -getStatusAllowList | @wppconnect/wa-js - v3.10.1

    Function getStatusAllowList

    Settings

    Member Visibility
    +getStatusAllowList | @wppconnect/wa-js - v3.10.1

    Function getStatusAllowList

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getTableVotes.html b/functions/whatsapp.functions.getTableVotes.html index b5e6ad2ead..105d316c32 100644 --- a/functions/whatsapp.functions.getTableVotes.html +++ b/functions/whatsapp.functions.getTableVotes.html @@ -1,2 +1,2 @@ -getTableVotes | @wppconnect/wa-js - v3.10.1

    Function getTableVotes

    Settings

    Member Visibility
    +getTableVotes | @wppconnect/wa-js - v3.10.1

    Function getTableVotes

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getUserhash.html b/functions/whatsapp.functions.getUserhash.html index 265265589e..c166603544 100644 --- a/functions/whatsapp.functions.getUserhash.html +++ b/functions/whatsapp.functions.getUserhash.html @@ -1,2 +1,2 @@ -getUserhash | @wppconnect/wa-js - v3.10.1

    Function getUserhash

    Settings

    Member Visibility
    +getUserhash | @wppconnect/wa-js - v3.10.1

    Function getUserhash

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getUserid.html b/functions/whatsapp.functions.getUserid.html index 09d17869b9..669447eb2c 100644 --- a/functions/whatsapp.functions.getUserid.html +++ b/functions/whatsapp.functions.getUserid.html @@ -1,2 +1,2 @@ -getUserid | @wppconnect/wa-js - v3.10.1

    Function getUserid

    Settings

    Member Visibility
    +getUserid | @wppconnect/wa-js - v3.10.1

    Function getUserid

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getVotes.html b/functions/whatsapp.functions.getVotes.html index 557bf844c8..0191120f75 100644 --- a/functions/whatsapp.functions.getVotes.html +++ b/functions/whatsapp.functions.getVotes.html @@ -1,3 +1,3 @@ -getVotes | @wppconnect/wa-js - v3.10.1

    Function getVotes

    Settings

    Member Visibility
    +getVotes | @wppconnect/wa-js - v3.10.1

    Function getVotes

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.getWhatsAppWebExternalBetaJoinedIdb.html b/functions/whatsapp.functions.getWhatsAppWebExternalBetaJoinedIdb.html index 0dce4ccb0a..61d9923c07 100644 --- a/functions/whatsapp.functions.getWhatsAppWebExternalBetaJoinedIdb.html +++ b/functions/whatsapp.functions.getWhatsAppWebExternalBetaJoinedIdb.html @@ -1,2 +1,2 @@ -getWhatsAppWebExternalBetaJoinedIdb | @wppconnect/wa-js - v3.10.1

    Function getWhatsAppWebExternalBetaJoinedIdb

    Settings

    Member Visibility
    +getWhatsAppWebExternalBetaJoinedIdb | @wppconnect/wa-js - v3.10.1

    Function getWhatsAppWebExternalBetaJoinedIdb

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.handleChatSimpleAck.html b/functions/whatsapp.functions.handleChatSimpleAck.html index f356757a7d..47482f8493 100644 --- a/functions/whatsapp.functions.handleChatSimpleAck.html +++ b/functions/whatsapp.functions.handleChatSimpleAck.html @@ -1,4 +1,4 @@ -handleChatSimpleAck | @wppconnect/wa-js - v3.10.1

    Function handleChatSimpleAck

    Settings

    Member Visibility
    +handleChatSimpleAck | @wppconnect/wa-js - v3.10.1

    Function handleChatSimpleAck

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.handleChatSimpleReceipt.html b/functions/whatsapp.functions.handleChatSimpleReceipt.html index 2a06a48306..436a50dffc 100644 --- a/functions/whatsapp.functions.handleChatSimpleReceipt.html +++ b/functions/whatsapp.functions.handleChatSimpleReceipt.html @@ -1,4 +1,4 @@ -handleChatSimpleReceipt | @wppconnect/wa-js - v3.10.1

    Function handleChatSimpleReceipt

    Settings

    Member Visibility
    +handleChatSimpleReceipt | @wppconnect/wa-js - v3.10.1

    Function handleChatSimpleReceipt

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.handleGroupSimpleAck.html b/functions/whatsapp.functions.handleGroupSimpleAck.html index 8a9727275e..fa4ad13347 100644 --- a/functions/whatsapp.functions.handleGroupSimpleAck.html +++ b/functions/whatsapp.functions.handleGroupSimpleAck.html @@ -1,4 +1,4 @@ -handleGroupSimpleAck | @wppconnect/wa-js - v3.10.1

    Function handleGroupSimpleAck

    Settings

    Member Visibility
    +handleGroupSimpleAck | @wppconnect/wa-js - v3.10.1

    Function handleGroupSimpleAck

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.handleGroupSimpleReceipt.html b/functions/whatsapp.functions.handleGroupSimpleReceipt.html index 6d25112974..d17d293d77 100644 --- a/functions/whatsapp.functions.handleGroupSimpleReceipt.html +++ b/functions/whatsapp.functions.handleGroupSimpleReceipt.html @@ -1,4 +1,4 @@ -handleGroupSimpleReceipt | @wppconnect/wa-js - v3.10.1

    Function handleGroupSimpleReceipt

    Settings

    Member Visibility
    +handleGroupSimpleReceipt | @wppconnect/wa-js - v3.10.1

    Function handleGroupSimpleReceipt

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.handleSingleMsg.html b/functions/whatsapp.functions.handleSingleMsg.html index 53ce99d9b1..b9076eb42c 100644 --- a/functions/whatsapp.functions.handleSingleMsg.html +++ b/functions/whatsapp.functions.handleSingleMsg.html @@ -1,2 +1,2 @@ -handleSingleMsg | @wppconnect/wa-js - v3.10.1

    Function handleSingleMsg

    Settings

    Member Visibility
    +handleSingleMsg | @wppconnect/wa-js - v3.10.1

    Function handleSingleMsg

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.handleStatusSimpleAck.html b/functions/whatsapp.functions.handleStatusSimpleAck.html index d8fa951ae3..e5f41e584e 100644 --- a/functions/whatsapp.functions.handleStatusSimpleAck.html +++ b/functions/whatsapp.functions.handleStatusSimpleAck.html @@ -1,4 +1,4 @@ -handleStatusSimpleAck | @wppconnect/wa-js - v3.10.1

    Function handleStatusSimpleAck

    Settings

    Member Visibility
    +handleStatusSimpleAck | @wppconnect/wa-js - v3.10.1

    Function handleStatusSimpleAck

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.handleStatusSimpleReceipt.html b/functions/whatsapp.functions.handleStatusSimpleReceipt.html index f23a1b2464..356cc0b45e 100644 --- a/functions/whatsapp.functions.handleStatusSimpleReceipt.html +++ b/functions/whatsapp.functions.handleStatusSimpleReceipt.html @@ -1,4 +1,4 @@ -handleStatusSimpleReceipt | @wppconnect/wa-js - v3.10.1

    Function handleStatusSimpleReceipt

    Settings

    Member Visibility
    +handleStatusSimpleReceipt | @wppconnect/wa-js - v3.10.1

    Function handleStatusSimpleReceipt

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.initializeAltDeviceLinking.html b/functions/whatsapp.functions.initializeAltDeviceLinking.html index 8379f57bfb..0e12f5f475 100644 --- a/functions/whatsapp.functions.initializeAltDeviceLinking.html +++ b/functions/whatsapp.functions.initializeAltDeviceLinking.html @@ -1,2 +1,2 @@ -initializeAltDeviceLinking | @wppconnect/wa-js - v3.10.1

    Function initializeAltDeviceLinking

    Settings

    Member Visibility
    +initializeAltDeviceLinking | @wppconnect/wa-js - v3.10.1

    Function initializeAltDeviceLinking

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.isAnimatedWebp.html b/functions/whatsapp.functions.isAnimatedWebp.html index de76bcd27a..72e7c86112 100644 --- a/functions/whatsapp.functions.isAnimatedWebp.html +++ b/functions/whatsapp.functions.isAnimatedWebp.html @@ -1,2 +1,2 @@ -isAnimatedWebp | @wppconnect/wa-js - v3.10.1

    Function isAnimatedWebp

    Settings

    Member Visibility
    +isAnimatedWebp | @wppconnect/wa-js - v3.10.1

    Function isAnimatedWebp

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.isAuthenticated.html b/functions/whatsapp.functions.isAuthenticated.html index 94e6f19fd0..00294cb887 100644 --- a/functions/whatsapp.functions.isAuthenticated.html +++ b/functions/whatsapp.functions.isAuthenticated.html @@ -1,4 +1,4 @@ -isAuthenticated | @wppconnect/wa-js - v3.10.1

    Function isAuthenticated

    Settings

    Member Visibility
    +isAuthenticated | @wppconnect/wa-js - v3.10.1

    Function isAuthenticated

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.isLoggedIn.html b/functions/whatsapp.functions.isLoggedIn.html index e48fb2a0ef..7acf4cfe57 100644 --- a/functions/whatsapp.functions.isLoggedIn.html +++ b/functions/whatsapp.functions.isLoggedIn.html @@ -1,4 +1,4 @@ -isLoggedIn | @wppconnect/wa-js - v3.10.1

    Function isLoggedIn

    Settings

    Member Visibility
    +isLoggedIn | @wppconnect/wa-js - v3.10.1

    Function isLoggedIn

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.isRegistered.html b/functions/whatsapp.functions.isRegistered.html index 75ae51126c..fadc97e2a1 100644 --- a/functions/whatsapp.functions.isRegistered.html +++ b/functions/whatsapp.functions.isRegistered.html @@ -1,2 +1,2 @@ -isRegistered | @wppconnect/wa-js - v3.10.1

    Function isRegistered

    Settings

    Member Visibility
    +isRegistered | @wppconnect/wa-js - v3.10.1

    Function isRegistered

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.isUnreadTypeMsg.html b/functions/whatsapp.functions.isUnreadTypeMsg.html index e7e760f71a..779a923a55 100644 --- a/functions/whatsapp.functions.isUnreadTypeMsg.html +++ b/functions/whatsapp.functions.isUnreadTypeMsg.html @@ -1,2 +1,2 @@ -isUnreadTypeMsg | @wppconnect/wa-js - v3.10.1

    Function isUnreadTypeMsg

    Settings

    Member Visibility
    +isUnreadTypeMsg | @wppconnect/wa-js - v3.10.1

    Function isUnreadTypeMsg

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.isWid.html b/functions/whatsapp.functions.isWid.html index 7ab1b127f6..cfc31b7cbb 100644 --- a/functions/whatsapp.functions.isWid.html +++ b/functions/whatsapp.functions.isWid.html @@ -1,2 +1,2 @@ -isWid | @wppconnect/wa-js - v3.10.1

    Function isWid

    Settings

    Member Visibility
    +isWid | @wppconnect/wa-js - v3.10.1

    Function isWid

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.joinGroupViaInvite.html b/functions/whatsapp.functions.joinGroupViaInvite.html index bbeac4042a..1085898cc8 100644 --- a/functions/whatsapp.functions.joinGroupViaInvite.html +++ b/functions/whatsapp.functions.joinGroupViaInvite.html @@ -1,2 +1,2 @@ -joinGroupViaInvite | @wppconnect/wa-js - v3.10.1

    Function joinGroupViaInvite

    Settings

    Member Visibility
    +joinGroupViaInvite | @wppconnect/wa-js - v3.10.1

    Function joinGroupViaInvite

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.keepMessage.html b/functions/whatsapp.functions.keepMessage.html index dddbd6464f..cd1a5c643d 100644 --- a/functions/whatsapp.functions.keepMessage.html +++ b/functions/whatsapp.functions.keepMessage.html @@ -1,2 +1,2 @@ -keepMessage | @wppconnect/wa-js - v3.10.1

    Function keepMessage

    Settings

    Member Visibility
    +keepMessage | @wppconnect/wa-js - v3.10.1

    Function keepMessage

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.labelAddAction.html b/functions/whatsapp.functions.labelAddAction.html index ddfbaf514a..1458877e2c 100644 --- a/functions/whatsapp.functions.labelAddAction.html +++ b/functions/whatsapp.functions.labelAddAction.html @@ -1,2 +1,2 @@ -labelAddAction | @wppconnect/wa-js - v3.10.1

    Function labelAddAction

    Settings

    Member Visibility
    +labelAddAction | @wppconnect/wa-js - v3.10.1

    Function labelAddAction

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.markForgetSenderKey.html b/functions/whatsapp.functions.markForgetSenderKey.html index 79cfa4088f..30cc32e3fb 100644 --- a/functions/whatsapp.functions.markForgetSenderKey.html +++ b/functions/whatsapp.functions.markForgetSenderKey.html @@ -1,3 +1,3 @@ -markForgetSenderKey | @wppconnect/wa-js - v3.10.1

    Function markForgetSenderKey

    Settings

    Member Visibility
    +markForgetSenderKey | @wppconnect/wa-js - v3.10.1

    Function markForgetSenderKey

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.markPlayed.html b/functions/whatsapp.functions.markPlayed.html index bccba22d6c..8a33990cd4 100644 --- a/functions/whatsapp.functions.markPlayed.html +++ b/functions/whatsapp.functions.markPlayed.html @@ -1,4 +1,4 @@ -markPlayed | @wppconnect/wa-js - v3.10.1

    Function markPlayed

    Settings

    Member Visibility
    +markPlayed | @wppconnect/wa-js - v3.10.1

    Function markPlayed

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.markUnread.html b/functions/whatsapp.functions.markUnread.html index 4462710c8e..f8a43f741c 100644 --- a/functions/whatsapp.functions.markUnread.html +++ b/functions/whatsapp.functions.markUnread.html @@ -1,3 +1,3 @@ -markUnread | @wppconnect/wa-js - v3.10.1

    Function markUnread

    Settings

    Member Visibility
    +markUnread | @wppconnect/wa-js - v3.10.1

    Function markUnread

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.mediaTypeFromProtobuf.html b/functions/whatsapp.functions.mediaTypeFromProtobuf.html index 7144c6b215..0378b68baa 100644 --- a/functions/whatsapp.functions.mediaTypeFromProtobuf.html +++ b/functions/whatsapp.functions.mediaTypeFromProtobuf.html @@ -1,5 +1,5 @@ -mediaTypeFromProtobuf | @wppconnect/wa-js - v3.10.1

    Function mediaTypeFromProtobuf

    • mediaTypeFromProtobuf(protoMessage): string | null

    • Parameters

      • protoMessage: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns string | null

      Whatsapp

      95318

      -

      Whatsapp

      58853 >= 2.2218.4

      -

      Whatsapp

      458853 >= 2.2222.8

      -

      Whatsapp

      760210 >= 2.2228.4

      -

    Settings

    Member Visibility
    +mediaTypeFromProtobuf | @wppconnect/wa-js - v3.10.1

    Function mediaTypeFromProtobuf

    • mediaTypeFromProtobuf(protoMessage): string | null

    • Parameters

      • protoMessage: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns string | null

      Whatsapp

      95318

      +

      Whatsapp

      58853 >= 2.2218.4

      +

      Whatsapp

      458853 >= 2.2222.8

      +

      Whatsapp

      760210 >= 2.2228.4

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.membershipApprovalRequestAction.html b/functions/whatsapp.functions.membershipApprovalRequestAction.html index df9020e1c0..7d81c9064e 100644 --- a/functions/whatsapp.functions.membershipApprovalRequestAction.html +++ b/functions/whatsapp.functions.membershipApprovalRequestAction.html @@ -1,2 +1,2 @@ -membershipApprovalRequestAction | @wppconnect/wa-js - v3.10.1

    Function membershipApprovalRequestAction

    Settings

    Member Visibility
    +membershipApprovalRequestAction | @wppconnect/wa-js - v3.10.1

    Function membershipApprovalRequestAction

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.msgDataFromMsgModel.html b/functions/whatsapp.functions.msgDataFromMsgModel.html index 1fbfdd7477..68ff91abac 100644 --- a/functions/whatsapp.functions.msgDataFromMsgModel.html +++ b/functions/whatsapp.functions.msgDataFromMsgModel.html @@ -1,2 +1,2 @@ -msgDataFromMsgModel | @wppconnect/wa-js - v3.10.1

    Function msgDataFromMsgModel

    Settings

    Member Visibility
    +msgDataFromMsgModel | @wppconnect/wa-js - v3.10.1

    Function msgDataFromMsgModel

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.msgFindQuery.html b/functions/whatsapp.functions.msgFindQuery.html index 7b301d4712..0c3c07de39 100644 --- a/functions/whatsapp.functions.msgFindQuery.html +++ b/functions/whatsapp.functions.msgFindQuery.html @@ -1,2 +1,2 @@ -msgFindQuery | @wppconnect/wa-js - v3.10.1

    Function msgFindQuery

    Settings

    Member Visibility
    +msgFindQuery | @wppconnect/wa-js - v3.10.1

    Function msgFindQuery

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.muteNewsletter.html b/functions/whatsapp.functions.muteNewsletter.html index 9a2417d52c..8a647937ba 100644 --- a/functions/whatsapp.functions.muteNewsletter.html +++ b/functions/whatsapp.functions.muteNewsletter.html @@ -1,2 +1,2 @@ -muteNewsletter | @wppconnect/wa-js - v3.10.1

    Function muteNewsletter

    Settings

    Member Visibility
    +muteNewsletter | @wppconnect/wa-js - v3.10.1

    Function muteNewsletter

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.primaryFeatureEnabled.html b/functions/whatsapp.functions.primaryFeatureEnabled.html index 508424f748..94561ecfc4 100644 --- a/functions/whatsapp.functions.primaryFeatureEnabled.html +++ b/functions/whatsapp.functions.primaryFeatureEnabled.html @@ -1,2 +1,2 @@ -primaryFeatureEnabled | @wppconnect/wa-js - v3.10.1

    Function primaryFeatureEnabled

    Settings

    Member Visibility
    +primaryFeatureEnabled | @wppconnect/wa-js - v3.10.1

    Function primaryFeatureEnabled

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.processRawAudioVideo.html b/functions/whatsapp.functions.processRawAudioVideo.html index ef3c1c7680..e46a06028f 100644 --- a/functions/whatsapp.functions.processRawAudioVideo.html +++ b/functions/whatsapp.functions.processRawAudioVideo.html @@ -1,2 +1,2 @@ -processRawAudioVideo | @wppconnect/wa-js - v3.10.1

    Function processRawAudioVideo

    • processRawAudioVideo(mediaBlob, isPtt, precomputedFields, asGif, m, type, isPtv?): Promise<{
          asGif: boolean;
          isPtt: boolean;
          isPtv?: boolean;
          m: any;
          mediaBlob: OpaqueData;
          precomputedFields: any;
          type: string;
      }>

    • Parameters

      • mediaBlob: OpaqueData
      • isPtt: boolean
      • precomputedFields: any
      • asGif: boolean
      • m: any
      • type: string
      • OptionalisPtv: boolean

      Returns Promise<{
          asGif: boolean;
          isPtt: boolean;
          isPtv?: boolean;
          m: any;
          mediaBlob: OpaqueData;
          precomputedFields: any;
          type: string;
      }>

      Whatsapp

      232294 >= 2.2242.6

      -

    Settings

    Member Visibility
    +processRawAudioVideo | @wppconnect/wa-js - v3.10.1

    Function processRawAudioVideo

    • processRawAudioVideo(mediaBlob, isPtt, precomputedFields, asGif, m, type, isPtv?): Promise<{
          asGif: boolean;
          isPtt: boolean;
          isPtv?: boolean;
          m: any;
          mediaBlob: OpaqueData;
          precomputedFields: any;
          type: string;
      }>

    • Parameters

      • mediaBlob: OpaqueData
      • isPtt: boolean
      • precomputedFields: any
      • asGif: boolean
      • m: any
      • type: string
      • OptionalisPtv: boolean

      Returns Promise<{
          asGif: boolean;
          isPtt: boolean;
          isPtv?: boolean;
          m: any;
          mediaBlob: OpaqueData;
          precomputedFields: any;
          type: string;
      }>

      Whatsapp

      232294 >= 2.2242.6

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.processRawMedia.html b/functions/whatsapp.functions.processRawMedia.html index 0f72b2ae43..26523347b6 100644 --- a/functions/whatsapp.functions.processRawMedia.html +++ b/functions/whatsapp.functions.processRawMedia.html @@ -1,2 +1,2 @@ -processRawMedia | @wppconnect/wa-js - v3.10.1

    Function processRawMedia

    • processRawMedia(data): Promise<{
          e: any;
          t?: {
              isPtt?: boolean;
              isPtv?: boolean;
          };
      }>

    • Parameters

      Returns Promise<{
          e: any;
          t?: {
              isPtt?: boolean;
              isPtv?: boolean;
          };
      }>

      Whatsapp

      232294 >= 2.2242.6

      -

    Settings

    Member Visibility
    +processRawMedia | @wppconnect/wa-js - v3.10.1

    Function processRawMedia

    • processRawMedia(data): Promise<{
          e: any;
          t?: {
              isPtt?: boolean;
              isPtv?: boolean;
          };
      }>

    • Parameters

      Returns Promise<{
          e: any;
          t?: {
              isPtt?: boolean;
              isPtv?: boolean;
          };
      }>

      Whatsapp

      232294 >= 2.2242.6

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.processRawSticker.html b/functions/whatsapp.functions.processRawSticker.html index 797ab9f069..a25330da01 100644 --- a/functions/whatsapp.functions.processRawSticker.html +++ b/functions/whatsapp.functions.processRawSticker.html @@ -1,2 +1,2 @@ -processRawSticker | @wppconnect/wa-js - v3.10.1

    Function processRawSticker

    Settings

    Member Visibility
    +processRawSticker | @wppconnect/wa-js - v3.10.1

    Function processRawSticker

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.productVisibilitySet.html b/functions/whatsapp.functions.productVisibilitySet.html index 52cc6ead1d..6d36451df6 100644 --- a/functions/whatsapp.functions.productVisibilitySet.html +++ b/functions/whatsapp.functions.productVisibilitySet.html @@ -1,2 +1,2 @@ -productVisibilitySet | @wppconnect/wa-js - v3.10.1

    Function productVisibilitySet

    Settings

    Member Visibility
    +productVisibilitySet | @wppconnect/wa-js - v3.10.1

    Function productVisibilitySet

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.promoteCommunityParticipants.html b/functions/whatsapp.functions.promoteCommunityParticipants.html index f6a56d8297..6c66b0e538 100644 --- a/functions/whatsapp.functions.promoteCommunityParticipants.html +++ b/functions/whatsapp.functions.promoteCommunityParticipants.html @@ -1,2 +1,2 @@ -promoteCommunityParticipants | @wppconnect/wa-js - v3.10.1

    Function promoteCommunityParticipants

    Settings

    Member Visibility
    +promoteCommunityParticipants | @wppconnect/wa-js - v3.10.1

    Function promoteCommunityParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.promoteParticipants.html b/functions/whatsapp.functions.promoteParticipants.html index d118a162c6..504fa4f789 100644 --- a/functions/whatsapp.functions.promoteParticipants.html +++ b/functions/whatsapp.functions.promoteParticipants.html @@ -1,4 +1,4 @@ -promoteParticipants | @wppconnect/wa-js - v3.10.1

    Function promoteParticipants

    Settings

    Member Visibility
    +promoteParticipants | @wppconnect/wa-js - v3.10.1

    Function promoteParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.queryCatalog.html b/functions/whatsapp.functions.queryCatalog.html index 8a074d6d7f..6f157fbfde 100644 --- a/functions/whatsapp.functions.queryCatalog.html +++ b/functions/whatsapp.functions.queryCatalog.html @@ -1,2 +1,2 @@ -queryCatalog | @wppconnect/wa-js - v3.10.1

    Function queryCatalog

    • queryCatalog(chatId?, t?, n?, r?, i?, s?, l?): any

    • Parameters

      • OptionalchatId: Wid
      • Optionalt: any
      • Optionaln: number
      • Optionalr: number
      • Optionali: number
      • Optionals: any
      • Optionall: any

      Returns any

      Whatsapp

      621374 >= 2.2228.14

      -

    Settings

    Member Visibility
    +queryCatalog | @wppconnect/wa-js - v3.10.1

    Function queryCatalog

    • queryCatalog(chatId?, t?, n?, r?, i?, s?, l?): any

    • Parameters

      • OptionalchatId: Wid
      • Optionalt: any
      • Optionaln: number
      • Optionalr: number
      • Optionali: number
      • Optionals: any
      • Optionall: any

      Returns any

      Whatsapp

      621374 >= 2.2228.14

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.queryCollectionsIQ.html b/functions/whatsapp.functions.queryCollectionsIQ.html index 3eb5dc9eb3..8c9d688640 100644 --- a/functions/whatsapp.functions.queryCollectionsIQ.html +++ b/functions/whatsapp.functions.queryCollectionsIQ.html @@ -1,2 +1,2 @@ -queryCollectionsIQ | @wppconnect/wa-js - v3.10.1

    Function queryCollectionsIQ

    Settings

    Member Visibility
    +queryCollectionsIQ | @wppconnect/wa-js - v3.10.1

    Function queryCollectionsIQ

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.queryGroupInviteCode.html b/functions/whatsapp.functions.queryGroupInviteCode.html index 56cf7d75e2..4895bb5020 100644 --- a/functions/whatsapp.functions.queryGroupInviteCode.html +++ b/functions/whatsapp.functions.queryGroupInviteCode.html @@ -1,2 +1,2 @@ -queryGroupInviteCode | @wppconnect/wa-js - v3.10.1

    Function queryGroupInviteCode

    Settings

    Member Visibility
    +queryGroupInviteCode | @wppconnect/wa-js - v3.10.1

    Function queryGroupInviteCode

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.queryNewsletterMetadataByJid.html b/functions/whatsapp.functions.queryNewsletterMetadataByJid.html index b9e6d4e5a5..89edaae6d2 100644 --- a/functions/whatsapp.functions.queryNewsletterMetadataByJid.html +++ b/functions/whatsapp.functions.queryNewsletterMetadataByJid.html @@ -1,2 +1,2 @@ -queryNewsletterMetadataByJid | @wppconnect/wa-js - v3.10.1

    Function queryNewsletterMetadataByJid

    • queryNewsletterMetadataByJid(jid, attributes): any

    • Parameters

      • jid: string
      • attributes: {
            creationTime?: boolean;
            description?: boolean;
            handle?: boolean;
            inviteLink?: boolean;
            linkedAccounts?: boolean;
            membership?: boolean;
            name?: boolean;
            picture?: boolean;
            privacy?: boolean;
            state?: boolean;
            subscribers?: boolean;
            verification?: boolean;
        }
        • OptionalcreationTime?: boolean
        • Optionaldescription?: boolean
        • Optionalhandle?: boolean
        • OptionalinviteLink?: boolean
        • OptionallinkedAccounts?: boolean
        • Optionalmembership?: boolean
        • Optionalname?: boolean
        • Optionalpicture?: boolean
        • Optionalprivacy?: boolean
        • Optionalstate?: boolean
        • Optionalsubscribers?: boolean
        • Optionalverification?: boolean

      Returns any

      Whatsapp

      657987

      -

    Settings

    Member Visibility
    +queryNewsletterMetadataByJid | @wppconnect/wa-js - v3.10.1

    Function queryNewsletterMetadataByJid

    • queryNewsletterMetadataByJid(jid, attributes): any

    • Parameters

      • jid: string
      • attributes: {
            creationTime?: boolean;
            description?: boolean;
            handle?: boolean;
            inviteLink?: boolean;
            linkedAccounts?: boolean;
            membership?: boolean;
            name?: boolean;
            picture?: boolean;
            privacy?: boolean;
            state?: boolean;
            subscribers?: boolean;
            verification?: boolean;
        }
        • OptionalcreationTime?: boolean
        • Optionaldescription?: boolean
        • Optionalhandle?: boolean
        • OptionalinviteLink?: boolean
        • OptionallinkedAccounts?: boolean
        • Optionalmembership?: boolean
        • Optionalname?: boolean
        • Optionalpicture?: boolean
        • Optionalprivacy?: boolean
        • Optionalstate?: boolean
        • Optionalsubscribers?: boolean
        • Optionalverification?: boolean

      Returns any

      Whatsapp

      657987

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.queryOrder.html b/functions/whatsapp.functions.queryOrder.html index c35c259b52..3bc05a571a 100644 --- a/functions/whatsapp.functions.queryOrder.html +++ b/functions/whatsapp.functions.queryOrder.html @@ -1,2 +1,2 @@ -queryOrder | @wppconnect/wa-js - v3.10.1

    Function queryOrder

    • queryOrder(productId, imageWidth, imageHeight, token, e?): Promise<{
          createdAt: number;
          currency: string;
          products: {
              currency: string;
              id: string;
              name: string;
              price: number;
              quantity: number;
              thumbnailId: string;
              thumbnailUrl: string;
          }[];
          subtotal: number;
          tax: number | null;
          total: number;
      }>

    • Parameters

      • productId: string
      • imageWidth: number
      • imageHeight: number
      • token: string
      • Optionale: any

      Returns Promise<{
          createdAt: number;
          currency: string;
          products: {
              currency: string;
              id: string;
              name: string;
              price: number;
              quantity: number;
              thumbnailId: string;
              thumbnailUrl: string;
          }[];
          subtotal: number;
          tax: number | null;
          total: number;
      }>

      Whatsapp

      WAWebBizQueryOrderJob >= 2.30000.0

      -

    Settings

    Member Visibility
    +queryOrder | @wppconnect/wa-js - v3.10.1

    Function queryOrder

    • queryOrder(productId, imageWidth, imageHeight, token, e?): Promise<{
          createdAt: number;
          currency: string;
          products: {
              currency: string;
              id: string;
              name: string;
              price: number;
              quantity: number;
              thumbnailId: string;
              thumbnailUrl: string;
          }[];
          subtotal: number;
          tax: number | null;
          total: number;
      }>

    • Parameters

      • productId: string
      • imageWidth: number
      • imageHeight: number
      • token: string
      • Optionale: any

      Returns Promise<{
          createdAt: number;
          currency: string;
          products: {
              currency: string;
              id: string;
              name: string;
              price: number;
              quantity: number;
              thumbnailId: string;
              thumbnailUrl: string;
          }[];
          subtotal: number;
          tax: number | null;
          total: number;
      }>

      Whatsapp

      WAWebBizQueryOrderJob >= 2.30000.0

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.queryProduct.html b/functions/whatsapp.functions.queryProduct.html index 2d5fdb0965..7b447ed1f0 100644 --- a/functions/whatsapp.functions.queryProduct.html +++ b/functions/whatsapp.functions.queryProduct.html @@ -1,2 +1,2 @@ -queryProduct | @wppconnect/wa-js - v3.10.1

    Function queryProduct

    • queryProduct(chatId?, productId?, imageWidth?, imageHeight?, i?, s?): any

    • Parameters

      • OptionalchatId: Wid
      • OptionalproductId: any
      • OptionalimageWidth: number
      • OptionalimageHeight: number
      • Optionali: any
      • Optionals: boolean

      Returns any

      Whatsapp

      621374 >= 2.2228.14

      -

    Settings

    Member Visibility
    +queryProduct | @wppconnect/wa-js - v3.10.1

    Function queryProduct

    • queryProduct(chatId?, productId?, imageWidth?, imageHeight?, i?, s?): any

    • Parameters

      • OptionalchatId: Wid
      • OptionalproductId: any
      • OptionalimageWidth: number
      • OptionalimageHeight: number
      • Optionali: any
      • Optionals: boolean

      Returns any

      Whatsapp

      621374 >= 2.2228.14

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.randomHex.html b/functions/whatsapp.functions.randomHex.html index 45fda4da32..00b569b5b0 100644 --- a/functions/whatsapp.functions.randomHex.html +++ b/functions/whatsapp.functions.randomHex.html @@ -1,3 +1,3 @@ -randomHex | @wppconnect/wa-js - v3.10.1

    Function randomHex

    Settings

    Member Visibility
    +randomHex | @wppconnect/wa-js - v3.10.1

    Function randomHex

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.randomMessageId.html b/functions/whatsapp.functions.randomMessageId.html index ac172c50f9..0cda70cad3 100644 --- a/functions/whatsapp.functions.randomMessageId.html +++ b/functions/whatsapp.functions.randomMessageId.html @@ -1,9 +1,9 @@ randomMessageId | @wppconnect/wa-js - v3.10.1

    Function randomMessageId

    • randomMessageId(): string | Promise<string>

    • Returns string | Promise<string>

      Promise for

      -

      Whatsapp

      65212

      -

      Whatsapp

      15860 >= 2.2204.13

      -

      Whatsapp

      465212 >= 2.2222.8

      -

      Whatsapp

      +

      Whatsapp

      65212

      +

      Whatsapp

      15860 >= 2.2204.13

      +

      Whatsapp

      465212 >= 2.2222.8

      +

      Whatsapp

      = 2.2321.4

      -

      Whatsapp

      < 2.2321.4

      -

    Settings

    Member Visibility
    +

    Whatsapp

    < 2.2321.4

    +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.removeParticipants.html b/functions/whatsapp.functions.removeParticipants.html index 1a427e75cd..cbfa3b2185 100644 --- a/functions/whatsapp.functions.removeParticipants.html +++ b/functions/whatsapp.functions.removeParticipants.html @@ -1,4 +1,4 @@ -removeParticipants | @wppconnect/wa-js - v3.10.1

    Function removeParticipants

    Settings

    Member Visibility
    +removeParticipants | @wppconnect/wa-js - v3.10.1

    Function removeParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.requestDeletePicture.html b/functions/whatsapp.functions.requestDeletePicture.html index ec70fc0fb3..80ae8e44b8 100644 --- a/functions/whatsapp.functions.requestDeletePicture.html +++ b/functions/whatsapp.functions.requestDeletePicture.html @@ -1,4 +1,4 @@ requestDeletePicture | @wppconnect/wa-js - v3.10.1

    Function requestDeletePicture

    • requestDeletePicture(chat): Promise<{
          status: number;
      }>

    • This function can be used to delete a group picture or self profile

      -

      Parameters

      Returns Promise<{
          status: number;
      }>

      Whatsapp

      78426

      -

      Whatsapp

      5018 >= 2.2204.13

      -

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<{
        status: number;
    }>

    Whatsapp

    78426

    +

    Whatsapp

    5018 >= 2.2204.13

    +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.resetGroupInviteCode.html b/functions/whatsapp.functions.resetGroupInviteCode.html index ba2d74f0d9..b9b4598f8f 100644 --- a/functions/whatsapp.functions.resetGroupInviteCode.html +++ b/functions/whatsapp.functions.resetGroupInviteCode.html @@ -1,2 +1,2 @@ -resetGroupInviteCode | @wppconnect/wa-js - v3.10.1

    Function resetGroupInviteCode

    Settings

    Member Visibility
    +resetGroupInviteCode | @wppconnect/wa-js - v3.10.1

    Function resetGroupInviteCode

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.revokeStatus.html b/functions/whatsapp.functions.revokeStatus.html index 659ab106cb..02822d9185 100644 --- a/functions/whatsapp.functions.revokeStatus.html +++ b/functions/whatsapp.functions.revokeStatus.html @@ -1,2 +1,2 @@ -revokeStatus | @wppconnect/wa-js - v3.10.1

    Function revokeStatus

    Settings

    Member Visibility
    +revokeStatus | @wppconnect/wa-js - v3.10.1

    Function revokeStatus

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendAddParticipants.html b/functions/whatsapp.functions.sendAddParticipants.html index b2ede83beb..3b7767a58a 100644 --- a/functions/whatsapp.functions.sendAddParticipants.html +++ b/functions/whatsapp.functions.sendAddParticipants.html @@ -1,2 +1,2 @@ -sendAddParticipants | @wppconnect/wa-js - v3.10.1

    Function sendAddParticipants

    • sendAddParticipants(group, participants): Promise<{
          participants?: ({
              [key: `${number}@c.us`]: {
                  code: string;
                  invite_code: string | null;
                  invite_code_exp: string | null;
              };
          } | {
              code: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              userWid: Wid;
          })[];
          status: number;
          [key: `${number}@c.us`]: number;
      }>

    • Parameters

      • group: Wid
      • participants: (Wid | {
            lid?: Wid;
            phoneNumber: Wid;
        })[]

      Returns Promise<{
          participants?: ({
              [key: `${number}@c.us`]: {
                  code: string;
                  invite_code: string | null;
                  invite_code_exp: string | null;
              };
          } | {
              code: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              userWid: Wid;
          })[];
          status: number;
          [key: `${number}@c.us`]: number;
      }>

      Whatsapp

      437722 >= 2.2222.8

      -

    Settings

    Member Visibility
    +sendAddParticipants | @wppconnect/wa-js - v3.10.1

    Function sendAddParticipants

    • sendAddParticipants(group, participants): Promise<{
          participants?: ({
              [key: `${number}@c.us`]: {
                  code: string;
                  invite_code: string | null;
                  invite_code_exp: string | null;
              };
          } | {
              code: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              userWid: Wid;
          })[];
          status: number;
          [key: `${number}@c.us`]: number;
      }>

    • Parameters

      • group: Wid
      • participants: (Wid | {
            lid?: Wid;
            phoneNumber: Wid;
        })[]

      Returns Promise<{
          participants?: ({
              [key: `${number}@c.us`]: {
                  code: string;
                  invite_code: string | null;
                  invite_code_exp: string | null;
              };
          } | {
              code: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              userWid: Wid;
          })[];
          status: number;
          [key: `${number}@c.us`]: number;
      }>

      Whatsapp

      437722 >= 2.2222.8

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendClear.html b/functions/whatsapp.functions.sendClear.html index 8df97981ab..b0af33908f 100644 --- a/functions/whatsapp.functions.sendClear.html +++ b/functions/whatsapp.functions.sendClear.html @@ -1,4 +1,4 @@ -sendClear | @wppconnect/wa-js - v3.10.1

    Function sendClear

    Settings

    Member Visibility
    +sendClear | @wppconnect/wa-js - v3.10.1

    Function sendClear

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendCreateCommunity.html b/functions/whatsapp.functions.sendCreateCommunity.html index e2e036141b..75fd788ea3 100644 --- a/functions/whatsapp.functions.sendCreateCommunity.html +++ b/functions/whatsapp.functions.sendCreateCommunity.html @@ -1,2 +1,2 @@ -sendCreateCommunity | @wppconnect/wa-js - v3.10.1

    Function sendCreateCommunity

    Settings

    Member Visibility
    +sendCreateCommunity | @wppconnect/wa-js - v3.10.1

    Function sendCreateCommunity

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendCreateGroup.html b/functions/whatsapp.functions.sendCreateGroup.html index ba805d02bf..218d44b93e 100644 --- a/functions/whatsapp.functions.sendCreateGroup.html +++ b/functions/whatsapp.functions.sendCreateGroup.html @@ -1,2 +1,2 @@ -sendCreateGroup | @wppconnect/wa-js - v3.10.1

    Function sendCreateGroup

    • sendCreateGroup(groupName, participants, ephemeral?, parentGroup?): Promise<{
          gid: Wid;
          participants: ({
              [key: `${number}@c.us`]: {
                  code: string;
                  invite_code: string | null;
                  invite_code_exp: string | null;
              };
          } | {
              code: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              userWid: Wid;
          })[];
      }>

    • Parameters

      • groupName: string
      • participants: Wid[]
      • Optionalephemeral: number
      • OptionalparentGroup: Wid

      Returns Promise<{
          gid: Wid;
          participants: ({
              [key: `${number}@c.us`]: {
                  code: string;
                  invite_code: string | null;
                  invite_code_exp: string | null;
              };
          } | {
              code: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              userWid: Wid;
          })[];
      }>

      Whatsapp

      79583

      -

    Settings

    Member Visibility
    +sendCreateGroup | @wppconnect/wa-js - v3.10.1

    Function sendCreateGroup

    • sendCreateGroup(groupName, participants, ephemeral?, parentGroup?): Promise<{
          gid: Wid;
          participants: ({
              [key: `${number}@c.us`]: {
                  code: string;
                  invite_code: string | null;
                  invite_code_exp: string | null;
              };
          } | {
              code: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              userWid: Wid;
          })[];
      }>

    • Parameters

      • groupName: string
      • participants: Wid[]
      • Optionalephemeral: number
      • OptionalparentGroup: Wid

      Returns Promise<{
          gid: Wid;
          participants: ({
              [key: `${number}@c.us`]: {
                  code: string;
                  invite_code: string | null;
                  invite_code_exp: string | null;
              };
          } | {
              code: string;
              invite_code: string | null;
              invite_code_exp: string | null;
              userWid: Wid;
          })[];
      }>

      Whatsapp

      79583

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendDeactivateCommunity.html b/functions/whatsapp.functions.sendDeactivateCommunity.html index 22aeb5305e..6fab54d91d 100644 --- a/functions/whatsapp.functions.sendDeactivateCommunity.html +++ b/functions/whatsapp.functions.sendDeactivateCommunity.html @@ -1,2 +1,2 @@ -sendDeactivateCommunity | @wppconnect/wa-js - v3.10.1

    Function sendDeactivateCommunity

    Settings

    Member Visibility
    +sendDeactivateCommunity | @wppconnect/wa-js - v3.10.1

    Function sendDeactivateCommunity

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendDelete.html b/functions/whatsapp.functions.sendDelete.html index f546c21a26..5e19b4b4f6 100644 --- a/functions/whatsapp.functions.sendDelete.html +++ b/functions/whatsapp.functions.sendDelete.html @@ -1,4 +1,4 @@ -sendDelete | @wppconnect/wa-js - v3.10.1

    Function sendDelete

    Settings

    Member Visibility
    +sendDelete | @wppconnect/wa-js - v3.10.1

    Function sendDelete

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendDemoteParticipants.html b/functions/whatsapp.functions.sendDemoteParticipants.html index abcedc8491..9b0b87bca1 100644 --- a/functions/whatsapp.functions.sendDemoteParticipants.html +++ b/functions/whatsapp.functions.sendDemoteParticipants.html @@ -1,2 +1,2 @@ -sendDemoteParticipants | @wppconnect/wa-js - v3.10.1

    Function sendDemoteParticipants

    Settings

    Member Visibility
    +sendDemoteParticipants | @wppconnect/wa-js - v3.10.1

    Function sendDemoteParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendExitGroup.html b/functions/whatsapp.functions.sendExitGroup.html index ffc03ce5a0..1ae5555a5f 100644 --- a/functions/whatsapp.functions.sendExitGroup.html +++ b/functions/whatsapp.functions.sendExitGroup.html @@ -1,4 +1,4 @@ -sendExitGroup | @wppconnect/wa-js - v3.10.1

    Function sendExitGroup

    Settings

    Member Visibility
    +sendExitGroup | @wppconnect/wa-js - v3.10.1

    Function sendExitGroup

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendJoinGroupViaInvite.html b/functions/whatsapp.functions.sendJoinGroupViaInvite.html index abb525b6f1..a12bceff29 100644 --- a/functions/whatsapp.functions.sendJoinGroupViaInvite.html +++ b/functions/whatsapp.functions.sendJoinGroupViaInvite.html @@ -1,3 +1,3 @@ -sendJoinGroupViaInvite | @wppconnect/wa-js - v3.10.1

    Function sendJoinGroupViaInvite

    Settings

    Member Visibility
    +sendJoinGroupViaInvite | @wppconnect/wa-js - v3.10.1

    Function sendJoinGroupViaInvite

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendLinkSubgroups.html b/functions/whatsapp.functions.sendLinkSubgroups.html index a815a95de7..020306259c 100644 --- a/functions/whatsapp.functions.sendLinkSubgroups.html +++ b/functions/whatsapp.functions.sendLinkSubgroups.html @@ -1,2 +1,2 @@ -sendLinkSubgroups | @wppconnect/wa-js - v3.10.1

    Function sendLinkSubgroups

    Settings

    Member Visibility
    +sendLinkSubgroups | @wppconnect/wa-js - v3.10.1

    Function sendLinkSubgroups

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendNewsletterMessageJob.html b/functions/whatsapp.functions.sendNewsletterMessageJob.html index 9350a9ee3c..a9bbc9f939 100644 --- a/functions/whatsapp.functions.sendNewsletterMessageJob.html +++ b/functions/whatsapp.functions.sendNewsletterMessageJob.html @@ -1,2 +1,2 @@ -sendNewsletterMessageJob | @wppconnect/wa-js - v3.10.1

    Function sendNewsletterMessageJob

    • sendNewsletterMessageJob(data): Promise<{
          ack: {
              t: number;
          };
          serverId: number;
          success: boolean;
      }>

    • Parameters

      • data: {
            editType?: "text" | "media";
            msg?: MsgModel;
            msgData?: any;
            newsletterJid: string;
            type: string;
        }
        • OptionaleditType?: "text" | "media"
        • Optionalmsg?: MsgModel
        • OptionalmsgData?: any
        • newsletterJid: string
        • type: string

      Returns Promise<{
          ack: {
              t: number;
          };
          serverId: number;
          success: boolean;
      }>

      Whatsapp

      397995

      -

    Settings

    Member Visibility
    +sendNewsletterMessageJob | @wppconnect/wa-js - v3.10.1

    Function sendNewsletterMessageJob

    • sendNewsletterMessageJob(data): Promise<{
          ack: {
              t: number;
          };
          serverId: number;
          success: boolean;
      }>

    • Parameters

      • data: {
            editType?: "text" | "media";
            msg?: MsgModel;
            msgData?: any;
            newsletterJid: string;
            type: string;
        }
        • OptionaleditType?: "text" | "media"
        • Optionalmsg?: MsgModel
        • OptionalmsgData?: any
        • newsletterJid: string
        • type: string

      Returns Promise<{
          ack: {
              t: number;
          };
          serverId: number;
          success: boolean;
      }>

      Whatsapp

      397995

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendPinInChatMsg.html b/functions/whatsapp.functions.sendPinInChatMsg.html index 831b042f63..d588d43f4d 100644 --- a/functions/whatsapp.functions.sendPinInChatMsg.html +++ b/functions/whatsapp.functions.sendPinInChatMsg.html @@ -1,2 +1,2 @@ -sendPinInChatMsg | @wppconnect/wa-js - v3.10.1

    Function sendPinInChatMsg

    Settings

    Member Visibility
    +sendPinInChatMsg | @wppconnect/wa-js - v3.10.1

    Function sendPinInChatMsg

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendProductToChat.html b/functions/whatsapp.functions.sendProductToChat.html index e0eb65d558..c7297a7518 100644 --- a/functions/whatsapp.functions.sendProductToChat.html +++ b/functions/whatsapp.functions.sendProductToChat.html @@ -1,4 +1,4 @@ -sendProductToChat | @wppconnect/wa-js - v3.10.1

    Function sendProductToChat

    Settings

    Member Visibility
    +sendProductToChat | @wppconnect/wa-js - v3.10.1

    Function sendProductToChat

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendPromoteParticipants.html b/functions/whatsapp.functions.sendPromoteParticipants.html index 10e54030a3..6637473820 100644 --- a/functions/whatsapp.functions.sendPromoteParticipants.html +++ b/functions/whatsapp.functions.sendPromoteParticipants.html @@ -1,2 +1,2 @@ -sendPromoteParticipants | @wppconnect/wa-js - v3.10.1

    Function sendPromoteParticipants

    Settings

    Member Visibility
    +sendPromoteParticipants | @wppconnect/wa-js - v3.10.1

    Function sendPromoteParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendQueryExists.html b/functions/whatsapp.functions.sendQueryExists.html index 8a8682c217..9c89aff98a 100644 --- a/functions/whatsapp.functions.sendQueryExists.html +++ b/functions/whatsapp.functions.sendQueryExists.html @@ -1,3 +1,3 @@ -sendQueryExists | @wppconnect/wa-js - v3.10.1

    Function sendQueryExists

    • sendQueryExists(contact): Promise<{
          biz: boolean;
          bizInfo?: {
              verifiedName?: {
                  isApi: boolean;
                  level: string;
                  name: string;
                  privacyMode: any;
                  serial: string;
              };
          };
          disappearingMode?: {
              duration: number;
              settingTimestamp: number;
          };
          wid: Wid;
      }>

    • Parameters

      Returns Promise<{
          biz: boolean;
          bizInfo?: {
              verifiedName?: {
                  isApi: boolean;
                  level: string;
                  name: string;
                  privacyMode: any;
                  serial: string;
              };
          };
          disappearingMode?: {
              duration: number;
              settingTimestamp: number;
          };
          wid: Wid;
      }>

      Whatsapp

      57547

      -

      Whatsapp

      69722 >= 2.2204.13

      -

    Settings

    Member Visibility
    +sendQueryExists | @wppconnect/wa-js - v3.10.1

    Function sendQueryExists

    • sendQueryExists(contact): Promise<{
          biz: boolean;
          bizInfo?: {
              verifiedName?: {
                  isApi: boolean;
                  level: string;
                  name: string;
                  privacyMode: any;
                  serial: string;
              };
          };
          disappearingMode?: {
              duration: number;
              settingTimestamp: number;
          };
          wid: Wid;
      }>

    • Parameters

      Returns Promise<{
          biz: boolean;
          bizInfo?: {
              verifiedName?: {
                  isApi: boolean;
                  level: string;
                  name: string;
                  privacyMode: any;
                  serial: string;
              };
          };
          disappearingMode?: {
              duration: number;
              settingTimestamp: number;
          };
          wid: Wid;
      }>

      Whatsapp

      57547

      +

      Whatsapp

      69722 >= 2.2204.13

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendQueryGroupInvite.html b/functions/whatsapp.functions.sendQueryGroupInvite.html index 798203b8e1..a1c570961e 100644 --- a/functions/whatsapp.functions.sendQueryGroupInvite.html +++ b/functions/whatsapp.functions.sendQueryGroupInvite.html @@ -1,3 +1,3 @@ -sendQueryGroupInvite | @wppconnect/wa-js - v3.10.1

    Function sendQueryGroupInvite

    Settings

    Member Visibility
    +sendQueryGroupInvite | @wppconnect/wa-js - v3.10.1

    Function sendQueryGroupInvite

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendQueryGroupInviteCode.html b/functions/whatsapp.functions.sendQueryGroupInviteCode.html index eec595c425..e6dd1646dc 100644 --- a/functions/whatsapp.functions.sendQueryGroupInviteCode.html +++ b/functions/whatsapp.functions.sendQueryGroupInviteCode.html @@ -1,2 +1,2 @@ -sendQueryGroupInviteCode | @wppconnect/wa-js - v3.10.1

    Function sendQueryGroupInviteCode

    Settings

    Member Visibility
    +sendQueryGroupInviteCode | @wppconnect/wa-js - v3.10.1

    Function sendQueryGroupInviteCode

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendReactionToMsg.html b/functions/whatsapp.functions.sendReactionToMsg.html index 3db2d9e6f7..2cc464e18f 100644 --- a/functions/whatsapp.functions.sendReactionToMsg.html +++ b/functions/whatsapp.functions.sendReactionToMsg.html @@ -1,4 +1,4 @@ -sendReactionToMsg | @wppconnect/wa-js - v3.10.1

    Function sendReactionToMsg

    Settings

    Member Visibility
    +sendReactionToMsg | @wppconnect/wa-js - v3.10.1

    Function sendReactionToMsg

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendRemoveParticipants.html b/functions/whatsapp.functions.sendRemoveParticipants.html index 32e58d3122..37c2ba3761 100644 --- a/functions/whatsapp.functions.sendRemoveParticipants.html +++ b/functions/whatsapp.functions.sendRemoveParticipants.html @@ -1,2 +1,2 @@ -sendRemoveParticipants | @wppconnect/wa-js - v3.10.1

    Function sendRemoveParticipants

    Settings

    Member Visibility
    +sendRemoveParticipants | @wppconnect/wa-js - v3.10.1

    Function sendRemoveParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendRevokeGroupInviteCode.html b/functions/whatsapp.functions.sendRevokeGroupInviteCode.html index ce0900dd7b..d135e48950 100644 --- a/functions/whatsapp.functions.sendRevokeGroupInviteCode.html +++ b/functions/whatsapp.functions.sendRevokeGroupInviteCode.html @@ -1,3 +1,3 @@ -sendRevokeGroupInviteCode | @wppconnect/wa-js - v3.10.1

    Function sendRevokeGroupInviteCode

    Settings

    Member Visibility
    +sendRevokeGroupInviteCode | @wppconnect/wa-js - v3.10.1

    Function sendRevokeGroupInviteCode

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendSeen.html b/functions/whatsapp.functions.sendSeen.html index e266bdcd7a..65e93de306 100644 --- a/functions/whatsapp.functions.sendSeen.html +++ b/functions/whatsapp.functions.sendSeen.html @@ -1,3 +1,3 @@ -sendSeen | @wppconnect/wa-js - v3.10.1

    Function sendSeen

    Settings

    Member Visibility
    +sendSeen | @wppconnect/wa-js - v3.10.1

    Function sendSeen

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendSetGroupDescription.html b/functions/whatsapp.functions.sendSetGroupDescription.html index 944f7d552d..8ef7cc804b 100644 --- a/functions/whatsapp.functions.sendSetGroupDescription.html +++ b/functions/whatsapp.functions.sendSetGroupDescription.html @@ -1,3 +1,3 @@ -sendSetGroupDescription | @wppconnect/wa-js - v3.10.1

    Function sendSetGroupDescription

    • sendSetGroupDescription(groupId, description, tagId, previousTagId?): Promise<void>

    • Parameters

      • groupId: Wid
      • description: string
      • tagId: string
      • OptionalpreviousTagId: string

      Returns Promise<void>

      Whatsapp

      57490

      -

      Whatsapp

      357490 >= 2.2222.8

      -

    Settings

    Member Visibility
    +sendSetGroupDescription | @wppconnect/wa-js - v3.10.1

    Function sendSetGroupDescription

    • sendSetGroupDescription(groupId, description, tagId, previousTagId?): Promise<void>

    • Parameters

      • groupId: Wid
      • description: string
      • tagId: string
      • OptionalpreviousTagId: string

      Returns Promise<void>

      Whatsapp

      57490

      +

      Whatsapp

      357490 >= 2.2222.8

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendSetGroupProperty.html b/functions/whatsapp.functions.sendSetGroupProperty.html index 0cf7f1596e..11935fec3d 100644 --- a/functions/whatsapp.functions.sendSetGroupProperty.html +++ b/functions/whatsapp.functions.sendSetGroupProperty.html @@ -1,3 +1,3 @@ -sendSetGroupProperty | @wppconnect/wa-js - v3.10.1

    Function sendSetGroupProperty

    Settings

    Member Visibility
    +sendSetGroupProperty | @wppconnect/wa-js - v3.10.1

    Function sendSetGroupProperty

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendSetGroupSubject.html b/functions/whatsapp.functions.sendSetGroupSubject.html index 201b8968f0..7c1c9e5985 100644 --- a/functions/whatsapp.functions.sendSetGroupSubject.html +++ b/functions/whatsapp.functions.sendSetGroupSubject.html @@ -1,3 +1,3 @@ -sendSetGroupSubject | @wppconnect/wa-js - v3.10.1

    Function sendSetGroupSubject

    Settings

    Member Visibility
    +sendSetGroupSubject | @wppconnect/wa-js - v3.10.1

    Function sendSetGroupSubject

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendSetPicture.html b/functions/whatsapp.functions.sendSetPicture.html index 21d1f648c5..033d77eaa6 100644 --- a/functions/whatsapp.functions.sendSetPicture.html +++ b/functions/whatsapp.functions.sendSetPicture.html @@ -1,4 +1,4 @@ sendSetPicture | @wppconnect/wa-js - v3.10.1

    Function sendSetPicture

    • sendSetPicture(chat, previewBase64, pictureBase64): Promise<{
          _duplicate: boolean;
          eurl: string;
          status: number;
          tag: string;
          token: string;
      }>

    • This function can be used to define a group picture or self profile

      -

      Parameters

      • chat: Wid
      • previewBase64: string
      • pictureBase64: string

      Returns Promise<{
          _duplicate: boolean;
          eurl: string;
          status: number;
          tag: string;
          token: string;
      }>

      Whatsapp

      78426

      -

      Whatsapp

      5018 >= 2.2204.13

      -

    Settings

    Member Visibility
    +

    Parameters

    • chat: Wid
    • previewBase64: string
    • pictureBase64: string

    Returns Promise<{
        _duplicate: boolean;
        eurl: string;
        status: number;
        tag: string;
        token: string;
    }>

    Whatsapp

    78426

    +

    Whatsapp

    5018 >= 2.2204.13

    +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendTextMsgToChat.html b/functions/whatsapp.functions.sendTextMsgToChat.html index 36feef7bcc..f56be347c1 100644 --- a/functions/whatsapp.functions.sendTextMsgToChat.html +++ b/functions/whatsapp.functions.sendTextMsgToChat.html @@ -1,4 +1,4 @@ -sendTextMsgToChat | @wppconnect/wa-js - v3.10.1

    Function sendTextMsgToChat

    Settings

    Member Visibility
    +sendTextMsgToChat | @wppconnect/wa-js - v3.10.1

    Function sendTextMsgToChat

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.sendUnlinkSubgroups.html b/functions/whatsapp.functions.sendUnlinkSubgroups.html index 0f19b0e9ee..a49f44aa2e 100644 --- a/functions/whatsapp.functions.sendUnlinkSubgroups.html +++ b/functions/whatsapp.functions.sendUnlinkSubgroups.html @@ -1,2 +1,2 @@ -sendUnlinkSubgroups | @wppconnect/wa-js - v3.10.1

    Function sendUnlinkSubgroups

    Settings

    Member Visibility
    +sendUnlinkSubgroups | @wppconnect/wa-js - v3.10.1

    Function sendUnlinkSubgroups

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.setArchive.html b/functions/whatsapp.functions.setArchive.html index 79099c3ead..d3ab678122 100644 --- a/functions/whatsapp.functions.setArchive.html +++ b/functions/whatsapp.functions.setArchive.html @@ -1,8 +1,8 @@ -setArchive | @wppconnect/wa-js - v3.10.1

    Function setArchive

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.setMyStatus.html b/functions/whatsapp.functions.setMyStatus.html index a9864f99ec..7faf50c42c 100644 --- a/functions/whatsapp.functions.setMyStatus.html +++ b/functions/whatsapp.functions.setMyStatus.html @@ -1,4 +1,4 @@ -setMyStatus | @wppconnect/wa-js - v3.10.1

    Function setMyStatus

    • setMyStatus(status, seqId?): Promise<{
          status: number;
      }>

    • Parameters

      • status: string
      • OptionalseqId: number

      Returns Promise<{
          status: number;
      }>

      Whatsapp

      46898

      -

      Whatsapp

      51316 >= 2.2204.13

      -

      Whatsapp

      546898 >= 2.2222.8

      -

    Settings

    Member Visibility
    +setMyStatus | @wppconnect/wa-js - v3.10.1

    Function setMyStatus

    • setMyStatus(status, seqId?): Promise<{
          status: number;
      }>

    • Parameters

      • status: string
      • OptionalseqId: number

      Returns Promise<{
          status: number;
      }>

      Whatsapp

      46898

      +

      Whatsapp

      51316 >= 2.2204.13

      +

      Whatsapp

      546898 >= 2.2222.8

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.setPin.html b/functions/whatsapp.functions.setPin.html index 67c43d4e1d..35e1e535ed 100644 --- a/functions/whatsapp.functions.setPin.html +++ b/functions/whatsapp.functions.setPin.html @@ -1,6 +1,6 @@ -setPin | @wppconnect/wa-js - v3.10.1

    Function setPin

    Settings

    Member Visibility
    +setPin | @wppconnect/wa-js - v3.10.1

    Function setPin

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.setPushname.html b/functions/whatsapp.functions.setPushname.html index 7aa93b1ccb..a418399c9e 100644 --- a/functions/whatsapp.functions.setPushname.html +++ b/functions/whatsapp.functions.setPushname.html @@ -1,2 +1,2 @@ -setPushname | @wppconnect/wa-js - v3.10.1

    Function setPushname

    Settings

    Member Visibility
    +setPushname | @wppconnect/wa-js - v3.10.1

    Function setPushname

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.syncABPropsTask.html b/functions/whatsapp.functions.syncABPropsTask.html index 2281231bf2..5ebbdb8564 100644 --- a/functions/whatsapp.functions.syncABPropsTask.html +++ b/functions/whatsapp.functions.syncABPropsTask.html @@ -1,2 +1,2 @@ -syncABPropsTask | @wppconnect/wa-js - v3.10.1

    Function syncABPropsTask

    Settings

    Member Visibility
    +syncABPropsTask | @wppconnect/wa-js - v3.10.1

    Function syncABPropsTask

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.typeAttributeFromProtobuf.html b/functions/whatsapp.functions.typeAttributeFromProtobuf.html index 5d8588950f..0ca286a1bf 100644 --- a/functions/whatsapp.functions.typeAttributeFromProtobuf.html +++ b/functions/whatsapp.functions.typeAttributeFromProtobuf.html @@ -1,4 +1,4 @@ -typeAttributeFromProtobuf | @wppconnect/wa-js - v3.10.1

    Function typeAttributeFromProtobuf

    • typeAttributeFromProtobuf(protoMessage): string

    • Parameters

      • protoMessage: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns string

      Whatsapp

      93650

      -

      Whatsapp

      193650 >= 2.2222.8

      -

      Whatsapp

      985947 >= 2.2228.4

      -

    Settings

    Member Visibility
    +typeAttributeFromProtobuf | @wppconnect/wa-js - v3.10.1

    Function typeAttributeFromProtobuf

    • typeAttributeFromProtobuf(protoMessage): string

    • Parameters

      • protoMessage: {
            [key: string]: any;
        }
        • [key: string]: any

      Returns string

      Whatsapp

      93650

      +

      Whatsapp

      193650 >= 2.2222.8

      +

      Whatsapp

      985947 >= 2.2228.4

      +

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.unblockContact.html b/functions/whatsapp.functions.unblockContact.html index 84a052c347..88a3179ca4 100644 --- a/functions/whatsapp.functions.unblockContact.html +++ b/functions/whatsapp.functions.unblockContact.html @@ -1,4 +1,4 @@ -unblockContact | @wppconnect/wa-js - v3.10.1

    Function unblockContact

    Settings

    Member Visibility
    +unblockContact | @wppconnect/wa-js - v3.10.1

    Function unblockContact

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.unixTime.html b/functions/whatsapp.functions.unixTime.html index afdc39da29..c1cfb8f52e 100644 --- a/functions/whatsapp.functions.unixTime.html +++ b/functions/whatsapp.functions.unixTime.html @@ -1,2 +1,2 @@ -unixTime | @wppconnect/wa-js - v3.10.1

    Function unixTime

    Settings

    Member Visibility
    +unixTime | @wppconnect/wa-js - v3.10.1

    Function unixTime

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.unixTimeMs.html b/functions/whatsapp.functions.unixTimeMs.html index a4d1aca436..040ee6f243 100644 --- a/functions/whatsapp.functions.unixTimeMs.html +++ b/functions/whatsapp.functions.unixTimeMs.html @@ -1,2 +1,2 @@ -unixTimeMs | @wppconnect/wa-js - v3.10.1

    Function unixTimeMs

    Settings

    Member Visibility
    +unixTimeMs | @wppconnect/wa-js - v3.10.1

    Function unixTimeMs

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.unmuteNewsletter.html b/functions/whatsapp.functions.unmuteNewsletter.html index 5df5ddd1aa..de3cfbe0b1 100644 --- a/functions/whatsapp.functions.unmuteNewsletter.html +++ b/functions/whatsapp.functions.unmuteNewsletter.html @@ -1,2 +1,2 @@ -unmuteNewsletter | @wppconnect/wa-js - v3.10.1

    Function unmuteNewsletter

    Settings

    Member Visibility
    +unmuteNewsletter | @wppconnect/wa-js - v3.10.1

    Function unmuteNewsletter

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.updateCart.html b/functions/whatsapp.functions.updateCart.html index 3a1830b0e0..e17f156e44 100644 --- a/functions/whatsapp.functions.updateCart.html +++ b/functions/whatsapp.functions.updateCart.html @@ -1,2 +1,2 @@ -updateCart | @wppconnect/wa-js - v3.10.1

    Function updateCart

    Settings

    Member Visibility
    +updateCart | @wppconnect/wa-js - v3.10.1

    Function updateCart

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.updateCartEnabled.html b/functions/whatsapp.functions.updateCartEnabled.html index e8b6de5168..d545830796 100644 --- a/functions/whatsapp.functions.updateCartEnabled.html +++ b/functions/whatsapp.functions.updateCartEnabled.html @@ -1,2 +1,2 @@ -updateCartEnabled | @wppconnect/wa-js - v3.10.1

    Function updateCartEnabled

    Settings

    Member Visibility
    +updateCartEnabled | @wppconnect/wa-js - v3.10.1

    Function updateCartEnabled

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.updateDBForGroupAction.html b/functions/whatsapp.functions.updateDBForGroupAction.html index 66bd67575f..86d2169367 100644 --- a/functions/whatsapp.functions.updateDBForGroupAction.html +++ b/functions/whatsapp.functions.updateDBForGroupAction.html @@ -1,2 +1,2 @@ -updateDBForGroupAction | @wppconnect/wa-js - v3.10.1

    Function updateDBForGroupAction

    Settings

    Member Visibility
    +updateDBForGroupAction | @wppconnect/wa-js - v3.10.1

    Function updateDBForGroupAction

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.updateNewsletterMsgRecord.html b/functions/whatsapp.functions.updateNewsletterMsgRecord.html index c3c0dc2cd7..b68c7f7ae3 100644 --- a/functions/whatsapp.functions.updateNewsletterMsgRecord.html +++ b/functions/whatsapp.functions.updateNewsletterMsgRecord.html @@ -1,2 +1,2 @@ -updateNewsletterMsgRecord | @wppconnect/wa-js - v3.10.1

    Function updateNewsletterMsgRecord

    Settings

    Member Visibility
    +updateNewsletterMsgRecord | @wppconnect/wa-js - v3.10.1

    Function updateNewsletterMsgRecord

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.updateParticipants.html b/functions/whatsapp.functions.updateParticipants.html index ec7f30babb..82ae91de89 100644 --- a/functions/whatsapp.functions.updateParticipants.html +++ b/functions/whatsapp.functions.updateParticipants.html @@ -1,3 +1,3 @@ -updateParticipants | @wppconnect/wa-js - v3.10.1

    Function updateParticipants

    Settings

    Member Visibility
    +updateParticipants | @wppconnect/wa-js - v3.10.1

    Function updateParticipants

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.uploadMedia.html b/functions/whatsapp.functions.uploadMedia.html index c26512e5c8..507018e499 100644 --- a/functions/whatsapp.functions.uploadMedia.html +++ b/functions/whatsapp.functions.uploadMedia.html @@ -1,2 +1,2 @@ -uploadMedia | @wppconnect/wa-js - v3.10.1

    Function uploadMedia

    Settings

    Member Visibility
    +uploadMedia | @wppconnect/wa-js - v3.10.1

    Function uploadMedia

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.uploadProductImage.html b/functions/whatsapp.functions.uploadProductImage.html index 2ed1d2b0bf..bf49c6db9f 100644 --- a/functions/whatsapp.functions.uploadProductImage.html +++ b/functions/whatsapp.functions.uploadProductImage.html @@ -1,3 +1,3 @@ -uploadProductImage | @wppconnect/wa-js - v3.10.1

    Function uploadProductImage

    Settings

    Member Visibility
    +uploadProductImage | @wppconnect/wa-js - v3.10.1

    Function uploadProductImage

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.uploadThumbnail.html b/functions/whatsapp.functions.uploadThumbnail.html index 8700313ca7..4609c0e02e 100644 --- a/functions/whatsapp.functions.uploadThumbnail.html +++ b/functions/whatsapp.functions.uploadThumbnail.html @@ -1,3 +1,3 @@ -uploadThumbnail | @wppconnect/wa-js - v3.10.1

    Function uploadThumbnail

    Settings

    Member Visibility
    +uploadThumbnail | @wppconnect/wa-js - v3.10.1

    Function uploadThumbnail

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.upsertVotes.html b/functions/whatsapp.functions.upsertVotes.html index 2001bcd5cc..941ed8cbb9 100644 --- a/functions/whatsapp.functions.upsertVotes.html +++ b/functions/whatsapp.functions.upsertVotes.html @@ -1,3 +1,3 @@ -upsertVotes | @wppconnect/wa-js - v3.10.1

    Function upsertVotes

    Settings

    Member Visibility
    +upsertVotes | @wppconnect/wa-js - v3.10.1

    Function upsertVotes

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.functions.voteFromDbRow.html b/functions/whatsapp.functions.voteFromDbRow.html index dc3dfa596b..5856075964 100644 --- a/functions/whatsapp.functions.voteFromDbRow.html +++ b/functions/whatsapp.functions.voteFromDbRow.html @@ -1,2 +1,2 @@ -voteFromDbRow | @wppconnect/wa-js - v3.10.1

    Function voteFromDbRow

    Settings

    Member Visibility
    +voteFromDbRow | @wppconnect/wa-js - v3.10.1

    Function voteFromDbRow

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.websocket.ensureE2ESessions.html b/functions/whatsapp.websocket.ensureE2ESessions.html index ff3c655954..13576daa87 100644 --- a/functions/whatsapp.websocket.ensureE2ESessions.html +++ b/functions/whatsapp.websocket.ensureE2ESessions.html @@ -1,2 +1,2 @@ -ensureE2ESessions | @wppconnect/wa-js - v3.10.1

    Function ensureE2ESessions

    Settings

    Member Visibility
    +ensureE2ESessions | @wppconnect/wa-js - v3.10.1

    Function ensureE2ESessions

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.websocket.generateId.html b/functions/whatsapp.websocket.generateId.html index 9eae78dae8..df7d5d2287 100644 --- a/functions/whatsapp.websocket.generateId.html +++ b/functions/whatsapp.websocket.generateId.html @@ -1,2 +1,2 @@ -generateId | @wppconnect/wa-js - v3.10.1

    Function generateId

    Settings

    Member Visibility
    +generateId | @wppconnect/wa-js - v3.10.1

    Function generateId

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.websocket.sendSmaxStanza.html b/functions/whatsapp.websocket.sendSmaxStanza.html index 442c82aabc..88ad36dd2b 100644 --- a/functions/whatsapp.websocket.sendSmaxStanza.html +++ b/functions/whatsapp.websocket.sendSmaxStanza.html @@ -1,2 +1,2 @@ -sendSmaxStanza | @wppconnect/wa-js - v3.10.1

    Function sendSmaxStanza

    Settings

    Member Visibility
    +sendSmaxStanza | @wppconnect/wa-js - v3.10.1

    Function sendSmaxStanza

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.websocket.smax.html b/functions/whatsapp.websocket.smax.html index 02ee246144..a6480feca3 100644 --- a/functions/whatsapp.websocket.smax.html +++ b/functions/whatsapp.websocket.smax.html @@ -1,2 +1,2 @@ -smax | @wppconnect/wa-js - v3.10.1

    Function smax

    Settings

    Member Visibility
    +smax | @wppconnect/wa-js - v3.10.1

    Function smax

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.websocket.startWebComms.html b/functions/whatsapp.websocket.startWebComms.html index 790c2f60b8..4637550d5b 100644 --- a/functions/whatsapp.websocket.startWebComms.html +++ b/functions/whatsapp.websocket.startWebComms.html @@ -1,2 +1,2 @@ -startWebComms | @wppconnect/wa-js - v3.10.1

    Function startWebComms

    Settings

    Member Visibility
    +startWebComms | @wppconnect/wa-js - v3.10.1

    Function startWebComms

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.websocket.stopComms.html b/functions/whatsapp.websocket.stopComms.html index 21d57a7e67..9df3f5c3de 100644 --- a/functions/whatsapp.websocket.stopComms.html +++ b/functions/whatsapp.websocket.stopComms.html @@ -1,2 +1,2 @@ -stopComms | @wppconnect/wa-js - v3.10.1

    Function stopComms

    Settings

    Member Visibility
    +stopComms | @wppconnect/wa-js - v3.10.1

    Function stopComms

    Settings

    Member Visibility
    diff --git a/functions/whatsapp.websocket.wap.html b/functions/whatsapp.websocket.wap.html index c48b6f0e46..21ecb345a1 100644 --- a/functions/whatsapp.websocket.wap.html +++ b/functions/whatsapp.websocket.wap.html @@ -1,2 +1,2 @@ -wap | @wppconnect/wa-js - v3.10.1

    Function wap

    Settings

    Member Visibility
    +wap | @wppconnect/wa-js - v3.10.1

    Function wap

    Settings

    Member Visibility
    diff --git a/interfaces/Config.html b/interfaces/Config.html index 5df18590b8..24286edf31 100644 --- a/interfaces/Config.html +++ b/interfaces/Config.html @@ -1,8 +1,8 @@ Config | @wppconnect/wa-js - v3.10.1

    Interface Config

    Define some global configurations

    -

    Example

    // Global variable before injection
    WPPConfig = {
      deviceName: 'WPPConnect',
      liveLocationLimit: 10,
      disableGoogleAnalytics: false,
      googleAnalyticsId: 'G-XXXXXXXXXX',
      sendStatusToDevice: true
    };
+

    Example

    // Global variable before injection
    WPPConfig = {
      deviceName: 'WPPConnect',
      liveLocationLimit: 10,
      disableGoogleAnalytics: false,
      googleAnalyticsId: 'G-XXXXXXXXXX',
      sendStatusToDevice: true
    };
    -
    interface Config {
        deviceName: string | false;
        disableGoogleAnalytics: boolean;
        googleAnalyticsId: null | string;
        googleAnalyticsUserProperty: {
            [key: string]: string | number | boolean;
        };
        linkPreviewApiServers: null | string[];
        liveLocationLimit: number;
        poweredBy: null | string;
        sendStatusToDevice: boolean;
        syncAllStatus: boolean;
        [key: string | symbol]: any;
    }

    Indexable

    • [key: string | symbol]: any

    Properties

    deviceName +
    interface Config {
        deviceName: string | false;
        disableGoogleAnalytics: boolean;
        googleAnalyticsId: null | string;
        googleAnalyticsUserProperty: {
            [key: string]: string | number | boolean;
        };
        linkPreviewApiServers: null | string[];
        liveLocationLimit: number;
        poweredBy: null | string;
        sendStatusToDevice: boolean;
        syncAllStatus: boolean;
        [key: string | symbol]: any;
    }

    Indexable

    • [key: string | symbol]: any

    Properties

    deviceName disableGoogleAnalytics googleAnalyticsId googleAnalyticsUserProperty @@ -12,21 +12,21 @@ sendStatusToDevice syncAllStatus

    Properties

    deviceName

    deviceName: string | false

    Set the device name connected, false to disable

    -

    Default

    'WPPConnect'
+

    Default

    'WPPConnect'
    -

    disableGoogleAnalytics

    disableGoogleAnalytics: boolean

    Disable Google Analytics tracking

    +

    disableGoogleAnalytics

    disableGoogleAnalytics: boolean

    Disable Google Analytics tracking

    googleAnalyticsId

    googleAnalyticsId: null | string

    Google Analytics Id

    googleAnalyticsUserProperty

    googleAnalyticsUserProperty: {
        [key: string]: string | number | boolean;
    }

    Google Analytics Id

    linkPreviewApiServers

    linkPreviewApiServers: null | string[]

    Link Preview API servers

    liveLocationLimit

    liveLocationLimit: number

    Number of last chats to check live location after a page reload

    poweredBy

    poweredBy: null | string

    Project name for google analytics

    sendStatusToDevice

    sendStatusToDevice: boolean

    Send the status to your device, set it to false to avoid WhatsApp crashing

    -

    Default

    false
+

    Default

    false
    -

    syncAllStatus

    syncAllStatus: boolean

    Option to disable status sync

    -

    Default

    false
+

    syncAllStatus

    syncAllStatus: boolean

    Option to disable status sync

    +

    Default

    false
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.AudioMessageOptions.html b/interfaces/chat.AudioMessageOptions.html index 08c040443f..a02bcefb6e 100644 --- a/interfaces/chat.AudioMessageOptions.html +++ b/interfaces/chat.AudioMessageOptions.html @@ -1,8 +1,8 @@ AudioMessageOptions | @wppconnect/wa-js - v3.10.1

    Interface AudioMessageOptions

    Send an audio message as a PTT, like a recorded message

    -

    Example

    // PTT audio
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true // false for common audio
     }
    );
+

    Example

    // PTT audio
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true // false for common audio
     }
    );
    -
    interface AudioMessageOptions {
        caption?: string;
        createChat?: boolean;
        delay?: number;
        detectMentioned?: boolean;
        filename?: string;
        footer?: string;
        isPtt?: boolean;
        isViewOnce?: boolean;
        markIsRead?: boolean;
        mentionedList?: (string | Wid)[];
        messageId?: string | MsgKey;
        mimetype?: string;
        quotedMsg?: string | MsgModel | MsgKey;
        type: "audio";
        waitForAck?: boolean;
        waveform?: boolean;
    }

    Hierarchy (view full)

    Properties

    caption? +
    interface AudioMessageOptions {
        caption?: string;
        createChat?: boolean;
        delay?: number;
        detectMentioned?: boolean;
        filename?: string;
        footer?: string;
        isPtt?: boolean;
        isViewOnce?: boolean;
        markIsRead?: boolean;
        mentionedList?: (string | Wid)[];
        messageId?: string | MsgKey;
        mimetype?: string;
        quotedMsg?: string | MsgModel | MsgKey;
        type: "audio";
        waitForAck?: boolean;
        waveform?: boolean;
    }

    Hierarchy (view full)

    Properties

    caption? createChat? delay? detectMentioned? @@ -19,52 +19,52 @@ waitForAck? waveform?

    Properties

    Optionalcaption

    caption?: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    OptionalisPtt

    isPtt?: boolean

    OptionalisViewOnce

    isViewOnce?: boolean

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    OptionalisPtt

    isPtt?: boolean

    OptionalisViewOnce

    isViewOnce?: boolean

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    type

    type: "audio"

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    type

    type

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Optionalwaveform

    waveform?: boolean

    Send an audio message as a PTT with waveform

    -

    Example

    // Enable waveform
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true,
       waveform: true // false to disable
     }
    );
    // Disable waveform
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true,
       waveform: false
     }
    );
+

    Optionalwaveform

    waveform?: boolean

    Send an audio message as a PTT with waveform

    +

    Example

    // Enable waveform
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true,
       waveform: true // false to disable
     }
    );
    // Disable waveform
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true,
       waveform: false
     }
    );
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.AutoDetectMessageOptions.html b/interfaces/chat.AutoDetectMessageOptions.html index a165a053b8..5df1df75c9 100644 --- a/interfaces/chat.AutoDetectMessageOptions.html +++ b/interfaces/chat.AutoDetectMessageOptions.html @@ -12,48 +12,48 @@ type waitForAck?

    Properties

    Optionalcaption

    caption?: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    type

    type: "auto-detect"

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    type

    type

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.DocumentMessageOptions.html b/interfaces/chat.DocumentMessageOptions.html index b378b50950..f4b041b3d9 100644 --- a/interfaces/chat.DocumentMessageOptions.html +++ b/interfaces/chat.DocumentMessageOptions.html @@ -15,50 +15,50 @@ waitForAck?

    Properties

    Optionalbuttons

    buttons?: MessageButtonsTypes[]

    List of buttons, with at least 1 option and a maximum of 3

    Optionalcaption

    caption?: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    Footer text for buttons

    +

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    Footer text for buttons

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    Optionaltitle

    title?: string

    Title for buttons, only for text message

    -

    type

    type: "document"

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    Optionaltitle

    title?: string

    Title for buttons, only for text message

    +

    type

    type

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.FileMessageOptions.html b/interfaces/chat.FileMessageOptions.html index 12cfaf3502..9c54e589c5 100644 --- a/interfaces/chat.FileMessageOptions.html +++ b/interfaces/chat.FileMessageOptions.html @@ -12,48 +12,48 @@ type? waitForAck?

    Properties

    Optionalcaption

    caption?: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    Optionaltype

    type?: string

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    Optionaltype

    type?: string

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.GroupInviteMessage.html b/interfaces/chat.GroupInviteMessage.html index a59581d2b7..73a5c37b4c 100644 --- a/interfaces/chat.GroupInviteMessage.html +++ b/interfaces/chat.GroupInviteMessage.html @@ -13,48 +13,48 @@ quotedMsg? waitForAck?

    Properties

    Optionalcaption

    caption?: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    groupId

    groupId: string | Wid

    OptionalgroupName

    groupName?: string

    inviteCode

    inviteCode: string

    OptionalinviteCodeExpiration

    inviteCodeExpiration?: number

    OptionaljpegThumbnail

    jpegThumbnail?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    groupId

    groupId: string | Wid

    OptionalgroupName

    groupName?: string

    inviteCode

    inviteCode: string

    OptionalinviteCodeExpiration

    inviteCodeExpiration?: number

    OptionaljpegThumbnail

    jpegThumbnail?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.ImageMessageOptions.html b/interfaces/chat.ImageMessageOptions.html index 3eaa786ed6..e831bd556b 100644 --- a/interfaces/chat.ImageMessageOptions.html +++ b/interfaces/chat.ImageMessageOptions.html @@ -16,50 +16,50 @@ waitForAck?

    Properties

    Optionalbuttons

    buttons?: MessageButtonsTypes[]

    List of buttons, with at least 1 option and a maximum of 3

    Optionalcaption

    caption?: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    Footer text for buttons

    +

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    Footer text for buttons

    OptionalisViewOnce

    isViewOnce?: boolean

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    Optionaltitle

    title?: string

    Title for buttons, only for text message

    -

    type

    type: "image"

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    Optionaltitle

    title?: string

    Title for buttons, only for text message

    +

    type

    type

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.LinkPreviewOptions.html b/interfaces/chat.LinkPreviewOptions.html index bf7942bfe1..810a10d1e9 100644 --- a/interfaces/chat.LinkPreviewOptions.html +++ b/interfaces/chat.LinkPreviewOptions.html @@ -1,9 +1,9 @@ LinkPreviewOptions | @wppconnect/wa-js - v3.10.1

    Interface LinkPreviewOptions

    interface LinkPreviewOptions {
        linkPreview?: boolean | {
            canonicalUrl?: string;
            description?: string;
            doNotPlayInline: boolean;
            matchedText?: string;
            richPreviewType?: number;
            thumbnail?: string;
            title?: string;
        };
    }

    Properties

    linkPreview?

    Properties

    OptionallinkPreview

    linkPreview?: boolean | {
        canonicalUrl?: string;
        description?: string;
        doNotPlayInline: boolean;
        matchedText?: string;
        richPreviewType?: number;
        thumbnail?: string;
        title?: string;
    }

    Send text message with link preview

    -

    Default

    true
+

    Default

    true
    -

    Example

    // Automatic detection
    WPP.chat.sendTextMessage('[number]@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8');

    // Overriding the title and description
    WPP.chat.sendTextMessage('[number]@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8', {
      linkPreview: {
        title: 'Another text',
        description: 'Another description'
      }
    });
+

    Example

    // Automatic detection
    WPP.chat.sendTextMessage('[number]@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8');

    // Overriding the title and description
    WPP.chat.sendTextMessage('[number]@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8', {
      linkPreview: {
        title: 'Another text',
        description: 'Another description'
      }
    });
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.ListMessageOptions.html b/interfaces/chat.ListMessageOptions.html index 1beec0d0dc..f08d0cc8cb 100644 --- a/interfaces/chat.ListMessageOptions.html +++ b/interfaces/chat.ListMessageOptions.html @@ -12,48 +12,48 @@ title? waitForAck?

    Properties

    buttonText

    buttonText: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    description

    description: string

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    description

    description: string

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfooter

    footer?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Optionalfooter

    footer?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    sections

    sections: {
        rows: {
            description: string;
            rowId: string;
            title: string;
        }[];
        title: string;
    }[]

    Optionaltitle

    title?: string

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    sections

    sections: {
        rows: {
            description: string;
            rowId: string;
            title: string;
        }[];
        title: string;
    }[]

    Optionaltitle

    title?: string

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.LocationMessageOptions.html b/interfaces/chat.LocationMessageOptions.html index 3bed1c227e..09f5638985 100644 --- a/interfaces/chat.LocationMessageOptions.html +++ b/interfaces/chat.LocationMessageOptions.html @@ -17,54 +17,54 @@

    Properties

    Optionaladdress

    address?: string

    The full address of place

    Optionalbuttons

    buttons?: MessageButtonsTypes[]

    List of buttons, with at least 1 option and a maximum of 3

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfooter

    footer?: string

    Footer text for buttons

    +

    Optionalfooter

    footer?: string

    Footer text for buttons

    lat

    lat: string | number

    latitude in degrees

    lng

    lng: string | number

    longitude in degrees

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalname

    name?: string

    Name of the place

    +

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalname

    name?: string

    Name of the place

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    Optionaltitle

    title?: string

    Title for buttons, only for text message

    +

    Optionaltitle

    title?: string

    Title for buttons, only for text message

    Optionalurl

    url?: string

    URL to open when click on the address/name

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.OrderMessageOptions.html b/interfaces/chat.OrderMessageOptions.html index 50ff76f2a4..d87bca7c2b 100644 --- a/interfaces/chat.OrderMessageOptions.html +++ b/interfaces/chat.OrderMessageOptions.html @@ -14,48 +14,48 @@ tax? waitForAck?

    Properties

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionaldiscount

    discount?: number

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Optionaldiscount

    discount?: number

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalnotes

    notes?: string

    Optionaloffset

    offset?: number

    Optionalpayment_instruction

    payment_instruction?: string

    Optionalpix

    pix?: {
        key: string;
        keyType:
            | "CNPJ"
            | "CPF"
            | "PHONE"
            | "EMAIL"
            | "EVP";
        name: string;
    }

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalnotes

    notes?: string

    Optionaloffset

    offset?: number

    Optionalpayment_instruction

    payment_instruction?: string

    Optionalpix

    pix?: {
        key: string;
        keyType:
            | "CNPJ"
            | "CPF"
            | "PHONE"
            | "EMAIL"
            | "EVP";
        name: string;
    }

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    Optionalshipping

    shipping?: number

    Optionaltax

    tax?: number

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    Optionalshipping

    shipping?: number

    Optionaltax

    tax?: number

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.PoolMessageOptions.html b/interfaces/chat.PoolMessageOptions.html index 89d84980c7..0c3251b139 100644 --- a/interfaces/chat.PoolMessageOptions.html +++ b/interfaces/chat.PoolMessageOptions.html @@ -8,48 +8,48 @@ selectableCount? waitForAck?

    Properties

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    OptionalselectableCount

    selectableCount?: number

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    OptionalselectableCount

    selectableCount?: number

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.ScheduledCallMessageOptions.html b/interfaces/chat.ScheduledCallMessageOptions.html index 1467a68e43..3c2533b407 100644 --- a/interfaces/chat.ScheduledCallMessageOptions.html +++ b/interfaces/chat.ScheduledCallMessageOptions.html @@ -10,48 +10,48 @@ title waitForAck?

    Properties

    callType

    callType: "video" | SCHEDULED_CALL_TYPE | "voice"

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    scheduledTimestampMs

    scheduledTimestampMs: string | number

    title

    title: string

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    scheduledTimestampMs

    scheduledTimestampMs: string | number

    title

    title: string

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.SendMessageOptions.html b/interfaces/chat.SendMessageOptions.html index d84f11f756..4a8804be01 100644 --- a/interfaces/chat.SendMessageOptions.html +++ b/interfaces/chat.SendMessageOptions.html @@ -7,48 +7,48 @@ quotedMsg? waitForAck?

    Properties

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.StickerMessageOptions.html b/interfaces/chat.StickerMessageOptions.html index c8e876b012..048e5eacd3 100644 --- a/interfaces/chat.StickerMessageOptions.html +++ b/interfaces/chat.StickerMessageOptions.html @@ -12,48 +12,48 @@ type waitForAck?

    Properties

    Optionalcaption

    caption?: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    type

    type: "sticker"

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    type

    type

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/chat.VideoMessageOptions.html b/interfaces/chat.VideoMessageOptions.html index 96ec209678..ad6dab0992 100644 --- a/interfaces/chat.VideoMessageOptions.html +++ b/interfaces/chat.VideoMessageOptions.html @@ -18,50 +18,50 @@ waitForAck?

    Properties

    Optionalbuttons

    buttons?: MessageButtonsTypes[]

    List of buttons, with at least 1 option and a maximum of 3

    Optionalcaption

    caption?: string

    OptionalcreateChat

    createChat?: boolean

    Create a new chat to a new contact

    -

    Default

    false
+

    Default

    false
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    -

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message +

    Optionaldelay

    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    -

    Default

    0
+

    Default

    0
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    -

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    -

    Default

    true
+

    OptionaldetectMentioned

    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    -

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    Footer text for buttons

    +

    Optionalfilename

    filename?: string

    Optionalfooter

    footer?: string

    Footer text for buttons

    OptionalisGif

    isGif?: boolean

    OptionalisPtv

    isPtv?: boolean

    OptionalisViewOnce

    isViewOnce?: boolean

    OptionalmarkIsRead

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    -

    Default

    true
+

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    -

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message +

    OptionalmentionedList

    mentionedList?: (string | Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    -

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
+

    OptionalmessageId

    messageId?: string | MsgKey

    Optionalmimetype

    mimetype?: string

    OptionalquotedMsg

    quotedMsg?: string | MsgModel | MsgKey

    Quote a message, like a reply message

    +

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    -

    Optionaltitle

    title?: string

    Title for buttons, only for text message

    -

    type

    type: "video"

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    -

    Default

    true
+

    Optionaltitle

    title?: string

    Title for buttons, only for text message

    +

    type

    type

    OptionalwaitForAck

    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    +

    Default

    true
    -

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
+

    Example

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/conn.AuthCodeMultiDevice.html b/interfaces/conn.AuthCodeMultiDevice.html index 6605655476..c172704930 100644 --- a/interfaces/conn.AuthCodeMultiDevice.html +++ b/interfaces/conn.AuthCodeMultiDevice.html @@ -4,4 +4,4 @@ secretKey staticKeyPair type -

    Properties

    fullCode

    fullCode: string

    identityKeyPair

    identityKeyPair: string

    ref

    ref: string

    secretKey

    secretKey: string

    staticKeyPair

    staticKeyPair: string

    type

    type: "multidevice"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    fullCode

    fullCode: string

    identityKeyPair

    identityKeyPair: string

    ref

    ref: string

    secretKey

    secretKey: string

    staticKeyPair

    staticKeyPair: string

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/conn.AuthCodeSingleDevice.html b/interfaces/conn.AuthCodeSingleDevice.html index ec5ce26a92..da7876045f 100644 --- a/interfaces/conn.AuthCodeSingleDevice.html +++ b/interfaces/conn.AuthCodeSingleDevice.html @@ -3,4 +3,4 @@ keyPair ref type -

    Properties

    browserId

    browserId: string

    fullCode

    fullCode: string

    keyPair

    keyPair: string

    ref

    ref: string

    type

    type: "single"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    browserId

    browserId: string

    fullCode

    fullCode: string

    keyPair

    keyPair: string

    ref

    ref: string

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ev.CallEventTypes.html b/interfaces/ev.CallEventTypes.html index 0d8b0dbf77..916d7061ef 100644 --- a/interfaces/ev.CallEventTypes.html +++ b/interfaces/ev.CallEventTypes.html @@ -6,7 +6,7 @@
  • offerTime: number

    timestamp of offer

  • peerJid: Wid

    Wid of sender with device id

  • sender: Wid

    Wid of sender without device id

    -

    • Example

    WPP.on('call.incoming_call', (call) => {
      // Your code
      //Example: Reject any incoming call
      WPP.call.rejectCall(call.id);
    });
+

    Example

    WPP.on('call.incoming_call', (call) => {
      // Your code
      //Example: Reject any incoming call
      WPP.call.rejectCall(call.id);
    });
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ev.ChatEventTypes.html b/interfaces/ev.ChatEventTypes.html index 098668e50f..f13ac0bccc 100644 --- a/interfaces/ev.ChatEventTypes.html +++ b/interfaces/ev.ChatEventTypes.html @@ -11,12 +11,12 @@ chat.presence_change chat.update_label

    Properties

    chat.active_chat

    chat.active_chat: null | ChatModel

    Triggered when change the active chat

    -

    Example

    WPP.on('chat.active_chat', (chat) => {
      // Your code
    });
+

    Example

    WPP.on('chat.active_chat', (chat) => {
      // Your code
    });
    -

    chat.live_location_end

    chat.live_location_end: {
        chat: Wid;
        id: Wid;
        seq: number;
    }

    Deprecated

    Temporary unsuported by WhatsApp Web Multi-Device

    -

    chat.live_location_start

    chat.live_location_start: {
        accuracy?: number;
        chat: Wid;
        degrees?: number;
        id: Wid;
        lat: number;
        lng: number;
        msgId: MsgKey;
        shareDuration: number;
        speed?: number;
    }

    chat.live_location_update

    chat.live_location_update: {
        accuracy?: number;
        comment: string;
        degrees?: number;
        elapsed: number;
        id: Wid;
        lastUpdated: number;
        lat: number;
        lng: number;
        speed?: number;
    }

    Deprecated

    Temporary unsuported by WhatsApp Web Multi-Device

    -

    chat.msg_ack_change

    chat.msg_ack_change: {
        ack: number;
        chat: Wid;
        ids: MsgKey[];
        sender?: Wid;
    }

    Type declaration

    • ack: number
    • chat: Wid

      The chat that sended the messeage

      +

    chat.live_location_end

    chat.live_location_end: {
        chat: Wid;
        id: Wid;
        seq: number;
    }

    Deprecated

    Temporary unsuported by WhatsApp Web Multi-Device

    +

    chat.live_location_start

    chat.live_location_start: {
        accuracy?: number;
        chat: Wid;
        degrees?: number;
        id: Wid;
        lat: number;
        lng: number;
        msgId: MsgKey;
        shareDuration: number;
        speed?: number;
    }

    chat.live_location_update

    chat.live_location_update: {
        accuracy?: number;
        comment: string;
        degrees?: number;
        elapsed: number;
        id: Wid;
        lastUpdated: number;
        lat: number;
        lng: number;
        speed?: number;
    }

    Deprecated

    Temporary unsuported by WhatsApp Web Multi-Device

    +

    chat.msg_ack_change

    chat.msg_ack_change: {
        ack: number;
        chat: Wid;
        ids: MsgKey[];
        sender?: Wid;
    }

    Type declaration

    • ack: number
    • chat: Wid

      The chat that sended the messeage

    • ids: MsgKey[]

      Message id of revoke event

    • Optionalsender?: Wid

      Who sended the ack, only for groups, broadcast and status

    chat.msg_edited

    chat.msg_edited: {
        chat: Wid;
        id: string;
        msg: MsgModel;
    }

    On Message edit

    @@ -25,17 +25,17 @@
  • refId: MsgKey

    Message id of revoked message

  • to: Wid
  • type: "revoke" | "sender_revoke" | "admin_revoke"

    Type of revoke

    • chat.new_message

    chat.new_message: MsgModel

    Triggered when new message is received

    -

    Example

    WPP.on('chat.new_message', (msg) => {
      // Your code
    });
+

    Example

    WPP.on('chat.new_message', (msg) => {
      // Your code
    });
    -

    chat.new_reaction

    chat.new_reaction: {
        id: MsgKey;
        msgId: MsgKey;
        orphan: number;
        orphanReason: any;
        reactionText: string;
        read: boolean;
        sender: Wid;
        timestamp: number;
    }

    Triggered when a new reaction is received

    +

    chat.new_reaction

    chat.new_reaction: {
        id: MsgKey;
        msgId: MsgKey;
        orphan: number;
        orphanReason: any;
        reactionText: string;
        read: boolean;
        sender: Wid;
        timestamp: number;
    }

    Triggered when a new reaction is received

    Type declaration

    • id: MsgKey

      Reaction ID

    • msgId: MsgKey

      Message ID that received the reaction

    • orphan: number
    • orphanReason: any
    • reactionText: string

      The reaction emoji or empty if removed

      -
    • read: boolean
    • sender: Wid
    • timestamp: number

    Example

    WPP.on('chat.new_reaction', (msg) => {
      // Your code
    });
+
  • read: boolean
  • sender: Wid
  • timestamp: number

    • Example

    WPP.on('chat.new_reaction', (msg) => {
      // Your code
    });
    -

    chat.poll_response

    chat.poll_response: {
        chatId: Wid;
        msgId: MsgKey;
        selectedOptions: number[];
        sender: Wid;
        timestamp: number;
    }

    On Poll response

    +

    chat.poll_response

    chat.poll_response: {
        chatId: Wid;
        msgId: MsgKey;
        selectedOptions: number[];
        sender: Wid;
        timestamp: number;
    }

    On Poll response

    chat.presence_change

    chat.presence_change: {
        id: Wid;
        isContact?: boolean;
        isGroup: boolean;
        isOnline: boolean;
        isUser: boolean;
        participants?: {
            id: string;
            shortName: string;
            state: string;
        }[];
        shortName: string;
        state: string;
        t: number;
    }

    On presence change

    chat.update_label

    chat.update_label: {
        chat: ChatModel;
        ids: string[];
        labels: Label[];
        type: "add" | "remove";
    }

    On Labels update

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ev.ConnEventTypes.html b/interfaces/ev.ConnEventTypes.html index f685a2f56c..b1beb70294 100644 --- a/interfaces/ev.ConnEventTypes.html +++ b/interfaces/ev.ConnEventTypes.html @@ -10,27 +10,27 @@ conn.qrcode_idle conn.require_auth

    Properties

    conn.auth_code_change

    conn.auth_code_change: null | AuthCode

    conn.authenticated

    conn.authenticated: undefined

    Triggered afted a success QR code scan

    -

    Example

    WPP.on('conn.authenticated', () => {
      // Your code
    });
+

    Example

    WPP.on('conn.authenticated', () => {
      // Your code
    });
    -

    conn.logout

    conn.logout: undefined

    conn.logout_reason

    conn.logout_reason: LogoutReason

    conn.main_init

    conn.main_init: undefined

    Triggered when the interface is booting

    -

    Example

    WPP.on('conn.main_init', () => {
      // Your code
    });
+

    conn.logout

    conn.logout: undefined

    conn.logout_reason

    conn.logout_reason: LogoutReason

    conn.main_init

    conn.main_init: undefined

    Triggered when the interface is booting

    +

    Example

    WPP.on('conn.main_init', () => {
      // Your code
    });
    -

    conn.main_loaded

    conn.main_loaded: undefined

    Triggered when the main interface is loaded, but is syncing

    -

    Example

    WPP.on('conn.main_loaded', () => {
      // Your code
    });
+

    conn.main_loaded

    conn.main_loaded: undefined

    Triggered when the main interface is loaded, but is syncing

    +

    Example

    WPP.on('conn.main_loaded', () => {
      // Your code
    });
    -

    conn.main_ready

    conn.main_ready: undefined

    Triggered when the main interface is loaded, authenticated and ready to send message

    -

    Example

    WPP.on('conn.main_ready', () => {
      // Your code
    });
+

    conn.main_ready

    conn.main_ready: undefined

    Triggered when the main interface is loaded, authenticated and ready to send message

    +

    Example

    WPP.on('conn.main_ready', () => {
      // Your code
    });
    -

    conn.needs_update

    conn.needs_update: undefined

    Triggered when a whatsapp web update is requested

    -

    Example

    WPP.on('conn.needs_update', () => {
      // Your code
    });
+

    conn.needs_update

    conn.needs_update: undefined

    Triggered when a whatsapp web update is requested

    +

    Example

    WPP.on('conn.needs_update', () => {
      // Your code
    });
    -

    conn.online

    conn.online: boolean

    Triggered when the online change to online or offline

    -

    Example

    WPP.on('conn.online', (online) => {
      if (online) {
        console.log('You are online');
      } else {
        console.log('You are offline');
      }
    });
+

    conn.online

    conn.online: boolean

    Triggered when the online change to online or offline

    +

    Example

    WPP.on('conn.online', (online) => {
      if (online) {
        console.log('You are online');
      } else {
        console.log('You are offline');
      }
    });
    -

    conn.qrcode_idle

    conn.qrcode_idle: undefined

    conn.require_auth

    conn.require_auth: undefined

    Settings

    Member Visibility

    On This Page

    Properties
    +

    conn.qrcode_idle

    conn.qrcode_idle: undefined

    conn.require_auth

    conn.require_auth: undefined

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ev.GroupEventTypes.html b/interfaces/ev.GroupEventTypes.html index 351e8e427f..995377a8ee 100644 --- a/interfaces/ev.GroupEventTypes.html +++ b/interfaces/ev.GroupEventTypes.html @@ -6,7 +6,7 @@
  • groupId: string

    The group id

  • operation:
        | "add"
        | "remove"
        | "demote"
        | "promote"

    The operation in group

  • participants: string[]

    List of members

    -

    • Example

    WPP.on('group.participant_changed', (event) => {
      // Your code
    });
+

    Example

    WPP.on('group.participant_changed', (event) => {
      // Your code
    });
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ev.OrderEventTypes.html b/interfaces/ev.OrderEventTypes.html index 7991c12583..6492cf93c8 100644 --- a/interfaces/ev.OrderEventTypes.html +++ b/interfaces/ev.OrderEventTypes.html @@ -1,6 +1,6 @@ OrderEventTypes | @wppconnect/wa-js - v3.10.1

    Interface OrderEventTypes

    interface OrderEventTypes {
        order.payment_status: {
            method: string;
            msgId: MsgKey;
            reference_id: string;
            timestamp: number;
        };
    }

    Properties

    order.payment_status

    Properties

    order.payment_status

    order.payment_status: {
        method: string;
        msgId: MsgKey;
        reference_id: string;
        timestamp: number;
    }

    Triggered when change the active chat

    -

    Example

    WPP.on('order.payment_status', (order) => {
      // Your code
    });
+

    Example

    WPP.on('order.payment_status', (order) => {
      // Your code
    });
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/whatsapp.VCardData.html b/interfaces/whatsapp.VCardData.html index 0179ede17e..09d2f297b8 100644 --- a/interfaces/whatsapp.VCardData.html +++ b/interfaces/whatsapp.VCardData.html @@ -1,4 +1,4 @@ VCardData | @wppconnect/wa-js - v3.10.1

    Interface VCardData

    interface VCardData {
        displayName: string;
        isMultiVcard: false;
        vcard: string;
    }

    Properties

    displayName isMultiVcard vcard -

    Properties

    displayName

    displayName: string

    isMultiVcard

    isMultiVcard: false

    vcard

    vcard: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    displayName

    displayName: string

    isMultiVcard

    isMultiVcard

    vcard

    vcard: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/whatsapp.functions.Group.html b/interfaces/whatsapp.functions.Group.html index 3372ac7cb3..9864e1f03d 100644 --- a/interfaces/whatsapp.functions.Group.html +++ b/interfaces/whatsapp.functions.Group.html @@ -1,5 +1,5 @@ -Group | @wppconnect/wa-js - v3.10.1

    Interface Group

    Whatsapp

    113269

    -
    interface Group {
        announce: boolean;
        creation: number;
        defaultSubgroup: boolean;
        id: Wid;
        incognito: boolean;
        isParentGroup: boolean;
        isParentGroupClosed: boolean;
        membershipApprovalModed: boolean;
        membershipApprovalRequest: any;
        noFrequentlyForwarded: boolean;
        numSubgroups: number;
        owner: Wid;
        participants: Wid[];
        pvId: number;
        restrict: boolean;
        size: any;
        subject: string;
        subjectTime: number;
        support: boolean;
        suspended: boolean;
    }

    Properties

    announce +Group | @wppconnect/wa-js - v3.10.1

    Interface Group

    Whatsapp

    113269

    +
    interface Group {
        announce: boolean;
        creation: number;
        defaultSubgroup: boolean;
        id: Wid;
        incognito: boolean;
        isParentGroup: boolean;
        isParentGroupClosed: boolean;
        membershipApprovalModed: boolean;
        membershipApprovalRequest: any;
        noFrequentlyForwarded: boolean;
        numSubgroups: number;
        owner: Wid;
        participants: Wid[];
        pvId: number;
        restrict: boolean;
        size: any;
        subject: string;
        subjectTime: number;
        support: boolean;
        suspended: boolean;
    }

    Properties

    announce creation defaultSubgroup id diff --git a/interfaces/whatsapp.functions.GroupActionChange.html b/interfaces/whatsapp.functions.GroupActionChange.html index c1a87390b6..f293cd5507 100644 --- a/interfaces/whatsapp.functions.GroupActionChange.html +++ b/interfaces/whatsapp.functions.GroupActionChange.html @@ -8,7 +8,7 @@ reason version

    Properties

    action

    action: string

    actionType

    actionType: string

    OptionalisInvite

    isInvite?: boolean

    OptionalisLidAddressingMode

    isLidAddressingMode?: boolean

    OptionalisLinkedGroupJoin

    isLinkedGroupJoin?: boolean

    participants

    participants: Wid[] | GroupActionParticipant[]

    GroupActionParticipant for

    -

    Whatsapp

    +

    Whatsapp

    = 2.2234.6

    -

    prevVersion

    prevVersion: number

    reason

    reason: string

    version

    version: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    prevVersion

    prevVersion: number

    reason

    reason: string

    version

    version: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/whatsapp.functions.GroupActionParticipant.html b/interfaces/whatsapp.functions.GroupActionParticipant.html index 7526d1632f..1ff06c03d2 100644 --- a/interfaces/whatsapp.functions.GroupActionParticipant.html +++ b/interfaces/whatsapp.functions.GroupActionParticipant.html @@ -1,8 +1,8 @@ GroupActionParticipant | @wppconnect/wa-js - v3.10.1

    Interface GroupActionParticipant

    GroupActionParticipant for

    -

    Whatsapp

    +

    Whatsapp

    = 2.2234.6

    -
    interface GroupActionParticipant {
        id: Wid;
        isAdmin: boolean;
        isSuperAdmin: boolean;
    }

    Properties

    id +
    interface GroupActionParticipant {
        id: Wid;
        isAdmin: boolean;
        isSuperAdmin: boolean;
    }

    Properties

    id isAdmin isSuperAdmin

    Properties

    id

    id: Wid

    isAdmin

    isAdmin: boolean

    isSuperAdmin

    isSuperAdmin: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/whatsapp.functions.QueryCollectionsIQtParams.html b/interfaces/whatsapp.functions.QueryCollectionsIQtParams.html index f0bad7e1a7..40bc9a30c6 100644 --- a/interfaces/whatsapp.functions.QueryCollectionsIQtParams.html +++ b/interfaces/whatsapp.functions.QueryCollectionsIQtParams.html @@ -5,4 +5,4 @@ limit productsCount? width? -

    Properties

    OptionalafterCursor

    afterCursor?: string

    OptionalcatalogWid

    catalogWid?: Wid

    OptionaldirectConnectionEncryptedInfo

    directConnectionEncryptedInfo?: any

    Optionalheight

    height?: 100

    limit

    limit: number

    OptionalproductsCount

    productsCount?: number

    Optionalwidth

    width?: 100

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalafterCursor

    afterCursor?: string

    OptionalcatalogWid

    catalogWid?: Wid

    OptionaldirectConnectionEncryptedInfo

    directConnectionEncryptedInfo?: any

    Optionalheight

    height

    limit

    limit: number

    OptionalproductsCount

    productsCount?: number

    Optionalwidth

    width

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/whatsapp.functions.ReactionReturn.html b/interfaces/whatsapp.functions.ReactionReturn.html index ce780d7f07..48741e7812 100644 --- a/interfaces/whatsapp.functions.ReactionReturn.html +++ b/interfaces/whatsapp.functions.ReactionReturn.html @@ -1,5 +1,5 @@ -ReactionReturn | @wppconnect/wa-js - v3.10.1

    Interface ReactionReturn

    Whatsapp

    297673

    -

    Whatsapp

    297673 >= 2.2232.6

    -
    interface ReactionReturn {
        reactionByMe: any;
        reactions: {
            aggregateEmoji: string;
            hasReactionByMe: boolean;
            senders: {
                msgKey: MsgKey;
                orphan: number;
                parentMsgKey: MsgKey;
                reactionText: string;
                read: boolean;
                senderUserJid: string;
                timestamp: number;
            }[];
        }[];
    }

    Properties

    reactionByMe +ReactionReturn | @wppconnect/wa-js - v3.10.1

    Interface ReactionReturn

    Whatsapp

    297673

    +

    Whatsapp

    297673 >= 2.2232.6

    +
    interface ReactionReturn {
        reactionByMe: any;
        reactions: {
            aggregateEmoji: string;
            hasReactionByMe: boolean;
            senders: {
                msgKey: MsgKey;
                orphan: number;
                parentMsgKey: MsgKey;
                reactionText: string;
                read: boolean;
                senderUserJid: string;
                timestamp: number;
            }[];
        }[];
    }

    Properties

    reactionByMe reactions

    Properties

    reactionByMe

    reactionByMe: any

    reactions

    reactions: {
        aggregateEmoji: string;
        hasReactionByMe: boolean;
        senders: {
            msgKey: MsgKey;
            orphan: number;
            parentMsgKey: MsgKey;
            reactionText: string;
            read: boolean;
            senderUserJid: string;
            timestamp: number;
        }[];
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/whatsapp.functions.SimpleAckData.html b/interfaces/whatsapp.functions.SimpleAckData.html index 0687ef6ab4..318c032ce2 100644 --- a/interfaces/whatsapp.functions.SimpleAckData.html +++ b/interfaces/whatsapp.functions.SimpleAckData.html @@ -9,4 +9,4 @@ stanzaId ts type -

    Properties

    ack

    ack: number

    ackString

    ackString: null | string

    Optionalbiz

    biz?: null

    externalIds

    externalIds: string[]

    from

    from: Wid

    offline

    offline: null

    participant

    participant: null | Wid

    recipient

    recipient: null

    stanzaId

    stanzaId: string

    ts

    ts: number

    type

    type: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    ack

    ack: number

    ackString

    ackString: null | string

    Optionalbiz

    biz

    externalIds

    externalIds: string[]

    from

    from: Wid

    offline

    offline

    participant

    participant: null | Wid

    recipient

    recipient

    stanzaId

    stanzaId: string

    ts

    ts: number

    type

    type: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/modules/whatsapp.Base64.html b/modules/whatsapp.Base64.html index 9e781a5b2e..512617d75d 100644 --- a/modules/whatsapp.Base64.html +++ b/modules/whatsapp.Base64.html @@ -1,6 +1,6 @@ -Base64 | @wppconnect/wa-js - v3.10.1

    Namespace Base64

    Whatsapp

    15688

    -

    Whatsapp

    615688 >= 2.2222.8

    -

    Index

    Variables

    BASE64_DATA_URL_SCHEME +Base64 | @wppconnect/wa-js - v3.10.1

    Namespace Base64

    Whatsapp

    15688

    +

    Whatsapp

    615688 >= 2.2222.8

    +

    Index

    Variables

    BASE64_DATA_URL_SCHEME

    Functions

    decodeB64 decodeB64ToJsArray decodeB64UrlSafe diff --git a/modules/whatsapp.Browser.html b/modules/whatsapp.Browser.html index 49f72b8e30..6070ea4f5d 100644 --- a/modules/whatsapp.Browser.html +++ b/modules/whatsapp.Browser.html @@ -1,7 +1,7 @@ -Browser | @wppconnect/wa-js - v3.10.1

    Namespace Browser

    Whatsapp

    79264

    -

    Whatsapp

    87045 >= 2.2204.13

    -

    Whatsapp

    379264 >= 2.2222.8

    -

    Index

    Variables

    promptUnloadGuards +Browser | @wppconnect/wa-js - v3.10.1

    Namespace Browser

    Whatsapp

    79264

    +

    Whatsapp

    87045 >= 2.2204.13

    +

    Whatsapp

    379264 >= 2.2222.8

    +

    Index

    Variables

    promptUnloadGuards

    Functions

    clearDownloading hardRefresh id diff --git a/modules/whatsapp.ChatPresence.html b/modules/whatsapp.ChatPresence.html index 9be1bdd483..f82df70450 100644 --- a/modules/whatsapp.ChatPresence.html +++ b/modules/whatsapp.ChatPresence.html @@ -1,7 +1,7 @@ -ChatPresence | @wppconnect/wa-js - v3.10.1

    Namespace ChatPresence

    Whatsapp

    371

    -

    Whatsapp

    800371 >= 2.2222.8

    -

    Whatsapp

    366517 >= 2.2228.4

    -

    Index

    Functions

    clearPresence +ChatPresence | @wppconnect/wa-js - v3.10.1

    Namespace ChatPresence

    Whatsapp

    371

    +

    Whatsapp

    800371 >= 2.2222.8

    +

    Whatsapp

    366517 >= 2.2228.4

    +

    Index

    Functions

    clearPresence markComposing markPaused markRecording diff --git a/modules/whatsapp.ImageUtils.html b/modules/whatsapp.ImageUtils.html index 6f0af0aae2..9b71b063d5 100644 --- a/modules/whatsapp.ImageUtils.html +++ b/modules/whatsapp.ImageUtils.html @@ -1,5 +1,5 @@ -ImageUtils | @wppconnect/wa-js - v3.10.1

    Namespace ImageUtils

    Whatsapp

    51428

    -

    Whatsapp

    36638 >= 2.2204.13

    -

    Whatsapp

    551428 >= 2.2222.8

    -

    Index

    Functions

    rotateAndResize +ImageUtils | @wppconnect/wa-js - v3.10.1

    Namespace ImageUtils

    Whatsapp

    51428

    +

    Whatsapp

    36638 >= 2.2204.13

    +

    Whatsapp

    551428 >= 2.2222.8

    +

    Index

    Functions

    rotateAndResize

    Settings

    Member Visibility
    diff --git a/modules/whatsapp.IsOfficialClient.html b/modules/whatsapp.IsOfficialClient.html index 1fe5efa40f..4255ff5166 100644 --- a/modules/whatsapp.IsOfficialClient.html +++ b/modules/whatsapp.IsOfficialClient.html @@ -1,6 +1,6 @@ -IsOfficialClient | @wppconnect/wa-js - v3.10.1

    Namespace IsOfficialClient

    Whatsapp

    +IsOfficialClient | @wppconnect/wa-js - v3.10.1

    Namespace IsOfficialClient

    Whatsapp

    = 2.3000.x

    -

    Index

    Variables

    isOfficialClient +

    Index

    Variables

    isOfficialClient

    Functions

    isUnofficialStanzaId

    Settings

    Member Visibility
    diff --git a/modules/whatsapp.MediaObjectUtil.html b/modules/whatsapp.MediaObjectUtil.html index 2767698ed8..3268e4602f 100644 --- a/modules/whatsapp.MediaObjectUtil.html +++ b/modules/whatsapp.MediaObjectUtil.html @@ -1,4 +1,4 @@ -MediaObjectUtil | @wppconnect/wa-js - v3.10.1

    Namespace MediaObjectUtil

    Whatsapp

    88297

    -

    Whatsapp

    988297 >= 2.2222.8

    -

    Index

    Functions

    getOrCreateMediaObject +MediaObjectUtil | @wppconnect/wa-js - v3.10.1

    Namespace MediaObjectUtil

    Whatsapp

    88297

    +

    Whatsapp

    988297 >= 2.2222.8

    +

    Index

    Functions

    getOrCreateMediaObject

    Settings

    Member Visibility
    diff --git a/modules/whatsapp.MediaPrep.html b/modules/whatsapp.MediaPrep.html index b28c04abbd..c57b766d51 100644 --- a/modules/whatsapp.MediaPrep.html +++ b/modules/whatsapp.MediaPrep.html @@ -1,5 +1,5 @@ -MediaPrep | @wppconnect/wa-js - v3.10.1

    Namespace MediaPrep

    Whatsapp

    78986

    -

    Whatsapp

    778986 >= 2.2222.8

    -

    Index

    Classes

    MediaPrep +MediaPrep | @wppconnect/wa-js - v3.10.1

    Namespace MediaPrep

    Whatsapp

    78986

    +

    Whatsapp

    778986 >= 2.2222.8

    +

    Index

    Classes

    MediaPrep

    Functions

    prepRawMedia

    Settings

    Member Visibility
    diff --git a/modules/whatsapp.MediaUtils.html b/modules/whatsapp.MediaUtils.html index 32c52b5c58..88728cc160 100644 --- a/modules/whatsapp.MediaUtils.html +++ b/modules/whatsapp.MediaUtils.html @@ -1,4 +1,4 @@ -MediaUtils | @wppconnect/wa-js - v3.10.1

    Namespace MediaUtils

    Whatsapp

    56406

    -

    Whatsapp

    756406 >= 2.2222.8

    -

    Index

    Functions

    getImageWidthHeight +MediaUtils | @wppconnect/wa-js - v3.10.1

    Namespace MediaUtils

    Whatsapp

    56406

    +

    Whatsapp

    756406 >= 2.2222.8

    +

    Index

    Functions

    getImageWidthHeight

    Settings

    Member Visibility
    diff --git a/modules/whatsapp.UserPrefs.html b/modules/whatsapp.UserPrefs.html index 696f338fdc..4447099036 100644 --- a/modules/whatsapp.UserPrefs.html +++ b/modules/whatsapp.UserPrefs.html @@ -1,5 +1,5 @@ -UserPrefs | @wppconnect/wa-js - v3.10.1

    Namespace UserPrefs

    Whatsapp

    459857 >= 2.2310.5

    -

    Index

    Functions

    assertGetMe +UserPrefs | @wppconnect/wa-js - v3.10.1

    Namespace UserPrefs

    Whatsapp

    459857 >= 2.2310.5

    +

    Index

    Functions

    assertGetMe assertGetMeUser clearGetMaybeMeUserCache getMaybeMeDisplayName diff --git a/modules/whatsapp.VCard.html b/modules/whatsapp.VCard.html index a4fac0e4b5..2d77d9042b 100644 --- a/modules/whatsapp.VCard.html +++ b/modules/whatsapp.VCard.html @@ -1,6 +1,6 @@ -VCard | @wppconnect/wa-js - v3.10.1

    Namespace VCard

    Whatsapp

    93778

    -

    Whatsapp

    78521 >= 2.2204.13

    -

    Whatsapp

    893778 >= 2.2222.8

    -

    Index

    Functions

    mergeVcards +VCard | @wppconnect/wa-js - v3.10.1

    Namespace VCard

    Whatsapp

    93778

    +

    Whatsapp

    78521 >= 2.2204.13

    +

    Whatsapp

    893778 >= 2.2222.8

    +

    Index

    Functions

    mergeVcards vcardFromContactModel

    Settings

    Member Visibility
    diff --git a/modules/whatsapp.WidFactory.html b/modules/whatsapp.WidFactory.html index 4f5ff2d2d4..0b44907b5d 100644 --- a/modules/whatsapp.WidFactory.html +++ b/modules/whatsapp.WidFactory.html @@ -1,7 +1,7 @@ -WidFactory | @wppconnect/wa-js - v3.10.1

    Namespace WidFactory

    Whatsapp

    45454

    -

    Whatsapp

    58021 >= 2.2204.13

    -

    Whatsapp

    745454 >= 2.2222.8

    -

    Index

    Functions

    createDeviceWid +WidFactory | @wppconnect/wa-js - v3.10.1

    Namespace WidFactory

    Whatsapp

    45454

    +

    Whatsapp

    58021 >= 2.2204.13

    +

    Whatsapp

    745454 >= 2.2222.8

    +

    Index

    Functions

    createDeviceWid createDeviceWidFromUserAndDevice createUserWid createWid diff --git a/modules/whatsapp.multidevice.adv.html b/modules/whatsapp.multidevice.adv.html index 8da00fc588..b1f9b26bf5 100644 --- a/modules/whatsapp.multidevice.adv.html +++ b/modules/whatsapp.multidevice.adv.html @@ -1,7 +1,7 @@ -adv | @wppconnect/wa-js - v3.10.1

    Namespace adv

    Whatsapp

    46308

    -

    Whatsapp

    24863 >= 2.2204.13

    -

    Whatsapp

    946308 >= 2.2222.8

    -

    Index

    Functions

    clearADVSecretKey +adv | @wppconnect/wa-js - v3.10.1

    Namespace adv

    Whatsapp

    46308

    +

    Whatsapp

    24863 >= 2.2204.13

    +

    Whatsapp

    946308 >= 2.2222.8

    +

    Index

    Functions

    clearADVSecretKey generateADVSecretKey generateDeviceSignature getADVEncodedIdentity diff --git a/variables/whatsapp.Base64.BASE64_DATA_URL_SCHEME.html b/variables/whatsapp.Base64.BASE64_DATA_URL_SCHEME.html index 56a0616152..5d22f02665 100644 --- a/variables/whatsapp.Base64.BASE64_DATA_URL_SCHEME.html +++ b/variables/whatsapp.Base64.BASE64_DATA_URL_SCHEME.html @@ -1 +1 @@ -BASE64_DATA_URL_SCHEME | @wppconnect/wa-js - v3.10.1

    Variable BASE64_DATA_URL_SCHEMEConst

    BASE64_DATA_URL_SCHEME: "data:image/jpeg;base64,"

    Settings

    Member Visibility
    +BASE64_DATA_URL_SCHEME | @wppconnect/wa-js - v3.10.1

    Variable BASE64_DATA_URL_SCHEMEConst

    BASE64_DATA_URL_SCHEME

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.BlocklistStore.html b/variables/whatsapp.BlocklistStore.html index 7101a099de..1b4b4f9cb8 100644 --- a/variables/whatsapp.BlocklistStore.html +++ b/variables/whatsapp.BlocklistStore.html @@ -1,3 +1,3 @@ -BlocklistStore | @wppconnect/wa-js - v3.10.1

    Variable BlocklistStoreConst

    BlocklistStore: BlocklistCollection

    Whatsapp

    32826

    -

    Whatsapp

    132826 >= 2.2222.8

    -

    Settings

    Member Visibility
    +BlocklistStore | @wppconnect/wa-js - v3.10.1

    Variable BlocklistStoreConst

    BlocklistStore: BlocklistCollection

    Whatsapp

    32826

    +

    Whatsapp

    132826 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.BusinessCategoriesResultStore.html b/variables/whatsapp.BusinessCategoriesResultStore.html index 47d1484dc0..9653f42c8c 100644 --- a/variables/whatsapp.BusinessCategoriesResultStore.html +++ b/variables/whatsapp.BusinessCategoriesResultStore.html @@ -1,3 +1,3 @@ -BusinessCategoriesResultStore | @wppconnect/wa-js - v3.10.1

    Variable BusinessCategoriesResultStoreConst

    BusinessCategoriesResultStore: BusinessCategoriesResultCollection

    Whatsapp

    3754

    -

    Whatsapp

    203754 >= 2.2222.8

    -

    Settings

    Member Visibility
    +BusinessCategoriesResultStore | @wppconnect/wa-js - v3.10.1

    Variable BusinessCategoriesResultStoreConst

    BusinessCategoriesResultStore: BusinessCategoriesResultCollection

    Whatsapp

    3754

    +

    Whatsapp

    203754 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.BusinessProfileStore.html b/variables/whatsapp.BusinessProfileStore.html index 00858e7ce7..7e80057ef6 100644 --- a/variables/whatsapp.BusinessProfileStore.html +++ b/variables/whatsapp.BusinessProfileStore.html @@ -1,3 +1,3 @@ -BusinessProfileStore | @wppconnect/wa-js - v3.10.1

    Variable BusinessProfileStoreConst

    BusinessProfileStore: BusinessProfileCollection

    Whatsapp

    93581

    -

    Whatsapp

    493581 >= 2.2222.8

    -

    Settings

    Member Visibility
    +BusinessProfileStore | @wppconnect/wa-js - v3.10.1

    Variable BusinessProfileStoreConst

    BusinessProfileStore: BusinessProfileCollection

    Whatsapp

    93581

    +

    Whatsapp

    493581 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.CallStore.html b/variables/whatsapp.CallStore.html index c6aa395cb8..82ef7387d6 100644 --- a/variables/whatsapp.CallStore.html +++ b/variables/whatsapp.CallStore.html @@ -1,4 +1,4 @@ -CallStore | @wppconnect/wa-js - v3.10.1

    Variable CallStoreConst

    CallStore: CallCollection

    Whatsapp

    60868

    -

    Whatsapp

    31218 >= 2.2204.13

    -

    Whatsapp

    160868 >= 2.2222.8

    -

    Settings

    Member Visibility
    +CallStore | @wppconnect/wa-js - v3.10.1

    Variable CallStoreConst

    CallStore: CallCollection

    Whatsapp

    60868

    +

    Whatsapp

    31218 >= 2.2204.13

    +

    Whatsapp

    160868 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.CartStore.html b/variables/whatsapp.CartStore.html index e5ac8f1759..2bdd6c84d3 100644 --- a/variables/whatsapp.CartStore.html +++ b/variables/whatsapp.CartStore.html @@ -1,3 +1,3 @@ -CartStore | @wppconnect/wa-js - v3.10.1

    Variable CartStoreConst

    CartStore: CartCollection

    Whatsapp

    12392

    -

    Whatsapp

    612392 >= 2.2222.8

    -

    Settings

    Member Visibility
    +CartStore | @wppconnect/wa-js - v3.10.1

    Variable CartStoreConst

    CartStore: CartCollection

    Whatsapp

    12392

    +

    Whatsapp

    612392 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.CatalogStore.html b/variables/whatsapp.CatalogStore.html index 538b87fee9..b489e5b08a 100644 --- a/variables/whatsapp.CatalogStore.html +++ b/variables/whatsapp.CatalogStore.html @@ -1,3 +1,3 @@ -CatalogStore | @wppconnect/wa-js - v3.10.1

    Variable CatalogStoreConst

    CatalogStore: CatalogCollection

    Whatsapp

    99989

    -

    Whatsapp

    599989 >= 2.2222.8

    -

    Settings

    Member Visibility
    +CatalogStore | @wppconnect/wa-js - v3.10.1

    Variable CatalogStoreConst

    CatalogStore: CatalogCollection

    Whatsapp

    99989

    +

    Whatsapp

    599989 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.ChatStore.html b/variables/whatsapp.ChatStore.html index c0cb247ead..5d595d26ae 100644 --- a/variables/whatsapp.ChatStore.html +++ b/variables/whatsapp.ChatStore.html @@ -1,3 +1,3 @@ -ChatStore | @wppconnect/wa-js - v3.10.1

    Variable ChatStoreConst

    ChatStore: ChatCollection

    Whatsapp

    69951

    -

    Whatsapp

    669951 >= 2.2222.8

    -

    Settings

    Member Visibility
    +ChatStore | @wppconnect/wa-js - v3.10.1

    Variable ChatStoreConst

    ChatStore: ChatCollection

    Whatsapp

    69951

    +

    Whatsapp

    669951 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.Cmd.html b/variables/whatsapp.Cmd.html index f69093418c..6056279a77 100644 --- a/variables/whatsapp.Cmd.html +++ b/variables/whatsapp.Cmd.html @@ -1,4 +1,4 @@ -Cmd | @wppconnect/wa-js - v3.10.1

    Variable CmdConst

    Cmd: CmdClass

    Whatsapp

    88102

    -

    Whatsapp

    81572 >= 2.2218.4

    -

    Whatsapp

    781572 >= 2.2222.8

    -

    Settings

    Member Visibility
    +Cmd | @wppconnect/wa-js - v3.10.1

    Variable CmdConst

    Cmd: CmdClass

    Whatsapp

    88102

    +

    Whatsapp

    81572 >= 2.2218.4

    +

    Whatsapp

    781572 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.ComposeBoxActions.html b/variables/whatsapp.ComposeBoxActions.html index 0d84a1ecf8..0b6acab409 100644 --- a/variables/whatsapp.ComposeBoxActions.html +++ b/variables/whatsapp.ComposeBoxActions.html @@ -1,2 +1,2 @@ -ComposeBoxActions | @wppconnect/wa-js - v3.10.1

    Variable ComposeBoxActionsConst

    ComposeBoxActions: ComposeBoxActionsClass

    Whatsapp

    WAWebComposeBoxActions >= 2.3000.0

    -

    Settings

    Member Visibility
    +ComposeBoxActions | @wppconnect/wa-js - v3.10.1

    Variable ComposeBoxActionsConst

    ComposeBoxActions: ComposeBoxActionsClass

    Whatsapp

    WAWebComposeBoxActions >= 2.3000.0

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.Conn.html b/variables/whatsapp.Conn.html index 4575e8e156..c7c1295696 100644 --- a/variables/whatsapp.Conn.html +++ b/variables/whatsapp.Conn.html @@ -1,3 +1,3 @@ -Conn | @wppconnect/wa-js - v3.10.1

    Variable ConnConst

    Conn: ConnModel

    Whatsapp

    17239

    -

    Whatsapp

    317239 >= 2.2222.8

    -

    Settings

    Member Visibility
    +Conn | @wppconnect/wa-js - v3.10.1

    Variable ConnConst

    Conn: ConnModel

    Whatsapp

    17239

    +

    Whatsapp

    317239 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.Constants.html b/variables/whatsapp.Constants.html index 04ff192695..20b1a521d5 100644 --- a/variables/whatsapp.Constants.html +++ b/variables/whatsapp.Constants.html @@ -1,4 +1,4 @@ -Constants | @wppconnect/wa-js - v3.10.1

    Variable ConstantsConst

    Constants: {
        BUSINESS_DESCRIPTION_INFO_PANEL_TRUNC_LENGTH: 200;
        DOC_THUMB_MAX_EDGE: 480;
        FREQUENTLY_FORWARDED_SENTINEL: 127;
        GROUP_DESCRIPTION_INFO_PANEL_TRUNC_LENGTH: 100;
        IMG_THUMB_MAX_EDGE: 100;
        KEY_BUNDLE_TYPE: "\u0005";
        MARKED_AS_UNREAD: -1;
        MAX_CAPTION_LENGTH: 1024;
        MAX_CART_MESSAGE_LENGTH: 1024;
        MAX_FILES: 30;
        MAX_PORTRAIT_MEDIA_CAPTION_LENGTH: 500;
        MAX_PUSHNAME_LENGTH: 25;
        MAX_SMB_LABEL_COUNT: 20;
        MAX_TXT_MSG_SIZE: 65536;
        MEDIA_EDITOR_OUTLINE_TENSION: 0.4;
        MMS_THUMBNAIL_UPLOAD_TIMEOUT: 3000;
        NEW_MSG_SENT: "new_msg_sent";
        ONE_BY_ONE_TRANS_GIF: "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7";
        REACTION_CONTENT_MAX_LENGTH: 30;
        SQUELCH_RESET_VALUE: -1;
        TEMPLATE_URL_END: 32;
        TEMPLATE_URL_START: 64;
        VIDEO_THUMB_MAX_EDGE: 480;
        VOIP_LOG_COLOR: "#aa6627";
        VOIP_MAX_GROUP_CALL_PARTICIPANTS: 8;
        WA_COMMERCE_POLICY_URL: "https://www.whatsapp.com/policies/commerce-policy";
        WAM_SYS_INFO_INIT_DELAY: 5000;
    }

    Whatsapp

    64369

    -

    Whatsapp

    69618 >= 2.2204.13

    -

    Whatsapp

    364369 >= 2.2222.8

    -

    Settings

    Member Visibility
    +Constants | @wppconnect/wa-js - v3.10.1

    Variable ConstantsConst

    Constants: {
        BUSINESS_DESCRIPTION_INFO_PANEL_TRUNC_LENGTH: 200;
        DOC_THUMB_MAX_EDGE: 480;
        FREQUENTLY_FORWARDED_SENTINEL: 127;
        GROUP_DESCRIPTION_INFO_PANEL_TRUNC_LENGTH: 100;
        IMG_THUMB_MAX_EDGE: 100;
        KEY_BUNDLE_TYPE: "\u0005";
        MARKED_AS_UNREAD: -1;
        MAX_CAPTION_LENGTH: 1024;
        MAX_CART_MESSAGE_LENGTH: 1024;
        MAX_FILES: 30;
        MAX_PORTRAIT_MEDIA_CAPTION_LENGTH: 500;
        MAX_PUSHNAME_LENGTH: 25;
        MAX_SMB_LABEL_COUNT: 20;
        MAX_TXT_MSG_SIZE: 65536;
        MEDIA_EDITOR_OUTLINE_TENSION: 0.4;
        MMS_THUMBNAIL_UPLOAD_TIMEOUT: 3000;
        NEW_MSG_SENT: "new_msg_sent";
        ONE_BY_ONE_TRANS_GIF: "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7";
        REACTION_CONTENT_MAX_LENGTH: 30;
        SQUELCH_RESET_VALUE: -1;
        TEMPLATE_URL_END: 32;
        TEMPLATE_URL_START: 64;
        VIDEO_THUMB_MAX_EDGE: 480;
        VOIP_LOG_COLOR: "#aa6627";
        VOIP_MAX_GROUP_CALL_PARTICIPANTS: 8;
        WA_COMMERCE_POLICY_URL: "https://www.whatsapp.com/policies/commerce-policy";
        WAM_SYS_INFO_INIT_DELAY: 5000;
    }

    Whatsapp

    64369

    +

    Whatsapp

    69618 >= 2.2204.13

    +

    Whatsapp

    364369 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.ContactStore.html b/variables/whatsapp.ContactStore.html index 475b61220f..db9d365ea7 100644 --- a/variables/whatsapp.ContactStore.html +++ b/variables/whatsapp.ContactStore.html @@ -1,3 +1,3 @@ -ContactStore | @wppconnect/wa-js - v3.10.1

    Variable ContactStoreConst

    ContactStore: ContactCollection

    Whatsapp

    19380

    -

    Whatsapp

    719380 >= 2.2222.8

    -

    Settings

    Member Visibility
    +ContactStore | @wppconnect/wa-js - v3.10.1

    Variable ContactStoreConst

    ContactStore: ContactCollection

    Whatsapp

    19380

    +

    Whatsapp

    719380 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.EmojiVariantStore.html b/variables/whatsapp.EmojiVariantStore.html index 8072e37759..64eeb0aae4 100644 --- a/variables/whatsapp.EmojiVariantStore.html +++ b/variables/whatsapp.EmojiVariantStore.html @@ -1,3 +1,3 @@ -EmojiVariantStore | @wppconnect/wa-js - v3.10.1

    Variable EmojiVariantStoreConst

    EmojiVariantStore: EmojiVariantCollection

    Whatsapp

    13185

    -

    Whatsapp

    513185 >= 2.2222.8

    -

    Settings

    Member Visibility
    +EmojiVariantStore | @wppconnect/wa-js - v3.10.1

    Variable EmojiVariantStoreConst

    EmojiVariantStore: EmojiVariantCollection

    Whatsapp

    13185

    +

    Whatsapp

    513185 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.GroupMetadataStore.html b/variables/whatsapp.GroupMetadataStore.html index bc675d3bd9..6cf206a40c 100644 --- a/variables/whatsapp.GroupMetadataStore.html +++ b/variables/whatsapp.GroupMetadataStore.html @@ -1,3 +1,3 @@ -GroupMetadataStore | @wppconnect/wa-js - v3.10.1

    Variable GroupMetadataStoreConst

    GroupMetadataStore: GroupMetadataCollection

    Whatsapp

    63928

    -

    Whatsapp

    963928 >= 2.2222.8

    -

    Settings

    Member Visibility
    +GroupMetadataStore | @wppconnect/wa-js - v3.10.1

    Variable GroupMetadataStoreConst

    GroupMetadataStore: GroupMetadataCollection

    Whatsapp

    63928

    +

    Whatsapp

    963928 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.LabelStore.html b/variables/whatsapp.LabelStore.html index cf0266a643..c0e98430c6 100644 --- a/variables/whatsapp.LabelStore.html +++ b/variables/whatsapp.LabelStore.html @@ -1,3 +1,3 @@ -LabelStore | @wppconnect/wa-js - v3.10.1

    Variable LabelStoreConst

    LabelStore: LabelCollection

    Whatsapp

    16770

    -

    Whatsapp

    316770 >= 2.2222.8

    -

    Settings

    Member Visibility
    +LabelStore | @wppconnect/wa-js - v3.10.1

    Variable LabelStoreConst

    LabelStore: LabelCollection

    Whatsapp

    16770

    +

    Whatsapp

    316770 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.MediaBlobCache.html b/variables/whatsapp.MediaBlobCache.html index bb24a79128..8b67842964 100644 --- a/variables/whatsapp.MediaBlobCache.html +++ b/variables/whatsapp.MediaBlobCache.html @@ -1,3 +1,3 @@ -MediaBlobCache | @wppconnect/wa-js - v3.10.1

    Variable MediaBlobCacheConst

    MediaBlobCache: MediaBlobCacheImpl

    Whatsapp

    84866

    -

    Whatsapp

    284866 >= 2.2222.8

    -

    Settings

    Member Visibility
    +MediaBlobCache | @wppconnect/wa-js - v3.10.1

    Variable MediaBlobCacheConst

    MediaBlobCache: MediaBlobCacheImpl

    Whatsapp

    84866

    +

    Whatsapp

    284866 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.MsgInfoStore.html b/variables/whatsapp.MsgInfoStore.html index ec2666a633..2e0e8bb81e 100644 --- a/variables/whatsapp.MsgInfoStore.html +++ b/variables/whatsapp.MsgInfoStore.html @@ -1,3 +1,3 @@ -MsgInfoStore | @wppconnect/wa-js - v3.10.1

    Variable MsgInfoStoreConst

    MsgInfoStore: MsgInfoCollection

    Whatsapp

    17972

    -

    Whatsapp

    617972 >= 2.2222.8

    -

    Settings

    Member Visibility
    +MsgInfoStore | @wppconnect/wa-js - v3.10.1

    Variable MsgInfoStoreConst

    MsgInfoStore: MsgInfoCollection

    Whatsapp

    17972

    +

    Whatsapp

    617972 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.MsgStore.html b/variables/whatsapp.MsgStore.html index 958654320c..43c83904b5 100644 --- a/variables/whatsapp.MsgStore.html +++ b/variables/whatsapp.MsgStore.html @@ -1,3 +1,3 @@ -MsgStore | @wppconnect/wa-js - v3.10.1

    Variable MsgStoreConst

    MsgStore: MsgCollection

    Whatsapp

    59871

    -

    Whatsapp

    559871 >= 2.2222.8

    -

    Settings

    Member Visibility
    +MsgStore | @wppconnect/wa-js - v3.10.1

    Variable MsgStoreConst

    MsgStore: MsgCollection

    Whatsapp

    59871

    +

    Whatsapp

    559871 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.MuteStore.html b/variables/whatsapp.MuteStore.html index 89c9136490..2143bf406c 100644 --- a/variables/whatsapp.MuteStore.html +++ b/variables/whatsapp.MuteStore.html @@ -1,2 +1,2 @@ -MuteStore | @wppconnect/wa-js - v3.10.1

    Variable MuteStoreConst

    MuteStore: MuteCollection

    Whatsapp

    72472

    -

    Settings

    Member Visibility
    +MuteStore | @wppconnect/wa-js - v3.10.1

    Variable MuteStoreConst

    MuteStore: MuteCollection

    Whatsapp

    72472

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.NetworkStatus.html b/variables/whatsapp.NetworkStatus.html index 8e3df091dd..344c6dfdec 100644 --- a/variables/whatsapp.NetworkStatus.html +++ b/variables/whatsapp.NetworkStatus.html @@ -1,2 +1,2 @@ -NetworkStatus | @wppconnect/wa-js - v3.10.1

    Variable NetworkStatusConst

    NetworkStatus: NetworkStatusModel

    Whatsapp

    765044 >= 2.2222.8

    -

    Settings

    Member Visibility
    +NetworkStatus | @wppconnect/wa-js - v3.10.1

    Variable NetworkStatusConst

    NetworkStatus: NetworkStatusModel

    Whatsapp

    765044 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.NewsletterStore.html b/variables/whatsapp.NewsletterStore.html index e88b398290..0cc541ab88 100644 --- a/variables/whatsapp.NewsletterStore.html +++ b/variables/whatsapp.NewsletterStore.html @@ -1,3 +1,3 @@ -NewsletterStore | @wppconnect/wa-js - v3.10.1

    Variable NewsletterStoreConst

    NewsletterStore: ChatCollection

    Whatsapp

    19380

    -

    Whatsapp

    719380 >= 2.2222.8

    -

    Settings

    Member Visibility
    +NewsletterStore | @wppconnect/wa-js - v3.10.1

    Variable NewsletterStoreConst

    NewsletterStore: ChatCollection

    Whatsapp

    19380

    +

    Whatsapp

    719380 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.OrderStore.html b/variables/whatsapp.OrderStore.html index da3c8737c5..48e2b81776 100644 --- a/variables/whatsapp.OrderStore.html +++ b/variables/whatsapp.OrderStore.html @@ -1,3 +1,3 @@ -OrderStore | @wppconnect/wa-js - v3.10.1

    Variable OrderStoreConst

    OrderStore: OrderCollection

    Whatsapp

    84312

    -

    Whatsapp

    584312 >= 2.2222.8

    -

    Settings

    Member Visibility
    +OrderStore | @wppconnect/wa-js - v3.10.1

    Variable OrderStoreConst

    OrderStore: OrderCollection

    Whatsapp

    84312

    +

    Whatsapp

    584312 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.PresenceStore.html b/variables/whatsapp.PresenceStore.html index 0680a466b3..2ff38b16e5 100644 --- a/variables/whatsapp.PresenceStore.html +++ b/variables/whatsapp.PresenceStore.html @@ -1,3 +1,3 @@ -PresenceStore | @wppconnect/wa-js - v3.10.1

    Variable PresenceStoreConst

    PresenceStore: PresenceCollection

    Whatsapp

    68315

    -

    Whatsapp

    868315 >= 2.2222.8

    -

    Settings

    Member Visibility
    +PresenceStore | @wppconnect/wa-js - v3.10.1

    Variable PresenceStoreConst

    PresenceStore: PresenceCollection

    Whatsapp

    68315

    +

    Whatsapp

    868315 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.ProductMessageListStore.html b/variables/whatsapp.ProductMessageListStore.html index d3e309cfc3..4078a76dc9 100644 --- a/variables/whatsapp.ProductMessageListStore.html +++ b/variables/whatsapp.ProductMessageListStore.html @@ -1,2 +1,2 @@ -ProductMessageListStore | @wppconnect/wa-js - v3.10.1

    Variable ProductMessageListStoreConst

    ProductMessageListStore: ProductMessageListCollection

    Whatsapp

    18952

    -

    Settings

    Member Visibility
    +ProductMessageListStore | @wppconnect/wa-js - v3.10.1

    Variable ProductMessageListStoreConst

    ProductMessageListStore: ProductMessageListCollection

    Whatsapp

    18952

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.ProfilePicThumbStore.html b/variables/whatsapp.ProfilePicThumbStore.html index 229d4b4f0e..85830fb07c 100644 --- a/variables/whatsapp.ProfilePicThumbStore.html +++ b/variables/whatsapp.ProfilePicThumbStore.html @@ -1,3 +1,3 @@ -ProfilePicThumbStore | @wppconnect/wa-js - v3.10.1

    Variable ProfilePicThumbStoreConst

    ProfilePicThumbStore: ProfilePicThumbCollection

    Whatsapp

    82039

    -

    Whatsapp

    582039 >= 2.2222.8

    -

    Settings

    Member Visibility
    +ProfilePicThumbStore | @wppconnect/wa-js - v3.10.1

    Variable ProfilePicThumbStoreConst

    ProfilePicThumbStore: ProfilePicThumbCollection

    Whatsapp

    82039

    +

    Whatsapp

    582039 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.QuickReplyStore.html b/variables/whatsapp.QuickReplyStore.html index 95aab49388..d2009533eb 100644 --- a/variables/whatsapp.QuickReplyStore.html +++ b/variables/whatsapp.QuickReplyStore.html @@ -1,3 +1,3 @@ -QuickReplyStore | @wppconnect/wa-js - v3.10.1

    Variable QuickReplyStoreConst

    QuickReplyStore: QuickReplyCollection

    Whatsapp

    99662

    -

    Whatsapp

    999662 >= 2.2222.8

    -

    Settings

    Member Visibility
    +QuickReplyStore | @wppconnect/wa-js - v3.10.1

    Variable QuickReplyStoreConst

    QuickReplyStore: QuickReplyCollection

    Whatsapp

    99662

    +

    Whatsapp

    999662 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.ReactionsStore.html b/variables/whatsapp.ReactionsStore.html index 6e6cdfb320..2cce726404 100644 --- a/variables/whatsapp.ReactionsStore.html +++ b/variables/whatsapp.ReactionsStore.html @@ -1,3 +1,3 @@ -ReactionsStore | @wppconnect/wa-js - v3.10.1

    Variable ReactionsStoreConst

    ReactionsStore: ReactionsCollection

    Whatsapp

    57162

    -

    Whatsapp

    257162 >= 2.2222.8

    -

    Settings

    Member Visibility
    +ReactionsStore | @wppconnect/wa-js - v3.10.1

    Variable ReactionsStoreConst

    ReactionsStore: ReactionsCollection

    Whatsapp

    57162

    +

    Whatsapp

    257162 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.RecentEmojiStore.html b/variables/whatsapp.RecentEmojiStore.html index 539f5fb35a..651547567b 100644 --- a/variables/whatsapp.RecentEmojiStore.html +++ b/variables/whatsapp.RecentEmojiStore.html @@ -1,3 +1,3 @@ -RecentEmojiStore | @wppconnect/wa-js - v3.10.1

    Variable RecentEmojiStoreConst

    RecentEmojiStore: RecentEmojiCollection

    Whatsapp

    92671

    -

    Whatsapp

    492671 >= 2.2222.8

    -

    Settings

    Member Visibility
    +RecentEmojiStore | @wppconnect/wa-js - v3.10.1

    Variable RecentEmojiStoreConst

    RecentEmojiStore: RecentEmojiCollection

    Whatsapp

    92671

    +

    Whatsapp

    492671 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.RecentStickerStore.html b/variables/whatsapp.RecentStickerStore.html index f0f683260e..a63ed64a03 100644 --- a/variables/whatsapp.RecentStickerStore.html +++ b/variables/whatsapp.RecentStickerStore.html @@ -1,3 +1,3 @@ -RecentStickerStore | @wppconnect/wa-js - v3.10.1

    Variable RecentStickerStoreConst

    RecentStickerStore: RecentStickerCollection

    Whatsapp

    49264

    -

    Whatsapp

    191692 >= 2.2222.8

    -

    Settings

    Member Visibility
    +RecentStickerStore | @wppconnect/wa-js - v3.10.1

    Variable RecentStickerStoreConst

    RecentStickerStore: RecentStickerCollection

    Whatsapp

    49264

    +

    Whatsapp

    191692 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.ServerProps.html b/variables/whatsapp.ServerProps.html index bfc3689732..9f650f45ac 100644 --- a/variables/whatsapp.ServerProps.html +++ b/variables/whatsapp.ServerProps.html @@ -1,3 +1,3 @@ -ServerProps | @wppconnect/wa-js - v3.10.1

    Variable ServerPropsConst

    ServerProps: ServerPropsModel

    Whatsapp

    8080

    -

    Whatsapp

    608080 >= 2.2222.8

    -

    Settings

    Member Visibility
    +ServerProps | @wppconnect/wa-js - v3.10.1

    Variable ServerPropsConst

    ServerProps: ServerPropsModel

    Whatsapp

    8080

    +

    Whatsapp

    608080 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.Socket.html b/variables/whatsapp.Socket.html index d958769c17..08f03180b8 100644 --- a/variables/whatsapp.Socket.html +++ b/variables/whatsapp.Socket.html @@ -1,3 +1,3 @@ -Socket | @wppconnect/wa-js - v3.10.1

    Variable SocketConst

    Socket: SocketModel

    Whatsapp

    65044

    -

    Whatsapp

    765044 >= 2.2222.8

    -

    Settings

    Member Visibility
    +Socket | @wppconnect/wa-js - v3.10.1

    Variable SocketConst

    Socket: SocketModel

    Whatsapp

    65044

    +

    Whatsapp

    765044 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.StarredMsgStore.html b/variables/whatsapp.StarredMsgStore.html index 02d51c12fb..3f017b0b78 100644 --- a/variables/whatsapp.StarredMsgStore.html +++ b/variables/whatsapp.StarredMsgStore.html @@ -1,3 +1,3 @@ -StarredMsgStore | @wppconnect/wa-js - v3.10.1

    Variable StarredMsgStoreConst

    StarredMsgStore: StarredMsgCollection

    Whatsapp

    19011

    -

    Whatsapp

    719011 >= 2.2222.8

    -

    Settings

    Member Visibility
    +StarredMsgStore | @wppconnect/wa-js - v3.10.1

    Variable StarredMsgStoreConst

    StarredMsgStore: StarredMsgCollection

    Whatsapp

    19011

    +

    Whatsapp

    719011 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.StatusStore.html b/variables/whatsapp.StatusStore.html index eca89942f2..2bcea31a09 100644 --- a/variables/whatsapp.StatusStore.html +++ b/variables/whatsapp.StatusStore.html @@ -1,2 +1,2 @@ -StatusStore | @wppconnect/wa-js - v3.10.1

    Variable StatusStoreConst

    StatusStore: StatusCollection

    Whatsapp

    46133

    -

    Settings

    Member Visibility
    +StatusStore | @wppconnect/wa-js - v3.10.1

    Variable StatusStoreConst

    StatusStore: StatusCollection

    Whatsapp

    46133

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.StatusV3Store.html b/variables/whatsapp.StatusV3Store.html index 204ba4cc2d..4b826d6e41 100644 --- a/variables/whatsapp.StatusV3Store.html +++ b/variables/whatsapp.StatusV3Store.html @@ -1,3 +1,3 @@ -StatusV3Store | @wppconnect/wa-js - v3.10.1

    Variable StatusV3StoreConst

    StatusV3Store: StatusV3Collection

    Whatsapp

    59387

    -

    Whatsapp

    459387 >= 2.2222.8

    -

    Settings

    Member Visibility
    +StatusV3Store | @wppconnect/wa-js - v3.10.1

    Variable StatusV3StoreConst

    StatusV3Store: StatusV3Collection

    Whatsapp

    59387

    +

    Whatsapp

    459387 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.StickerPackStore.html b/variables/whatsapp.StickerPackStore.html index 79c646f665..ac985366df 100644 --- a/variables/whatsapp.StickerPackStore.html +++ b/variables/whatsapp.StickerPackStore.html @@ -1,3 +1,3 @@ -StickerPackStore | @wppconnect/wa-js - v3.10.1

    Variable StickerPackStoreConst

    StickerPackStore: StickerPackCollection

    Whatsapp

    44333

    -

    Whatsapp

    344333 >= 2.2222.8

    -

    Settings

    Member Visibility
    +StickerPackStore | @wppconnect/wa-js - v3.10.1

    Variable StickerPackStoreConst

    StickerPackStore: StickerPackCollection

    Whatsapp

    44333

    +

    Whatsapp

    344333 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.StickerSearchStore.html b/variables/whatsapp.StickerSearchStore.html index b8069aa5d7..a7683c3317 100644 --- a/variables/whatsapp.StickerSearchStore.html +++ b/variables/whatsapp.StickerSearchStore.html @@ -1,3 +1,3 @@ -StickerSearchStore | @wppconnect/wa-js - v3.10.1

    Variable StickerSearchStoreConst

    StickerSearchStore: StickerSearchCollection

    Whatsapp

    45068

    -

    Whatsapp

    545068 >= 2.2222.8

    -

    Settings

    Member Visibility
    +StickerSearchStore | @wppconnect/wa-js - v3.10.1

    Variable StickerSearchStoreConst

    StickerSearchStore: StickerSearchCollection

    Whatsapp

    45068

    +

    Whatsapp

    545068 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.StickerStore.html b/variables/whatsapp.StickerStore.html index 533b221127..166970144a 100644 --- a/variables/whatsapp.StickerStore.html +++ b/variables/whatsapp.StickerStore.html @@ -1,3 +1,3 @@ -StickerStore | @wppconnect/wa-js - v3.10.1

    Variable StickerStoreConst

    StickerStore: StickerCollection

    Whatsapp

    67963

    -

    Whatsapp

    767963 >= 2.2222.8

    -

    Settings

    Member Visibility
    +StickerStore | @wppconnect/wa-js - v3.10.1

    Variable StickerStoreConst

    StickerStore: StickerCollection

    Whatsapp

    67963

    +

    Whatsapp

    767963 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.Stream.html b/variables/whatsapp.Stream.html index fa9512973f..3600dacd66 100644 --- a/variables/whatsapp.Stream.html +++ b/variables/whatsapp.Stream.html @@ -1,3 +1,3 @@ -Stream | @wppconnect/wa-js - v3.10.1

    Variable StreamConst

    Stream: StreamModel

    Whatsapp

    8080

    -

    Whatsapp

    608080 >= 2.2222.8

    -

    Settings

    Member Visibility
    +Stream | @wppconnect/wa-js - v3.10.1

    Variable StreamConst

    Stream: StreamModel

    Whatsapp

    8080

    +

    Whatsapp

    608080 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.contants.DROP_ATTR.html b/variables/whatsapp.contants.DROP_ATTR.html index 04d73e2357..7f4e60a4fd 100644 --- a/variables/whatsapp.contants.DROP_ATTR.html +++ b/variables/whatsapp.contants.DROP_ATTR.html @@ -1,2 +1,2 @@ -DROP_ATTR | @wppconnect/wa-js - v3.10.1

    Variable DROP_ATTRConst

    DROP_ATTR: any

    Whatsapp

    831914

    -

    Settings

    Member Visibility
    +DROP_ATTR | @wppconnect/wa-js - v3.10.1

    Variable DROP_ATTRConst

    DROP_ATTR: any

    Whatsapp

    831914

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.contants.SANITIZED_VERSION_STR.html b/variables/whatsapp.contants.SANITIZED_VERSION_STR.html index b168ac6bb5..6a7e646813 100644 --- a/variables/whatsapp.contants.SANITIZED_VERSION_STR.html +++ b/variables/whatsapp.contants.SANITIZED_VERSION_STR.html @@ -1,2 +1,2 @@ -SANITIZED_VERSION_STR | @wppconnect/wa-js - v3.10.1

    Variable SANITIZED_VERSION_STRConst

    SANITIZED_VERSION_STR: string

    Whatsapp

    831914

    -

    Settings

    Member Visibility
    +SANITIZED_VERSION_STR | @wppconnect/wa-js - v3.10.1

    Variable SANITIZED_VERSION_STRConst

    SANITIZED_VERSION_STR: string

    Whatsapp

    831914

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.enums.SYSTEM_MESSAGE_TYPES.html b/variables/whatsapp.enums.SYSTEM_MESSAGE_TYPES.html index f4be845812..5d2a670ed2 100644 --- a/variables/whatsapp.enums.SYSTEM_MESSAGE_TYPES.html +++ b/variables/whatsapp.enums.SYSTEM_MESSAGE_TYPES.html @@ -1,4 +1,4 @@ -SYSTEM_MESSAGE_TYPES | @wppconnect/wa-js - v3.10.1

    Variable SYSTEM_MESSAGE_TYPESConst

    SYSTEM_MESSAGE_TYPES: string[]

    Whatsapp

    15461

    -

    Whatsapp

    69618 >= 2.2204.13

    -

    Whatsapp

    115461 >= 2.2222.8

    -

    Settings

    Member Visibility
    +SYSTEM_MESSAGE_TYPES | @wppconnect/wa-js - v3.10.1

    Variable SYSTEM_MESSAGE_TYPESConst

    SYSTEM_MESSAGE_TYPES: string[]

    Whatsapp

    15461

    +

    Whatsapp

    69618 >= 2.2204.13

    +

    Whatsapp

    115461 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.functions.STATUS_JID.html b/variables/whatsapp.functions.STATUS_JID.html index e6f445ca73..78c617887b 100644 --- a/variables/whatsapp.functions.STATUS_JID.html +++ b/variables/whatsapp.functions.STATUS_JID.html @@ -1,2 +1,2 @@ -STATUS_JID | @wppconnect/wa-js - v3.10.1

    Variable STATUS_JIDConst

    STATUS_JID: string

    Whatsapp

    WAJids

    -

    Settings

    Member Visibility
    +STATUS_JID | @wppconnect/wa-js - v3.10.1

    Variable STATUS_JIDConst

    STATUS_JID: string

    Whatsapp

    WAJids

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.multidevice.waNoiseInfo.html b/variables/whatsapp.multidevice.waNoiseInfo.html index 0799143412..aa1ceb20eb 100644 --- a/variables/whatsapp.multidevice.waNoiseInfo.html +++ b/variables/whatsapp.multidevice.waNoiseInfo.html @@ -1,5 +1,5 @@ -waNoiseInfo | @wppconnect/wa-js - v3.10.1

    Variable waNoiseInfoConst

    waNoiseInfo: NoiseInfo

    Whatsapp

    15875

    -

    Whatsapp

    14111 >= 2.2204.13

    -

    Whatsapp

    34898 >= 2.2218.4

    -

    Whatsapp

    134898 >= 2.2222.8

    -

    Settings

    Member Visibility
    +waNoiseInfo | @wppconnect/wa-js - v3.10.1

    Variable waNoiseInfoConst

    waNoiseInfo: NoiseInfo

    Whatsapp

    15875

    +

    Whatsapp

    14111 >= 2.2204.13

    +

    Whatsapp

    34898 >= 2.2218.4

    +

    Whatsapp

    134898 >= 2.2222.8

    +

    Settings

    Member Visibility
    diff --git a/variables/whatsapp.multidevice.waSignalStore.html b/variables/whatsapp.multidevice.waSignalStore.html index d1f5beabf9..1ab4fb3d2c 100644 --- a/variables/whatsapp.multidevice.waSignalStore.html +++ b/variables/whatsapp.multidevice.waSignalStore.html @@ -1,4 +1,4 @@ -waSignalStore | @wppconnect/wa-js - v3.10.1

    Variable waSignalStoreConst

    waSignalStore: SignalStore

    Whatsapp

    11849

    -

    Whatsapp

    40623 >= 2.2218.4

    -

    Whatsapp

    640623 >= 2.2222.8

    -

    Settings

    Member Visibility
    +waSignalStore | @wppconnect/wa-js - v3.10.1

    Variable waSignalStoreConst

    waSignalStore: SignalStore

    Whatsapp

    11849

    +

    Whatsapp

    40623 >= 2.2218.4

    +

    Whatsapp

    640623 >= 2.2222.8

    +

    Settings

    Member Visibility