Class ProductModel

9468

509468 >= 2.2222.8

Hierarchy (View Summary)

ModelProxy<Props, Session, Derived>
Model
- ProductModel

Index

Constructors

constructor

Constructors

constructor

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

Properties

`Optional`additionalImageCdnUrl

additionalImageCdnUrl?: any

`Optional`additionalImageHashes

additionalImageHashes?: any

`Readonly`attributes

attributes: Props & Session

`Optional`availability

availability?: any

canAppeal

canAppeal: boolean

`Optional`catalogWid

catalogWid?: any

`Optional`checkmark

checkmark?: any

`Optional`collection

collection?: undefined

`Optional`currency

currency?: any

`Optional`description

description?: any

`Optional`fetchedFromServer

fetchedFromServer?: any

`Optional`id

id?: any

image

image: string

`Optional`imageCdnUrl

imageCdnUrl?: any

`Optional`imageCount

imageCount?: any

`Optional`imageHash

imageHash?: any

`Optional`index

index?: any

`Optional`isHidden

isHidden?: boolean

`Readonly`isState

isState: true

`Readonly`mirrorMask

mirrorMask: {
    "change:additionalImageCdnUrl"?: number;
    "change:additionalImageHashes"?: number;
    "change:availability"?: number;
    "change:canAppeal": number;
    "change:catalogWid"?: number;
    "change:checkmark"?: number;
    "change:currency"?: number;
    "change:description"?: number;
    "change:fetchedFromServer"?: number;
    "change:id"?: number;
    "change:imageCdnUrl"?: number;
    "change:imageCount"?: number;
    "change:imageHash"?: number;
    "change:index"?: number;
    "change:isHidden"?: number;
    "change:name"?: number;
    "change:old"?: number;
    "change:priceAmount1000"?: number;
    "change:productImageCollection"?: number;
    "change:productMsgMediaData"?: number;
    "change:retailerId"?: number;
    "change:reviewStatus"?: number;
    "change:salePriceAmount1000"?: number;
    "change:salePriceEndDate"?: number;
    "change:salePriceStartDate"?: number;
    "change:stale"?: number;
    "change:t"?: number;
    "change:url"?: number;
}

`Optional`name

name?: string

`Optional`old

old?: any

`Optional`parent

parent?: any

`Optional`priceAmount1000

priceAmount1000?: any

`Optional`productImageCollection

productImageCollection?: any

`Optional`productMsgMediaData

productMsgMediaData?: any

proxyName

proxyName: string

`Optional`retailerId

retailerId?: any

`Optional`reviewStatus

reviewStatus?: any

`Optional`salePriceAmount1000

salePriceAmount1000?: any

`Optional`salePriceEndDate

salePriceEndDate?: any

`Optional`salePriceStartDate

salePriceStartDate?: any

`Optional`stale

stale?: any

`Optional`t

t?: any

`Optional`url

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

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

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

evictImagesFromCache

evictImagesFromCache(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ProductModel.d.ts:66

get

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

getDefault

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

getHeadImageFile

getHeadImageFile(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ProductModel.d.ts:65

getPreviewImage

getPreviewImage(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ProductModel.d.ts:67

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

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

markOld

markOld(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ProductModel.d.ts:63

markProductImagesOld

markProductImagesOld(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ProductModel.d.ts:64

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

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

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

triggerImageUpdate

triggerImageUpdate(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/ProductModel.d.ts:62

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

`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 ProductModel

Whatsapp

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProductModel

Properties

OptionaladditionalImageCdnUrl

OptionaladditionalImageHashes

Readonlyattributes

Optionalavailability

canAppeal

OptionalcatalogWid

Optionalcheckmark

Optionalcollection

Optionalcurrency

Optionaldescription

OptionalfetchedFromServer

Optionalid

image

OptionalimageCdnUrl

OptionalimageCount

OptionalimageHash

Optionalindex

OptionalisHidden

ReadonlyisState

ReadonlymirrorMask

Optionalname

Optionalold

Optionalparent

OptionalpriceAmount1000

OptionalproductImageCollection

OptionalproductMsgMediaData

proxyName

OptionalretailerId

OptionalreviewStatus

OptionalsalePriceAmount1000

OptionalsalePriceEndDate

OptionalsalePriceStartDate

Optionalstale

Optionalt

Optionalurl

Static OptionalallowedIds

Static OptionalidClass

StaticProxy

Methods

addChild

Parameters

Returns void

bind

Parameters

Returns this

Alias

clear

Returns void

decObservers

Returns void

delete

Returns void

emit

Parameters

Returns this

Alias

evictImagesFromCache

Returns any

get

Type Parameters

Parameters

Returns ProductModel[T]

getDefault

Type Parameters

Parameters

Returns any

getHeadImageFile

`Optional`additionalImageCdnUrl

`Optional`additionalImageHashes

`Readonly`attributes

`Optional`availability

`Optional`catalogWid

`Optional`checkmark

`Optional`collection

`Optional`currency

`Optional`description

`Optional`fetchedFromServer

`Optional`id

`Optional`imageCdnUrl

`Optional`imageCount

`Optional`imageHash

`Optional`index

`Optional`isHidden

`Readonly`isState

`Readonly`mirrorMask

`Optional`name

`Optional`old

`Optional`parent

`Optional`priceAmount1000

`Optional`productImageCollection

`Optional`productMsgMediaData

`Optional`retailerId

`Optional`reviewStatus

`Optional`salePriceAmount1000

`Optional`salePriceEndDate

`Optional`salePriceStartDate

`Optional`stale

`Optional`t

`Optional`url

`Static` `Optional`allowedIds

`Static` `Optional`idClass

`Static`Proxy

`Static`isIdType