ABroadcastedEvent
extends Event
in package
implements
JsonSerializable
AbstractYes
Base event class for the event dispatcher service
Tags
Table of Contents
Interfaces
- JsonSerializable
Properties
- $broadcasted : mixed
Methods
- __construct() : mixed
- Compatibility constructor
- broadcastAs() : string
- Get the name of the event, as received on the client-side
- getUids() : array<string|int, string>
- isBroadcasted() : bool
- isPropagationStopped() : bool
- {@inheritDoc}
- setBroadcasted() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$broadcasted
private
mixed
$broadcasted
= false
Tags
Methods
__construct()
Compatibility constructor
public
__construct() : mixed
In Nextcloud 17.0.0 this event class used a now deprecated/removed Symfony base class that had a constructor (with default arguments). To lower the risk of a breaking change (PHP won't allow parent constructor calls if there is none), this empty constructor's only purpose is to hopefully not break existing sub- classes of this class.
Tags
broadcastAs()
Get the name of the event, as received on the client-side
public
broadcastAs() : string
Uses the fully qualified event class name by default
Tags
Return values
stringgetUids()
public
abstract getUids() : array<string|int, string>
Tags
Return values
array<string|int, string>isBroadcasted()
public
isBroadcasted() : bool
Tags
Return values
boolisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Return values
boolsetBroadcasted()
public
setBroadcasted() : void
Tags
stopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void