Interface SocketIoConnector

Hierarchy

Connector
- SocketIoConnector

Callable

__call(options: SocketIoConfig): Connector
__call(options: Config): Connector

- Defined in laravel-echo.d.ts:332
Create a new class instance.

Parameters
- options: SocketIoConfig
Returns Connector
- Defined in laravel-echo.d.ts:166
Create a new class instance.

Parameters
- options: Config
Returns Connector

Index

Properties

Methods

Properties

channels

channels: any

All of the subscribed channel names.

options

options: Config

Connector options.

socket

socket: Socket

The Socket.io connection instance.

Methods

channel

channel(name: string): SocketIoChannel

Overrides Connector.channel
- Defined in laravel-echo.d.ts:365
Get a channel instance by name.

Parameters
- name: string
Returns SocketIoChannel

connect

connect(): void

Inherited from Connector.connect
- Defined in laravel-echo.d.ts:179
Create a fresh connection.

Returns void

disconnect

disconnect(): void

Inherited from Connector.disconnect
- Defined in laravel-echo.d.ts:232
Disconnect from the Echo server.

Returns void

getSocketIO

getSocketIO(): SocketIOClientStatic

- Defined in laravel-echo.d.ts:347
Get socket.io module from global scope or options.

Returns SocketIOClientStatic

leave

leave(channel: string): void

Inherited from Connector.leave
- Defined in laravel-echo.d.ts:220
Leave the given channel.

Parameters
- channel: string
Returns void

listen

listen(name: string, event: string, callback: function): SocketIoChannel

Overrides Connector.listen
- Defined in laravel-echo.d.ts:357
Listen for an event on a channel instance.

Parameters
- name: string
- event: string
- callback: function
  - - (event: any): void
    - Parameters
      - event: any
      Returns void
Returns SocketIoChannel

presenceChannel

presenceChannel(name: string): SocketIoPresenceChannel

Overrides Connector.presenceChannel
- Defined in laravel-echo.d.ts:381
Get a presence channel instance by name.

Parameters
- name: string
Returns SocketIoPresenceChannel

privateChannel

privateChannel(name: string): SocketIoPrivateChannel

Overrides Connector.privateChannel
- Defined in laravel-echo.d.ts:373
Get a private channel instance by name.

Parameters
- name: string
Returns SocketIoPrivateChannel

socketId

socketId(): string

Inherited from Connector.socketId
- Defined in laravel-echo.d.ts:227
Get the socket_id of the connection.

Returns string