Page MenuHomeWickedGov Phorge
Files F4131492

mw.echo.dm.CrossWikiNotificationItem.js
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

mw.echo.dm.CrossWikiNotificationItem.js
View Options

/**
* Cross-wiki notification item model. Contains a list of sources,
* that each contain a list of notification items from that source.
*
* @class
* @extends mw.echo.dm.NotificationItem
*
* @constructor
* @param {number} id Notification id
* @param {Object} [config={}]
* @param {number} config.count The initial anticipated count of notifications through all
* of the sources.
*/
mw.echo.dm.CrossWikiNotificationItem = function MwEchoDmCrossWikiNotificationItem( id, config ) {
config = config || {};
mw.echo.dm.CrossWikiNotificationItem.super.call( this, id, config );
this.foreign = true;
this.source = null;
this.count = config.count || 0;
this.modelName = config.modelName || 'xwiki';
this.list = new mw.echo.dm.NotificationGroupsList();
this.list.connect( this, { discard: 'onListDiscard' } );
};
OO.inheritClass( mw.echo.dm.CrossWikiNotificationItem, mw.echo.dm.NotificationItem );
/* Events */
/**
* A sub list has been discarded
*
* @event mw.echo.dm.CrossWikiNotificationItem#discard
* @param {string} name The symbolic name for the list model that was discarded
*/
/* Methods */
/**
* Respond to list being removed from the cross-wiki bundle.
*
* @param {mw.echo.dm.NotificationGroupsList} sourceModel The source model that was removed
* @fires mw.echo.dm.CrossWikiNotificationItem#discard
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.onListDiscard = function ( sourceModel ) {
this.emit( 'discard', sourceModel.getName() );
};
/**
* Get the list of sources
*
* @return {mw.echo.dm.NotificationGroupsList} List of sources
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.getList = function () {
return this.list;
};
/**
* Get an array of source names that are in the cross-wiki list
*
* @return {string[]} Source names
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.getSourceNames = function () {
const sourceNames = [],
sourceLists = this.list.getItems();
for ( let i = 0; i < sourceLists.length; i++ ) {
sourceNames.push( sourceLists[ i ].getName() );
}
return sourceNames;
};
/**
* Get a specific item from the list by its source name
*
* @param {string} sourceName Source name
* @return {mw.echo.dm.NotificationGroupsList} Source item
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.getItemBySource = function ( sourceName ) {
return this.list.getGroupByName( sourceName );
};
/**
* Get expected item count from all sources
*
* @return {number} Item count
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.getCount = function () {
return this.count;
};
/**
* Check if there are unseen items in any of the cross wiki source lists.
* This method is required for all models that are managed by the
* mw.echo.dm.ModelManager.
*
* @return {boolean} There are unseen items
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.hasUnseen = function () {
const sourceLists = this.getList().getItems();
for ( let i = 0; i < sourceLists.length; i++ ) {
const items = sourceLists[ i ].getItems();
for ( let j = 0; j < items.length; j++ ) {
if ( !items[ j ].isSeen() ) {
return true;
}
}
}
return false;
};
/**
* Set all notifications in all groups to seen
*
* @param {number} timestamp New seen timestamp
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.updateSeenState = function ( timestamp ) {
this.getList().getItems().forEach( ( source ) => {
source.getItems().forEach( ( notification ) => {
notification.toggleSeen(
notification.isRead() || notification.getTimestamp() < timestamp
);
} );
} );
};
/**
* Get all items in the cross wiki notification bundle
*
* @return {mw.echo.dm.NotificationItem[]} All items across all sources
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.getItems = function () {
let notifications = [];
this.list.getItems().forEach( ( sourceList ) => {
notifications = notifications.concat( sourceList.getItems() );
} );
return notifications;
};
/**
* This item is a group.
* This method is required for all models that are managed by the
* mw.echo.dm.ModelManager.
*
* @return {boolean} This item is a group
*/
mw.echo.dm.CrossWikiNotificationItem.prototype.isGroup = function () {
return true;
};
mw.echo.dm.CrossWikiNotificationItem.prototype.isEmpty = function () {
return this.getList().isEmpty();
};

File Metadata

Mime Type
text/plain
Expires
Wed, Aug 19, 11:01 (3 w, 15 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
bf/2d/7210274d62069cc2bf50c6af2b74
Default Alt Text
mw.echo.dm.CrossWikiNotificationItem.js (4 KB)

Event Timeline