Elgg\Notifications\NotificationEvent Interface Reference

Notification event interface. More...

Inheritance diagram for Elgg\Notifications\NotificationEvent:

Public Member Functions
	getActor ()
	Get the actor of the event. More...
	getActorGUID ()
	Get the GUID of the actor. More...
	getObject ()
	Get the object of the event. More...
	getAction ()
	Get the name of the action. More...
	getDescription ()
	Get a description of the event. More...

Detailed Description

Notification event interface.

Definition at line 11 of file NotificationEvent.php.

Member Function Documentation

Elgg\Notifications\NotificationEvent::getAction

(

)

Get the name of the action.

Returns

string

Implemented in Elgg\Notifications\SubscriptionNotificationEvent, and Elgg\Notifications\InstantNotificationEvent.

Elgg\Notifications\NotificationEvent::getActor

(

)

Get the actor of the event.

Returns

|false

Implemented in Elgg\Notifications\SubscriptionNotificationEvent, and Elgg\Notifications\InstantNotificationEvent.

Elgg\Notifications\NotificationEvent::getActorGUID

(

)

Get the GUID of the actor.

Returns

int

Implemented in Elgg\Notifications\SubscriptionNotificationEvent, and Elgg\Notifications\InstantNotificationEvent.

Elgg\Notifications\NotificationEvent::getDescription

(

)

Get a description of the event.

Returns

string

Implemented in Elgg\Notifications\SubscriptionNotificationEvent, and Elgg\Notifications\InstantNotificationEvent.

Elgg\Notifications\NotificationEvent::getObject

(

)

Get the object of the event.

Returns

|false

Implemented in Elgg\Notifications\SubscriptionNotificationEvent, and Elgg\Notifications\InstantNotificationEvent.

---

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

• engine/classes/Elgg/Notifications/NotificationEvent.php