Our new Appfire Documentation Space is now live!

Take a look here! If you have any questions please email support@appfire.com

ApplicationUser interface

Owned by Radhika Vijji. (Unlicensed)
Last updated: Aug 14, 2019

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.

(green star) denotes a method that is specific to JMWE

Getters

MethodReturn typeReturns
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) (green star)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 null.

isActive()
Boolean

True if this user is active

isInProjectRole(String projectRoleName, Project project) (green star)boolean

Returns true if this user is in the specified project role in the specified project. For example:

currentUser.isInProjectRole("Developers", issue.get("project"))

returns true if the current user belongs to the "Developers" project role in the current issue's project.

getUserProperty(String propertyName) (green star)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) (green star)BooleanReturns true if this user is in the specified

Setters

MethodReturn typeReturns
setEntityProperty(String propertyName, Object value) (green star)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) (green star)void

Sets the value of the specified Entity property of the user to the specified JSON string.

Deleters

MethodReturn typeReturns
deleteEntityProperty(String propertyName) (green star)void

Deletes the specified Entity property of the user.