Class ContactModel

121

400121 >= 2.2222.8

Hierarchy (View Summary)

ModelProxy<Props, Session, Derived>
Model<ContactCollection>
- ContactModel

Index

Constructors

Properties

attributes businessCatalog? businessProfile? canRequestPhoneNumber collection? commonGroups? disappearingModeDuration? disappearingModeSettingTimestamp? displayName? displayNameOrPnForLid? formattedName? formattedPhone? formattedShortName? formattedShortNameWithNonBreakingSpaces? formattedUser? header? id idClass isBroadcast isBusiness isContactBlocked isDisplayNameApproved? isEnterprise isGroup isIAS isMe isMyContact isNewsletter isPSA isState isSupportAccount isUser isWAContact labels? liveLocations? locale? mentionName? mirrorMask name? notifyName? parent? pendingAction? pnForLid? premiumMessageName? privacyMode? profilePicThumb? promises? proxyName pushname? searchName? searchVerifiedName? sectionHeader? shortName? shouldForceBusinessUpdate? showBusinessCheckmarkAsPrimary? showBusinessCheckmarkAsSecondary? showBusinessCheckmarkInChatlist? stale? status? statusMute? type? userhash? userid? verificationBinary? verificationString? verifiedLevel? verifiedName? allowedIds? idClass? Proxy

Constructors

constructor

new ContactModel(
proterties?: ModelPropertiesContructor<ContactModel>,
options?: ModelOptions,
): ContactModel
Parameters
- Optionalproterties: ModelPropertiesContructor<ContactModel>
- Optionaloptions: ModelOptions
Returns ContactModel
Inherited from Model.constructor
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:223

Properties

`Readonly`attributes

attributes: Props & Session

`Optional`businessCatalog

businessCatalog?: any

`Optional`businessProfile

businessProfile?: any

`Readonly`canRequestPhoneNumber

canRequestPhoneNumber: boolean

Deprecated in favor of getCanRequestPhoneNumber

Deprecated

`Optional`collection

collection?: ContactCollection

`Optional`commonGroups

commonGroups?: any

`Optional`disappearingModeDuration

disappearingModeDuration?: any

`Optional`disappearingModeSettingTimestamp

disappearingModeSettingTimestamp?: any

`Optional` `Readonly`displayName

displayName?: any

Deprecated in favor of getDisplayName

Deprecated

`Optional` `Readonly`displayNameOrPnForLid

displayNameOrPnForLid?: any

Deprecated in favor of getDisplayNameOrPnForLid

Deprecated

`Optional` `Readonly`formattedName

formattedName?: any

Deprecated in favor of getFormattedName

Deprecated

`Optional` `Readonly`formattedPhone

formattedPhone?: any

Deprecated in favor of getFormattedPhone

Deprecated

`Optional` `Readonly`formattedShortName

formattedShortName?: any

Deprecated in favor of getFormattedShortName

Deprecated

`Optional` `Readonly`formattedShortNameWithNonBreakingSpaces

formattedShortNameWithNonBreakingSpaces?: any

Deprecated in favor of getFormattedShortNameWithNonBreakingSpaces

Deprecated

`Optional` `Readonly`formattedUser

formattedUser?: any

Deprecated in favor of getFormattedUser

Deprecated

`Optional` `Readonly`header

header?: any

Deprecated in favor of getHeader

Deprecated

id

id: WAJS.whatsapp.Wid

idClass

idClass: typeof WAJS.whatsapp.Wid

`Readonly`isBroadcast

isBroadcast: boolean

Deprecated in favor of getIsBroadcast

Deprecated

isBusiness

isBusiness: boolean

isContactBlocked

isContactBlocked: boolean

`Optional` `Readonly`isDisplayNameApproved

isDisplayNameApproved?: any

Deprecated in favor of getIsDisplayNameApproved

Deprecated

isEnterprise

isEnterprise: boolean

`Readonly`isGroup

isGroup: boolean

Deprecated in favor of getIsGroup

Deprecated

`Readonly`isIAS

isIAS: boolean

Deprecated in favor of getIsIAS

Deprecated

`Readonly`isMe

isMe: boolean

Deprecated in favor of getIsMe

Deprecated

`Readonly`isMyContact

isMyContact: boolean

