1. interface
  2. Hypervel
  3. \
  4. Inertia
  5. \
  6. SupportsLiveUpdates

SupportsLiveUpdates

interface SupportsLiveUpdates

Methods

SupportsLiveUpdates
live(array|object|string|null $on = null, array|Channel|string|null $channel = null, int|null $throttle = null)

Mark the property as live, refreshing it whenever one of the given events is received.

bool
isLive()

Determine if the property should receive live updates.

array
liveListeners()

Get the live-update listeners that should refresh the property.

int|null
liveThrottle()

Get the number of milliseconds to throttle live updates by.

Details

at line 17
SupportsLiveUpdates live(array|object|string|null $on = null, array|Channel|string|null $channel = null, int|null $throttle = null)

Mark the property as live, refreshing it whenever one of the given events is received.

Parameters

array|object|string|null $on
array|Channel|string|null $channel
int|null $throttle

Return Value

SupportsLiveUpdates

at line 22
bool isLive()

Determine if the property should receive live updates.

Return Value

bool

at line 29
array liveListeners()

Get the live-update listeners that should refresh the property.

Return Value

array

at line 34
int|null liveThrottle()

Get the number of milliseconds to throttle live updates by.

Return Value

int|null