Class BotProfileCollection

WAWebBotProfileCollection

Hierarchy (View Summary)

Collection<BotProfileModel>
- BotProfileCollection

Index

Constructors

constructor

new BotProfileCollection(e?: any, t?: { parent: any }): BotProfileCollection
Parameters
- Optionale: any
- Optionalt: { parent: any }
Returns BotProfileCollection
Inherited from Collection.constructor
- Defined in src/whatsapp/collections/Collection.ts:55

Properties

findFirst

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

Type declaration

- <S extends BotProfileModel>(
      predicate: (
          value: BotProfileModel,
          index: number,
          obj: BotProfileModel[],
      ) => value is S,
      thisArg?: any,
  ): undefined | S
- Returns the value of the first element in the array where predicate is true, and undefined otherwise.
  Type Parameters
  - S extends BotProfileModel
  Parameters
  - predicate: (value: BotProfileModel, index: number, obj: BotProfileModel[]) => 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 undefined | S
- (
      predicate: (
          value: BotProfileModel,
          index: number,
          obj: BotProfileModel[],
      ) => unknown,
      thisArg?: any,
  ): undefined | BotProfileModel
- Parameters
  - predicate: (value: BotProfileModel, index: number, obj: BotProfileModel[]) => unknown
  - OptionalthisArg: any
  Returns undefined | BotProfileModel

modelClass

modelClass: BotProfileModel

`Static`comparator

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

`Static`model

model: BotProfileModel

`Static` `Optional`staleCollection

staleCollection?: any

Accessors

length

get length(): number
Returns number
Inherited from Collection.length
- Defined in src/whatsapp/collections/Collection.ts:57

Methods

add

add(
    value:
        | BotProfileModel
        | BotProfileModel[]
        | WritableProperties<BotProfileModel | BotProfileModel[]>,
    options?: Option,
): BotProfileModel | BotProfileModel[]
Parameters
- value:
      | BotProfileModel
      | BotProfileModel[]
      | WritableProperties<BotProfileModel | BotProfileModel[]>
- Optionaloptions: Option
Returns BotProfileModel | BotProfileModel[]
Inherited from Collection.add
- Defined in src/whatsapp/collections/Collection.ts:59

assertGet

assertGet(e: Stringable): BotProfileModel
Parameters
- e: Stringable
Returns BotProfileModel
Inherited from Collection.assertGet
- Defined in src/whatsapp/collections/Collection.ts:75

at

at(position: number): undefined | BotProfileModel
Parameters
- position: number
Returns undefined | BotProfileModel
Inherited from Collection.at
- Defined in src/whatsapp/collections/Collection.ts:77

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 src/whatsapp/misc/EventEmitter.ts:99

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 src/whatsapp/misc/EventEmitter.ts:120

every

every<S extends BotProfileModel>(
    predicate: (
        value: BotProfileModel,
        index: number,
        array: BotProfileModel[],
    ) => value is S,
    thisArg?: any,
): this is S[]
Determines whether all the members of an array satisfy the specified test.
Type Parameters
- S extends BotProfileModel
Parameters
- predicate: (value: BotProfileModel, index: number, array: BotProfileModel[]) => 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: BotProfileModel,
        index: number,
        array: BotProfileModel[],
    ) => unknown,
    thisArg?: any,
): boolean
Determines whether all the members of an array satisfy the specified test.
Parameters
- predicate: (value: BotProfileModel, index: number, array: BotProfileModel[]) => 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 BotProfileModel>(
    predicate: (
        value: BotProfileModel,
        index: number,
        array: BotProfileModel[],
    ) => 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 BotProfileModel
Parameters
- predicate: (value: BotProfileModel, index: number, array: BotProfileModel[]) => 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: BotProfileModel,
        index: number,
        array: BotProfileModel[],
    ) => unknown,
    thisArg?: any,
): BotProfileModel[]
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
- predicate: (value: BotProfileModel, index: number, array: BotProfileModel[]) => 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 BotProfileModel[]
Inherited from Collection.filter
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1475