Deprecated in favor of getIsMyContact

Deprecated

`Readonly`isNewsletter

isNewsletter: boolean

Deprecated in favor of getIsBroadcast

Deprecated

`Readonly`isPSA

isPSA: boolean

Deprecated in favor of getIsPSA

Deprecated

`Readonly`isState

isState: true

`Readonly`isSupportAccount

isSupportAccount: boolean

Deprecated in favor of getIsSupportAccount

Deprecated

`Readonly`isUser

isUser: boolean

Deprecated in favor of getIsUser

Deprecated

`Readonly`isWAContact

isWAContact: boolean

Deprecated in favor of getIsWAContact

Deprecated

`Optional`labels

labels?: string[]

`Optional`liveLocations

liveLocations?: any

`Optional`locale

locale?: any

`Optional` `Readonly`mentionName

mentionName?: any

Deprecated in favor of getMentionName

Deprecated

`Readonly`mirrorMask

mirrorMask: {
    "change:businessCatalog"?: number;
    "change:businessProfile"?: number;
    "change:canRequestPhoneNumber": number;
    "change:commonGroups"?: number;
    "change:disappearingModeDuration"?: number;
    "change:disappearingModeSettingTimestamp"?: number;
    "change:displayName"?: number;
    "change:displayNameOrPnForLid"?: number;
    "change:formattedName"?: number;
    "change:formattedPhone"?: number;
    "change:formattedShortName"?: number;
    "change:formattedShortNameWithNonBreakingSpaces"?: number;
    "change:formattedUser"?: number;
    "change:header"?: number;
    "change:id": number;
    "change:isBroadcast": number;
    "change:isBusiness": number;
    "change:isContactBlocked": number;
    "change:isDisplayNameApproved"?: number;
    "change:isEnterprise": number;
    "change:isGroup": number;
    "change:isIAS": number;
    "change:isMe": number;
    "change:isMyContact": number;
    "change:isNewsletter": number;
    "change:isPSA": number;
    "change:isSupportAccount": number;
    "change:isUser": number;
    "change:isWAContact": number;
    "change:labels"?: number;
    "change:liveLocations"?: number;
    "change:locale"?: number;
    "change:mentionName"?: number;
    "change:name"?: number;
    "change:notifyName"?: number;
    "change:pendingAction"?: number;
    "change:pnForLid"?: number;
    "change:premiumMessageName"?: number;
    "change:privacyMode"?: number;
    "change:profilePicThumb"?: number;
    "change:promises"?: number;
    "change:pushname"?: number;
    "change:searchName"?: number;
    "change:searchVerifiedName"?: number;
    "change:sectionHeader"?: number;
    "change:shortName"?: number;
    "change:shouldForceBusinessUpdate"?: number;
    "change:showBusinessCheckmarkAsPrimary"?: number;
    "change:showBusinessCheckmarkAsSecondary"?: number;
    "change:showBusinessCheckmarkInChatlist"?: number;
    "change:stale"?: number;
    "change:status"?: number;
    "change:statusMute"?: number;
    "change:type"?: number;
    "change:userhash"?: number;
    "change:userid"?: number;
    "change:verificationBinary"?: number;
    "change:verificationString"?: number;
    "change:verifiedLevel"?: number;
    "change:verifiedName"?: number;
}

`Optional`name

name?: any

`Optional` `Readonly`notifyName

notifyName?: any

Deprecated in favor of getNotifyName

Deprecated

`Optional`parent

parent?: any

`Optional`pendingAction

pendingAction?: any

`Optional` `Readonly`pnForLid

pnForLid?: any

Deprecated in favor of getPnForLid

Deprecated

`Optional` `Readonly`premiumMessageName

premiumMessageName?: any

Deprecated in favor of getPremiumMessageName

Deprecated

`Optional`privacyMode

privacyMode?: any

`Optional`profilePicThumb

profilePicThumb?: any

`Optional`promises

promises?: any

proxyName

proxyName: string

`Optional`pushname

pushname?: any

`Optional` `Readonly`searchName

searchName?: any

Deprecated in favor of getSearchName

Deprecated

`Optional` `Readonly`searchVerifiedName

searchVerifiedName?: any

Deprecated in favor of getSearchVerifiedName

