Class ChatModel

Whatsapp

63183

Hierarchy (view full)

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? 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? 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

constructor

Properties

OptionalackedProps

ackedProps?: any

Optionalactive

active?: any

Optionalarchive

archive?: any

OptionalattachMediaContents

attachMediaContents?: any

Readonlyattributes

attributes: Props & Session

canSend

canSend: boolean

ReadonlycanUnread

canUnread: boolean

OptionalchangeNumberNewJid

changeNumberNewJid?: any

OptionalchangeNumberOldJid

changeNumberOldJid?: any

Optionalcollection

collection?: ChatCollection

Optionalcolors

colors?: any

OptionalcomposeContents

composeContents?: any

OptionalcomposeQuotedMsg

composeQuotedMsg?: any

OptionalcomposeQuotedMsgRemoteJid

composeQuotedMsgRemoteJid?: any

Optionalcontact

contact?: any

OptionalcreatedLocally

createdLocally?: any

disableUnreadAnchor

disableUnreadAnchor: any

OptionaldisappearingModeInitiator

disappearingModeInitiator?: any

OptionaldocCount

docCount?: any

OptionalendOfHistoryTransfer

endOfHistoryTransfer?: any

OptionalendOfHistoryTransferType

endOfHistoryTransferType?: any

OptionalephemeralDuration

ephemeralDuration?: any

OptionalephemeralSettingTimestamp

ephemeralSettingTimestamp?: any

OptionalformattedTitle

formattedTitle?: string

OptionalftsCache

ftsCache?: any

OptionalgroupMetadata

groupMetadata?: GroupMetadataModel

hasEstablishedE2EESession

hasEstablishedE2EESession: boolean

ReadonlyhasUnread

hasUnread: boolean

Deprecated in favor of getHasUnread

Deprecated

id

id: Wid

idClass

idClass: typeof Wid

isAnnounceGrpRestrict

isAnnounceGrpRestrict: boolean

ReadonlyisBroadcast

isBroadcast: boolean

ReadonlyisGroup

isGroup: boolean

Deprecated in favor of getIsPSA

Deprecated

ReadonlyisNewsletter

isNewsletter: boolean

ReadonlyisParentGroup

isParentGroup: boolean

Deprecated in favor of getIsGroup

Deprecated

ReadonlyisPSA

isPSA: boolean

Deprecated in favor of getIsUser

Deprecated

isReadOnly

isReadOnly: boolean

ReadonlyisState

isState

ReadonlyisUser

isUser: boolean

Optional Readonlykind

kind?: any

Optionallabels

labels?: string[]

OptionallastReceivedKey

lastReceivedKey?: MsgKey

OptionallinkCount

linkCount?: any

OptionalliveLocation

liveLocation?: any

OptionalliveLocationQueried

liveLocationQueried?: any

OptionalmarkedUnread

markedUnread?: any

OptionalmediaCount

mediaCount?: any

ReadonlymirrorMask

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

OptionalmodifyTag

modifyTag?: any

msgChunks

msgChunks: MsgLoad[]

msgs

msgs: MsgLoad

msgsChanged

msgsChanged: number

msgsLength

msgsLength: number

OptionalmsgUnsyncedButtonReplyMsgs

msgUnsyncedButtonReplyMsgs?: any

mute

mute: MuteModel

OptionalmuteExpiration

muteExpiration?: any

Optionalname

name?: string

OptionalnotSpam

notSpam?: any

Optional ReadonlyoptimisticUnreadCount

optimisticUnreadCount?: any

Optionalparent

parent?: any

OptionalpausedTimerId

pausedTimerId?: any

OptionalpendingAction

pendingAction?: any

OptionalpendingInitialLoading

pendingInitialLoading?: any

pendingMsgs

pendingMsgs: boolean

OptionalpendingSeenCount

pendingSeenCount?: any

Optionalpin

pin?: any

Optionalpresence

presence?: any

OptionalpresenceResendTimerId

presenceResendTimerId?: any

Optional ReadonlypreviewMessage

previewMessage?: any

Deprecated in favor of getPreviewMessage

Deprecated

OptionalproductCount

productCount?: any

promises

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

proxyName

proxyName: string

OptionalquotedMsgAdminGroupJid

quotedMsgAdminGroupJid?: any

Optionalrecording

recording?: any

Optional ReadonlyshouldAppearInList

shouldAppearInList?: any

Deprecated in favor of getShouldAppearInList

