Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProviderSocket

Hierarchy

Implements

Index

Constructors

constructor

  • new ProviderSocket(_pageId?: undefined | number, _folderId?: undefined | number): ProviderSocket
  • Parameters

    • Optional _pageId: undefined | number
    • Optional _folderId: undefined | number

    Returns ProviderSocket

Properties

Private _data

_data: any

Private _error

_error: boolean = false

Private Optional _folderId

_folderId: undefined | number

Private Optional _pageId

_pageId: undefined | number

Private _redirectCounter

_redirectCounter: number = 0

Private _redirectLimit

_redirectLimit: number = 10

Private _socket

_socket: Socket

Private _stopped

_stopped: boolean = false

Private _wsUrl

_wsUrl: string

listeners

listeners: IListeners = []

onListeners

onListeners: any

Accessors

Static SOCKET_EVENT_PAGE_CONTENT

  • get SOCKET_EVENT_PAGE_CONTENT(): string
  • Returns string

Static SOCKET_EVENT_PAGE_DATA

  • get SOCKET_EVENT_PAGE_DATA(): string
  • Returns string

Static SOCKET_EVENT_PAGE_ERROR

  • get SOCKET_EVENT_PAGE_ERROR(): string
  • Returns string

Static SOCKET_EVENT_PAGE_PUSH

  • get SOCKET_EVENT_PAGE_PUSH(): string
  • Returns string

Static SOCKET_EVENT_PAGE_SETTINGS

  • get SOCKET_EVENT_PAGE_SETTINGS(): string
  • Returns string

Static SOCKET_EVENT_PAGE_USER_JOINED

  • get SOCKET_EVENT_PAGE_USER_JOINED(): string
  • Returns string

Static SOCKET_EVENT_PAGE_USER_LEFT

  • get SOCKET_EVENT_PAGE_USER_LEFT(): string
  • Returns string

Methods

Private connect

  • connect(): Socket
  • Connect socket to a server. If client doesnt support websockets, it tries to fall back to long polling

    Returns Socket

destroy

  • destroy(hard?: boolean): void
  • Remove listeners for all socket events, disconnects socket and destroys object

    Parameters

    • Default value hard: boolean = true

    Returns void

emit

  • emit(name: string, args?: any): void
  • Parameters

    • name: string
    • Optional args: any

    Returns void

getData

  • getData(): any
  • Returns any

Private init

  • init(): void
  • Initialize socket connection with all listeners

    Returns void

off

  • off(name: string, callback: any): void
  • Parameters

    • name: string
    • callback: any

    Returns void

on

  • on(name: string, callback: any): void
  • Parameters

    • name: string
    • callback: any

    Returns void

Private onAuthRefresh

  • onAuthRefresh(): void
  • onAuthRefresh event action

    Returns void

Private onConnect

  • onConnect(): void
  • onConnect event action

    Returns void

Private onDisconnect

  • onDisconnect(): void
  • onDisconnect event action

    Returns void

Private onOAuthError

  • onOAuthError(data: any): void
  • onOAuthError event action

    Parameters

    • data: any

    Returns void

Private onPageContent

  • onPageContent eent action

    Parameters

    Returns void

Private onPageError

  • onPageError(data: any): void
  • onPageError event action

    Parameters

    • data: any

    Returns void

Private onPageSettings

  • onPageSettings event action

    Parameters

    Returns void

Private onReconnectError

  • onReconnectError(): void
  • onReconnectError event action Try and brake the previous redirect. Go back to root

    Returns void

Private onReconnectingError

  • onReconnectingError(attempt: number): void
  • Parameters

    • attempt: number

    Returns void

Private onRedirect

  • onRedirect(msg: string): void
  • onRedirect event action

    Parameters

    • msg: string

    Returns void

register

  • register(callback: any): void
  • Parameters

    • callback: any

    Returns void

removeEvent

  • removeEvent(): void

removeEvents

  • removeEvents(): void

start

  • start(): void
  • Start listening for content updates. If socket not connected yet, it will initialize the socket connection

    Returns void

stop

  • stop(): void
  • Stop receiving page content updates (still keeps receiving settings/meta updates and other events) This will NOT disconnect the socket, merely it will just stop listening for updates - throws them away

    Returns void

Private supportsWebSockets

  • supportsWebSockets(): boolean
  • Determines if client supports websockets

    Returns boolean

unRegister

  • unRegister(callback: any): void
  • Parameters

    • callback: any

    Returns void

Generated using TypeDoc