Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EchoStatic

Hierarchy

  • EchoStatic

Index

Constructors

constructor

  • new EchoStatic(options: Echo.Config): EchoStatic
  • Create a new class instance.

    Parameters

    • options: Echo.Config

    Returns EchoStatic

Properties

connector

connector: Echo.PusherConnector | Echo.SocketIoConnector | Echo.NullConnector

The broadcasting connector.

options

options: Echo.Config

The echo options.

Methods

channel

  • channel(channel: string): Echo.Channel
  • Get a channel instance by name.

    Parameters

    • channel: string

    Returns Echo.Channel

disconnect

  • disconnect(): void
  • Disconnect from the Echo server.

    Returns void

join

  • join(channel: string): Echo.PresenceChannel
  • Get a presence channel instance by name.

    Parameters

    • channel: string

    Returns Echo.PresenceChannel

leave

  • leave(channel: string): void
  • Leave the given channel.

    Parameters

    • channel: string

    Returns void

listen

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

    Parameters

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

          • event: any

          Returns void

    Returns Echo.Channel

private

  • private(channel: string): Echo.PrivateChannel
  • Get a private channel instance by name.

    Parameters

    • channel: string

    Returns Echo.PrivateChannel

registerAxiosRequestInterceptor

  • registerAxiosRequestInterceptor(): void
  • Register an Axios HTTP interceptor to add the X-Socket-ID header.

    Returns void

registerVueRequestInterceptor

  • registerVueRequestInterceptor(): void
  • Register a Vue HTTP interceptor to add the X-Socket-ID header.

    Returns void

registerjQueryAjaxSetup

  • registerjQueryAjaxSetup(): void
  • Register jQuery AjaxSetup to add the X-Socket-ID header.

    Returns void

socketId

  • socketId(): string
  • Get the Socket ID for the connection.

    Returns string