Deprecated

`Optional`sectionHeader

sectionHeader?: any

`Optional`shortName

shortName?: any

`Optional` `Readonly`shouldForceBusinessUpdate

shouldForceBusinessUpdate?: any

Deprecated in favor of getShouldForceBusinessUpdate

Deprecated

`Optional` `Readonly`showBusinessCheckmarkAsPrimary

showBusinessCheckmarkAsPrimary?: any

Deprecated in favor of getShowBusinessCheckmarkAsPrimary

Deprecated

`Optional` `Readonly`showBusinessCheckmarkAsSecondary

showBusinessCheckmarkAsSecondary?: any

Deprecated in favor of getShowBusinessCheckmarkAsSecondary

Deprecated

`Optional` `Readonly`showBusinessCheckmarkInChatlist

showBusinessCheckmarkInChatlist?: any

Deprecated in favor of getShowBusinessCheckmarkInChatlist

Deprecated

`Optional`stale

stale?: any

`Optional`status

status?: any

`Optional`statusMute

statusMute?: any

`Optional`type

type?: any

`Optional` `Readonly`userhash

userhash?: any

Deprecated in favor of getUserhash

Deprecated

`Optional` `Readonly`userid

userid?: any

Deprecated in favor of getUserid

Deprecated

`Optional`verificationBinary

verificationBinary?: any

`Optional`verificationString

verificationString?: any

`Optional`verifiedLevel

verifiedLevel?: any

`Optional`verifiedName

verifiedName?: 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 node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:51

addPendingAction

