MediaWiki master
Public Member Functions | List of all members
MediaWiki\Notification\NotificationEnvelope Class Reference

An object representing notification with list of recipients. More...

Public Member Functions

 __construct ( $notification, $recipientSet)
 
 equals (NotificationEnvelope $envelope)
 Syntax sugar, allows easy check if two envelopes point to the same thing.
 
 getNotification ()
 
 getRecipientSet ()
 
 hasAgent ()
 Check if the Notification has defined agent.
 

Detailed Description

An object representing notification with list of recipients.

Stability: newable
Since
1.45 @template T of Notification

Definition at line 10 of file NotificationEnvelope.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Notification\NotificationEnvelope::__construct ( $notification,
$recipientSet )
Parameters
T$notification
RecipientSet$recipientSet

Definition at line 20 of file NotificationEnvelope.php.

Member Function Documentation

◆ equals()

MediaWiki\Notification\NotificationEnvelope::equals ( NotificationEnvelope $envelope)

Syntax sugar, allows easy check if two envelopes point to the same thing.

Definition at line 39 of file NotificationEnvelope.php.

◆ getNotification()

MediaWiki\Notification\NotificationEnvelope::getNotification ( )
Returns
T

Definition at line 28 of file NotificationEnvelope.php.

◆ getRecipientSet()

MediaWiki\Notification\NotificationEnvelope::getRecipientSet ( )

Definition at line 32 of file NotificationEnvelope.php.

◆ hasAgent()

MediaWiki\Notification\NotificationEnvelope::hasAgent ( )

Check if the Notification has defined agent.

Utility method for a very common check where middleware filters Notifications from specific agent.

Definition at line 49 of file NotificationEnvelope.php.

The documentation for this class was generated from the following file: