Class SocketModel

constructor

• new SocketModel(
      proterties?: ModelPropertiesContructor<SocketModel>,
      options?: ModelOptions,
  ): SocketModel

• Parameters

  • Optionalproterties: ModelPropertiesContructor<SocketModel>
  • Optionaloptions: ModelOptions

  Returns SocketModel

Optionalcollection

Optionalparent

proxyName

Static OptionalallowedIds

Static OptionalidClass

StaticProxy

addChild

• addChild(id: Stringable, context: { [key: string]: any }): void

• Parameters

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

  Returns void

bind

• bind(eventName: Event, listener: Listener, context?: any): this

• Alias of on

  Parameters

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

  Returns this

  Alias

  on

canRequestBeSent

• canRequestBeSent(e?: any): 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): 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: Event, ...args: any[]): this

• Alias of trigger

  Parameters

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

  Returns this

  Alias

  trigger

exitLoop

• exitLoop(e?: any): any

• Parameters

  • Optionale: any

  Returns any

flushQueue

• flushQueue(): any

• Returns any

get

• get<T extends keyof SocketModel>(attr: T): SocketModel[T]

• Type Parameters

  • T extends keyof SocketModel

  Parameters

  • attr: T

  Returns SocketModel[T]

getDefault

• getDefault<T extends keyof SocketModel>(attr: T): any

• Type Parameters

  • T extends keyof SocketModel

  Parameters

  • attr: T

  Returns any

hasObservers

• hasObservers(): boolean

• Returns boolean

hasUnfiredChanges

• hasUnfiredChanges(): boolean

• Returns boolean

incObservers

• incObservers(e?: boolean): void

• Parameters

  • Optionale: boolean

  Returns void

initConn

• initConn(): any

• Returns any

initialize

• initialize(): any

• Returns any

isListening

• isListening(eventName: Event): boolean

• Parameters

  • eventName: Event

  Returns boolean

launch

• launch(e?: any, t?: number): any

• Parameters

  • Optionale: any
  • Optionalt: number

  Returns any

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

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

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

logout

• logout(sendLogout?: boolean, reason?: LogoutReason): void

• Parameters

  • OptionalsendLogout: boolean
  • Optionalreason: LogoutReason

  Returns void

lookForAndHandleChallenge

• lookForAndHandleChallenge(): any

• Returns any

manageRef

• manageRef(): any

• Returns any

maybeResendRequestEventually

• maybeResendRequestEventually(e?: any): any

• Parameters

  • Optionale: any

  Returns any

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.

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.

on5xx

• on5xx(e?: any): any

• Parameters

  • Optionale: any

  Returns any

onActivity

• onActivity(e?: any): any

• Parameters

  • Optionale: any

  Returns any

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.

onCriticalSyncDone

• onCriticalSyncDone(): any

• Returns any

onMessage

• onMessage(e?: any): 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): 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?: Event, listener?: Listener, context?: any): this

• Alias of off

  Parameters

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

  Returns this

  Alias

  off

requestSync

• requestSync(e?: any): any

• Parameters

  • Optionale: any

  Returns any

reset

• reset(): void

• Returns void

run

• run(e?: any, t?: any): any

• Parameters

  • Optionale: any
  • Optionalt: any

  Returns any

runResume

• runResume(e?: any): any

• Parameters

  • Optionale: any

  Returns any

send

• send(e?: any): any

• Parameters

  • Optionale: any

  Returns any

send2

• send2(e?: any): any

• Parameters

  • Optionale: any

  Returns any

sendBasic

• sendBasic(e?: any): any

• Parameters

  • Optionale: any

  Returns any

sendCurrentLogout

• sendCurrentLogout(e?: any): any

• Parameters

  • Optionale: any

  Returns any

sendEphemeral

• sendEphemeral(e?: any): any

• Parameters

  • Optionale: any

  Returns any

sendEphemeral2

• sendEphemeral2(e?: any): any

• Parameters

  • Optionale: any

  Returns any

sendEphemeralIgnore

• sendEphemeralIgnore(e?: any): any

• Parameters

  • Optionale: any

  Returns any

sendRemainingLogouts

• sendRemainingLogouts(): any

• Returns any

set

• set(...args: any): any

• Parameters

  • ...args: any

  Returns any

setPokeable

• setPokeable(e?: any, t?: number): any

• Parameters

  • Optionale: any
  • Optionalt: number

  Returns any

shortTag

• shortTag(): any

• Returns any

stopListening

• stopListening(context?: any, eventName?: Event, listener?: Listener): this

• Parameters

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

  Returns this

summary

• summary(): any

• Returns any

tag

• tag(e?: any): any

• Parameters

  • Optionale: any

  Returns any

takeover

• takeover(): any

• Returns any

throwOnClose

• throwOnClose(): any

• Returns any

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.

unbind

• unbind(eventName?: Event, listener?: Listener, context?: any): this

• Alias of off

  Parameters

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

  Returns this

  Alias

  off

unset

• unset(ids: Stringable | Stringable[], t?: any): void

• Parameters

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

  Returns void

updateImmediately

• updateImmediately(e?: any): any

• Parameters

  • Optionale: any

  Returns any

waitForSyncInfo

• waitForSyncInfo(): any

• Returns any

StaticisIdType

• isIdType(e: any): boolean

• Parameters

  • e: any

  Returns boolean