Class ProductMessageListCollection

18952

Hierarchy (View Summary)

Collection<ProductMessageListModel>
- ProductMessageListCollection

Index

Constructors

constructor

new ProductMessageListCollection(
e?: any,
t?: { parent: any },
): ProductMessageListCollection
Parameters
- Optionale: any
- Optionalt: { parent: any }
Returns ProductMessageListCollection
Inherited from Collection.constructor
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:36

Properties

findFirst

findFirst: {
    <S extends ProductMessageListModel>(
        predicate: (
            value: ProductMessageListModel,
            index: number,
            obj: ProductMessageListModel[],
        ) => value is S,
        thisArg?: any,
    ): S;
    (
        predicate: (
            value: ProductMessageListModel,
            index: number,
            obj: ProductMessageListModel[],
        ) => unknown,
        thisArg?: any,
    ): ProductMessageListModel;
}

Type declaration

- <S extends ProductMessageListModel>(
      predicate: (
          value: ProductMessageListModel,
          index: number,
          obj: ProductMessageListModel[],
      ) => value is S,
      thisArg?: any,
  ): S
- Returns the value of the first element in the array where predicate is true, and undefined otherwise.
  Type Parameters
  - S extends ProductMessageListModel
  Parameters
  - predicate: (
        value: ProductMessageListModel,
        index: number,
        obj: ProductMessageListModel[],
    ) => value is S
    find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - OptionalthisArg: any
    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
  Returns S
- (
      predicate: (
          value: ProductMessageListModel,
          index: number,
          obj: ProductMessageListModel[],
      ) => unknown,
      thisArg?: any,
  ): ProductMessageListModel
- Parameters
  - predicate: (
        value: ProductMessageListModel,
        index: number,
        obj: ProductMessageListModel[],
    ) => unknown
  - OptionalthisArg: any
  Returns ProductMessageListModel

modelClass

modelClass: ProductMessageListModel

`Static`comparator

comparator: (a: any, b: any) => number

`Static`model

model: ProductMessageListModel

`Static` `Optional`staleCollection

staleCollection?: any

Accessors

length

get length(): number
Returns number
Inherited from Collection.length
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:39

Methods

add

add(
    value:
        | ProductMessageListModel
        | ProductMessageListModel[]
        | WritableProperties<ProductMessageListModel | ProductMessageListModel[]>,
    options?: Option,
): ProductMessageListModel | ProductMessageListModel[]
Parameters
- value:
      | ProductMessageListModel
      | ProductMessageListModel[]
      | WritableProperties<ProductMessageListModel | ProductMessageListModel[]>
- Optionaloptions: Option
Returns ProductMessageListModel | ProductMessageListModel[]
Inherited from Collection.add
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:40

assertGet

assertGet(e: Stringable): ProductMessageListModel
Parameters
- e: Stringable
Returns ProductMessageListModel
Inherited from Collection.assertGet
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:53

at

at(position: number): ProductMessageListModel
Parameters
- position: number
Returns ProductMessageListModel
Inherited from Collection.at
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:54

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

emit

emit(eventName: Event, ...args: any[]): this
Alias of trigger
Parameters
- eventName: Event
- ...args: any[]
Returns this
Alias
trigger
Inherited from Collection.emit
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:105

every

every<S extends ProductMessageListModel>(
    predicate: (
        value: ProductMessageListModel,
        index: number,
        array: ProductMessageListModel[],
    ) => value is S,
    thisArg?: any,
): this is S[]
Determines whether all the members of an array satisfy the specified test.
Type Parameters
- S extends ProductMessageListModel
Parameters
- predicate: (
      value: ProductMessageListModel,
      index: number,
      array: ProductMessageListModel[],
  ) => value is S
  A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns this is S[]
Inherited from Collection.every
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1433
every(
    predicate: (
        value: ProductMessageListModel,
        index: number,
        array: ProductMessageListModel[],
    ) => unknown,
    thisArg?: any,
): boolean
Determines whether all the members of an array satisfy the specified test.
Parameters
- predicate: (
      value: ProductMessageListModel,
      index: number,
      array: ProductMessageListModel[],
  ) => unknown
  A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
Inherited from Collection.every
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1442

filter

