Interface NullPrivateChannel

Hierarchy

NullChannel
PrivateChannel
- NullPrivateChannel
  - NullPresenceChannel

Index

Properties

Methods

Properties

eventFormatter

eventFormatter: EventFormatter

The event formatter.

name

name: string

The name of the channel.

options

options: any

Channel options.

Methods

listen

listen(event: string, callback: function): Channel

Inherited from Channel.listen

Overrides Channel.listen
- Defined in laravel-echo.d.ts:407
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

Inherited from Channel.listenForWhisper

Overrides Channel.listenForWhisper
- Defined in laravel-echo.d.ts:424
Listen for a whisper event on the channel instance.

Parameters
- event: string
- callback: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns Channel

notification

notification(callback: function): Channel

Inherited from Channel.notification

Overrides Channel.notification
- Defined in laravel-echo.d.ts:415
Listen for a notification on the channel instance.

Parameters
- callback: function
  - - (notification: any): void
    - Parameters
      - notification: any
      Returns void
Returns Channel

on

on(event: string, callback: Null.EventCallback): Channel

Inherited from NullChannel.on
- Defined in laravel-echo.d.ts:490
Bind a channel to an event.

Parameters
- event: string
- callback: Null.EventCallback
Returns Channel

stopListening

stopListening(event: string): Channel

Inherited from NullChannel.stopListening
- Defined in laravel-echo.d.ts:481
Stop listening for an event on the channel instance.

Parameters
- event: string
Returns Channel

subscribe

subscribe(): void

Inherited from NullChannel.subscribe
- Defined in laravel-echo.d.ts:468
Subscribe to a Null channel.

Returns void

unsubscribe

unsubscribe(): void

Inherited from NullChannel.unsubscribe
- Defined in laravel-echo.d.ts:473
Unsubscribe from a Null channel.

Returns void

whisper

whisper(event: string, data: any): PrivateChannel

Inherited from PrivateChannel.whisper
- Defined in laravel-echo.d.ts:435
Trigger client event on the channel.

Parameters
- event: string
- data: any
Returns PrivateChannel