findImpl

findImpl(a?: any): any
Parameters
- Optionala: any
Returns any
- Defined in src/whatsapp/collections/BotProfileCollection.ts:27

forEach

forEach(
    callbackfn: (
        value: BotProfileModel,
        index: number,
        array: BotProfileModel[],
    ) => void,
    thisArg?: any,
): void
Performs the specified action for each element in an array.
Parameters
- callbackfn: (value: BotProfileModel, index: number, array: BotProfileModel[]) => 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): undefined | BotProfileModel
Parameters
- e: Stringable
Returns undefined | BotProfileModel
Inherited from Collection.get
- Defined in src/whatsapp/collections/Collection.ts:73

includes

includes(model: BotProfileModel, position?: number): boolean
Parameters
- model: BotProfileModel
- Optionalposition: number
Returns boolean
Inherited from Collection.includes
- Defined in src/whatsapp/collections/Collection.ts:85

indexOf

indexOf(searchElement: BotProfileModel, 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: BotProfileModel
  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 src/whatsapp/misc/EventEmitter.ts:93

isModel

isModel(model: any): model is BotProfileModel
Parameters
- model: any
Returns model is BotProfileModel
Inherited from Collection.isModel
- Defined in src/whatsapp/collections/Collection.ts:83

last

last(): undefined | BotProfileModel
Returns undefined | BotProfileModel
Inherited from Collection.last
- Defined in src/whatsapp/collections/Collection.ts:93

lastIndexOf

lastIndexOf(searchElement: BotProfileModel, 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: BotProfileModel
  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 src/whatsapp/misc/EventEmitter.ts:77

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 src/whatsapp/misc/EventEmitter.ts:91

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 src/whatsapp/misc/EventEmitter.ts:84

map

map<U>(
    callbackfn: (
        value: BotProfileModel,
        index: number,
        array: BotProfileModel[],
    ) => 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: BotProfileModel, index: number, array: BotProfileModel[]) => 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 src/whatsapp/misc/EventEmitter.ts:62

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 src/whatsapp/misc/EventEmitter.ts:42

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 src/whatsapp/misc/EventEmitter.ts:52

reduce

reduce(
    callbackfn: (
        previousValue: BotProfileModel,
        currentValue: BotProfileModel,
        currentIndex: number,
        array: BotProfileModel[],
    ) => BotProfileModel,
): BotProfileModel
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: BotProfileModel,
      currentValue: BotProfileModel,
      currentIndex: number,
      array: BotProfileModel[],
  ) => BotProfileModel
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Returns BotProfileModel
Inherited from Collection.reduce
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1481
reduce(
    callbackfn: (
        previousValue: BotProfileModel,
        currentValue: BotProfileModel,
        currentIndex: number,
        array: BotProfileModel[],
    ) => BotProfileModel,
    initialValue: BotProfileModel,
): BotProfileModel
Parameters
- callbackfn: (
      previousValue: BotProfileModel,
      currentValue: BotProfileModel,
      currentIndex: number,
      array: BotProfileModel[],
  ) => BotProfileModel
- initialValue: BotProfileModel
Returns BotProfileModel
Inherited from Collection.reduce
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1482
reduce<U>(
    callbackfn: (
        previousValue: U,
        currentValue: BotProfileModel,
        currentIndex: number,
        array: BotProfileModel[],
    ) => 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: BotProfileModel,
      currentIndex: number,
      array: BotProfileModel[],
  ) => 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: BotProfileModel | BotProfileModel[],
options?: { index?: boolean; silent?: boolean },
): BotProfileModel[]
Parameters
- value: BotProfileModel | BotProfileModel[]
- Optionaloptions: { index?: boolean; silent?: boolean }
Returns BotProfileModel[]
Inherited from Collection.remove
- Defined in src/whatsapp/collections/Collection.ts:63

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 src/whatsapp/misc/EventEmitter.ts:115

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 src/whatsapp/misc/EventEmitter.ts:110