addPendingAction(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:227

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:85

clear

clear(): void
Returns void
Inherited from Model.clear
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:58

decObservers

decObservers(): void
Returns void
Inherited from Model.decObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:49

decPending

decPending(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:228

delete

delete(): void
Returns void
Inherited from Model.delete
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:59

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:105

get

get<T extends keyof ContactModel>(attr: T): ContactModel[T]
Type Parameters
- T extends keyof ContactModel
Parameters
- attr: T
Returns ContactModel[T]
Inherited from Model.get
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:54

getCollection

getCollection(): ContactCollection
Returns ContactCollection
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:232

getDefault

getDefault<T extends keyof ContactModel>(attr: T): any
Type Parameters
- T extends keyof ContactModel
Parameters
- attr: T
Returns any
Inherited from Model.getDefault
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:61

getFormattedUser

getFormattedUser(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:231

getProfilePicThumb

getProfilePicThumb(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:226

getStatus

getStatus(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:225

hasObservers

hasObservers(): boolean
Returns boolean
Inherited from Model.hasObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:50

hasUnfiredChanges

hasUnfiredChanges(): boolean
Returns boolean
Inherited from Model.hasUnfiredChanges
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:56

incObservers

incObservers(e?: boolean): void
Parameters
- Optionale: boolean
Returns void
Inherited from Model.incObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:48

initialize

initialize(): void
Returns void
Inherited from Model.initialize
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:47

isBlocked

isBlocked(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:229

isListening

isListening(eventName: Event): boolean
Parameters
- eventName: Event
Returns boolean
Inherited from Model.isListening
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:80

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:67

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:79

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:73

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:55

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:37

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:46

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:100

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:95

reset

reset(): void
Returns void
Inherited from Model.reset
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:60

searchMatch

searchMatch(e?: any, t?: any, r?: any): any
Parameters
- Optionale: any
- Optionalt: any
- Optionalr: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:230

serialize

serialize(): Props
Returns Props
Inherited from ModelProxy.serialize
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:26

set

set(...args: any): any
Parameters
- ...args: any
Returns any
Inherited from Model.set
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:55

setNotMyContact

setNotMyContact(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:233

stopListening

stopListening(context?: any, eventName?: Event, listener?: Listener): this
Parameters
- Optionalcontext: any
- OptionaleventName: Event
- Optionallistener: Listener
Returns this
Inherited from Model.stopListening
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:61

toJSON

toJSON(): Props
Returns Props
Inherited from ModelProxy.toJSON
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:25

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:60

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 node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:90

unset

unset(ids: Stringable | Stringable[], t?: any): void
Parameters
- ids: Stringable | Stringable[]
- Optionalt: any
Returns void
Inherited from Model.unset
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:57

updateShortName

updateShortName(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ContactModel.d.ts:224

`Static`isIdType

isIdType(e: any): boolean
Parameters
- e: any
Returns boolean
Inherited from Model.isIdType
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:62

Class ContactModel

Whatsapp

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ContactModel

Properties

Readonlyattributes

OptionalbusinessCatalog

OptionalbusinessProfile

ReadonlycanRequestPhoneNumber

Deprecated

Optionalcollection

OptionalcommonGroups

OptionaldisappearingModeDuration

OptionaldisappearingModeSettingTimestamp

Optional ReadonlydisplayName

Deprecated

Optional ReadonlydisplayNameOrPnForLid

Deprecated

Optional ReadonlyformattedName

Deprecated

Optional ReadonlyformattedPhone

Deprecated

Optional ReadonlyformattedShortName

Deprecated

Optional ReadonlyformattedShortNameWithNonBreakingSpaces

Deprecated

Optional ReadonlyformattedUser

Deprecated

Optional Readonlyheader

Deprecated

id

idClass

ReadonlyisBroadcast

Deprecated

isBusiness

isContactBlocked

Optional ReadonlyisDisplayNameApproved

Deprecated

isEnterprise

ReadonlyisGroup

Deprecated

ReadonlyisIAS

Deprecated

ReadonlyisMe

Deprecated

ReadonlyisMyContact

Deprecated

ReadonlyisNewsletter

Deprecated

ReadonlyisPSA

Deprecated

ReadonlyisState

ReadonlyisSupportAccount

Deprecated

ReadonlyisUser

Deprecated

ReadonlyisWAContact

Deprecated

Optionallabels

OptionalliveLocations

Optionallocale

Optional ReadonlymentionName

Deprecated

ReadonlymirrorMask

Optionalname

Optional ReadonlynotifyName

Deprecated

Optionalparent

OptionalpendingAction

Optional ReadonlypnForLid

Deprecated

Optional ReadonlypremiumMessageName

`Readonly`attributes

`Optional`businessCatalog

`Optional`businessProfile

`Readonly`canRequestPhoneNumber

`Optional`collection

`Optional`commonGroups

`Optional`disappearingModeDuration

`Optional`disappearingModeSettingTimestamp

`Optional` `Readonly`displayName

`Optional` `Readonly`displayNameOrPnForLid

`Optional` `Readonly`formattedName

`Optional` `Readonly`formattedPhone

`Optional` `Readonly`formattedShortName

`Optional` `Readonly`formattedShortNameWithNonBreakingSpaces

`Optional` `Readonly`formattedUser

`Optional` `Readonly`header

`Readonly`isBroadcast

`Optional` `Readonly`isDisplayNameApproved

`Readonly`isGroup

`Readonly`isIAS

`Readonly`isMe

`Readonly`isMyContact

`Readonly`isNewsletter

`Readonly`isPSA

`Readonly`isState

`Readonly`isSupportAccount

`Readonly`isUser

`Readonly`isWAContact

`Optional`labels

`Optional`liveLocations

`Optional`locale

`Optional` `Readonly`mentionName

`Readonly`mirrorMask

`Optional`name

`Optional` `Readonly`notifyName

`Optional`parent

`Optional`pendingAction

`Optional` `Readonly`pnForLid

`Optional` `Readonly`premiumMessageName

`Optional`privacyMode

`Optional`profilePicThumb

`Optional`promises

`Optional`pushname

`Optional` `Readonly`searchName

`Optional` `Readonly`searchVerifiedName

`Optional`sectionHeader

`Optional`shortName

`Optional` `Readonly`shouldForceBusinessUpdate

`Optional` `Readonly`showBusinessCheckmarkAsPrimary

`Optional` `Readonly`showBusinessCheckmarkAsSecondary

`Optional` `Readonly`showBusinessCheckmarkInChatlist

`Optional`stale

`Optional`status

`Optional`statusMute

`Optional`type

`Optional` `Readonly`userhash

`Optional` `Readonly`userid

`Optional`verificationBinary

`Optional`verificationString

`Optional`verifiedLevel

`Optional`verifiedName

`Static` `Optional`allowedIds

`Static` `Optional`idClass

`Static`Proxy