filter<S extends ProductMessageListModel>(
    predicate: (
        value: ProductMessageListModel,
        index: number,
        array: ProductMessageListModel[],
    ) => value is S,
    thisArg?: any,
): S[]
Returns the elements of an array that meet the condition specified in a callback function.
Type Parameters
- S extends ProductMessageListModel
Parameters
- predicate: (
      value: ProductMessageListModel,
      index: number,
      array: ProductMessageListModel[],
  ) => value is S
  A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Collection.filter
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1469
filter(
    predicate: (
        value: ProductMessageListModel,
        index: number,
        array: ProductMessageListModel[],
    ) => unknown,
    thisArg?: any,
): ProductMessageListModel[]
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
- predicate: (
      value: ProductMessageListModel,
      index: number,
      array: ProductMessageListModel[],
  ) => unknown
  A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns ProductMessageListModel[]
Inherited from Collection.filter
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1475

forEach

forEach(
    callbackfn: (
        value: ProductMessageListModel,
        index: number,
        array: ProductMessageListModel[],
    ) => void,
    thisArg?: any,
): void
Performs the specified action for each element in an array.
Parameters
- callbackfn: (
      value: ProductMessageListModel,
      index: number,
      array: ProductMessageListModel[],
  ) => void
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
Inherited from Collection.forEach
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1457

get

get(e: Stringable): ProductMessageListModel
Parameters
- e: Stringable
Returns ProductMessageListModel
Inherited from Collection.get
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:52

getModelsArray

getModelsArray(): ProductMessageListModel[]
Returns ProductMessageListModel[]
Inherited from Collection.getModelsArray
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:64

getOrAdd

getOrAdd(e?: any, t?: any, r?: any, a?: any): any
Parameters
- Optionale: any
- Optionalt: any
- Optionalr: any
- Optionala: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/ProductMessageListCollection.d.ts:22

head

head(): ProductMessageListModel
Returns ProductMessageListModel
Inherited from Collection.head
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:61

includes

includes(model: ProductMessageListModel, position?: number): boolean
Parameters
- model: ProductMessageListModel
- Optionalposition: number
Returns boolean
Inherited from Collection.includes
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:58

indexOf

indexOf(searchElement: ProductMessageListModel, fromIndex?: number): number
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
Parameters
- searchElement: ProductMessageListModel
  The value to locate in the array.
- OptionalfromIndex: number
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
Inherited from Collection.indexOf
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1418

isListening

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

isModel

isModel(model: any): model is ProductMessageListModel
Parameters
- model: any
Returns model is ProductMessageListModel
Inherited from Collection.isModel
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:57

last

last(): ProductMessageListModel
Returns ProductMessageListModel
Inherited from Collection.last
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:62

lastIndexOf

lastIndexOf(searchElement: ProductMessageListModel, fromIndex?: number): number
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
Parameters
- searchElement: ProductMessageListModel
  The value to locate in the array.
- OptionalfromIndex: number
  The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
Returns number
Inherited from Collection.lastIndexOf
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1424

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

map

map<U>(
    callbackfn: (
        value: ProductMessageListModel,
        index: number,
        array: ProductMessageListModel[],
    ) => U,
    thisArg?: any,
): U[]
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Type Parameters
- U
Parameters
- callbackfn: (
      value: ProductMessageListModel,
      index: number,
      array: ProductMessageListModel[],
  ) => U
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]
Inherited from Collection.map
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1463

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

reduce

reduce(
    callbackfn: (
        previousValue: ProductMessageListModel,
        currentValue: ProductMessageListModel,
        currentIndex: number,
        array: ProductMessageListModel[],
    ) => ProductMessageListModel,
): ProductMessageListModel
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
- callbackfn: (
      previousValue: ProductMessageListModel,
      currentValue: ProductMessageListModel,
      currentIndex: number,
      array: ProductMessageListModel[],
  ) => ProductMessageListModel
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Returns ProductMessageListModel
Inherited from Collection.reduce
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1481
reduce(
    callbackfn: (
        previousValue: ProductMessageListModel,
        currentValue: ProductMessageListModel,
        currentIndex: number,
        array: ProductMessageListModel[],
    ) => ProductMessageListModel,
    initialValue: ProductMessageListModel,
): ProductMessageListModel
Parameters
- callbackfn: (
      previousValue: ProductMessageListModel,
      currentValue: ProductMessageListModel,
      currentIndex: number,
      array: ProductMessageListModel[],
  ) => ProductMessageListModel
