CommentsEvent
extends Event
in package
implements
IWebhookCompatibleEvent
Class CommentsEvent
Tags
Attributes
- #[Consumable]
- $since: '9.0.0'
Table of Contents
Interfaces
- IWebhookCompatibleEvent
- Interface for events which can be listened to by webhooks
Constants
- EVENT_ADD : mixed = 'OCP\Comments\ICommentsManager::addComment'
- EVENT_DELETE : mixed = 'OCP\Comments\ICommentsManager::deleteComment'
- EVENT_PRE_UPDATE : mixed = 'OCP\Comments\ICommentsManager::preUpdateComment'
- EVENT_UPDATE : mixed = 'OCP\Comments\ICommentsManager::updateComment'
Properties
Methods
- __construct() : mixed
- CommentsEvent constructor.
- getComment() : IComment
- getEvent() : string
- 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
Constants
EVENT_ADD
Use \OCP\Comments\Events\CommentAddedEvent instead.
public
mixed
EVENT_ADD
= 'OCP\Comments\ICommentsManager::addComment'
Tags
EVENT_DELETE
Use \OCP\Comments\Events\CommentDeletedEvent instead.
public
mixed
EVENT_DELETE
= 'OCP\Comments\ICommentsManager::deleteComment'
Tags
EVENT_PRE_UPDATE
Use \OCP\Comments\Events\BeforeCommentUpdatedEvent instead.
public
mixed
EVENT_PRE_UPDATE
= 'OCP\Comments\ICommentsManager::preUpdateComment'
Tags
EVENT_UPDATE
Use \OCP\Comments\Events\CommentUpdatedEvent instead.
public
mixed
EVENT_UPDATE
= 'OCP\Comments\ICommentsManager::updateComment'
Tags
Properties
$comment read-only
protected
IComment
$comment
$event read-only
protected
string
$event
Methods
__construct()
CommentsEvent constructor.
public
__construct(string $event, IComment $comment) : mixed
Parameters
- $event : string
- $comment : IComment
Tags
getComment()
public
getComment() : IComment
Tags
Return values
ICommentgetEvent()
public
getEvent() : string
Use instanceof CommentAddedEvent, CommentRemovedEvent, CommentUpdatedEvent or BeforeCommentUpdatedEvent instead.
Tags
Return values
stringgetWebhookSerializable()
Return data to be serialized and sent to the webhook. Will be serialized using json_encode.
public
getWebhookSerializable() : array<string|int, mixed>
Tags
Attributes
- #[Override]
Return values
array<string|int, mixed>isPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Attributes
- #[Override]
Return values
boolstopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void