Class SocketModel

Whatsapp

65044

Hierarchy (view full)

Constructors

constructor

Properties

attributes backoffGeneration cancelHash? canSend? collection? conflictPromise? doubleAckHash? hasSynced? isIncognito? isState lastPhoneMessage? launched? launchGeneration logoutMutex mirrorMask mustExitLoop? parent? pendingPhoneReqs phoneWatchdog? pokeable? proxyName refWatcher? resumePromise? retryTimestamp? runPromise? sendHash? sendQueue? sequence shortTagBase? shouldForceReconnect shouldUpgradeToMDIntern shouldUpgradeToMDPord socket? socketPreload? socketWatcher? state stream streamPromise? syncTag? allowedIds? idClass? Proxy

Methods

addChild bind canRequestBeSent clear clearCredentials clearCredentialsAndStoredData clearSendHash clearState decObservers delete deprecatedVersion destroyStorage emit exitLoop flushQueue get getDefault hasObservers hasUnfiredChanges incObservers initConn initialize isListening launch listenTo listenToAndRun listenToOnce logout lookForAndHandleChallenge manageRef maybeResendRequestEventually off on on5xx onActivity once onCriticalSyncDone onMessage onPhoneWatchdogActivated onPhoneWatchdogDeactivated onPhoneWatchdogFed onRefCycle onStateChange onStreamChange openSocket openStream phoneTimedOut poke preload queryReceivedActions registerHandler removeAllListeners removeListener requestSync reset run runResume send send2 sendBasic sendCurrentLogout sendEphemeral sendEphemeral2 sendEphemeralIgnore sendRemainingLogouts serialize set setPokeable shortTag stopListening summary tag takeover throwOnClose toJSON trigger unbind unset updateImmediately waitForSyncInfo isIdType

Constructors

constructor

Properties

Readonlyattributes

attributes: Props & Session

backoffGeneration

backoffGeneration: number

OptionalcancelHash

cancelHash?: any

OptionalcanSend

canSend?: any

Optionalcollection

collection?: undefined

OptionalconflictPromise

conflictPromise?: any

OptionaldoubleAckHash

doubleAckHash?: any

OptionalhasSynced

hasSynced?: any

OptionalisIncognito

isIncognito?: any

ReadonlyisState

isState

OptionallastPhoneMessage

lastPhoneMessage?: any

Optionallaunched

launched?: any

launchGeneration

launchGeneration: number

logoutMutex

logoutMutex: number

ReadonlymirrorMask

mirrorMask: {
    change:backoffGeneration: number;
    change:cancelHash: number;
    change:canSend: number;
    change:conflictPromise: number;
    change:doubleAckHash: number;
    change:hasSynced: number;
    change:isIncognito: number;
    change:lastPhoneMessage: number;
    change:launched: number;
    change:launchGeneration: number;
    change:logoutMutex: number;
    change:mustExitLoop: number;
    change:pendingPhoneReqs: number;
    change:phoneWatchdog: number;
    change:pokeable: number;
    change:refWatcher: number;
    change:resumePromise: number;
    change:retryTimestamp: number;
    change:runPromise: number;
    change:sendHash: number;
    change:sendQueue: number;
    change:sequence: number;
    change:shortTagBase: number;
    change:shouldForceReconnect: number;
    change:shouldUpgradeToMDIntern: number;
    change:shouldUpgradeToMDPord: number;
    change:socket: number;
    change:socketPreload: number;
    change:socketWatcher: number;
    change:state: number;
    change:stream: number;
    change:streamPromise: number;
    change:syncTag: number;
}

OptionalmustExitLoop

mustExitLoop?: any

Optionalparent

parent?: any

pendingPhoneReqs

pendingPhoneReqs: number

OptionalphoneWatchdog

phoneWatchdog?: any

Optionalpokeable

pokeable?: any

proxyName

proxyName: string

OptionalrefWatcher

refWatcher?: any

OptionalresumePromise

resumePromise?: any

OptionalretryTimestamp

retryTimestamp?: any

OptionalrunPromise

runPromise?: any

OptionalsendHash

sendHash?: any

OptionalsendQueue

sendQueue?: any

sequence

sequence: number

OptionalshortTagBase

shortTagBase?: any

shouldForceReconnect

shouldForceReconnect: boolean

shouldUpgradeToMDIntern

shouldUpgradeToMDIntern: boolean

shouldUpgradeToMDPord

