@wppconnect-team/wppconnect - v1.36.4
    Preparing search index...

    Class SocketModel

    65044

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    attributes: Props & Session
    backoffGeneration: number
    cancelHash?: any
    canSend?: any
    collection?: undefined
    conflictPromise?: any
    doubleAckHash?: any
    hasSynced?: any
    isIncognito?: any
    isState: true
    lastPhoneMessage?: any
    launched?: any
    launchGeneration: number
    logoutMutex: number
    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;
    }
    mustExitLoop?: any
    parent?: any
    pendingPhoneReqs: number
    phoneWatchdog?: any
    pokeable?: any
    proxyName: string
    refWatcher?: any
    resumePromise?: any
    retryTimestamp?: any
    runPromise?: any
    sendHash?: any
    sendQueue?: any
    sequence: number
    shortTagBase?: any
    shouldForceReconnect: boolean
    shouldUpgradeToMDIntern: boolean
    shouldUpgradeToMDPord: boolean
    socket?: any
    socketPreload?: any
    socketWatcher?: any
    state: string
    stream: string
    streamPromise?: any
    syncTag?: any
    allowedIds?: any[]
    idClass?: any
    Proxy: string

    Methods

    • Parameters

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

      Returns void

    • Alias of on

      Parameters

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

      Returns this

      on

    • Parameters

      • Optionale: any

      Returns any

    • Returns void

    • Returns any

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Returns void

    • Returns void

    • Returns any

    • Returns any

    • Alias of trigger

      Parameters

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

      Returns this

      trigger

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Type Parameters

      Parameters

      • attr: T

      Returns any

    • Returns boolean

    • Returns boolean

    • Parameters

      • Optionale: boolean

      Returns void

    • Returns any

    • Returns any

    • Parameters

      • eventName: Event

      Returns boolean

    • Parameters

      • Optionale: any
      • Optionalt: number

      Returns any

    • 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

    • 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

    • 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

    • Parameters

      Returns void

    • Returns any

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • 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.

    • 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.

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • 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.

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns any

    • Returns void

    • Returns any

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Removes all listeners.

      Returns this

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

    • Alias of off

      Parameters

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

      Returns this

      off

    • Parameters

      • Optionale: any

      Returns any

    • Returns void

    • Parameters

      • Optionale: any
      • Optionalt: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Returns Props

    • Parameters

      • ...args: any

      Returns any

    • Parameters

      • Optionale: any
      • Optionalt: number

      Returns any

    • Returns any

    • Parameters

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

      Returns this

    • Returns any

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Returns any

    • Returns Props

    • 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.

    • Alias of off

      Parameters

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

      Returns this

      off

    • Parameters

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

      Returns void

    • Parameters

      • Optionale: any

      Returns any

    • Returns any

    • Parameters

      • e: any

      Returns boolean