Users

You can reference a user in the following contexts:

Context	Description
`loggedInUser`	This keyword references the user who is currently logged in to YouTrack.
`Assignee`	This default custom field is assigned a `user` data type. This means that you can return properties and use methods for a user account when you reference this custom field. The same guidelines apply for any custom field that is assigned a `user` data type.
`issue.project.leader`	This property of a project is also assigned a `user` data type.
`owner`	A property of a custom field that uses the `ownedField` type. This property is assigned the `user` data type.
`project.getUser`	This method returns a specific user account in the context of the current project.

You can also reference a specific user login as a literal value.

User Properties

The following properties of a user account can be accessed with a workflow.

Property	Description
`login: string`	The username of a user account. For example, `root`.
`fullName: string`	The full name of a user. For example, `John Smith`.
`email: string`	The email address of a user account. For example, `j.smith@example.com`.

The following methods are available for use with users. See also User Properties.

Syntax	`getVisibleName(): string`
Description	Returns the full name of the specified user. If the full name is not set, the username is returned.

Syntax	`isBanned(): Boolean`
Description	Checks whether the user account is banned.
Example	`if (Assignee.isBanned()) { Assignee = null; }`

Syntax	`hasRole(role: string): Boolean`
Description	Checks whether the user has the specified role in any project.
Example	`if (loggedInUser.hasRole("Developer")) { Assignee = loggedInUser; }`

Syntax	`isInGroup(): string`
Description	Checks whether the user is a member of the specified group.
Example	`when Assignee.changed && Assignee != null { if (permittedGroup != null && !Assignee.isInGroup(permittedGroup.name)) { message(l10n ( Please take into account that new assignee ' {Assignee.fullName} ' isn't included into the visibility group ' {permittedGroup.name} '!)); } }`

Syntax	`createNewIssue(projectShortName: String): issue`
Parameters	`projectShortName`	The ID of the project in which the issue is created.
Description	Creates a new issue in the specified project.
Example	`var todoIssue = loggedInUser.createNewIssue(project.shortName); todoIssue.summary = "iPhone :" + issue.summary; todoIssue.tags.add(iOSTag); tags.add(iOSTag);`

Syntax	`getIssues(context: SavedSearch, query: String): sequence of issues`
Parameters	`context`	The name of the saved search to use as the context for the search query. The default context is `Everything`.
Parameters	query	The search query. Can be an empty string.
Description	Returns a list of issues based on the specified context and search query.
Example	`for each notMyIssue in loggedInUser.getIssues({savedSearch: Reported by me}, "for: -me") { notMyIssue.Assignee = loggedInUser; }`
Variations	`var issues = project.leader.getIssues(Everything, ""); var issues = project.leader.getIssues({savedSearch: Unassigned in A}, ""); var issues = project.leader.getIssues({savedSearch: Unassigned in A}, "Priority: Critical");`

Syntax	`watchIssue(issue: issue)`
Parameters	`issue`	The issue to which the user is added as a watcher.
Description	Adds the current user to the issue as a watcher (add `Star` tag).
Example	`if (loggedInUser.isInGroup("developers") && loggedInUser.hasRole("Developer")) { loggedInUser.watchIssue(issue); } else { loggedInUser.unwatchIssue(issue); }`

Syntax	`unwatchIssue(issue: Issue)`
Parameters	`issue`	The issue to from which the user is removed as a watcher.
Description	Removes the current user from the list of watchers for the issue (remove `Star` tag).
Example	`if (loggedInUser.isInGroup("developers") && loggedInUser.hasRole("Developer")) { loggedInUser.watchIssue(issue); } else { loggedInUser.unwatchIssue(issue); }`

Syntax	`getTag(tagName: string, createIfNotExists: Boolean): tag`
Parameters	`tagName`	The name of the tag.
Parameters	`createIfNotExists`	If `true` and the specified tag does not exist or is not visible to the user and the user has permission to create tags, a new tag with the specified name is created.
Description	Returns a tag that is visible to the user.
Example	`var createIfNotExist = loggedInUser.getSharedTag("iOS") == null; var iOSTag = loggedInUser.getTag("iOS", createIfNotExist);`

Syntax	`getSharedTag(tagName: string): tag`
Parameters	`tagName`	The name of the tag.
Description	Returns a tag with the specified name that is shared with but not owned by the user. If such a tag does not exist, a null value is returned.
Example	`var createIfNotExist = loggedInUser.getSharedTag("iOS") == null; var iOSTag = loggedInUser.getTag("iOS", createIfNotExist);`

Syntax	`canVoteIssue(issue: issue): Boolean`
Description	Checks whether the user is able to vote for the specified issue.
Example	`var user = project.getUser("user"); if (user.canVoteIssue(issue)) { user.voteIssue(issue); }`

Syntax	`voteIssue(issue: issue)`
Parameters	`issue`	The issue to which the vote is added.
Description	Adds a vote on behalf of the user to the issue, if allowed.
Example	`>var user = project.getUser("user"); if (user.canVoteIssue(issue)) { user.voteIssue(issue); }`

Syntax	`canUnvoteIssue(issue: issue): Boolean`
Description	Checks whether the user is able to remove their vote from the specified issue.

Syntax	`unvoteIssue(issue: issue)`
Parameters	`issue`	The issue from which the vote is removed.
Description	Removes a vote on behalf of the user from the issue, if allowed

Syntax	`notify(subject: string, body: string, ignoreNotifyOnOwnChangesSetting: Boolean)`
Parameters	`subject`	The subject line of the email notification.
	`body`	The message text of the email notification.
	`ignoreNotifyOnOwnChangesSetting`	If `false`, the message is not sent when changes are performed on behalf of the current user. The corresponding flag is unchecked. Otherwise, the message is sent anyway.
Description	Sends an email notification to the email address that is set in the user profile.
Example	`var projectLeader = project.leader; projectLeader.notify("Attention","Please pay attention to " + getId()); projectLeader.sendJabber("Please look at " + getId());`

Syntax	`sendMail(subject: string, body: string)`
Parameters	`subject`	The subject line text of the email notification.
Parameters	`body`	The message text of the email notification.
Description	An alias for `notify(subject, body, true)`
Example	`sendMail(Reporter email, "[YouTrack, Commented]", "New comment was added: " + comments.added.first.text));`

Syntax	`sendJabber(text: string)`
Parameters	`text`	The message text for the Jabber notification.
Description	Sends a notification message over Jabber. Similar to `notify` method, the message won't be sent on own changes and corresponding flag unchecked.
Example	`project.leader.sendJabber("Please pay attention to " + getId());`

Last modified: 18 April 2017