Class MsgModel

17304

Hierarchy (View Summary)

ModelProxy<Props, Session, Derived>
Model
- MsgModel

Index

Constructors

Properties

accuracy? ack? appStateFatalExceptionNotification? appStateSyncKeyRequest? appStateSyncKeyShare? asAlbumAsset? asBroadcastNotification? asDoc? asGroupedSticker? asGroupNotification? asImage? asMms? asPollCreation? asPollUpdate? asProduct? asProductInquiry? asRevoked? asUrl? asVideo? asViewOnce? asVisualMedia? attributes author? backgroundColor? bizPrivacyStatus? body? broadcast? broadcastEphSettings? broadcastId? broadcastParticipants? businessOwnerJid? buttons? buttonsResponse? canonicalUrl caption? chat? clearMedia? clientUrl? collection? comment? containsEmoji? ctwaContext? currencyCode? degrees? deprecatedMms3Url? description? devicesAdded? devicesRemoved? dir? directPath? disappearingModeInitiator? doNotPlayInline? duration? dynamicReplyButtons? encFilehash? ephemeralDuration? ephemeralExpirationTimestamp? ephemeralOutOfSync? ephemeralSettingTimestamp? ephemeralSharedSecret? ephemeralStartTimestamp? eventType? filehash? filename? finalAccuracy? finalDegrees? finalLat? finalLng? finalSpeed? finalThumbnail? finalTimeOffset? firstFrameLength? firstFrameSidecar? font? footer? forwardedFromWeb? forwardingScore? from? gifAttribution? hasBodyOrFooter hasTemplateButtons height? historySyncMetaData? hydratedButtons? id idClass initialPageSize? interactiveAnnotations? interactiveMessage? interactivePayload? invis? inviteCode? inviteCodeExp? inviteGrp? inviteGrpJpegThum? inviteGrpName? isAnimated isBizNotification isCaptionByUser isDynamicReplyButtonsMsg isEphemeral isFailed isForwarded isFrequentlyForwarded isFromTemplate isFutureproof isGif isGroupMsg isGroupsV4InviteExpired isInternational isLive isMdHistoryMsg isMedia isNewMsg isNotification isPersistent isPSA isQuickReply isQuotedMsgAvailable isRevokedByMe isRTL isSendFailure isSentByMe isSentByMeFromWeb isState isStatusV3 isThisDeviceAdded isUnreadType isUnsentMedia isUserCreatedType isVcardOverMmsDocument isViewOnce itemCount? labels? lat? linkPreview? linksIndexParsed? list? listResponse? lng? loc? local? matchedText? mdDowngrade? mediaData? mediaKey? mediaKeyTimestamp? mediaObject? mentionedJidList? message? mimetype? mirrorMask msgChunk? multicast? nativeFlowName? notifyName? numTimesForwarded? orderId? orderTitle? pageCount? parent? paymentAmount1000? paymentCurrency? paymentExpiryTimestamp? paymentMessageReceiverJid? paymentNoteMsg? paymentRequestMessageKey? paymentStatus? paymentTransactionTimestamp? paymentTxnStatus? phoneUploading? pollInvalidated? pollName? pollOptions? pollSelectableOptionsCount? pollUpdateParentKey? priceAmount1000? privacyModeWhenSent? productHeaderImageRejected? productId? productImageCount? productListHeaderImage? productListItemCount? protocolMessageKey? proxyName quotedGroupSubject? quotedMsg? quotedMsgId? quotedMsgKey? quotedParentGroupJid? quotedParticipant? quotedRemoteJid? quotedStanzaID? recipients? recvFresh? replyButtons? retailerId? richPreviewType? rowId? rtl? salePriceAmount1000? scanLengths? scansSidecar? search? selectedButtonId? selectedId? selectedIndex? self? sellerJid? sendDeferred? sender? senderObj? sequence? serverId? sessionId? shareDuration? size? speed? stale? star? startOfDay? startOfDaySkew? status? statusV3TextBg? streamable? streamingSidecar? subtype? supportsMessageFooter? supportsMessageFooterLinks? surface? t? templateParams? text? textColor? thumbnail? thumbnailDirectPath? thumbnailEncSha256? thumbnailHeight? thumbnailHQ? thumbnailSha256? thumbnailWidth? title? to? token? totalAmount1000? totalCurrencyCode? type? url? urlNumber? urlText? vcard? vcardFormattedName? vcardList? verifiedBizName? waveform? width? allowedIds? idClass? Proxy

Methods

addChild applyUpdate avParams bind cancelDownload cancelUpload canForward canPrivateReply canPrivateReplyInRestrictedGrp canQuickForward canReply? 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 listenToAndRun listenToOnce mayFail mentionMap msgContextInfo off on once onCiphertextDecrypted onViewOnceMediaStatusChanged quotedMsgObj? removeAllListeners removeListener resend reset resumeRemoteUpload resumeUpload safe serialize set stopListening toJSON trigger unbind unsafe unset updateAck updateEphemeralStartTimestamp waitForPhoneUpload waitForPrep isIdType

Constructors

constructor

new MsgModel(
proterties: ModelPropertiesContructor<MsgModel, "id">,
options?: ModelOptions,
): MsgModel
Parameters
- proterties: ModelPropertiesContructor<MsgModel, "id">
- Optionaloptions: ModelOptions
Returns MsgModel
Inherited from Model.constructor
- Defined in src/whatsapp/models/MsgModel.ts:349

