ApplicationUser interface
This document details the methods of the ApplicationUser
interface you can use on any ApplicationUser, such as those returned by the Getters when you access users such as Reporter, Assignee, a Watcher of the issue etc.
denotes a method that is specific to JMWE
Getters
Method | Return type | Returns |
---|---|---|
equals(Object obj) | Boolean | True if and only if the object represents the same user |
getDirectoryId() | Long | The ID of the user directory that this user comes from. |
getDisplayName() | String | Display name of the user, must never be null. |
getEmailAddress() | String | Email address of the user. |
getEntityProperty(String propertyName) | Object | The value of the specified Entity property of the user, parsed into a Groovy object. |
getKey() | String | The key which distinguishes the ApplicationUser as unique. |
getUsername() | String | The username (login) of the user; must never be |
isActive() | Boolean | True if this user is active |
isInProjectRole( | boolean | Returns
returns |
getUserProperty( | String | Returns the value of the specified User Property of the user. This method returns User Properties that are defined on the Edit User Properties Jira admin page. These are different from the Entity Properties that can only be set and read programmatically (see the Set/Get/DeleteEntityProperty methods). |
isInGroup(String groupName) | Boolean | Returns true if this user is in the specified |
Setters
Method | Return type | Returns |
---|---|---|
setEntityProperty(String propertyName, Object value) | void | Sets the value of the specified Entity property of the user to a JSON representation of the specified value. |
setEntityPropertyToJsonString(String propertyName, String jsonString) |
| Sets the value of the specified Entity property of the user to the specified JSON string. |
Deleters
Method | Return type | Returns |
---|---|---|
deleteEntityProperty(String propertyName) | void | Deletes the specified Entity property of the user. |