Controls the notification area on the notification page.
- Source:
- Copyright:
- 2016 Ryan Wyllie
- 2016 Ryan Wyllie
- License:
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Methods
(inner) getCacheNotification(id) → {object}
Retrieve a notification from the cache.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
int | The id for the notification you wish to retrieve |
Returns:
A notification (as returned by a webservice)
- Type
- object
(inner) getContainer() → {object}
Get the container element (which the control area is within).
Returns:
jQuery element
- Type
- object
(inner) getContent() → {object}
Get the control area content element.
Returns:
jQuery element
- Type
- object
(inner) getLimit() → {int}
Get the limit value for the paginated loading of the notifications.
Returns:
- Type
- int
(inner) getNotificationElement(id) → {object|null}
Find the notification element in the control area for the given id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
int | The notification id |
Returns:
jQuery element or null
- Type
- object | null
(inner) getOffset() → {int}
Get the offset value for paginated loading of the notifications.
Returns:
- Type
- int
(inner) getRoot() → {object}
Get the root element.
Returns:
jQuery element
- Type
- object
(inner) getUserId() → {int}
Get the user id.
Returns:
- Type
- int
(inner) hasDoneInitialLoad() → {bool}
Check if the first load of notifications has been triggered.
Returns:
true if first notification loaded, false otherwise
- Type
- bool
(inner) hasLoadedAllContent() → {bool}
Check if all of the notifications have been loaded.
Returns:
- Type
- bool
(inner) incrementOffset()
Increment the offset by the limit amount.
(inner) loadMoreNotifications() → {object}
Load notifications from the server and render them.
Returns:
jQuery promise
- Type
- object
(inner) markNotificationAsRead(notificationElement) → {object}
Send a request to mark the notification as read in the server and remove the unread status from the element.
Parameters:
| Name | Type | Description |
|---|---|---|
notificationElement |
object | The jQuery notification element |
Returns:
jQuery promise
- Type
- object
(inner) registerEventListeners()
Create the event listeners for the control area.
(inner) renderNotifications(notifications) → {object}
Render the notification data with the appropriate template and add it to the DOM.
Parameters:
| Name | Type | Description |
|---|---|---|
notifications |
array | Array of notification data |
Returns:
jQuery promise that is resolved when all notifications have been rendered and added to the DOM
- Type
- object
(inner) scrollNotificationIntoView(notificationElement)
Scroll the notification element into view within the control area, if it isn't already visible.
Parameters:
| Name | Type | Description |
|---|---|---|
notificationElement |
object | The jQuery notification element |
(inner) setCacheNotification(notification)
Save a notification in the cache.
Parameters:
| Name | Type | Description |
|---|---|---|
notification |
object | A notification returned by a webservice |
(inner) setLimit(value)
Set the limit value for the paginated loading of the notifications.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
int | The new limit value |
(inner) setLoadedAllContent(val)
Set the state of the loaded all content property.
Parameters:
| Name | Type | Description |
|---|---|---|
val |
bool | True if all content is loaded, false otherwise |
(inner) setOffset(value)
Set the offset value for the paginated loading of the notifications.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
int | The new offset value |
(inner) showNotification(notificationElement)
Show the full notification for the given notification element. The notification context is retrieved from the cache and send as data with an event to be rendered in the content area.
Parameters:
| Name | Type | Description |
|---|---|---|
notificationElement |
int | object | The notification id or jQuery notification element |
(inner) startLoading()
Flag the control area as loading.
(inner) stopLoading()
Remove the loading flag from the control area.