Expand all

mw.echo.ui.NotificationsInboxWidget

Extends

Constructor

new mw.echo.ui.NotificationsInboxWidget(controller, manager, [config]) #

An inbox-type widget that encompases a dated notifications list with pagination

Parameters:

Name Type Attributes Description
controller mw.echo.Controller

Echo controller

manager mw.echo.dm.ModelManager

Model manager

config Object optional

Configuration object

Mixes in:
Source:
An inbox-type widget that encompases a dated notifications list with pagination

Methods

displayMessage(displayMessage)private #

Display the error/notice message instead of the notifications list or vise versa.

Parameters:

Name Type Description
displayMessage boolean

Display error message

Source:
Display the error/notice message instead of the notifications list or vise versa.

onReadStateFilter(readState) #

Respond to read state filter event

Parameters:

Name Type Description
readState string

Read state 'all', 'read' or 'unread'

Source:
Respond to read state filter event

onSettingsMarkAllRead() #

Respond to mark all read for selected wiki

Source:
Respond to mark all read for selected wiki

onSourcePageFilter(source, page) #

Respond to unread page filter

Parameters:

Name Type Description
source string

Source symbolic name

page string

Page name

Source:
Respond to unread page filter

popPending() #

Extend the popPending method to enable UI elements

Source:
Extend the popPending method to enable UI elements

populateNotifications([direction]) → {jQuery.Promise} #

Populate the notifications list

Parameters:

Name Type Attributes Description
direction string optional

Direction to fetch from. 'prev' for previous page or 'next' for the next page. If not given, the first page of results will be fetched.

Source:

Returns:

A promise that is resolved when the results have been fetched.

Type
jQuery.Promise
Populate the notifications list

pushPending() #

Extend the pushPending method to disable UI elements

Source:
Extend the pushPending method to disable UI elements

resetMessageLabel() #

Reset the text of the error message that displays in place of the list in case the list is empty.

Source:

Reset the text of the error message that displays in place of the list in case the list is empty.

updatePaginationLabels() #

Update pagination messages

Source:
Update pagination messages

updateReadStateSelectWidget() #

Respond to filters update

Source:
Respond to filters update