HasDatabaseNotifications
This is a delegate component and requires ColdBox 7+. It should be added to an INotifiable instance.
getNotifications
Returns all database notifications for this Notifiable.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
channelName |
| false |
| The name of the channel to retrieve notifications from. Defaults to |
initialPage |
| false |
| The initial page of the returned |
maxRows |
| false |
| The number of rows per page for the returned |
Return: A DatabaseNotificationCursor to interact with a paginated list of notifications for this notifiable.
Throws: Megaphone.Configuration.MissingChannel
Throws: Megaphone.Configuration.InvalidChannelProvider
getReadNotifications
Returns all read database notifications for this Notifiable.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
channelName |
| false |
| The name of the channel to retrieve read notifications from. Defaults to |
initialPage |
| false |
| The initial page of the returned |
maxRows |
| false |
| The number of rows per page for the returned |
Return: A DatabaseNotificationCursor to interact with a paginated list of read notifications for this notifiable.
Throws: Megaphone.Configuration.MissingChannel
Throws: Megaphone.Configuration.InvalidChannelProvider
getUnreadNotifications
Returns all unread database notifications for this Notifiable.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
channelName |
| false |
| The name of the channel to retrieve unread notifications from. Defaults to |
initialPage |
| false |
| The initial page of the returned |
maxRows |
| false |
| The number of rows per page for the returned |
Return: A DatabaseNotificationCursor to interact with a paginated list of unread notifications for this notifiable.
Throws: Megaphone.Configuration.MissingChannel
Throws: Megaphone.Configuration.InvalidChannelProvider
Last updated