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
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
getID()
Identifier of the notifier, only use [a-z0-9_]
public
getID() : string
Tags
Return values
string —getName()
Human readable name describing the notifier
public
getName() : string
Tags
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