org.xwiki.platform.notifications.test.po

Class NotificationsTrayPage

java.lang.Object

org.xwiki.test.ui.po.BaseElement

org.xwiki.test.ui.po.BasePage

org.xwiki.test.ui.po.ViewPage

org.xwiki.platform.notifications.test.po.NotificationsTrayPage

public class NotificationsTrayPage
extends ViewPage

Represents the user Notifications tab.

Since:

9.4RC1

Version:

$Id: a9634ffafa7a7bf81a532f0a078b79ccbbf58e2c $

Field Summary

Fields inherited from class org.xwiki.test.ui.po.BasePage

logo

Constructor Summary

Constructors

Constructor and Description
NotificationsTrayPage() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	areNotificationsAvailable() Test if the text "No notification available!" is displayed in the notification tray.
boolean	arePageAndChildrenWatched()
void	clearAllNotifications() Click the button «Clear All» in the notification tray.
String	getNotificationContent(int notificationNumber) Get the content of a notification.
String	getNotificationDescription(int notificationNumber) Get the description of a notification.
String	getNotificationPage(int notificationNumber) Get the page concerned by a notification (if any).
String	getNotificationRawContent(int notificationNumber) Get the raw content of a notification.
NotificationsRSS	getNotificationRSS(String username, String password)
int	getNotificationsCount() Get the number of available notifications.
int	getNotificationsListCount() Get the number of notifications displayed.
String	getNotificationType(int notificationNumber) Get the type of notification (bold text before notification content).
int	getReadNotificationsCount() Get the number of read notifications.
int	getUnreadNotificationsCount() Get the number of unread notifications.
boolean	isMenuOpen()
boolean	isPageOnlyWatched()
boolean	isWikiWatched()
void	markAsRead(int notificationNumber) Mark a notification as read.
void	setPageAndChildrenWatchedState(boolean watched) Watch or unwatch the current "space".
void	setPageOnlyWatchedState(boolean watched) Watch or unwatch the current page.
void	setWikiWatchedState(boolean watched) Watch or unwatch the current wiki.
void	showNotificationTray() Ensure that the notifications tray is visible.

Methods inherited from class org.xwiki.test.ui.po.ViewPage

clickBreadcrumbLink, clickWantedLink, clickWantedLink, contentContainsElement, editSection, exists, getBreadcrumb, getBreadcrumbContent, getContent, hasBreadcrumbContent, hasBreadcrumbContent, isInlinePage, openAttachmentsDocExtraPane, openCommentsDocExtraPane, openHistoryDocExtraPane, openInformationDocExtraPane, useShortcutKeyForAttachmentPane, useShortcutKeyForCommentPane, useShortcutKeyForHistoryPane, useShortcutKeyForInformationPane, waitForDocExtraPaneActive, waitUntilContent

Methods inherited from class org.xwiki.test.ui.po.BasePage

canDelete, clickAdminActionsSubMenuEntry, clickEditSubMenuEntry, clickLocale, clickMoreActionsSubMenuEntry, copy, createInlinePage, createPage, delete, edit, editClass, editInline, editObjects, editRights, editWiki, editWYSIWYG, getCurrentUser, getDocumentTitle, getEditURL, getErrorContent, getHTMLMetaDataValue, getLocales, getMetaDataValue, getPageTitle, getPageURL, hasLeftPanel, hasLoginLink, hasNotificationsMenu, hideDrawer, isAuthenticated, isDrawerVisible, isForbidden, isNewDocument, isNotificationsMenuOpen, login, logout, register, rename, sendKeys, showDrawer, toggleActionMenu, toggleDrawer, toggleNotificationsMenu, useShortcutKeyForClassEditing, useShortcutKeyForEditing, useShortcutKeyForInlineEditing, useShortcutKeyForObjectEditing, useShortcutKeyForPageDeletion, useShortcutKeyForPageRenaming, useShortcutKeyForRightsEditing, useShortcutKeyForSourceViewer, useShortcutKeyForWikiEditing, useShortcutKeyForWysiwygEditing, viewChildren, waitUntilPageIsLoaded, waitUntilPageJSIsLoaded, watchDocument, watchSpace, watchWiki

