Interface PresenceChannel

Hierarchy

PrivateChannel
- PresenceChannel

Index

Properties

Methods

Properties

eventFormatter

eventFormatter: EventFormatter

The event formatter.

name

name: string

The name of the channel.

options

options: any

Channel options.

Methods

here

here(callback: function): PresenceChannel

- Defined in laravel-echo.d.ts:445
Register a callback to be called anytime the member list changes.

Parameters
- callback: function
  - - (users: any[]): void
    - Parameters
      - users: any[]
      Returns void
Returns PresenceChannel

joining

joining(callback: function): PresenceChannel

- Defined in laravel-echo.d.ts:453
Listen for someone joining the channel.

Parameters
- callback: function
  - - (user: any): void
    - Parameters
      - user: any
      Returns void
Returns PresenceChannel

leaving

leaving(callback: function): PresenceChannel

- Defined in laravel-echo.d.ts:461
Listen for someone leaving the channel.

Parameters
- callback: function
  - - (user: any): void
    - Parameters
      - user: any
      Returns void
Returns PresenceChannel

listen

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

Inherited from 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
- 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
- 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

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