Nextcloud PHP API (stable18)

IDismissableNotifier extends INotifier

Interface INotifier classes should implement if they want to process notifications that are dismissed by the user.

This can be useful if dismissing the notification will leave it in an incomplete state. The handler can chose to for example do some default action.

Tags
since
18.0.0

Table of Contents

dismissNotification()  : void
getID()  : string
Identifier of the notifier, only use [a-z0-9_]
getName()  : string
Human readable name describing the notifier
prepare()  : INotification

Methods

dismissNotification()

public dismissNotification(INotification $notification) : void
Parameters
$notification : INotification
Tags
throws
InvalidArgumentException

In case the handler can't handle the notification

since
18.0.0

getID()

Identifier of the notifier, only use [a-z0-9_]

public getID() : string
Tags
since
17.0.0
Return values
string

getName()

Human readable name describing the notifier

public getName() : string
Tags
since
17.0.0
Return values
string

prepare()

public prepare(INotification $notification, string $languageCode) : INotification
Parameters
$notification : INotification
$languageCode : string

The code of the language that should be used to prepare the notification

Tags
throws
InvalidArgumentException

When the notification was not prepared by a notifier

throws
AlreadyProcessedException

When the notification is not needed anymore and should be deleted

since
9.0.0
Return values
INotification

Search results