- initialValue: ProductMessageListModel
Returns ProductMessageListModel
Inherited from Collection.reduce
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1482
reduce<U>(
    callbackfn: (
        previousValue: U,
        currentValue: ProductMessageListModel,
        currentIndex: number,
        array: ProductMessageListModel[],
    ) => U,
    initialValue: U,
): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type Parameters
- U
Parameters
- callbackfn: (
      previousValue: U,
      currentValue: ProductMessageListModel,
      currentIndex: number,
      array: ProductMessageListModel[],
  ) => U
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
- initialValue: U
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
Inherited from Collection.reduce
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1488

remove

remove(
value: ProductMessageListModel | ProductMessageListModel[],
options?: { index?: boolean; silent?: boolean },
): ProductMessageListModel[]
Parameters
- value: ProductMessageListModel | ProductMessageListModel[]
- Optionaloptions: { index?: boolean; silent?: boolean }
Returns ProductMessageListModel[]
Inherited from Collection.remove
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:42

removeAllListeners

removeAllListeners(): this
Removes all listeners.

Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Collection.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 Collection.removeListener
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:95

reorder

reorder(e: number, t: number): ProductMessageListModel[]
Parameters
- e: number
- t: number
Returns ProductMessageListModel[]
Inherited from Collection.reorder
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:65

reorderMutate

reorderMutate(e: any, t: any): void
Parameters
- e: any
- t: any
Returns void
Inherited from Collection.reorderMutate
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:51

replaceId

replaceId(e: any, t: any): void
Parameters
- e: any
- t: any
Returns void
Inherited from Collection.replaceId
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:50

reset

reset(): void
Returns void
Inherited from Collection.reset
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:46

serialize

serialize(): any[]
Returns any[]
Inherited from Collection.serialize
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:55

set

set(
value: ProductMessageListModel | ProductMessageListModel[],
options?: Option,
): ProductMessageListModel | ProductMessageListModel[]
Parameters
- value: ProductMessageListModel | ProductMessageListModel[]
- Optionaloptions: Option
Returns ProductMessageListModel | ProductMessageListModel[]
Inherited from Collection.set
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:41

slice

slice(start?: number, end?: number): ProductMessageListModel[]
Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
Parameters
- Optionalstart: number
  The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
- Optionalend: number
  The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.
Returns ProductMessageListModel[]
Inherited from Collection.slice
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1381

some

some(
    predicate: (
        value: ProductMessageListModel,
        index: number,
        array: ProductMessageListModel[],
    ) => unknown,
    thisArg?: any,
): boolean
Determines whether the specified callback function returns true for any element of an array.
Parameters
- predicate: (
      value: ProductMessageListModel,
      index: number,
      array: ProductMessageListModel[],
  ) => unknown
  A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
Inherited from Collection.some
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1451

sort

sort(options?: { silent?: boolean }): this
Parameters
- Optionaloptions: { silent?: boolean }
Returns this
Inherited from Collection.sort
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:47

stopListening

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

toArray

toArray(): ProductMessageListModel[]
Returns ProductMessageListModel[]
Inherited from Collection.toArray
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:63

toJSON

toJSON(): any[]
Returns any[]
Inherited from Collection.toJSON
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:56

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

where

where(ids: Stringable[]): ProductMessageListModel[]
Parameters
- ids: Stringable[]
Returns ProductMessageListModel[]
Inherited from Collection.where
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/collections/Collection.d.ts:60

Class ProductMessageListCollection

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ProductMessageListCollection

Properties

findFirst

Type declaration

Type Parameters

Parameters

Returns S

Parameters

Returns ProductMessageListModel

modelClass

Staticcomparator

Staticmodel

Static OptionalstaleCollection

Accessors

length

Returns number

Methods

add

Parameters

Returns ProductMessageListModel | ProductMessageListModel[]

assertGet

Parameters

Returns ProductMessageListModel

at

Parameters

Returns ProductMessageListModel

bind

Parameters

Returns this

Alias

emit

Parameters

Returns this

Alias

every

Type Parameters

Parameters

Returns this is S[]

Parameters

Returns boolean

filter

Type Parameters

Parameters

Returns S[]

Parameters

Returns ProductMessageListModel[]

forEach

Parameters

Returns void

get

Parameters

Returns ProductMessageListModel

getModelsArray

Returns ProductMessageListModel[]

getOrAdd

Parameters

Returns any

head

Returns ProductMessageListModel

includes

Parameters

Returns boolean

indexOf

Parameters

Returns number

isListening

Parameters

Returns boolean

isModel

`Static`comparator

`Static`model

`Static` `Optional`staleCollection