shouldUpgradeToMDPord: boolean

Optionalsocket

socket?: any

OptionalsocketPreload

socketPreload?: any

OptionalsocketWatcher

socketWatcher?: any

state

state: string

stream

stream: string

OptionalstreamPromise

streamPromise?: any

OptionalsyncTag

syncTag?: any

Static OptionalallowedIds

allowedIds?: any[]

Static OptionalidClass

idClass?: any

StaticProxy

Proxy: string

Methods

addChild

  • addChild(id, context): void

  • Parameters

    • id: Stringable
    • context: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns void

bind

  • bind(eventName, listener, context?): this

  • Alias of on

    Parameters

    • eventName: Event
    • listener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    on

canRequestBeSent

  • canRequestBeSent(e?): any

  • Parameters

    • Optionale: any

    Returns any

clear

  • clear(): void

  • Returns void

clearCredentials

  • clearCredentials(): any

  • Returns any

clearCredentialsAndStoredData

  • clearCredentialsAndStoredData(): any

  • Returns any

clearSendHash

  • clearSendHash(e?): any

  • Parameters

    • Optionale: any

    Returns any

clearState

  • clearState(): any

  • Returns any

decObservers

  • decObservers(): void

  • Returns void

delete

  • delete(): void

  • Returns void

deprecatedVersion

  • deprecatedVersion(): any

  • Returns any

destroyStorage

  • destroyStorage(): any

  • Returns any

emit

  • emit(eventName, ...args): this

  • Alias of trigger

    Parameters

    • eventName: Event
    • Rest...args: any[]

    Returns this

    Alias

    trigger

exitLoop

  • exitLoop(e?): any

  • Parameters

    • Optionale: any

    Returns any

flushQueue

  • flushQueue(): any

  • Returns any

get

getDefault

  • getDefault<T>(attr): any

  • Type Parameters

    Parameters

    • attr: T

    Returns any

hasObservers

  • hasObservers(): boolean

  • Returns boolean

hasUnfiredChanges

  • hasUnfiredChanges(): boolean

  • Returns boolean

incObservers

  • incObservers(e?): void

  • Parameters

    • Optionale: boolean

    Returns void

initConn

  • initConn(): any

  • Returns any

initialize

  • initialize(): any

  • Returns any

isListening

  • isListening(eventName): boolean

  • Parameters

    • eventName: Event

    Returns boolean

launch

  • launch(e?, t?): any

  • Parameters

    • Optionale: any
    • Optionalt: number

    Returns any

