Interface UserProfile
- All Known Implementing Classes:
UserProfileImpl
public interface UserProfile
Interface for carrying out user profile operations
- Since:
- v3.13
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionchangeAutowatch
(boolean autowatch) Changes the current user's autowatch preference.void
changeDefaultSharingType
(boolean global) Changes the default sharing settings for users that have not configured any.changeNotifyMyChanges
(boolean notify) Changes the current user would like to be notified by their own changes.changeQuickSearchingMode
(String quichSearchingMode) Changes the current user's quickSearchMide preference.void
changeUserLanguage
(String lang) Changes the current user's language preferences.void
changeUserLanguageByValue
(String langValue) Changes the current user's language preferences by value.void
Changes the current user's language preferences to the system default.void
changeUserNotificationType
(boolean useHtml) Changes the current user's notification preferences.void
changeUserSharingType
(boolean global) Changes the user's default sharing settings.changeUserTimeZone
(String timeZoneID) Changes the current user's time zone.void
Goto the current user's profile page.void
gotoUserProfile
(String userName) Go to the user's profile page.link()
Retrieves the user profile link on the JIRA Header.userName()
Retrieves the username on the profile for the currently logged in user.
-
Method Details
-
changeUserNotificationType
void changeUserNotificationType(boolean useHtml) Changes the current user's notification preferences.- Parameters:
useHtml
- Set to True for HTML notifications, False for plain text notifications
-
changeUserSharingType
void changeUserSharingType(boolean global) Changes the user's default sharing settings.- Parameters:
global
- true if default sharing should be public, false otherwise.
-
changeDefaultSharingType
void changeDefaultSharingType(boolean global) Changes the default sharing settings for users that have not configured any.- Parameters:
global
- true if default sharing should be public, false otherwise.
-
changeUserLanguage
Changes the current user's language preferences.- Parameters:
lang
- the full language text to change to e.g. "German (Germany)"
-
changeUserLanguageByValue
Changes the current user's language preferences by value. Note that the JIRA (not system) default will have a value of -1. ConsiderchangeUserLanguageToJiraDefault()
- Parameters:
langValue
- the language value to change to e.g. "en_AU"
-
changeUserLanguageToJiraDefault
void changeUserLanguageToJiraDefault()Changes the current user's language preferences to the system default. -
gotoCurrentUserProfile
void gotoCurrentUserProfile()Goto the current user's profile page. -
gotoUserProfile
Go to the user's profile page.- Parameters:
userName
- The user name of the other user.
-
changeUserTimeZone
Changes the current user's time zone. A null time zone means that this user will use the default JIRA user time zone.- Parameters:
timeZoneID
- @return this
-
changeNotifyMyChanges
Changes the current user would like to be notified by their own changes.- Parameters:
notify
-
-
changeAutowatch
Changes the current user's autowatch preference.- Parameters:
autowatch
- true if autowatch should be enabled
-
changeQuickSearchingMode
Changes the current user's quickSearchMide preference.- Parameters:
quichSearchingMode
- "text" or "smartquery"
-
userName
String userName()Retrieves the username on the profile for the currently logged in user.- Returns:
- the username on the profile for the currently logged in user.
-
link
UserProfile.Link link()Retrieves the user profile link on the JIRA Header.- Returns:
- the user profile link on the JIRA Header.
-