Class SocketModel

Whatsapp

65044

Hierarchy (view full)

Constructors

constructor

Properties

attributes backoffGeneration canSend? cancelHash? collection? conflictPromise? doubleAckHash? hasSynced? isIncognito? isState lastPhoneMessage? launchGeneration launched? 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? Proxy allowedIds? idClass?

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 onCriticalSyncDone onMessage onPhoneWatchdogActivated onPhoneWatchdogDeactivated onPhoneWatchdogFed onRefCycle onStateChange onStreamChange once 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

Readonly attributes

attributes: Props & Session

backoffGeneration

backoffGeneration: number

Optional canSend

canSend?: any

Optional cancelHash

cancelHash?: any

Optional collection

collection?: undefined

Optional conflictPromise

conflictPromise?: any

Optional doubleAckHash

doubleAckHash?: any

Optional hasSynced

hasSynced?: any

Optional isIncognito

isIncognito?: any

Readonly isState

isState: true

Optional lastPhoneMessage

lastPhoneMessage?: any

launchGeneration

launchGeneration: number

Optional launched

launched?: any

logoutMutex

logoutMutex: number

Readonly mirrorMask

mirrorMask: {
    change:backoffGeneration: number;
    change:canSend: number;
    change:cancelHash: number;
    change:conflictPromise: number;
    change:doubleAckHash: number;
    change:hasSynced: number;
    change:isIncognito: number;
    change:lastPhoneMessage: number;
    change:launchGeneration: number;
    change:launched: 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;
}

Type declaration

  • change:backoffGeneration: number
  • change:canSend: number
  • change:cancelHash: number
  • change:conflictPromise: number
  • change:doubleAckHash: number
  • change:hasSynced: number
  • change:isIncognito: number
  • change:lastPhoneMessage: number
  • change:launchGeneration: number
  • change:launched: 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

Optional mustExitLoop

mustExitLoop?: any

Optional parent

parent?: any

pendingPhoneReqs

pendingPhoneReqs: number

Optional phoneWatchdog

phoneWatchdog?: any

Optional pokeable

pokeable?: any

proxyName

proxyName: string

Optional refWatcher

refWatcher?: any

Optional resumePromise

resumePromise?: any

Optional retryTimestamp

retryTimestamp?: any

Optional runPromise

runPromise?: any

Optional sendHash

sendHash?: any

Optional sendQueue

sendQueue?: any

sequence

sequence: number

Optional shortTagBase

shortTagBase?: any

shouldForceReconnect

shouldForceReconnect: boolean

shouldUpgradeToMDIntern

shouldUpgradeToMDIntern: boolean

shouldUpgradeToMDPord

shouldUpgradeToMDPord: boolean

Optional socket

socket?: any

Optional socketPreload

socketPreload?: any

Optional socketWatcher

socketWatcher?: any

state

state: string

stream

stream: string

Optional streamPromise

streamPromise?: any

Optional syncTag

syncTag?: any

Static Proxy

Proxy: string

Static Optional allowedIds

allowedIds?: any[]

Static Optional idClass

idClass?: any

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
    • Optional context: any

    Returns this

    Alias

    on

canRequestBeSent

  • canRequestBeSent(e?): any

  • Parameters

    • Optional e: any

    Returns any

clear

  • clear(): void

  • Returns void

clearCredentials

  • clearCredentials(): any

  • Returns any

clearCredentialsAndStoredData

  • clearCredentialsAndStoredData(): any

  • Returns any

clearSendHash

  • clearSendHash(e?): any

  • Parameters

    • Optional e: 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

    • Optional e: 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

    • Optional e: 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

    • Optional e: any
    • Optional t: 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.

    • Optional listener: 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.

    • Optional listener: 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.

    • Optional listener: 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

    • Optional e: any

    Returns any

off

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

  • Removes the specified listener from the listener array for the event named eventName.

    Parameters

    • Optional eventName: Event

      The name of the event.

    • Optional listener: Listener

      The callback function.

    • Optional context: 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.

    • Optional context: 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

    • Optional e: any

    Returns any

onActivity

  • onActivity(e?): any

  • Parameters

    • Optional e: any

    Returns any