Methods inherited from class org.xwiki.test.ui.po.BaseElement

getDriver, getUtil, isElementVisible, setContext, waitForNotificationErrorMessage, waitForNotificationInProgressMessage, waitForNotificationSuccessMessage, waitForNotificationWarningMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationsTrayPage

public NotificationsTrayPage()

Constructor.

Method Detail

isMenuOpen

public boolean isMenuOpen()

Returns:

either or not the notification menu is open

areNotificationsAvailable

public boolean areNotificationsAvailable()

Test if the text "No notification available!" is displayed in the notification tray.

Returns:

true if the text is not displayed

getNotificationsCount

public int getNotificationsCount()

Get the number of available notifications.

Returns:

Number of unread notifications, 0 if no notification available and MAX_INT if 20+ notifications

clearAllNotifications

public void clearAllNotifications()

Click the button «Clear All» in the notification tray.

showNotificationTray

public void showNotificationTray()

Ensure that the notifications tray is visible.

getUnreadNotificationsCount

public int getUnreadNotificationsCount()

Get the number of unread notifications.

Returns:

number of unread notifications

getReadNotificationsCount

public int getReadNotificationsCount()

Get the number of read notifications.

Returns:

number of read notifications

getNotificationsListCount

public int getNotificationsListCount()

Get the number of notifications displayed.

Returns:

number of notifications

getNotificationType

public String getNotificationType(int notificationNumber)

Get the type of notification (bold text before notification content).

Parameters:

notificationNumber - index of the notification in the list

Returns:

notification type

getNotificationContent

public String getNotificationContent(int notificationNumber)

Get the content of a notification.

Parameters:

notificationNumber - index of the notification in the list

Returns:

notification content

getNotificationPage

public String getNotificationPage(int notificationNumber)

Get the page concerned by a notification (if any).

Parameters:

notificationNumber - index of the notification in the list

Returns:

notification page

getNotificationDescription

public String getNotificationDescription(int notificationNumber)

Get the description of a notification.

Parameters:

notificationNumber - index of the notification in the list

Returns:

notification description

getNotificationRawContent

public String getNotificationRawContent(int notificationNumber)

Get the raw content of a notification.

Parameters:

notificationNumber - index of the notification in the list

Returns:

the notification raw content

markAsRead

public void markAsRead(int notificationNumber)

Mark a notification as read.

Parameters:

notificationNumber - index of the notification in the list

isPageOnlyWatched

public boolean isPageOnlyWatched()

Returns:

either or not the page is watched

Since:

10.8RC1, 9.11.8

arePageAndChildrenWatched

public boolean arePageAndChildrenWatched()

Returns:

either or not the "space" is watched

Since:

10.8RC1, 9.11.8

isWikiWatched

public boolean isWikiWatched()

Returns:

either or not the wiki is watched

Since:

10.8RC1, 9.11.8

setPageOnlyWatchedState

public void setPageOnlyWatchedState(boolean watched)
                             throws Exception

Watch or unwatch the current page.

Parameters:

watched - the desired state

Throws:

Exception - if the expected state cannot be set

Since:

10.8RC1, 9.11.8

setPageAndChildrenWatchedState

public void setPageAndChildrenWatchedState(boolean watched)
                                    throws Exception

Watch or unwatch the current "space".

Parameters:

watched - the desired state

Throws:

Exception - if the expected state cannot be set

Since:

10.8RC1, 9.11.8

setWikiWatchedState

public void setWikiWatchedState(boolean watched)
                         throws Exception

Watch or unwatch the current wiki.

Parameters:

watched - the desired state

Throws:

Exception - if the expected state cannot be set

Since:

10.8RC1, 9.11.8

getNotificationRSS

public NotificationsRSS getNotificationRSS(String username,
                                           String password)
                                    throws Exception

Parameters:

username - name of the current user

password - password of the current user

Returns:

the rss feed

Throws:

Exception - if an error happens

Since:

11.5RC1, 11.4, 11.3.1