@wppconnect-team/wppconnect - v1.36.4
    Preparing search index...

    Class MsgModel

    17304

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    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

    Properties

    accuracy?: number
    ack?: ACK

    See Constants

    appStateFatalExceptionNotification?: any
    appStateSyncKeyRequest?: any
    appStateSyncKeyShare?: any
    asAlbumAsset?: any
    asBroadcastNotification?: any
    asDoc?: any
    asGroupedSticker?: any
    asGroupNotification?: any
    asImage?: any
    asMms?: any
    asPollCreation?: any
    asPollUpdate?: any
    asProduct?: any
    asProductInquiry?: any
    asRevoked?: any
    asUrl?: any
    asVideo?: any
    asViewOnce?: any
    asVisualMedia?: any
    attributes: Props & Session
    author?: WAJS.whatsapp.Wid
    backgroundColor?: number
    bizPrivacyStatus?: any

    Optionalbody

    body?: string
    broadcast?: any
    broadcastEphSettings?: any
    broadcastId?: any
    broadcastParticipants?: any
    businessOwnerJid?: any
    buttons?: TemplateButtonCollection
    buttonsResponse?: any
    canonicalUrl: boolean
    caption?: string
    chat?: ChatModel
    clearMedia?: any
    clientUrl?: any
    collection?: undefined
    comment?: string
    containsEmoji?: any
    ctwaContext?: any
    currencyCode?: any
    degrees?: number
    deprecatedMms3Url?: any
    description?: any
    devicesAdded?: any
    devicesRemoved?: any
    dir?: any
    directPath?: any
    disappearingModeInitiator?: any
    doNotPlayInline?: any
    duration?: number
    dynamicReplyButtons?: {
        buttonId: string;
        buttonText: { displayText: string };
        type: number;
    }[]
    encFilehash?: any
    ephemeralDuration?: number
    ephemeralExpirationTimestamp?: any
    ephemeralOutOfSync?: any
    ephemeralSettingTimestamp?: number
    ephemeralSharedSecret?: any
    ephemeralStartTimestamp?: any
    eventType?: any
    filehash?: any
    filename?: any
    finalAccuracy?: any
    finalDegrees?: any
    finalLat?: any
    finalLng?: any
    finalSpeed?: any
    finalThumbnail?: any
    finalTimeOffset?: any
    firstFrameLength?: any
    firstFrameSidecar?: any
    font?: TextFontStyle
    footer?: string
    forwardedFromWeb?: any
    forwardingScore?: any
    from?: WAJS.whatsapp.Wid
    gifAttribution?: any
    hasBodyOrFooter: boolean
    hasTemplateButtons: boolean
    height?: any
    historySyncMetaData?: any
    hydratedButtons?: {
        callButton?: { displayText: string; phoneNumber: string };
        index?: number;
        quickReplyButton?: { displayText: string; id: string };
        urlButton?: { displayText: string; url: string };
    }[]
    id: MsgKey
    idClass: typeof MsgKey
    initialPageSize?: any
    interactiveAnnotations?: any
    interactiveMessage?: any
    interactivePayload?: any
    invis?: any
    inviteCode?: any
    inviteCodeExp?: any
    inviteGrp?: any
    inviteGrpJpegThum?: any
    inviteGrpName?: any
    isAnimated: boolean
    isBizNotification: boolean
    isCaptionByUser: boolean
    isDynamicReplyButtonsMsg: boolean
    isEphemeral: boolean
    isFailed: boolean
    isForwarded: boolean
    isFrequentlyForwarded: boolean
    isFromTemplate: boolean
    isFutureproof: boolean
    isGif: boolean
    isGroupMsg: boolean
    isGroupsV4InviteExpired: boolean
    isInternational: boolean
    isLive: boolean
    isMdHistoryMsg: boolean
    isMedia: boolean
    isNewMsg: boolean
    isNotification: boolean
    isPersistent: boolean
    isPSA: boolean
    isQuickReply: boolean
    isQuotedMsgAvailable: boolean
    isRevokedByMe: boolean
    isRTL: boolean
    isSendFailure: boolean
    isSentByMe: boolean
    isSentByMeFromWeb: boolean
    isState: true
    isStatusV3: boolean
    isThisDeviceAdded: boolean
    isUnreadType: boolean
    isUnsentMedia: boolean
    isUserCreatedType: boolean
    isVcardOverMmsDocument: boolean
    isViewOnce: boolean
    itemCount?: any
    labels?: any
    lat?: number
    linkPreview?: {
        canonicalUrl?: string;
        description?: string;
        doNotPlayInline: boolean;
        matchedText: string;
        richPreviewType: number;
        thumbnail?: string;
        title?: string;
    }
    linksIndexParsed?: any
    list?: {
        buttonText: string;
        description: string;
        footerText?: string;
        listType: number;
        sections: {
            rows: { description: string; rowId: string; title: string }[];
            title: string;
        }[];
        title?: string;
    }
    listResponse?: any
    lng?: number
    loc?: any
    local?: true
    matchedText?: any
    mdDowngrade?: any
    mediaData?: MediaDataModel
    mediaKey?: any
    mediaKeyTimestamp?: any
    mediaObject?: MediaObject
    mentionedJidList?: WAJS.whatsapp.Wid[]
    message?: any
    mimetype?: any
    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;
    }
    msgChunk?: any
    multicast?: any
    nativeFlowName?: string
    notifyName?: any
    numTimesForwarded?: any
    orderId?: any
    orderTitle?: any
    pageCount?: any
    parent?: any
    paymentAmount1000?: any
    paymentCurrency?: any
    paymentExpiryTimestamp?: any
    paymentMessageReceiverJid?: any
    paymentNoteMsg?: any
    paymentRequestMessageKey?: any
    paymentStatus?: any
    paymentTransactionTimestamp?: any
    paymentTxnStatus?: any
    phoneUploading?: any
    pollInvalidated?: boolean
    pollName?: string
    pollOptions?: any
    pollSelectableOptionsCount?: number
    pollUpdateParentKey?: any
    priceAmount1000?: any
    privacyModeWhenSent?: any
    productHeaderImageRejected?: any
    productId?: any
    productImageCount?: any
    productListHeaderImage?: any
    productListItemCount?: any
    protocolMessageKey?: any
    proxyName: string
    quotedGroupSubject?: any
    quotedMsg?: MsgModel
    quotedMsgId?: MsgKey
    quotedMsgKey?: MsgKey
    quotedParentGroupJid?: any
    quotedParticipant?: any
    quotedRemoteJid?: any
    quotedStanzaID?: any
    recipients?: any
    recvFresh?: any
    replyButtons?: ButtonCollection
    retailerId?: any
    richPreviewType?: any
    rowId?: any
    rtl?: any
    salePriceAmount1000?: any
    scanLengths?: any
    scansSidecar?: any
    search?: any
    selectedButtonId?: string
    selectedId?: any
    selectedIndex?: any
    self?: string
    sellerJid?: any
    sendDeferred?: any
    sender?: WAJS.whatsapp.Wid
    senderObj?: any
    sequence?: number
    serverId?: number
    sessionId?: any
    shareDuration?: number
    size?: any
    speed?: number
    stale?: any
    star?: any
    startOfDay?: any
    startOfDaySkew?: any
    status?: any
    statusV3TextBg?: any
    streamable?: any
    streamingSidecar?: any
    subtype?: string
    supportsMessageFooter?: any
    supportsMessageFooterLinks?: any
    surface?: any
    t?: number
    templateParams?: any

    Optional Readonlytext

    text?: any
    textColor?: number
    thumbnail?: any
    thumbnailDirectPath?: any
    thumbnailEncSha256?: any
    thumbnailHeight?: any
    thumbnailHQ?: any
    thumbnailSha256?: any
    thumbnailWidth?: any
    title?: string
    to?: WAJS.whatsapp.Wid
    token?: any
    totalAmount1000?: any
    totalCurrencyCode?: any
    type?: string
    url?: any
    urlNumber?: string
    urlText?: string
    vcard?: any
    vcardFormattedName?: any
    vcardList?: any
    verifiedBizName?: any
    waveform?: any
    width?: any
    allowedIds?: any[]
    idClass?: any
    Proxy: string

    Methods

    • Parameters

      • id: Stringable
      • context: { [key: string]: any }

      Returns void

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Alias of on

      Parameters

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

      Returns this

      on

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • Optionale: any
      • Optionalt: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Alias of trigger

      Parameters

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

      Returns this

      trigger

    • Returns any

    • Type Parameters

      Parameters

      • attr: T

      Returns MsgModel[T]

    • Returns MsgCollection

    • Type Parameters

      Parameters

      • attr: T

      Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Parameters

      • Optionale: number

      Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      • Optionale: boolean

      Returns void

    • Returns void

    • Returns any

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      • eventName: Event

      Returns boolean

    • Parameters

      • Optionale: any

      Returns boolean

    • Parameters

      • Optionale: any

      Returns boolean

    • Returns boolean

    • Returns boolean

    • 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

    • 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

    • 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

    • Returns any

    • Returns any

    • Parameters

      Returns any

    • 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.

    • 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.

    • 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.

    • Returns any

    • Returns any

    • Returns any

      < 2.2245.8

    • Removes all listeners.

      Returns this

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

    • Alias of off

      Parameters

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

      Returns this

      off

    • Returns any

    • Returns void

    • Returns any

    • Returns any

    • Returns any

    • Returns Props

    • Parameters

      • ...args: any

      Returns any

    • Parameters

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

      Returns this

    • Returns Props

    • 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.

    • Alias of off

      Parameters

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

      Returns this

      off

    • Returns any

    • Parameters

      • ids: Stringable | Stringable[]
      • Optionalt: any

      Returns void

    • Parameters

      • Optionale: any
      • Optionalt: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Returns any

    • Parameters

      • e: any

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    accuracyackappStateFatalExceptionNotificationappStateSyncKeyRequestappStateSyncKeyShareasAlbumAssetasBroadcastNotificationasDocasGroupedStickerasGroupNotificationasImageasMmsasPollCreationasPollUpdateasProductasProductInquiryasRevokedasUrlasVideoasViewOnceasVisualMediaattributesauthorbackgroundColorbizPrivacyStatusbodybroadcastbroadcastEphSettingsbroadcastIdbroadcastParticipantsbusinessOwnerJidbuttonsbuttonsResponsecanonicalUrlcaptionchatclearMediaclientUrlcollectioncommentcontainsEmojictwaContextcurrencyCodedegreesdeprecatedMms3UrldescriptiondevicesAddeddevicesRemoveddirdirectPathdisappearingModeInitiatordoNotPlayInlinedurationdynamicReplyButtonsencFilehashephemeralDurationephemeralExpirationTimestampephemeralOutOfSyncephemeralSettingTimestampephemeralSharedSecretephemeralStartTimestampeventTypefilehashfilenamefinalAccuracyfinalDegreesfinalLatfinalLngfinalSpeedfinalThumbnailfinalTimeOffsetfirstFrameLengthfirstFrameSidecarfontfooterforwardedFromWebforwardingScorefromgifAttributionhasBodyOrFooterhasTemplateButtonsheighthistorySyncMetaDatahydratedButtonsididClassinitialPageSizeinteractiveAnnotationsinteractiveMessageinteractivePayloadinvisinviteCodeinviteCodeExpinviteGrpinviteGrpJpegThuminviteGrpNameisAnimatedisBizNotificationisCaptionByUserisDynamicReplyButtonsMsgisEphemeralisFailedisForwardedisFrequentlyForwardedisFromTemplateisFutureproofisGifisGroupMsgisGroupsV4InviteExpiredisInternationalisLiveisMdHistoryMsgisMediaisNewMsgisNotificationisPersistentisPSAisQuickReplyisQuotedMsgAvailableisRevokedByMeisRTLisSendFailureisSentByMeisSentByMeFromWebisStateisStatusV3isThisDeviceAddedisUnreadTypeisUnsentMediaisUserCreatedTypeisVcardOverMmsDocumentisViewOnceitemCountlabelslatlinkPreviewlinksIndexParsedlistlistResponselngloclocalmatchedTextmdDowngrademediaDatamediaKeymediaKeyTimestampmediaObjectmentionedJidListmessagemimetypemirrorMaskmsgChunkmulticastnativeFlowNamenotifyNamenumTimesForwardedorderIdorderTitlepageCountparentpaymentAmount1000paymentCurrencypaymentExpiryTimestamppaymentMessageReceiverJidpaymentNoteMsgpaymentRequestMessageKeypaymentStatuspaymentTransactionTimestamppaymentTxnStatusphoneUploadingpollInvalidatedpollNamepollOptionspollSelectableOptionsCountpollUpdateParentKeypriceAmount1000privacyModeWhenSentproductHeaderImageRejectedproductIdproductImageCountproductListHeaderImageproductListItemCountprotocolMessageKeyproxyNamequotedGroupSubjectquotedMsgquotedMsgIdquotedMsgKeyquotedParentGroupJidquotedParticipantquotedRemoteJidquotedStanzaIDrecipientsrecvFreshreplyButtonsretailerIdrichPreviewTyperowIdrtlsalePriceAmount1000scanLengthsscansSidecarsearchselectedButtonIdselectedIdselectedIndexselfsellerJidsendDeferredsendersenderObjsequenceserverIdsessionIdshareDurationsizespeedstalestarstartOfDaystartOfDaySkewstatusstatusV3TextBgstreamablestreamingSidecarsubtypesupportsMessageFootersupportsMessageFooterLinkssurfacettemplateParamstexttextColorthumbnailthumbnailDirectPaththumbnailEncSha256thumbnailHeightthumbnailHQthumbnailSha256thumbnailWidthtitletotokentotalAmount1000totalCurrencyCodetypeurlurlNumberurlTextvcardvcardFormattedNamevcardListverifiedBizNamewaveformwidthallowedIdsidClassProxy
    Methods
    addChildapplyUpdateavParamsbindcancelDownloadcancelUploadcanForwardcanPrivateReplycanPrivateReplyInRestrictedGrpcanQuickForwardcanReplycanRevokecanStarcleardecObserversdeletedisplayNamedownloadMediaemitforceRMRgetgetCollectiongetDefaultgetFooterLinksgetForwardingScoreWhenForwardedgetGalleryLinksgetHeaderLinksgetLinksgetLocObjectgetQuotedMsgAdminGroupJidgetSuspiciousLinksgetVcardWidsgetWamMediaTypegetWamMessageTypehasObservershasSymbolhasUnfiredChangesincObserversinitializeinteractiveButtonsReleasedisDownloadableisExpiredisForcingRMRisGroupLeaveisListeningisMentionedisQuotedisTrustedisUnsentPhoneMsglistenTolistenToAndRunlistenToOncemayFailmentionMapmsgContextInfooffononceonCiphertextDecryptedonViewOnceMediaStatusChangedquotedMsgObjremoveAllListenersremoveListenerresendresetresumeRemoteUploadresumeUploadsafeserializesetstopListeningtoJSONtriggerunbindunsafeunsetupdateAckupdateEphemeralStartTimestampwaitForPhoneUploadwaitForPrepisIdType