Class StreamModel

8080

608080 >= 2.2222.8

Hierarchy (View Summary)

ModelProxy<Props, Session, Derived>
Model
- StreamModel

Index

Constructors

constructor

Constructors

constructor

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

Properties

`Readonly`attributes

attributes: Props & Session

`Optional`available

available?: any

`Optional`clientExpired

clientExpired?: any

`Optional`collection

collection?: undefined

`Optional`couldForce

couldForce?: any

`Optional` `Readonly`displayInfo

displayInfo?: any

`Optional`hardExpired

hardExpired?: any

`Optional`info

info?: any

`Readonly`isState

isState: true

`Optional`lastSyncStart

lastSyncStart?: any

`Readonly`mirrorMask

mirrorMask: {
    "change:available"?: number;
    "change:clientExpired"?: number;
    "change:couldForce"?: number;
    "change:displayInfo"?: number;
    "change:hardExpired"?: number;
    "change:info"?: number;
    "change:lastSyncStart"?: number;
    "change:mode": number;
    "change:needsManualDownload"?: number;
    "change:needsUpdate"?: number;
    "change:obscurity"?: number;
    "change:phoneAuthed"?: number;
    "change:resumeCount"?: number;
    "change:timeoutEvent"?: number;
    "change:uiActive"?: number;
    "change:unavailableLogoutTimer"?: number;
    "change:unavailableShiftTimer"?: number;
    "change:unobscureShiftTimer"?: number;
}

mode

mode: string

`Optional`needsManualDownload

needsManualDownload?: any

`Optional`needsUpdate

needsUpdate?: any

`Optional`obscurity

obscurity?: any

`Optional`parent

parent?: any

`Optional`phoneAuthed

phoneAuthed?: any

proxyName

proxyName: string

`Optional`resumeCount

resumeCount?: any

`Optional`timeoutEvent

timeoutEvent?: any

`Optional`uiActive

uiActive?: any

`Optional`unavailableLogoutTimer

unavailableLogoutTimer?: any

`Optional`unavailableShiftTimer

unavailableShiftTimer?: any

`Optional`unobscureShiftTimer

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

get

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

getDefault

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

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

logModeChange

logModeChange(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:63

logPageResume

logPageResume(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:61

markAvailable

markAvailable(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:51

markUnavailable

markUnavailable(e?: any): void
Parameters
- Optionale: any
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:52

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

onAvailableUpdate

onAvailableUpdate(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:57

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

onPhoneAuthedUpdate

onPhoneAuthedUpdate(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:56

onSelfUpdate

onSelfUpdate(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:53

onSocketUpdate

onSocketUpdate(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:54

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

sendAvailability

sendAvailability(e?: any): void
Parameters
- Optionale: any
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:58

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

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

unobscure

unobscure(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:55

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

updateCouldForce

updateCouldForce(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:59

updateHardExpire

updateHardExpire(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:60

updateWamLog

updateWamLog(): void
Returns void
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/StreamModel.d.ts:62

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

Whatsapp

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StreamModel

Properties

Readonlyattributes

Optionalavailable

OptionalclientExpired

Optionalcollection

OptionalcouldForce

Optional ReadonlydisplayInfo

OptionalhardExpired

Optionalinfo

ReadonlyisState

OptionallastSyncStart

ReadonlymirrorMask

mode

OptionalneedsManualDownload

OptionalneedsUpdate

Optionalobscurity

Optionalparent

OptionalphoneAuthed

proxyName

OptionalresumeCount

OptionaltimeoutEvent

OptionaluiActive

OptionalunavailableLogoutTimer

OptionalunavailableShiftTimer

OptionalunobscureShiftTimer

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

get

Type Parameters

Parameters

Returns StreamModel[T]

getDefault

Type Parameters

Parameters

Returns any

hasObservers

Returns boolean

hasUnfiredChanges

Returns boolean

incObservers

Parameters

Returns void

initialize

Returns void

isListening

Parameters

Returns boolean

listenTo

Parameters

`Readonly`attributes

`Optional`available

`Optional`clientExpired

`Optional`collection

`Optional`couldForce

`Optional` `Readonly`displayInfo

`Optional`hardExpired

`Optional`info

`Readonly`isState

`Optional`lastSyncStart

`Readonly`mirrorMask

`Optional`needsManualDownload

`Optional`needsUpdate

`Optional`obscurity

`Optional`parent

`Optional`phoneAuthed

`Optional`resumeCount

`Optional`timeoutEvent

`Optional`uiActive

`Optional`unavailableLogoutTimer

`Optional`unavailableShiftTimer

`Optional`unobscureShiftTimer

`Static` `Optional`allowedIds

`Static` `Optional`idClass

`Static`Proxy