Nextcloud PHP API (master)

AbstractCalendarObjectEvent extends Event
in package
implements IWebhookCompatibleEvent

AbstractYes

Base event class for the event dispatcher service

Tags
since
32.0.0

Table of Contents

Interfaces

IWebhookCompatibleEvent
Interface for events which can be listened to by webhooks

Properties

$calendarData  : array<string|int, mixed>
$calendarId  : int
$objectData  : array<string|int, mixed>
$propagationStopped  : bool
$shares  : array<string|int, mixed>

Methods

__construct()  : mixed
Compatibility constructor
getCalendarData()  : array<string|int, mixed>
getCalendarId()  : int
getObjectData()  : array<string|int, mixed>
getShares()  : array<string|int, mixed>
getWebhookSerializable()  : array<string|int, mixed>
Return data to be serialized and sent to the webhook. Will be serialized using json_encode.
isPropagationStopped()  : bool
{@inheritDoc}
stopPropagation()  : void
Stops the propagation of the event to further event listeners

Properties

$propagationStopped

private bool $propagationStopped = false
Tags
since
22.0.0

Methods

__construct()

Compatibility constructor

public __construct(int $calendarId, array<string|int, mixed> $calendarData, array<string|int, mixed> $shares, array<string|int, mixed> $objectData) : mixed
Parameters
$calendarId : int
$calendarData : array<string|int, mixed>
$shares : array<string|int, mixed>
$objectData : array<string|int, mixed>
Tags
since
32.0.0

getCalendarData()

public getCalendarData() : array<string|int, mixed>
Tags
since
32.0.0
Return values
array<string|int, mixed>

getObjectData()

public getObjectData() : array<string|int, mixed>
Tags
since
32.0.0
Return values
array<string|int, mixed>

getWebhookSerializable()

Return data to be serialized and sent to the webhook. Will be serialized using json_encode.

public getWebhookSerializable() : array<string|int, mixed>
Tags
since
32.0.0
Return values
array<string|int, mixed>

isPropagationStopped()

{@inheritDoc}

public isPropagationStopped() : bool
Tags
since
22.0.0
see
StoppableEventInterface
Return values
bool

stopPropagation()

Stops the propagation of the event to further event listeners

public stopPropagation() : void
Tags
since
22.0.0

        
On this page

Search results