listenTo

  • listenTo(context, eventName, 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

listenToAndRun

  • listenToAndRun(context, eventName, 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

listenToOnce

  • listenToOnce(context, eventName, 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

logout

  • logout(sendLogout?, reason?): void

  • Parameters

    Returns void

lookForAndHandleChallenge

  • lookForAndHandleChallenge(): any

  • Returns any

manageRef

  • manageRef(): any

  • Returns any

maybeResendRequestEventually

  • maybeResendRequestEventually(e?): any

  • Parameters

    • Optionale: any

    Returns any

off

  • off(eventName?, listener?, context?): 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.

on

  • on(eventName, listener, context?): 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.

on5xx

  • on5xx(e?): any

  • Parameters

    • Optionale: any

    Returns any

onActivity

  • onActivity(e?): any

  • Parameters

    • Optionale: any

    Returns any

once

  • once(eventName, listener, context?): 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.

onCriticalSyncDone

  • onCriticalSyncDone(): any

  • Returns any

onMessage

  • onMessage(e?): any

  • Parameters

    • Optionale: any

    Returns any

onPhoneWatchdogActivated

  • onPhoneWatchdogActivated(): any

  • Returns any

onPhoneWatchdogDeactivated

  • onPhoneWatchdogDeactivated(): any

  • Returns any

onPhoneWatchdogFed

  • onPhoneWatchdogFed(): any

  • Returns any

onRefCycle

  • onRefCycle(): any

  • Returns any

onStateChange

  • onStateChange(): any

  • Returns any

onStreamChange

  • onStreamChange(): any

  • Returns any

openSocket

  • openSocket(): any

  • Returns any

openStream

  • openStream(): any

  • Returns any

phoneTimedOut

  • phoneTimedOut(): any

  • Returns any

poke

  • poke(): void

  • Returns void

preload

  • preload(): any

  • Returns any

queryReceivedActions

  • queryReceivedActions(): any

  • Returns any

registerHandler

  • registerHandler(e?): any

  • Parameters

    • Optionale: any

    Returns any

removeAllListeners

  • removeAllListeners(): this

  • Removes all listeners.

    Returns this

    Returns a reference to the EventEmitter, so that calls can be chained.

removeListener

  • removeListener(eventName?, listener?, context?): this

  • Alias of off

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

requestSync

  • requestSync(e?): any

  • Parameters

    • Optionale: any

    Returns any

reset

  • reset(): void

  • Returns void

run

  • run(e?, t?): any

  • Parameters

    • Optionale: any
    • Optionalt: any

    Returns any

runResume

  • runResume(e?): any

  • Parameters

    • Optionale: any

    Returns any

send

  • send(e?): any

  • Parameters

    • Optionale: any

    Returns any

send2

  • send2(e?): any

  • Parameters

    • Optionale: any

    Returns any

sendBasic

  • sendBasic(e?): any

  • Parameters

    • Optionale: any

    Returns any

sendCurrentLogout

  • sendCurrentLogout(e?): any

  • Parameters

    • Optionale: any

    Returns any

sendEphemeral

  • sendEphemeral(e?): any

  • Parameters

    • Optionale: any

    Returns any

sendEphemeral2

  • sendEphemeral2(e?): any

  • Parameters

    • Optionale: any

    Returns any

sendEphemeralIgnore

  • sendEphemeralIgnore(e?): any

  • Parameters

    • Optionale: any

    Returns any

sendRemainingLogouts

  • sendRemainingLogouts(): any

  • Returns any

serialize

  • serialize(): Props

  • Returns Props

set

  • set(...args): any

  • Parameters

    • Rest...args: any

    Returns any

setPokeable

  • setPokeable(e?, t?): any

  • Parameters

    • Optionale: any
    • Optionalt: number

    Returns any

shortTag

  • shortTag(): any

  • Returns any

stopListening

  • stopListening(context?, eventName?, listener?): this

  • Parameters

    • Optionalcontext: any
    • OptionaleventName: Event
    • Optionallistener: Listener

    Returns this

summary

  • summary(): any

  • Returns any

tag

  • tag(e?): any

  • Parameters

    • Optionale: any

    Returns any

takeover

  • takeover(): any

  • Returns any

throwOnClose

  • throwOnClose(): any

  • Returns any

toJSON

  • toJSON(): Props

  • Returns Props

trigger

  • trigger(eventName, ...args): 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
    • Rest...args: any[]

    Returns this

    Returns a reference to the EventEmitter, so that calls can be chained.

unbind

  • unbind(eventName?, listener?, context?): this

  • Alias of off

    Parameters

    • OptionaleventName: Event
    • Optionallistener: Listener
    • Optionalcontext: any

    Returns this

    Alias

    off

unset

  • unset(ids, t?): void

  • Parameters

    • ids: Stringable | Stringable[]
    • Optionalt: any

    Returns void

updateImmediately

  • updateImmediately(e?): any

  • Parameters

    • Optionale: any

    Returns any

waitForSyncInfo

  • waitForSyncInfo(): any

  • Returns any

StaticisIdType

  • isIdType(e): boolean

  • Parameters

    • e: any

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
addChildbindcanRequestBeSentclearclearCredentialsclearCredentialsAndStoredDataclearSendHashclearStatedecObserversdeletedeprecatedVersiondestroyStorageemitexitLoopflushQueuegetgetDefaulthasObservershasUnfiredChangesincObserversinitConninitializeisListeninglaunchlistenTolistenToAndRunlistenToOncelogoutlookForAndHandleChallengemanageRefmaybeResendRequestEventuallyoffonon5xxonActivityonceonCriticalSyncDoneonMessageonPhoneWatchdogActivatedonPhoneWatchdogDeactivatedonPhoneWatchdogFedonRefCycleonStateChangeonStreamChangeopenSocketopenStreamphoneTimedOutpokepreloadqueryReceivedActionsregisterHandlerremoveAllListenersremoveListenerrequestSyncresetrunrunResumesendsend2sendBasicsendCurrentLogoutsendEphemeralsendEphemeral2sendEphemeralIgnoresendRemainingLogoutsserializesetsetPokeableshortTagstopListeningsummarytagtakeoverthrowOnClosetoJSONtriggerunbindunsetupdateImmediatelywaitForSyncInfoisIdType