|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SUser
Presents TeamCity user data.
Method Summary | |
---|---|
void |
deleteUserProperty(PropertyKey propertyKey)
Deletes a property with specified key from the user profile. |
java.util.List<SVcsModification> |
getAllModifications()
Returns the list of all (personal and non-personal) user modifications sorted by VCS date. |
java.util.List<UserGroup> |
getAllUserGroups()
Returns the list of all user groups that include this user, directly or through intermediate subgroups. |
java.lang.String |
getBlockState(java.lang.String blockType)
Retrieves state of a block stored for this user |
java.util.List<SBuildType> |
getOrderedBuildTypes(SProject project)
Returns the list of build configurations (in a project, or globally) sorted according to user settings. |
java.util.List<UserGroup> |
getUserGroups()
Returns the list of groups which this user belongs to. |
java.util.List<SVcsModification> |
getVcsModifications(int numberOfActiveDays)
Returns the list of changes made by this user filtered according to the caller's permissions. |
java.util.List<VcsUsernamePropertyKey> |
getVcsUsernameProperties()
Returns list of VCS username properties associated with this user. |
void |
hideProject(java.lang.String projectId)
Marks a project with specified id as invisible |
boolean |
isHighlightRelatedDataInUI()
Returns true if highlighting of user changes, investigations, and other related data in web UI is enabled. |
void |
setBlockState(java.lang.String blockType,
java.lang.String blockState)
Stores collapsable block state for this user |
void |
setBuildTypesOrder(SProject project,
java.util.List<SBuildType> visible,
java.util.List<SBuildType> invisible)
Sets visible and invisible build types for the given project in the specified order. |
void |
setLastLoginTimestamp(java.util.Date timestamp)
Updates last login timestamp |
void |
setPassword(java.lang.String password)
Changes password of this user |
void |
setProjectsOrder(java.util.List<java.lang.String> projectsOrder)
Sets order of the projects. |
void |
setUserProperties(java.util.Map<? extends PropertyKey,java.lang.String> properties)
Updates properties of the user specified by user id. |
void |
setUserProperty(PropertyKey propertyKey,
java.lang.String value)
Sets a property with specified key and value in user profile |
void |
setVisibleProjects(java.util.Collection<java.lang.String> visibleProjects)
Sets projects visible for specified user |
void |
updateUserAccount(java.lang.String username,
java.lang.String name,
java.lang.String email)
Updates user fields: username, name and email. |
Methods inherited from interface jetbrains.buildServer.serverSide.auth.RolesHolder |
---|
addRole, getAllParentHolders, getParentHolders, getRoles, getRolesWithScope, getScopes, isSystemAdministratorRoleGranted, isSystemAdministratorRoleGrantedDirectly, isSystemAdministratorRoleInherited, removeRole, removeRole, removeRoles |
Methods inherited from interface jetbrains.buildServer.users.User |
---|
getAllProjects, getDescriptiveName, getEmail, getExtendedName, getId, getLastLoginTimestamp, getName, getRealm, getUsername, getVisibleProjects |
Methods inherited from interface jetbrains.buildServer.serverSide.auth.AuthorityHolder |
---|
getAssociatedUser, getGlobalPermissions, getPermissionsGrantedForProject, getProjectsPermissions, isPermissionGrantedForAnyProject, isPermissionGrantedForProject, isPermissionGrantedGlobally |
Methods inherited from interface jetbrains.buildServer.users.PropertyHolder |
---|
getBooleanProperty, getProperties, getPropertyValue |
Methods inherited from interface jetbrains.buildServer.log.Loggable |
---|
describe |
Methods inherited from interface jetbrains.buildServer.notification.NotificationRulesHolder |
---|
addNewRule, applyOrder, findConflictingRules, findRuleById, getNotificationRules, getParentRulesHolders, removeRule, setNotificationRules |
Method Detail |
---|
@NotNull java.util.List<SVcsModification> getVcsModifications(int numberOfActiveDays)
numberOfActiveDays
- number of last active days of changing
@NotNull java.util.List<SVcsModification> getAllModifications()
void updateUserAccount(@NotNull java.lang.String username, java.lang.String name, java.lang.String email) throws UserNotFoundException, DuplicateUserAccountException, EmptyUsernameException
username
- username, cannot be nullname
- full name of a useremail
- email address
UserNotFoundException
- if specified user no longer exists in the model
DuplicateUserAccountException
- if a new username name already assigned to another user
EmptyUsernameException
- if username is an empty stringvoid setUserProperties(@NotNull java.util.Map<? extends PropertyKey,java.lang.String> properties) throws UserNotFoundException
properties
- properties
UserNotFoundException
- if specified user no longer existsvoid setUserProperty(@NotNull PropertyKey propertyKey, java.lang.String value) throws UserNotFoundException
propertyKey
- property keyvalue
- value of the property
UserNotFoundException
- if specified user no longer existsvoid deleteUserProperty(@NotNull PropertyKey propertyKey) throws UserNotFoundException
propertyKey
- property key
UserNotFoundException
- if specified user no longer existsvoid setPassword(java.lang.String password) throws UserNotFoundException
password
- new password
UserNotFoundException
- if specified user no longer existsvoid setProjectsOrder(@NotNull java.util.List<java.lang.String> projectsOrder) throws UserNotFoundException
projectsOrder
- identificators of all projects in the order specified by user
UserNotFoundException
- if specified user no longer existsvoid setVisibleProjects(@NotNull java.util.Collection<java.lang.String> visibleProjects) throws UserNotFoundException
visibleProjects
- collection of identifiers of visible projects
UserNotFoundException
- if specified user no longer existsvoid hideProject(@NotNull java.lang.String projectId) throws UserNotFoundException
projectId
- id of the project
UserNotFoundException
- if this user does not exist anymorevoid setLastLoginTimestamp(@NotNull java.util.Date timestamp) throws UserNotFoundException
timestamp
- last login timestamp
UserNotFoundException
- if this user does not exist anymorevoid setBlockState(java.lang.String blockType, java.lang.String blockState)
blockType
- type of blockblockState
- state@Nullable java.lang.String getBlockState(java.lang.String blockType)
blockType
- type of block
@NotNull java.util.List<UserGroup> getUserGroups()
getAllUserGroups()
.
No specific order of the groups is guaranteed.
getAllUserGroups()
@NotNull java.util.List<UserGroup> getAllUserGroups()
No specific order of the groups is guaranteed.
getUserGroups()
@NotNull java.util.List<VcsUsernamePropertyKey> getVcsUsernameProperties()
@NotNull java.util.List<SBuildType> getOrderedBuildTypes(@Nullable SProject project)
project
- the project (can be null)
void setBuildTypesOrder(@NotNull SProject project, @NotNull java.util.List<SBuildType> visible, @NotNull java.util.List<SBuildType> invisible)
project
- the projectvisible
- the list of visible build typesinvisible
- the list of invisible build typesboolean isHighlightRelatedDataInUI()
StandardProperties.HIGHLIGHT_MY_CHANGES
property.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |