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

    Class ChatModel

    63183

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    ackedProps? active? archive? attachMediaContents? attributes canSend canUnread changeNumberNewJid? changeNumberOldJid? collection? colors? composeContents? composeQuotedMsg? composeQuotedMsgRemoteJid? contact? createdLocally? disableUnreadAnchor disappearingModeInitiator? docCount? endOfHistoryTransfer? endOfHistoryTransferType? ephemeralDuration? ephemeralSettingTimestamp? formattedTitle? ftsCache? groupMetadata? groupSafetyChecked? groupType? hasEstablishedE2EESession hasUnread id idClass isAnnounceGrpRestrict isBroadcast isGroup isNewsletter isParentGroup isPSA isReadOnly isState isUser kind? labels? lastReceivedKey? linkCount? liveLocation? liveLocationQueried? markedUnread? mediaCount? mirrorMask modifyTag? msgChunks msgs msgsChanged msgsLength msgUnsyncedButtonReplyMsgs? mute muteExpiration? name? newsletterMetadata? notSpam? optimisticUnreadCount? parent? pausedTimerId? pendingAction? pendingInitialLoading? pendingMsgs pendingSeenCount? pin? presence? presenceResendTimerId? previewMessage? productCount? promises proxyName quotedMsgAdminGroupJid? recording? shouldAppearInList? shouldShowUnreadDivider? shouldShowUnreadInTitle? showChangeNumberNotification? squelch? stale? t? trusted? typing? unreadCount unreadMentionsOfMe? unreadMsgAnchor vcardDismissed? allowedIds? idClass? Proxy

    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 getSearchContext? getSessionPersistedComposeContents getStarredMsgs getWebcChatType hasMaybeSentMsgToChat hasObservers hasUnfiredChanges incObservers initialize isDirty isEphemeralSettingOn isListening isMostRecentCMC isMsgForMediaCollection isSupportGroup isTrusted listenTo listenToAndRun listenToOnce loadAssignedColors loadEarlierMsgs loadRecentMsgs matchFilter notifyMsgCollectionMerge off on onActiveUpdate once onEmptyMRM onNewMsg onNotSpamChange onPendingActionUpdate preload regCancellablePromise removeAllListeners removeFromCollection removeListener removeMsg removeMsgsCollection replaceMsgsCollection reset resetMediaMsgs resetMediasCount saveAssignedColors sendDeleteMsgs sendDismissChangeNumber sendGroupInviteMessage sendRevokeMsgs serialize set setAndKeepPrevious setAttachMediaContents setComposeContents shouldShowEphemeralSetting sortMsgs stopListening title toJSON trigger unbind unset unstarAll updateCanSend updateIsAnnounceGrpRestrict updateMediasCountOnMsg updateMuteExpiration updateReadOnly updateSortTime updateTitle waitForChatLoading isIdType

    Constructors

    Properties

    ackedProps?: any
    active?: any
    archive?: boolean
    attachMediaContents?: any
    attributes: Props & Session
    canSend: boolean
    canUnread: boolean
    changeNumberNewJid?: any
    changeNumberOldJid?: any
    collection?: ChatCollection
    colors?: any
    composeContents?: any
    composeQuotedMsg?: any
    composeQuotedMsgRemoteJid?: any
    contact?: any
    createdLocally?: any
    disableUnreadAnchor: any
    disappearingModeInitiator?: any
    docCount?: any
    endOfHistoryTransfer?: any
    endOfHistoryTransferType?: any
    ephemeralDuration?: any
    ephemeralSettingTimestamp?: any
    formattedTitle?: string
    ftsCache?: any
    groupMetadata?: GroupMetadataModel
    groupSafetyChecked?: boolean
    groupType?: any
    hasEstablishedE2EESession: boolean
    hasUnread: boolean

    Deprecated in favor of getHasUnread

    id: WAJS.whatsapp.Wid
    idClass: typeof WAJS.whatsapp.Wid
    isAnnounceGrpRestrict: boolean
    isBroadcast: boolean
    isGroup: boolean

    Deprecated in favor of getIsPSA

    isNewsletter: boolean
    isParentGroup: boolean

    Deprecated in favor of getIsGroup

    isPSA: boolean

    Deprecated in favor of getIsUser

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

    Deprecated in favor of getPreviewMessage

    productCount?: any
    promises: { [key: string]: Promise<any> }
    proxyName: string
    quotedMsgAdminGroupJid?: any
    recording?: any
    shouldAppearInList?: any

    Deprecated in favor of getShouldAppearInList

    shouldShowUnreadDivider?: any

    Deprecated in favor of getShouldShowUnreadDivider

    shouldShowUnreadInTitle?: any
    showChangeNumberNotification?: any

    Deprecated in favor of getShowChangeNumberNotification

    squelch?: any
    stale?: any
    t?: number
    trusted?: any
    typing?: any
    unreadCount: number
    unreadMentionsOfMe?: any
    unreadMsgAnchor: any
    vcardDismissed?: any
    allowedIds?: any[]
    idClass?: any
    Proxy: string

    Methods

    • Parameters

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

      Returns void

    • Parameters

      • Optionale: any
      • Optionalt: any

      Returns any

    • Parameters

      • Optionale: 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 void

    • Parameters

      • Optionale: any

      Returns any

    • Returns void

    • Returns any

    • Returns void

    • Parameters

      • Optionale: any
      • Optionalt: any

      Returns any

    • Parameters

      • Optionale: any
      • Optionalt: boolean
      • Optionalr: any

      Returns any

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any

      Returns any

    • Parameters

      • Optionale: any
      • Optionalt: boolean

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Alias of trigger

      Parameters

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

      Returns this

      trigger

    • Parameters

      • msgs: MsgModel[]
      • Optionalmulticast: any
      • OptionaldisplayCaptionText: boolean

      Returns any

    • Parameters

      • Optionale: any
      • Optionalt: boolean
      • Optionalr: any

      Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Type Parameters

      Parameters

      • attr: T

      Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns MsgKey

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Parameters

      Returns { collection: MsgLoad; highlightMsg: true; key?: MsgKey; msg?: MsgModel }

    • Returns any

    • Returns any

    • Returns any

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      • Optionale: boolean

      Returns void

    • Returns void

    • 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

    • Parameters

      • Optionale: any
      • Optionalt: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any
      • Optionalt: any
      • Optionalr: any
      • Optionala: any

      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.

    • Returns any

    • 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

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Returns any

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Removes all listeners.

      Returns this

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

    • Parameters

      • Optionale: any

      Returns any

    • Alias of off

      Parameters

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

      Returns this

      off

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns void

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Parameters

      • messages: MsgModel[]
      • OptionaldeleteMediaInDevice: boolean

      Returns Promise<SendMsgResult>

    • Returns any

    • Parameters

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

      Returns any

    • Parameters

      • messages: MsgModel[]
      • OptionaldeleteMediaInDevice: boolean

      Returns Promise<SendMsgResult>

    • Parameters

      • messages: MsgModel[]
      • sender: string
      • OptionaldeleteMediaInDevice: boolean

      Returns Promise<SendMsgResult>

    • Returns Props

    • Parameters

      • ...args: any

      Returns any

    • Parameters

      • Optionale: any
      • Optionalt: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

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

      Returns this

    • Returns any

    • 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

    • Parameters

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

      Returns void

    • Returns any

    • Returns any

    • Returns any

    • Parameters

      • Optionale: any
      • Optionalt: boolean

      Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Parameters

      • e: any

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    ackedPropsactivearchiveattachMediaContentsattributescanSendcanUnreadchangeNumberNewJidchangeNumberOldJidcollectioncolorscomposeContentscomposeQuotedMsgcomposeQuotedMsgRemoteJidcontactcreatedLocallydisableUnreadAnchordisappearingModeInitiatordocCountendOfHistoryTransferendOfHistoryTransferTypeephemeralDurationephemeralSettingTimestampformattedTitleftsCachegroupMetadatagroupSafetyCheckedgroupTypehasEstablishedE2EESessionhasUnreadididClassisAnnounceGrpRestrictisBroadcastisGroupisNewsletterisParentGroupisPSAisReadOnlyisStateisUserkindlabelslastReceivedKeylinkCountliveLocationliveLocationQueriedmarkedUnreadmediaCountmirrorMaskmodifyTagmsgChunksmsgsmsgsChangedmsgsLengthmsgUnsyncedButtonReplyMsgsmutemuteExpirationnamenewsletterMetadatanotSpamoptimisticUnreadCountparentpausedTimerIdpendingActionpendingInitialLoadingpendingMsgspendingSeenCountpinpresencepresenceResendTimerIdpreviewMessageproductCountpromisesproxyNamequotedMsgAdminGroupJidrecordingshouldAppearInListshouldShowUnreadDividershouldShowUnreadInTitleshowChangeNumberNotificationsquelchstalettrustedtypingunreadCountunreadMentionsOfMeunreadMsgAnchorvcardDismissedallowedIdsidClassProxy
    Methods
    addChildaddMediaMsgsassignedColorbindcanArchivecancelPendingPromisescanPincanSenderRevokeclearconstructMediaMsgsdecObserversdecPendingdeletedeleteMsgsdeleteMsgsBeforeMsgInclusivedeleteMsgsOlderThandeleteMsgsPartialderegisterExpiredViewOnceBulkMessagesdismissVcardemitforwardMessagesftsgetgetAckedPhonePropsgetAllCMCsgetAllMsgsgetCollectiongetComposeContentsgetDefaultgetDisappearingModeInitiatorgetDocMsgsgetEphemeralSettinggetEphemeralSettingTimestampgetFirstMsgWithStatusgetGroupMetadataCollectiongetLastMsgKeyForActiongetLastReceivedMsggetLastReceivedNonExpiredMsggetLastTimestampMsggetLinkMsgsgetMediaMsgsgetParticipantCountgetProductMsgsgetReceivedVcardMsgsgetSearchContextgetSessionPersistedComposeContentsgetStarredMsgsgetWebcChatTypehasMaybeSentMsgToChathasObservershasUnfiredChangesincObserversinitializeisDirtyisEphemeralSettingOnisListeningisMostRecentCMCisMsgForMediaCollectionisSupportGroupisTrustedlistenTolistenToAndRunlistenToOnceloadAssignedColorsloadEarlierMsgsloadRecentMsgsmatchFilternotifyMsgCollectionMergeoffononActiveUpdateonceonEmptyMRMonNewMsgonNotSpamChangeonPendingActionUpdatepreloadregCancellablePromiseremoveAllListenersremoveFromCollectionremoveListenerremoveMsgremoveMsgsCollectionreplaceMsgsCollectionresetresetMediaMsgsresetMediasCountsaveAssignedColorssendDeleteMsgssendDismissChangeNumbersendGroupInviteMessagesendRevokeMsgsserializesetsetAndKeepPrevioussetAttachMediaContentssetComposeContentsshouldShowEphemeralSettingsortMsgsstopListeningtitletoJSONtriggerunbindunsetunstarAllupdateCanSendupdateIsAnnounceGrpRestrictupdateMediasCountOnMsgupdateMuteExpirationupdateReadOnlyupdateSortTimeupdateTitlewaitForChatLoadingisIdType