Elgg  Version 4.x
Public Member Functions | List of all members
Elgg\Notifications\InstantNotificationEventHandler Class Reference

Notification Event Handler for instant notifications. More...

Inheritance diagram for Elgg\Notifications\InstantNotificationEventHandler:
Elgg\Notifications\NotificationEventHandler

Public Member Functions

 getSubscriptions ()
 
- Public Member Functions inherited from Elgg\Notifications\NotificationEventHandler
 __construct (NotificationEvent $event, NotificationsService $service, array $params=[])
 Constructor. More...
 
 send ()
 Process the event. More...
 
 getSubscriptions ()
 Returns subscriptions for the event. More...
 
 getMethods ()
 Returns methods to be used for this notification. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Elgg\Notifications\NotificationEventHandler
static isConfigurableByUser ()
 Is this event configurable by the user on the notification settings page. More...
 
static isConfigurableForEntity (\ElggEntity $entity)
 Can this event be configured for a specific entity. More...
 
- Protected Member Functions inherited from Elgg\Notifications\NotificationEventHandler
 prepareSubscriptions ()
 Returns subscriptions. More...
 
 filterMutedSubscriptions ()
 Should muted subscribers be filtered. More...
 
 getNotificationSubsciptionExclusionGUIDs ()
 Get an array of GUIDs to not get the subscription records for. More...
 
 excludeOwnerSubscribers ()
 Exclude the NotificationEvent object owner_guid when fetching the subscription records for this notification. More...
 
 excludeContainerSubscribers ()
 Exclude the NotificationEvent object container_guid when fetching the subscription records for this notification. More...
 
 excludeEntitySubscribers ()
 Exclude the NotificationEvent object guid when fetching the subscription records for this notification. More...
 
 sendNotifications ($subscriptions, array $params=[])
 Sends the notifications based on subscriptions. More...
 
 sendNotification (int $guid, string $method, array $params=[])
 Send a notification to a subscriber. More...
 
 deliverNotification (Notification $notification, string $method)
 Deliver a notification. More...
 
 prepareNotification (array $params)
 Prepares a notification for delivery. More...
 
 getNotificationSubject (\ElggUser $recipient, string $method)
 Get subject for the notification. More...
 
 getNotificationBody (\ElggUser $recipient, string $method)
 Get body for the notification. More...
 
 getNotificationSummary (\ElggUser $recipient, string $method)
 Return the summary for a notification. More...
 
 getNotificationURL (\ElggUser $recipient, string $method)
 Returns the url related to this notification. More...
 
- Static Protected Member Functions inherited from Elgg\Notifications\NotificationEventHandler
static isConfigurableForUser (\ElggUser $user)
 Can this event be configured for a specific user. More...
 
static isConfigurableForGroup (\ElggGroup $group)
 Can this event be configured for a specific group. More...
 
- Protected Attributes inherited from Elgg\Notifications\NotificationEventHandler
 $event
 
 $service
 
 $params = []
 

Detailed Description

Notification Event Handler for instant notifications.

Since
4.0

Definition at line 10 of file InstantNotificationEventHandler.php.

Member Function Documentation

Elgg\Notifications\InstantNotificationEventHandler::getSubscriptions ( )

Definition at line 15 of file InstantNotificationEventHandler.php.


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