Properties

`Optional`accuracy

accuracy?: number

`Optional`ack

ack?: ACK

See Constants

`Optional`appStateFatalExceptionNotification

appStateFatalExceptionNotification?: any

`Optional`appStateSyncKeyRequest

appStateSyncKeyRequest?: any

`Optional`appStateSyncKeyShare

appStateSyncKeyShare?: any

`Optional` `Readonly`asAlbumAsset

asAlbumAsset?: any

`Optional` `Readonly`asBroadcastNotification

asBroadcastNotification?: any

`Optional` `Readonly`asDoc

asDoc?: any

`Optional` `Readonly`asGroupedSticker

asGroupedSticker?: any

`Optional` `Readonly`asGroupNotification

asGroupNotification?: any

`Optional` `Readonly`asImage

asImage?: any

`Optional` `Readonly`asMms

asMms?: any

`Optional` `Readonly`asPollCreation

asPollCreation?: any

`Optional` `Readonly`asPollUpdate

asPollUpdate?: any

`Optional` `Readonly`asProduct

asProduct?: any

`Optional` `Readonly`asProductInquiry

asProductInquiry?: any

`Optional` `Readonly`asRevoked

asRevoked?: any

`Optional` `Readonly`asUrl

asUrl?: any

`Optional` `Readonly`asVideo

asVideo?: any

`Optional` `Readonly`asViewOnce

asViewOnce?: any

`Optional` `Readonly`asVisualMedia

asVisualMedia?: any

`Readonly`attributes

attributes: Props & Session

`Optional`author

author?: Wid

`Optional`backgroundColor

backgroundColor?: number

`Optional`bizPrivacyStatus

bizPrivacyStatus?: any

`Optional`body

body?: string

`Optional`broadcast

broadcast?: any

`Optional`broadcastEphSettings

broadcastEphSettings?: any

`Optional`broadcastId

broadcastId?: any

`Optional`broadcastParticipants

broadcastParticipants?: any

`Optional`businessOwnerJid

businessOwnerJid?: any

`Optional`buttons

buttons?: TemplateButtonCollection

`Optional`buttonsResponse

buttonsResponse?: any

canonicalUrl

canonicalUrl: boolean

`Optional`caption

caption?: string

`Optional` `Readonly`chat

chat?: ChatModel

Deprecated

`Optional`clearMedia

clearMedia?: any

`Optional`clientUrl

clientUrl?: any

`Optional`collection

collection?: undefined

`Optional`comment

comment?: string

`Optional` `Readonly`containsEmoji

containsEmoji?: any

`Optional`ctwaContext

ctwaContext?: any

`Optional`currencyCode

currencyCode?: any

`Optional`degrees

degrees?: number

`Optional`deprecatedMms3Url

deprecatedMms3Url?: any

`Optional`description

description?: any

`Optional`devicesAdded

devicesAdded?: any

`Optional`devicesRemoved

devicesRemoved?: any

`Optional` `Readonly`dir

dir?: any

`Optional`directPath

directPath?: any

`Optional`disappearingModeInitiator

disappearingModeInitiator?: any

`Optional`doNotPlayInline

doNotPlayInline?: any

`Optional`duration

duration?: number

`Optional`dynamicReplyButtons

dynamicReplyButtons?: {
    buttonId: string;
    buttonText: { displayText: string };
    type: number;
}[]

`Optional`encFilehash

encFilehash?: any

`Optional`ephemeralDuration

ephemeralDuration?: number

`Optional` `Readonly`ephemeralExpirationTimestamp

ephemeralExpirationTimestamp?: any

`Optional`ephemeralOutOfSync

ephemeralOutOfSync?: any

`Optional`ephemeralSettingTimestamp

ephemeralSettingTimestamp?: number

`Optional`ephemeralSharedSecret

ephemeralSharedSecret?: any

`Optional`ephemeralStartTimestamp

ephemeralStartTimestamp?: any

`Optional` `Readonly`eventType

eventType?: any

`Optional`filehash

filehash?: any

`Optional`filename

filename?: any

`Optional`finalAccuracy

finalAccuracy?: any

`Optional`finalDegrees

finalDegrees?: any

`Optional`finalLat

finalLat?: any

`Optional`finalLng

finalLng?: any

`Optional`finalSpeed

finalSpeed?: any

`Optional`finalThumbnail

finalThumbnail?: any

`Optional`finalTimeOffset

finalTimeOffset?: any

`Optional`firstFrameLength

firstFrameLength?: any

`Optional`firstFrameSidecar

firstFrameSidecar?: any

`Optional`font

font?: TextFontStyle

`Optional`footer

footer?: string

`Optional`forwardedFromWeb

forwardedFromWeb?: any

`Optional`forwardingScore

forwardingScore?: any

`Optional`from

from?: Wid

`Optional`gifAttribution

gifAttribution?: any

`Readonly`hasBodyOrFooter

hasBodyOrFooter: boolean

`Readonly`hasTemplateButtons

hasTemplateButtons: boolean

`Optional`height

height?: any

`Optional`historySyncMetaData

historySyncMetaData?: any

`Optional`hydratedButtons

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` `Readonly`initialPageSize

initialPageSize?: any

`Optional`interactiveAnnotations

interactiveAnnotations?: any

`Optional`interactiveMessage

interactiveMessage?: any

`Optional` `Readonly`interactivePayload

interactivePayload?: any

`Optional`invis

invis?: any

`Optional`inviteCode

inviteCode?: any

`Optional`inviteCodeExp

inviteCodeExp?: any

`Optional`inviteGrp

inviteGrp?: any

`Optional`inviteGrpJpegThum

inviteGrpJpegThum?: any

`Optional`inviteGrpName

inviteGrpName?: any

isAnimated

isAnimated: boolean

`Readonly`isBizNotification

isBizNotification: boolean

isCaptionByUser

isCaptionByUser: boolean

isDynamicReplyButtonsMsg

isDynamicReplyButtonsMsg: boolean

`Readonly`isEphemeral

isEphemeral: boolean

`Readonly`isFailed

isFailed: boolean

isForwarded

isForwarded: boolean

`Readonly`isFrequentlyForwarded

isFrequentlyForwarded: boolean

isFromTemplate

isFromTemplate: boolean

`Readonly`isFutureproof

isFutureproof: boolean

isGif

isGif: boolean

`Readonly`isGroupMsg

isGroupMsg: boolean

Deprecated

`Readonly`isGroupsV4InviteExpired

isGroupsV4InviteExpired: boolean

`Readonly`isInternational

isInternational: boolean

isLive

isLive: boolean

isMdHistoryMsg

isMdHistoryMsg: boolean

`Readonly`isMedia

isMedia: boolean

isNewMsg

isNewMsg: boolean

`Readonly`isNotification

isNotification: boolean

`Readonly`isPersistent

isPersistent: boolean

`Readonly`isPSA

isPSA: boolean

`Readonly`isQuickReply

isQuickReply: boolean

isQuotedMsgAvailable

isQuotedMsgAvailable: boolean

`Readonly`isRevokedByMe

isRevokedByMe: boolean

`Readonly`isRTL

isRTL: boolean

isSendFailure

isSendFailure: boolean

`Readonly`isSentByMe

isSentByMe: boolean

`Readonly`isSentByMeFromWeb

isSentByMeFromWeb: boolean

`Readonly`isState

isState: true

`Readonly`isStatusV3

isStatusV3: boolean

isThisDeviceAdded

isThisDeviceAdded: boolean

`Readonly`isUnreadType

isUnreadType: boolean

`Readonly`isUnsentMedia

isUnsentMedia: boolean

`Readonly`isUserCreatedType

isUserCreatedType: boolean

isVcardOverMmsDocument

isVcardOverMmsDocument: boolean

isViewOnce

isViewOnce: boolean

`Optional`itemCount

itemCount?: any

`Optional`labels

labels?: any

`Optional`lat

lat?: number

`Optional` `Readonly`linkPreview

linkPreview?: {
    canonicalUrl?: string;
    description?: string;
    doNotPlayInline: boolean;
    matchedText: string;
    richPreviewType: number;
    thumbnail?: string;
    title?: string;
}

`Optional`linksIndexParsed

linksIndexParsed?: any

`Optional`list

list?: {
    buttonText: string;
    description: string;
    footerText?: string;
    listType: number;
    sections: {
        rows: { description: string; rowId: string; title: string }[];
        title: string;
    }[];
    title?: string;
}

`Optional`listResponse

listResponse?: any

`Optional`lng

lng?: number

`Optional`loc

loc?: any

`Optional`local

local?: true

`Optional`matchedText

matchedText?: any

`Optional`mdDowngrade

mdDowngrade?: any

`Optional`mediaData

mediaData?: MediaDataModel

`Optional`mediaKey

mediaKey?: any

`Optional`mediaKeyTimestamp

mediaKeyTimestamp?: any

`Optional`mediaObject

mediaObject?: MediaObject

`Optional`mentionedJidList

mentionedJidList?: Wid[]

`Optional`message

message?: any

`Optional`mimetype

mimetype?: any

`Readonly`mirrorMask

mirrorMask: {
    "change:accuracy"?: number;
    "change:ack"?: number;
    "change:appStateFatalExceptionNotification"?: number;
    "change:appStateSyncKeyRequest"?: number;
    "change:appStateSyncKeyShare"?: number;
    "change:asAlbumAsset"?: number;
    "change:asBroadcastNotification"?: number;
    "change:asDoc"?: number;
    "change:asGroupedSticker"?: number;
    "change:asGroupNotification"?: number;
    "change:asImage"?: number;
    "change:asMms"?: number;
    "change:asPollCreation"?: number;
    "change:asPollUpdate"?: number;
    "change:asProduct"?: number;
    "change:asProductInquiry"?: number;
    "change:asRevoked"?: number;
    "change:asUrl"?: number;
    "change:asVideo"?: number;
    "change:asViewOnce"?: number;
    "change:asVisualMedia"?: number;
    "change:author"?: number;
    "change:backgroundColor"?: number;
    "change:bizPrivacyStatus"?: number;
    "change:body"?: number;
    "change:broadcast"?: number;
    "change:broadcastEphSettings"?: number;
    "change:broadcastId"?: number;
    "change:broadcastParticipants"?: number;
    "change:businessOwnerJid"?: number;
    "change:buttons"?: number;
    "change:buttonsResponse"?: number;
    "change:canonicalUrl": number;
    "change:caption"?: number;
    "change:chat"?: number;
    "change:clearMedia"?: number;
    "change:clientUrl"?: number;
    "change:comment"?: number;
    "change:containsEmoji"?: number;
    "change:ctwaContext"?: number;
    "change:currencyCode"?: number;
    "change:degrees"?: number;
    "change:deprecatedMms3Url"?: number;
    "change:description"?: number;
    "change:devicesAdded"?: number;
    "change:devicesRemoved"?: number;
    "change:dir"?: number;
    "change:directPath"?: number;
    "change:disappearingModeInitiator"?: number;
    "change:doNotPlayInline"?: number;
    "change:duration"?: number;
    "change:dynamicReplyButtons"?: number;
    "change:encFilehash"?: number;
    "change:ephemeralDuration"?: number;
    "change:ephemeralExpirationTimestamp"?: number;
    "change:ephemeralOutOfSync"?: number;
    "change:ephemeralSettingTimestamp"?: number;
    "change:ephemeralSharedSecret"?: number;
    "change:ephemeralStartTimestamp"?: number;
    "change:eventType"?: number;
    "change:filehash"?: number;
    "change:filename"?: number;
    "change:finalAccuracy"?: number;
    "change:finalDegrees"?: number;
    "change:finalLat"?: number;
    "change:finalLng"?: number;
    "change:finalSpeed"?: number;
    "change:finalThumbnail"?: number;
    "change:finalTimeOffset"?: number;
    "change:firstFrameLength"?: number;
    "change:firstFrameSidecar"?: number;
    "change:font"?: number;
    "change:footer"?: number;
    "change:forwardedFromWeb"?: number;
    "change:forwardingScore"?: number;
    "change:from"?: number;
    "change:gifAttribution"?: number;
    "change:hasBodyOrFooter": number;
    "change:hasTemplateButtons": number;
    "change:height"?: number;
    "change:historySyncMetaData"?: number;
    "change:hydratedButtons"?: number;
    "change:id": number;
    "change:initialPageSize"?: number;
    "change:interactiveAnnotations"?: number;
    "change:interactiveMessage"?: number;
    "change:interactivePayload"?: number;
    "change:invis"?: number;
    "change:inviteCode"?: number;
    "change:inviteCodeExp"?: number;
    "change:inviteGrp"?: number;
    "change:inviteGrpJpegThum"?: number;
    "change:inviteGrpName"?: 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"?: number;
    "change:labels"?: number;
    "change:lat"?: number;
    "change:linkPreview"?: number;
    "change:linksIndexParsed"?: number;
    "change:list"?: number;
    "change:listResponse"?: number;
    "change:lng"?: number;
    "change:loc"?: number;
    "change:local"?: number;
    "change:matchedText"?: number;
    "change:mdDowngrade"?: number;
    "change:mediaData"?: number;
    "change:mediaKey"?: number;
    "change:mediaKeyTimestamp"?: number;
    "change:mentionedJidList"?: number;
    "change:message"?: number;
    "change:mimetype"?: number;
    "change:msgChunk"?: number;
    "change:multicast"?: number;
    "change:nativeFlowName"?: number;
    "change:notifyName"?: number;
    "change:numTimesForwarded"?: number;
    "change:orderId"?: number;
    "change:orderTitle"?: number;
    "change:pageCount"?: number;
    "change:paymentAmount1000"?: number;
    "change:paymentCurrency"?: number;
    "change:paymentExpiryTimestamp"?: number;
    "change:paymentMessageReceiverJid"?: number;
    "change:paymentNoteMsg"?: number;
    "change:paymentRequestMessageKey"?: number;
    "change:paymentStatus"?: number;
    "change:paymentTransactionTimestamp"?: number;
    "change:paymentTxnStatus"?: number;
    "change:phoneUploading"?: number;
    "change:pollInvalidated"?: number;
    "change:pollName"?: number;
    "change:pollOptions"?: number;
    "change:pollSelectableOptionsCount"?: number;
    "change:pollUpdateParentKey"?: number;
    "change:priceAmount1000"?: number;
    "change:privacyModeWhenSent"?: number;
    "change:productHeaderImageRejected"?: number;
    "change:productId"?: number;
    "change:productImageCount"?: number;
    "change:productListHeaderImage"?: number;
    "change:productListItemCount"?: number;
    "change:protocolMessageKey"?: number;
    "change:quotedGroupSubject"?: number;
    "change:quotedMsg"?: number;
    "change:quotedMsgId"?: number;
    "change:quotedMsgKey"?: number;
    "change:quotedParentGroupJid"?: number;
    "change:quotedParticipant"?: number;
    "change:quotedRemoteJid"?: number;
    "change:quotedStanzaID"?: number;
    "change:recipients"?: number;
    "change:recvFresh"?: number;
    "change:replyButtons"?: number;
    "change:retailerId"?: number;
    "change:richPreviewType"?: number;
    "change:rowId"?: number;
    "change:rtl"?: number;
    "change:salePriceAmount1000"?: number;
    "change:scanLengths"?: number;
    "change:scansSidecar"?: number;
    "change:search"?: number;
    "change:selectedButtonId"?: number;
    "change:selectedId"?: number;
    "change:selectedIndex"?: number;
    "change:self"?: number;
    "change:sellerJid"?: number;
    "change:sendDeferred"?: number;
    "change:sender"?: number;
    "change:senderObj"?: number;
    "change:sequence"?: number;
    "change:serverId"?: number;
    "change:sessionId"?: number;
    "change:shareDuration"?: number;
    "change:size"?: number;
    "change:speed"?: number;
    "change:stale"?: number;
    "change:star"?: number;
    "change:startOfDay"?: number;
    "change:startOfDaySkew"?: number;
    "change:status"?: number;
    "change:statusV3TextBg"?: number;
    "change:streamable"?: number;
    "change:streamingSidecar"?: number;
    "change:subtype"?: number;
    "change:supportsMessageFooter"?: number;
    "change:supportsMessageFooterLinks"?: number;
    "change:surface"?: number;
    "change:t"?: number;
    "change:templateParams"?: number;
    "change:text"?: number;
    "change:textColor"?: number;
    "change:thumbnail"?: number;
    "change:thumbnailDirectPath"?: number;
    "change:thumbnailEncSha256"?: number;
    "change:thumbnailHeight"?: number;
    "change:thumbnailHQ"?: number;
    "change:thumbnailSha256"?: number;
    "change:thumbnailWidth"?: number;
    "change:title"?: number;
    "change:to"?: number;
    "change:token"?: number;
    "change:totalAmount1000"?: number;
    "change:totalCurrencyCode"?: number;
    "change:type"?: number;
    "change:url"?: number;
    "change:urlNumber"?: number;
    "change:urlText"?: number;
    "change:vcard"?: number;
    "change:vcardFormattedName"?: number;
    "change:vcardList"?: number;
    "change:verifiedBizName"?: number;
    "change:waveform"?: number;
    "change:width"?: number;
}

`Optional`msgChunk

msgChunk?: any

`Optional`multicast

multicast?: any

`Optional` `Readonly`nativeFlowName

nativeFlowName?: string

`Optional`notifyName

notifyName?: any

`Optional` `Readonly`numTimesForwarded

numTimesForwarded?: any

`Optional`orderId

orderId?: any

`Optional`orderTitle

orderTitle?: any

`Optional`pageCount

pageCount?: any

`Optional`parent

parent?: any

`Optional`paymentAmount1000

paymentAmount1000?: any

`Optional`paymentCurrency

paymentCurrency?: any

`Optional`paymentExpiryTimestamp

paymentExpiryTimestamp?: any

`Optional`paymentMessageReceiverJid

paymentMessageReceiverJid?: any

`Optional`paymentNoteMsg

paymentNoteMsg?: any

`Optional`paymentRequestMessageKey

paymentRequestMessageKey?: any

`Optional`paymentStatus

paymentStatus?: any

`Optional`paymentTransactionTimestamp

paymentTransactionTimestamp?: any

`Optional`paymentTxnStatus

paymentTxnStatus?: any

`Optional`phoneUploading

phoneUploading?: any

`Optional` `Readonly`pollInvalidated

pollInvalidated?: boolean

`Optional` `Readonly`pollName

pollName?: string

`Optional` `Readonly`pollOptions

pollOptions?: any

`Optional` `Readonly`pollSelectableOptionsCount

pollSelectableOptionsCount?: number

`Optional` `Readonly`pollUpdateParentKey

pollUpdateParentKey?: any

`Optional`priceAmount1000

priceAmount1000?: any

`Optional`privacyModeWhenSent

privacyModeWhenSent?: any

`Optional`productHeaderImageRejected

productHeaderImageRejected?: any

`Optional`productId

productId?: any

`Optional`productImageCount

productImageCount?: any

`Optional` `Readonly`productListHeaderImage

productListHeaderImage?: any

`Optional`productListItemCount

productListItemCount?: any

`Optional`protocolMessageKey

protocolMessageKey?: any

proxyName

proxyName: string

`Optional`quotedGroupSubject

quotedGroupSubject?: any

`Optional`quotedMsg

quotedMsg?: MsgModel

`Optional`quotedMsgId

quotedMsgId?: MsgKey

Deprecated

`Optional`quotedMsgKey

quotedMsgKey?: MsgKey

`Optional`quotedParentGroupJid

quotedParentGroupJid?: any

`Optional`quotedParticipant

quotedParticipant?: any

`Optional`quotedRemoteJid

quotedRemoteJid?: any

`Optional`quotedStanzaID

quotedStanzaID?: any

`Optional`recipients

recipients?: any

`Optional`recvFresh

recvFresh?: any

`Optional`replyButtons

replyButtons?: ButtonCollection

`Optional`retailerId

retailerId?: any

`Optional`richPreviewType

richPreviewType?: any

`Optional`rowId

rowId?: any

`Optional` `Readonly`rtl

rtl?: any

`Optional`salePriceAmount1000

salePriceAmount1000?: any

`Optional`scanLengths

scanLengths?: any

`Optional`scansSidecar

scansSidecar?: any

`Optional`search

search?: any

`Optional`selectedButtonId

selectedButtonId?: string

`Optional`selectedId

selectedId?: any

`Optional`selectedIndex

selectedIndex?: any

`Optional`self

self?: string

`Optional`sellerJid

sellerJid?: any

`Optional`sendDeferred

sendDeferred?: any

`Optional` `Readonly`sender

sender?: Wid

`Optional`senderObj

senderObj?: any

`Optional`sequence

sequence?: number

`Optional`serverId

serverId?: number

`Optional`sessionId

sessionId?: any

`Optional`shareDuration

shareDuration?: number

`Optional`size

size?: any

`Optional`speed

speed?: number

`Optional`stale

stale?: any

`Optional`star

star?: any

`Optional`startOfDay

startOfDay?: any

`Optional`startOfDaySkew

startOfDaySkew?: any

`Optional`status

status?: any

`Optional` `Readonly`statusV3TextBg

statusV3TextBg?: any

`Optional`streamable

streamable?: any

`Optional`streamingSidecar

streamingSidecar?: any

`Optional`subtype

subtype?: null | string

`Optional` `Readonly`supportsMessageFooter

supportsMessageFooter?: any

`Optional` `Readonly`supportsMessageFooterLinks

supportsMessageFooterLinks?: any

`Optional`surface

surface?: any

`Optional`t

t?: number

`Optional`templateParams

templateParams?: any

`Optional` `Readonly`text

text?: any

`Optional`textColor

textColor?: number

`Optional`thumbnail

thumbnail?: any

`Optional`thumbnailDirectPath

thumbnailDirectPath?: any

`Optional`thumbnailEncSha256

thumbnailEncSha256?: any

`Optional`thumbnailHeight

thumbnailHeight?: any

`Optional`thumbnailHQ

thumbnailHQ?: any

`Optional`thumbnailSha256

thumbnailSha256?: any

`Optional`thumbnailWidth

thumbnailWidth?: any

`Optional`title

title?: string

`Optional`to

to?: Wid

`Optional`token

token?: any

`Optional`totalAmount1000

totalAmount1000?: any

`Optional`totalCurrencyCode

totalCurrencyCode?: any

`Optional`type

type?: string

`Optional`url

url?: any

`Optional`urlNumber

urlNumber?: null | string

`Optional`urlText

urlText?: null | string

`Optional` `Readonly`vcard

vcard?: any

`Optional`vcardFormattedName

vcardFormattedName?: any

`Optional`vcardList

vcardList?: any

`Optional`verifiedBizName

verifiedBizName?: any

`Optional`waveform

waveform?: any

`Optional`width

width?: any

`Static` `Optional`allowedIds

allowedIds?: any[]

`Static` `Optional`idClass

idClass?: any

`Static`Proxy

Proxy: string

Methods

addChild

addChild(id: Stringable, context: { [key: string]: any }): void
Parameters
- id: Stringable
- context: { [key: string]: any }
Returns void
Inherited from Model.addChild
- Defined in src/whatsapp/models/Model.ts:80

applyUpdate

applyUpdate(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:381

avParams

avParams(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:395

bind

bind(eventName: Event, listener: Listener, context?: any): this
Alias of on
Parameters
- eventName: Event
- listener: Listener
- Optionalcontext: any
Returns this
Alias
on
Inherited from Model.bind
- Defined in src/whatsapp/misc/EventEmitter.ts:99

cancelDownload

cancelDownload(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:376

cancelUpload

cancelUpload(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:378

canForward

canForward(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:365

canPrivateReply

canPrivateReply(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:363

canPrivateReplyInRestrictedGrp

canPrivateReplyInRestrictedGrp(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:364

canQuickForward

canQuickForward(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:366

`Optional`canReply

canReply(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:362

canRevoke

canRevoke(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:399

canStar

canStar(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:367

clear

clear(): void
Returns void
Inherited from Model.clear
- Defined in src/whatsapp/models/Model.ts:90

decObservers

decObservers(): void
Returns void
Inherited from Model.decObservers
- Defined in src/whatsapp/models/Model.ts:76

delete

delete(): void
Returns void
Inherited from Model.delete
- Defined in src/whatsapp/models/Model.ts:92

displayName

displayName(e?: any, t?: any): any
Parameters
- Optionale: any
- Optionalt: any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:390

downloadMedia

downloadMedia(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:380

emit

emit(eventName: Event, ...args: any[]): this
Alias of trigger
Parameters
- eventName: Event
- ...args: any[]
Returns this
Alias
trigger
Inherited from Model.emit
- Defined in src/whatsapp/misc/EventEmitter.ts:120

forceRMR

forceRMR(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:374

get

get<T extends keyof MsgModel>(attr: T): MsgModel[T]
Type Parameters
- T extends keyof MsgModel
Parameters
- attr: T
Returns MsgModel[T]
Inherited from Model.get
- Defined in src/whatsapp/models/Model.ts:82

getCollection

getCollection(): MsgCollection
Returns MsgCollection
- Defined in src/whatsapp/models/MsgModel.ts:405

getDefault

getDefault<T extends keyof MsgModel>(attr: T): any
Type Parameters
- T extends keyof MsgModel
Parameters
- attr: T
Returns any
Inherited from Model.getDefault
- Defined in src/whatsapp/models/Model.ts:96

getFooterLinks

getFooterLinks(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:356

getForwardingScoreWhenForwarded

getForwardingScoreWhenForwarded(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:402

getGalleryLinks

getGalleryLinks(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:357

getHeaderLinks

getHeaderLinks(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:355

getLinks

getLinks(e?: number): any
Parameters
- Optionale: number
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:354

getLocObject

getLocObject(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:372

getQuotedMsgAdminGroupJid

getQuotedMsgAdminGroupJid(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:388

getSuspiciousLinks

getSuspiciousLinks(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:358

getVcardWids

getVcardWids(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:371

getWamMediaType

getWamMediaType(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:401

getWamMessageType

getWamMessageType(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:400

hasObservers

hasObservers(): boolean
Returns boolean
Inherited from Model.hasObservers
- Defined in src/whatsapp/models/Model.ts:78

hasSymbol

hasSymbol(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:359

hasUnfiredChanges

hasUnfiredChanges(): boolean
Returns boolean
Inherited from Model.hasUnfiredChanges
- Defined in src/whatsapp/models/Model.ts:86

incObservers

incObservers(e?: boolean): void
Parameters
- Optionale: boolean
Returns void
Inherited from Model.incObservers
- Defined in src/whatsapp/models/Model.ts:74

initialize

initialize(): void
Returns void
Inherited from Model.initialize
- Defined in src/whatsapp/models/Model.ts:72

interactiveButtonsReleased

interactiveButtonsReleased(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:368

isDownloadable

isDownloadable(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:406

isExpired

isExpired(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:404

isForcingRMR

isForcingRMR(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:375

isGroupLeave

isGroupLeave(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:369

isListening

isListening(eventName: Event): boolean
Parameters
- eventName: Event
Returns boolean
Inherited from Model.isListening
- Defined in src/whatsapp/misc/EventEmitter.ts:93

isMentioned

isMentioned(e?: any): boolean
Parameters
- Optionale: any
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:392

isQuoted

isQuoted(e?: any): boolean
Parameters
- Optionale: any
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:391

isTrusted

isTrusted(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:370

isUnsentPhoneMsg

isUnsentPhoneMsg(): boolean
Returns boolean
- Defined in src/whatsapp/models/MsgModel.ts:361

listenTo

listenTo(context: any, eventName: Event, listener?: 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
Inherited from Model.listenTo
- Defined in src/whatsapp/misc/EventEmitter.ts:77

listenToAndRun

listenToAndRun(context: any, eventName: Event, listener?: 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
Inherited from Model.listenToAndRun
- Defined in src/whatsapp/misc/EventEmitter.ts:91

listenToOnce

listenToOnce(context: any, eventName: Event, listener?: 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
Inherited from Model.listenToOnce
- Defined in src/whatsapp/misc/EventEmitter.ts:84

mayFail

mayFail(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:360

mentionMap

mentionMap(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:393

msgContextInfo

msgContextInfo(chatId: Wid): any
Parameters
- chatId: Wid
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:389

off

off(eventName?: Event, listener?: Listener, context?: any): this
Removes the specified listener from the listener array for the event named eventName.
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.
Inherited from Model.off
- Defined in src/whatsapp/misc/EventEmitter.ts:62

on

on(eventName: Event, listener: Listener, context?: any): 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.
- 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.
Inherited from Model.on
- Defined in src/whatsapp/misc/EventEmitter.ts:42

once

once(eventName: Event, listener: Listener, context?: any): this
Adds a one-time listener function for the event named eventName.
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.
Inherited from Model.once
- Defined in src/whatsapp/misc/EventEmitter.ts:52

onCiphertextDecrypted

onCiphertextDecrypted(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:397

onViewOnceMediaStatusChanged

onViewOnceMediaStatusChanged(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:398

`Optional`quotedMsgObj

quotedMsgObj(): any
Returns any
Deprecated
Whatsapp
< 2.2245.8
- Defined in src/whatsapp/models/MsgModel.ts:387

removeAllListeners

removeAllListeners(): this
Removes all listeners.

Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.removeAllListeners
- Defined in src/whatsapp/misc/EventEmitter.ts:115

removeListener

removeListener(eventName?: Event, listener?: Listener, context?: any): this
Alias of off
Parameters
- OptionaleventName: Event
- Optionallistener: Listener
- Optionalcontext: any
Returns this
Alias
off
Inherited from Model.removeListener
- Defined in src/whatsapp/misc/EventEmitter.ts:110

resend

resend(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:396

reset

reset(): void
Returns void
Inherited from Model.reset
- Defined in src/whatsapp/models/Model.ts:94

resumeRemoteUpload

resumeRemoteUpload(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:373

resumeUpload

resumeUpload(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:377

safe

safe(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:407

serialize

serialize(): Props
Returns Props
Inherited from ModelProxy.serialize
- Defined in src/whatsapp/models/Model.ts:35

set

set(...args: any): any
Parameters
- ...args: any
Returns any
Inherited from Model.set
- Defined in src/whatsapp/models/Model.ts:84

stopListening

stopListening(context?: any, eventName?: Event, listener?: Listener): this
Parameters
- Optionalcontext: any
- OptionaleventName: Event
- Optionallistener: Listener
Returns this
Inherited from Model.stopListening
- Defined in src/whatsapp/misc/EventEmitter.ts:70

toJSON

toJSON(): Props
Returns Props
Inherited from ModelProxy.toJSON
- Defined in src/whatsapp/models/Model.ts:33

trigger

trigger(eventName: Event, ...args: any[]): 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
- ...args: any[]
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.trigger
- Defined in src/whatsapp/misc/EventEmitter.ts:68

unbind

unbind(eventName?: Event, listener?: Listener, context?: any): this
Alias of off
Parameters
- OptionaleventName: Event
- Optionallistener: Listener
- Optionalcontext: any
Returns this
Alias
off
Inherited from Model.unbind
- Defined in src/whatsapp/misc/EventEmitter.ts:105

unsafe

unsafe(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:408

unset

unset(ids: Stringable | Stringable[], t?: any): void
Parameters
- ids: Stringable | Stringable[]
- Optionalt: any
Returns void
Inherited from Model.unset
- Defined in src/whatsapp/models/Model.ts:88

updateAck

updateAck(e?: any, t?: any): any
Parameters
- Optionale: any
- Optionalt: any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:394

updateEphemeralStartTimestamp

updateEphemeralStartTimestamp(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:403

waitForPhoneUpload

waitForPhoneUpload(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:379

waitForPrep

waitForPrep(): any
Returns any
- Defined in src/whatsapp/models/MsgModel.ts:382

`Static`isIdType

isIdType(e: any): boolean
Parameters
- e: any
Returns boolean
Inherited from Model.isIdType
- Defined in src/whatsapp/models/Model.ts:100

Class MsgModel

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MsgModel

Properties

Optionalaccuracy

Optionalack

OptionalappStateFatalExceptionNotification

OptionalappStateSyncKeyRequest

OptionalappStateSyncKeyShare

Optional ReadonlyasAlbumAsset

Optional ReadonlyasBroadcastNotification

Optional ReadonlyasDoc

Optional ReadonlyasGroupedSticker

Optional ReadonlyasGroupNotification

Optional ReadonlyasImage

Optional ReadonlyasMms

Optional ReadonlyasPollCreation

Optional ReadonlyasPollUpdate

Optional ReadonlyasProduct

Optional ReadonlyasProductInquiry

Optional ReadonlyasRevoked

Optional ReadonlyasUrl

Optional ReadonlyasVideo

Optional ReadonlyasViewOnce

Optional ReadonlyasVisualMedia

Readonlyattributes

Optionalauthor

OptionalbackgroundColor

OptionalbizPrivacyStatus

Optionalbody

Optionalbroadcast

OptionalbroadcastEphSettings

OptionalbroadcastId

OptionalbroadcastParticipants

OptionalbusinessOwnerJid

Optionalbuttons

OptionalbuttonsResponse

canonicalUrl

Optionalcaption

Optional Readonlychat

Deprecated

OptionalclearMedia

OptionalclientUrl

Optionalcollection

Optionalcomment

Optional ReadonlycontainsEmoji

OptionalctwaContext

OptionalcurrencyCode

Optionaldegrees

OptionaldeprecatedMms3Url

Optionaldescription

OptionaldevicesAdded

OptionaldevicesRemoved

Optional Readonlydir

OptionaldirectPath

OptionaldisappearingModeInitiator

OptionaldoNotPlayInline

Optionalduration

OptionaldynamicReplyButtons

OptionalencFilehash

OptionalephemeralDuration

Optional ReadonlyephemeralExpirationTimestamp

OptionalephemeralOutOfSync

OptionalephemeralSettingTimestamp

OptionalephemeralSharedSecret

OptionalephemeralStartTimestamp

Optional ReadonlyeventType

Optionalfilehash

Optionalfilename

OptionalfinalAccuracy

OptionalfinalDegrees

OptionalfinalLat

`Optional`accuracy

`Optional`ack

`Optional`appStateFatalExceptionNotification

`Optional`appStateSyncKeyRequest

`Optional`appStateSyncKeyShare

`Optional` `Readonly`asAlbumAsset

`Optional` `Readonly`asBroadcastNotification

`Optional` `Readonly`asDoc

`Optional` `Readonly`asGroupedSticker

`Optional` `Readonly`asGroupNotification

`Optional` `Readonly`asImage

`Optional` `Readonly`asMms

`Optional` `Readonly`asPollCreation

`Optional` `Readonly`asPollUpdate

`Optional` `Readonly`asProduct

`Optional` `Readonly`asProductInquiry

`Optional` `Readonly`asRevoked

`Optional` `Readonly`asUrl

`Optional` `Readonly`asVideo

`Optional` `Readonly`asViewOnce

`Optional` `Readonly`asVisualMedia

`Readonly`attributes

`Optional`author

`Optional`backgroundColor

`Optional`bizPrivacyStatus

`Optional`body

`Optional`broadcast

`Optional`broadcastEphSettings

`Optional`broadcastId

`Optional`broadcastParticipants

`Optional`businessOwnerJid

`Optional`buttons

`Optional`buttonsResponse

`Optional`caption

`Optional` `Readonly`chat

`Optional`clearMedia

`Optional`clientUrl

`Optional`collection

`Optional`comment

`Optional` `Readonly`containsEmoji

`Optional`ctwaContext

`Optional`currencyCode

`Optional`degrees

`Optional`deprecatedMms3Url

`Optional`description

`Optional`devicesAdded

`Optional`devicesRemoved

`Optional` `Readonly`dir

`Optional`directPath

`Optional`disappearingModeInitiator

`Optional`doNotPlayInline

`Optional`duration

`Optional`dynamicReplyButtons

`Optional`encFilehash

`Optional`ephemeralDuration

`Optional` `Readonly`ephemeralExpirationTimestamp

`Optional`ephemeralOutOfSync

`Optional`ephemeralSettingTimestamp

`Optional`ephemeralSharedSecret

`Optional`ephemeralStartTimestamp

`Optional` `Readonly`eventType

`Optional`filehash

`Optional`filename

`Optional`finalAccuracy

`Optional`finalDegrees

`Optional`finalLat

`Optional`finalLng

`Optional`finalSpeed

`Optional`finalThumbnail

`Optional`finalTimeOffset

`Optional`firstFrameLength

`Optional`firstFrameSidecar

`Optional`font

`Optional`footer

`Optional`forwardedFromWeb

`Optional`forwardingScore

`Optional`from

`Optional`gifAttribution

`Readonly`hasBodyOrFooter

`Readonly`hasTemplateButtons