Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SocketIoChannel

Hierarchy

Callable

Index

Properties

eventFormatter

eventFormatter: EventFormatter

The event formatter.

events

events: any

The event callbacks applied to the channel.

name

name: string

The name of the channel.

options

options: any

Channel options.

socket

socket: io

The SocketIo client instance

Methods

bind

  • Bind the channel's socket to an event and store the callback.

    Parameters

    • event: string
    • callback: function
        • (event: any): void
        • Parameters

          • event: any

          Returns void

    Returns SocketIoChannel

configureReconnector

  • configureReconnector(): void

listen

  • listen(event: string, callback: function): Channel
  • Listen for an event on the channel instance.

    Parameters

    • event: string
    • callback: function
        • (event: any): void
        • Parameters

          • event: any

          Returns void

    Returns Channel

listenForWhisper

  • listenForWhisper(event: string, callback: function): Channel

notification

  • notification(callback: function): Channel
  • Listen for a notification on the channel instance.

    Parameters

    • callback: function
        • (notification: any): void
        • Parameters

          • notification: any

          Returns void

    Returns Channel

on

  • Bind a channel to an event.

    Parameters

    • event: string
    • callback: function
        • (event: any): void
        • Parameters

          • event: any

          Returns void

    Returns SocketIoChannel

subscribe

  • subscribe(): void

unbind

  • unbind(): void
  • Unbind the channel's socket from all stored event callbacks.

    Returns void

unsubscribe

  • unsubscribe(): void