reorder

reorder(e: number, t: number): BotProfileModel[]
Parameters
- e: number
- t: number
Returns BotProfileModel[]
Inherited from Collection.reorder
- Defined in src/whatsapp/collections/Collection.ts:99

reorderMutate

reorderMutate(e: any, t: any): void
Parameters
- e: any
- t: any
Returns void
Inherited from Collection.reorderMutate
- Defined in src/whatsapp/collections/Collection.ts:71

replaceId

replaceId(e: any, t: any): void
Parameters
- e: any
- t: any
Returns void
Inherited from Collection.replaceId
- Defined in src/whatsapp/collections/Collection.ts:69

reset

reset(): void
Returns void
Inherited from Collection.reset
- Defined in src/whatsapp/collections/Collection.ts:65

serialize

serialize(): any[]
Returns any[]
Inherited from Collection.serialize
- Defined in src/whatsapp/collections/Collection.ts:79

set

set(
value: BotProfileModel | BotProfileModel[],
options?: Option,
): BotProfileModel | BotProfileModel[]
Parameters
- value: BotProfileModel | BotProfileModel[]
- Optionaloptions: Option
Returns BotProfileModel | BotProfileModel[]
Inherited from Collection.set
- Defined in src/whatsapp/collections/Collection.ts:61

slice

slice(start?: number, end?: number): BotProfileModel[]
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 BotProfileModel[]
Inherited from Collection.slice
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1381

some

some(
    predicate: (
        value: BotProfileModel,
        index: number,
        array: BotProfileModel[],
    ) => unknown,
    thisArg?: any,
): boolean
Determines whether the specified callback function returns true for any element of an array.
Parameters
- predicate: (value: BotProfileModel, index: number, array: BotProfileModel[]) => 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 src/whatsapp/collections/Collection.ts:67

stopListening

stopListening(context?: any, eventName?: Event, listener?: Listener): this
Parameters
- Optionalcontext: any
- OptionaleventName: Event
- Optionallistener: Listener
Returns this
Inherited from Collection.stopListening
- Defined in src/whatsapp/misc/EventEmitter.ts:70

toArray

toArray(): BotProfileModel[]
Returns BotProfileModel[]
Inherited from Collection.toArray
- Defined in src/whatsapp/collections/Collection.ts:95

toJSON

toJSON(): any[]
Returns any[]
Inherited from Collection.toJSON
- Defined in src/whatsapp/collections/Collection.ts:81

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 src/whatsapp/misc/EventEmitter.ts:68

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 src/whatsapp/misc/EventEmitter.ts:105

update

update(): any
Returns any
- Defined in src/whatsapp/collections/BotProfileCollection.ts:28

where

where(ids: Stringable[]): BotProfileModel[]
Parameters
- ids: Stringable[]
Returns BotProfileModel[]
Inherited from Collection.where
- Defined in src/whatsapp/collections/Collection.ts:89

Class BotProfileCollection

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BotProfileCollection

Properties

findFirst

Type declaration

Type Parameters

Parameters

Returns undefined | S

Parameters

Returns undefined | BotProfileModel

modelClass

Staticcomparator

Staticmodel

Static OptionalstaleCollection

Accessors

length

Returns number

Methods

add

Parameters

Returns BotProfileModel | BotProfileModel[]

assertGet

Parameters

Returns BotProfileModel

at

Parameters

Returns undefined | BotProfileModel

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 BotProfileModel[]

findImpl

Parameters

Returns any

forEach

Parameters

Returns void

get

Parameters

Returns undefined | BotProfileModel

getDefaultBot

Returns any

getModelsArray

Returns BotProfileModel[]

head

Returns undefined | BotProfileModel

includes

Parameters

Returns boolean

indexOf

Parameters

Returns number

isListening

Parameters

`Static`comparator

`Static`model

`Static` `Optional`staleCollection