onCriticalSyncDone

  • onCriticalSyncDone(): any

  • Returns any

onMessage

  • onMessage(e?): any

  • Parameters

    • Optional e: 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

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.

    • Optional context: 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.

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

    • Optional e: 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

    • Optional eventName: Event
    • Optional listener: Listener
    • Optional context: any

    Returns this

    Alias

    off

requestSync

  • requestSync(e?): any

  • Parameters

    • Optional e: any

    Returns any

reset

  • reset(): void

  • Returns void

run

  • run(e?, t?): any

  • Parameters

    • Optional e: any
    • Optional t: any

    Returns any

runResume

  • runResume(e?): any

  • Parameters

    • Optional e: any

    Returns any

send

  • send(e?): any

  • Parameters

    • Optional e: any

    Returns any

send2

  • send2(e?): any

  • Parameters

    • Optional e: any

    Returns any

sendBasic

  • sendBasic(e?): any

  • Parameters

    • Optional e: any

    Returns any

sendCurrentLogout

  • sendCurrentLogout(e?): any

  • Parameters

    • Optional e: any

    Returns any

sendEphemeral

  • sendEphemeral(e?): any

  • Parameters

    • Optional e: any

    Returns any

sendEphemeral2

  • sendEphemeral2(e?): any

  • Parameters

    • Optional e: any

    Returns any

sendEphemeralIgnore

  • sendEphemeralIgnore(e?): any

  • Parameters

    • Optional e: 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

    • Optional e: any
    • Optional t: number

    Returns any

shortTag

  • shortTag(): any

  • Returns any

stopListening

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

  • Parameters

    • Optional context: any
    • Optional eventName: Event
    • Optional listener: Listener

    Returns this

summary

  • summary(): any

  • Returns any

tag

  • tag(e?): any

  • Parameters

    • Optional e: 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

    • Optional eventName: Event
    • Optional listener: Listener
    • Optional context: any

    Returns this

    Alias

    off

unset

  • unset(ids, t?): void

  • Parameters

    • ids: Stringable | Stringable[]
    • Optional t: any

    Returns void

updateImmediately

  • updateImmediately(e?): any

  • Parameters

    • Optional e: any

    Returns any

waitForSyncInfo

  • waitForSyncInfo(): any

  • Returns any

Static isIdType

  • isIdType(e): boolean

  • Parameters

    • e: any

    Returns boolean

Settings

Member Visibility

Theme

On This Page

constructorattributesbackoffGenerationcanSendcancelHashcollectionconflictPromisedoubleAckHashhasSyncedisIncognitoisStatelastPhoneMessagelaunchGenerationlaunchedlogoutMutexmirrorMaskmustExitLoopparentpendingPhoneReqsphoneWatchdogpokeableproxyNamerefWatcherresumePromiseretryTimestamprunPromisesendHashsendQueuesequenceshortTagBaseshouldForceReconnectshouldUpgradeToMDInternshouldUpgradeToMDPordsocketsocketPreloadsocketWatcherstatestreamstreamPromisesyncTagProxyallowedIdsidClassaddChildbindcanRequestBeSentclearclearCredentialsclearCredentialsAndStoredDataclearSendHashclearStatedecObserversdeletedeprecatedVersiondestroyStorageemitexitLoopflushQueuegetgetDefaulthasObservershasUnfiredChangesincObserversinitConninitializeisListeninglaunchlistenTolistenToAndRunlistenToOncelogoutlookForAndHandleChallengemanageRefmaybeResendRequestEventuallyoffonon5xxonActivityonCriticalSyncDoneonMessageonPhoneWatchdogActivatedonPhoneWatchdogDeactivatedonPhoneWatchdogFedonRefCycleonStateChangeonStreamChangeonceopenSocketopenStreamphoneTimedOutpokepreloadqueryReceivedActionsregisterHandlerremoveAllListenersremoveListenerrequestSyncresetrunrunResumesendsend2sendBasicsendCurrentLogoutsendEphemeralsendEphemeral2sendEphemeralIgnoresendRemainingLogoutsserializesetsetPokeableshortTagstopListeningsummarytagtakeoverthrowOnClosetoJSONtriggerunbindunsetupdateImmediatelywaitForSyncInfoisIdType