Deprecated

Optional ReadonlyshouldShowUnreadDivider

shouldShowUnreadDivider?: any

Deprecated in favor of getShouldShowUnreadDivider

Deprecated

Optional ReadonlyshouldShowUnreadInTitle

shouldShowUnreadInTitle?: any

Optional ReadonlyshowChangeNumberNotification

showChangeNumberNotification?: any

Deprecated in favor of getShowChangeNumberNotification

Deprecated

Optionalsquelch

squelch?: any

Optionalstale

stale?: any

Optionalt

t?: number

Optionaltrusted

trusted?: any

Optionaltyping

typing?: any

unreadCount

unreadCount: number

OptionalunreadMentionsOfMe

unreadMentionsOfMe?: any

unreadMsgAnchor

unreadMsgAnchor: any

OptionalvcardDismissed

vcardDismissed?: any

Static OptionalallowedIds

allowedIds?: any[]

Static OptionalidClass

idClass?: any

StaticProxy

Proxy: string

Methods

addChild

addMediaMsgs

assignedColor

bind

canArchive

cancelPendingPromises

canPin

canSenderRevoke

clear

constructMediaMsgs

decObservers

decPending

delete

deleteMsgs

deleteMsgsBeforeMsgInclusive

deleteMsgsOlderThan

deleteMsgsPartial

deregisterExpiredViewOnceBulkMessages

dismissVcard

emit

forwardMessages

fts

get

getAckedPhoneProps

getAllCMCs

getAllMsgs

getCollection

getComposeContents

getDefault

getDisappearingModeInitiator

getDocMsgs

getEphemeralSetting

getEphemeralSettingTimestamp

getFirstMsgWithStatus

getGroupMetadataCollection

getLastMsgKeyForAction

getLastReceivedMsg

getLastReceivedNonExpiredMsg

getLastTimestampMsg

getLinkMsgs

getMediaMsgs

getParticipantCount

getProductMsgs

getReceivedVcardMsgs

OptionalgetSearchContext

  • getSearchContext(msg, options?): {
        collection: MsgLoad;
        highlightMsg: true;
        key?: MsgKey;
        msg?: MsgModel;
    }

  • Parameters

    • msg: MsgModel | MsgKey
    • Optionaloptions: {
          isQuotedMsgAvailable: boolean;
      }
      • isQuotedMsgAvailable: boolean

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

getSessionPersistedComposeContents

getStarredMsgs

getWebcChatType

hasMaybeSentMsgToChat

hasObservers

hasUnfiredChanges

incObservers

initialize

isDirty

isEphemeralSettingOn

isListening

isMostRecentCMC

isMsgForMediaCollection

isSupportGroup

isTrusted

listenTo

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

  • Parameters

    • context: any

      The value of this provided for the call to listener

    • eventName: Event

      The name of the event.

    • Optionallistener: Listener

      The callback function.

    Returns this

listenToAndRun

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

  • Parameters

    • context: any

      The value of this provided for the call to listener

    • eventName: Event

      The name of the event.

    • Optionallistener: Listener

      The callback function.

    Returns this

listenToOnce

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

  • Parameters

    • context: any

      The value of this provided for the call to listener

    • eventName: Event

      The name of the event.

    • Optionallistener: Listener

      The callback function.

    Returns this

loadAssignedColors

loadEarlierMsgs

loadRecentMsgs

matchFilter

notifyMsgCollectionMerge

off

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

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

    Parameters

    • OptionaleventName: Event

      The name of the event.

    • Optionallistener: Listener

      The callback function.

    • Optionalcontext: any

      The value of this provided for the call to listener

    Returns this

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

on

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

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

    Parameters

    • eventName: Event

      The name of the event.

    • listener: Listener

      The callback function.

    • Optionalcontext: any

      The value of this provided for the call to listener

    Returns this

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

onActiveUpdate

once

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

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

    Parameters

    • eventName: Event

      The name of the event.

    • listener: Listener

      The callback function.

    • Optionalcontext: any

      The value of this provided for the call to listener

    Returns this

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

onEmptyMRM

onNewMsg

onNotSpamChange

onPendingActionUpdate

preload

regCancellablePromise

removeAllListeners

removeFromCollection

removeListener

removeMsg

removeMsgsCollection

replaceMsgsCollection

reset

resetMediaMsgs

resetMediasCount

saveAssignedColors

sendDeleteMsgs

sendDismissChangeNumber

