Plugin Notifications Service
Plenty\Modules\Notifications\Contracts
public addNotification(array $notificationBuiltWithNotificationBuilder):array
Add a Notification in the system
| array | $notificationBuiltWithNotificationBuilder | An array built with NotificationBuilder::build() method |
public fetchNotifications(array $queryBuiltWithNotificationsQueryBuilder, int $page, int $itemsPerPage):UnspecifiedLengthPaginationResponse
Fetch a list of short/incomplete notifications, containing only the subject. To be used for listing purposes.
| array | $queryBuiltWithNotificationsQueryBuilder | An array built with NotificationsQueryBuilder::build() method |
| int | $page | The page number, starting from 1 |
| int | $itemsPerPage | The number of notifications per page |
public fetchNotificationsDetails(array $notificationsFetchDetailsQuery):array
Fetch all the details of a Notification based on its id.
| array | $notificationsFetchDetailsQuery | An array built with NotificationsFetchDetailsQueryBuilder::build() method |
public acknowledgeNotifications(array $queryBuiltWithNotificationsAcknowledgeQueryBuilder):bool
Mark a Notification as acknowledged.
| array | $queryBuiltWithNotificationsAcknowledgeQueryBuilder | An array built with NotificationsAcknowledgeQueryBuilder::build() method |
public getNotificationsCount(array $queryBuiltWithNotificationsQueryBuilder):int
Retrieve the current unread Notifications count
| array | $queryBuiltWithNotificationsQueryBuilder | An array built with NotificationsQueryBuilder::build() method |
The Notification Model
Plenty\Modules\Notifications\Models
public toArray()
Returns this model as an array.
The Notification Content model
Plenty\Modules\Notifications\Models
public toArray()
Returns this model as an array.