org.xwiki.platform.notifications.test.po

Class NotificationsUserProfilePage

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.NotificationsUserProfilePage

public class NotificationsUserProfilePage
extends ViewPage

Represents the user profile's Notifications tab.

Since:

9.4RC1

Version:

$Id: 17404ff4aae097261663691086d61d791f3dfd2f $

Field Summary

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

logo

Constructor Summary

Constructors

Constructor and Description
NotificationsUserProfilePage() Construct a NotificationsUserProfilePage (and for the browser page to be fully loaded).

Method Summary

Modifier and Type	Method and Description
void	disableAllParameters() Disable every notification parameters.
ApplicationPreferences	getApplication(String applicationId)
Map<String,ApplicationPreferences>	getApplicationPreferences()
BootstrapSwitch.State	getApplicationState(String applicationId, String format)
EventTypePreferences	getEventType(String applicationId, String eventType)
BootstrapSwitch.State	getEventTypeState(String applicationId, String eventType, String format)
List<NotificationFilterPreference>	getNotificationFilterPreferences()
static NotificationsUserProfilePage	gotoPage(String username)
void	setApplicationState(String applicationId, String format, BootstrapSwitch.State state) Set the state of the given application for the given format.
void	setEventTypeState(String applicationId, String eventType, String format, BootstrapSwitch.State state) Set the state of the event type for the given format.

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

NotificationsUserProfilePage

public NotificationsUserProfilePage()

Construct a NotificationsUserProfilePage (and for the browser page to be fully loaded).

Method Detail

getApplicationPreferences

public Map<String,ApplicationPreferences> getApplicationPreferences()

Returns:

a map of the preferences for each application

Since:

9.7RC1

gotoPage

public static NotificationsUserProfilePage gotoPage(String username)

Parameters:

username - the user profile document name

Returns:

the notifications profile tab page object

Since:

9.7RC1

getApplication

public ApplicationPreferences getApplication(String applicationId)
                                      throws Exception

Parameters:

applicationId - id of the application

Returns:

the preferences for the given application

Throws:

Exception - if the application cannot be found

Since:

9.7RC1

getEventType

public EventTypePreferences getEventType(String applicationId,
                                         String eventType)
                                  throws Exception

Parameters:

applicationId - id of the application

eventType - name of the event type

Returns:

the preferences for the given event type of the given application

Throws:

Exception - if the event type cannot be found

Since:

9.7RC1

getApplicationState

public BootstrapSwitch.State getApplicationState(String applicationId,
                                                 String format)
                                          throws Exception

Parameters:

applicationId - id of the application

format - the format of the notification

Returns:

the state of the switch related to given application and format

Throws:

Exception - if the application cannot be found

Since:

9.7RC1

getEventTypeState

public BootstrapSwitch.State getEventTypeState(String applicationId,
                                               String eventType,
                                               String format)
                                        throws Exception

Parameters:

applicationId - id of the application

eventType - name of the event type

format - the format of the notification

Returns:

the state of the switch related to given event type and format

Throws:

Exception - if the event type cannot be found

Since:

9.7RC1

setApplicationState

public void setApplicationState(String applicationId,
                                String format,
                                BootstrapSwitch.State state)
                         throws Exception

Set the state of the given application for the given format.

Parameters:

applicationId - id of the application

format - the format of the notification

state - the state to set

Throws:

Exception - if the application is not found

Since:

9.7RC1

setEventTypeState

public void setEventTypeState(String applicationId,
                              String eventType,
                              String format,
                              BootstrapSwitch.State state)
                       throws Exception

Set the state of the event type for the given format.

Parameters:

applicationId - id of the application

eventType - name of the event type

format - the format of the notification

state - the state to set

Throws:

Exception - if the event type cannot be found

Since:

9.7RC1

disableAllParameters

public void disableAllParameters()

Disable every notification parameters.

getNotificationFilterPreferences

public List<NotificationFilterPreference> getNotificationFilterPreferences()

Returns:

the notification filter preferences, as they are described in the corresponding livetable

Since:

10.8RC1, 9.11.8