sendGroupInviteMessage

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

  • Parameters

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

    Returns any

sendRevokeMsgs

serialize

set

setAndKeepPrevious

setAttachMediaContents

setComposeContents

shouldShowEphemeralSetting

sortMsgs

stopListening

title

toJSON

trigger

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

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

    Parameters

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

    Returns this

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

unbind

unset

unstarAll

updateCanSend

updateIsAnnounceGrpRestrict

updateMediasCountOnMsg

updateMuteExpiration

updateReadOnly

updateSortTime

updateTitle

waitForChatLoading

StaticisIdType

Settings

Member Visibility

On This Page

Constructors
Properties
ackedPropsactivearchiveattachMediaContentsattributescanSendcanUnreadchangeNumberNewJidchangeNumberOldJidcollectioncolorscomposeContentscomposeQuotedMsgcomposeQuotedMsgRemoteJidcontactcreatedLocallydisableUnreadAnchordisappearingModeInitiatordocCountendOfHistoryTransferendOfHistoryTransferTypeephemeralDurationephemeralSettingTimestampformattedTitleftsCachegroupMetadatahasEstablishedE2EESessionhasUnreadididClassisAnnounceGrpRestrictisBroadcastisGroupisNewsletterisParentGroupisPSAisReadOnlyisStateisUserkindlabelslastReceivedKeylinkCountliveLocationliveLocationQueriedmarkedUnreadmediaCountmirrorMaskmodifyTagmsgChunksmsgsmsgsChangedmsgsLengthmsgUnsyncedButtonReplyMsgsmutemuteExpirationnamenotSpamoptimisticUnreadCountparentpausedTimerIdpendingActionpendingInitialLoadingpendingMsgspendingSeenCountpinpresencepresenceResendTimerIdpreviewMessageproductCountpromisesproxyNamequotedMsgAdminGroupJidrecordingshouldAppearInListshouldShowUnreadDividershouldShowUnreadInTitleshowChangeNumberNotificationsquelchstalettrustedtypingunreadCountunreadMentionsOfMeunreadMsgAnchorvcardDismissedallowedIdsidClassProxy
Methods
addChildaddMediaMsgsassignedColorbindcanArchivecancelPendingPromisescanPincanSenderRevokeclearconstructMediaMsgsdecObserversdecPendingdeletedeleteMsgsdeleteMsgsBeforeMsgInclusivedeleteMsgsOlderThandeleteMsgsPartialderegisterExpiredViewOnceBulkMessagesdismissVcardemitforwardMessagesftsgetgetAckedPhonePropsgetAllCMCsgetAllMsgsgetCollectiongetComposeContentsgetDefaultgetDisappearingModeInitiatorgetDocMsgsgetEphemeralSettinggetEphemeralSettingTimestampgetFirstMsgWithStatusgetGroupMetadataCollectiongetLastMsgKeyForActiongetLastReceivedMsggetLastReceivedNonExpiredMsggetLastTimestampMsggetLinkMsgsgetMediaMsgsgetParticipantCountgetProductMsgsgetReceivedVcardMsgsgetSearchContextgetSessionPersistedComposeContentsgetStarredMsgsgetWebcChatTypehasMaybeSentMsgToChathasObservershasUnfiredChangesincObserversinitializeisDirtyisEphemeralSettingOnisListeningisMostRecentCMCisMsgForMediaCollectionisSupportGroupisTrustedlistenTolistenToAndRunlistenToOnceloadAssignedColorsloadEarlierMsgsloadRecentMsgsmatchFilternotifyMsgCollectionMergeoffononActiveUpdateonceonEmptyMRMonNewMsgonNotSpamChangeonPendingActionUpdatepreloadregCancellablePromiseremoveAllListenersremoveFromCollectionremoveListenerremoveMsgremoveMsgsCollectionreplaceMsgsCollectionresetresetMediaMsgsresetMediasCountsaveAssignedColorssendDeleteMsgssendDismissChangeNumbersendGroupInviteMessagesendRevokeMsgsserializesetsetAndKeepPrevioussetAttachMediaContentssetComposeContentsshouldShowEphemeralSettingsortMsgsstopListeningtitletoJSONtriggerunbindunsetunstarAllupdateCanSendupdateIsAnnounceGrpRestrictupdateMediasCountOnMsgupdateMuteExpirationupdateReadOnlyupdateSortTimeupdateTitlewaitForChatLoadingisIdType