DatabaseNotificationService
getNotifications
Returns all database notifications for a Notifiable.
Name | Type | Required | Default | Description |
---|---|---|---|---|
notifiable | true | The | ||
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 the notifiable.
Throws: Megaphone.Configuration.MissingChannel
Throws: Megaphone.Configuration.InvalidChannelProvider
getReadNotifications
Returns all read database notifications for a Notifiable.
Name | Type | Required | Default | Description |
---|---|---|---|---|
notifiable | true | The | ||
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 the notifiable.
Throws: Megaphone.Configuration.MissingChannel
Throws: Megaphone.Configuration.InvalidChannelProvider
getUnreadNotifications
Returns all unread database notifications for a Notifiable.
Name | Type | Required | Default | Description |
---|---|---|---|---|
notifiable | true | The | ||
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 the notifiable.
Throws: Megaphone.Configuration.MissingChannel
Throws: Megaphone.Configuration.InvalidChannelProvider
Last updated