Nextcloud PHP API (stable18)

ABroadcastedEvent extends Event implements JsonSerializable

Base event class for the event dispatcher service

Typically this class isn't instantiated directly but sub classed for specific event types

Tags
since
18.0.0

Interfaces, Classes and Traits

JsonSerializable

Table of Contents

$broadcasted  : mixed
__construct()  : mixed
Compatibility constructor
broadcastAs()  : string
Get the name of the event, as received on the client-side
getUids()  : string[]
isBroadcasted()  : bool
setBroadcasted()  : void

Properties

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
since
18.0.0
Return values
mixed

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
since
18.0.0
Return values
string

getUids()

public abstract getUids() : string[]
Tags
since
18.0.0
Return values
string[]

isBroadcasted()

public isBroadcasted() : bool
Tags
since
18.0.0
Return values
bool

Search results