YouTrack Standalone 2017.3 Help

IssueTag

Represents a tag.

Extends WatchFolder.

Properties

NameTypeDescriptionRead-only
name String The name of the tag or saved search. /help/img/youtrack/2017.3/checkbox-marked.png
owner User The user who created the tag. /help/img/youtrack/2017.3/checkbox-marked.png
shareGroup UserGroup The group of users for whom the tag or saved search is visible. If the tag or the saved search is only visible to its owner, the value for this property is `null`. /help/img/youtrack/2017.3/checkbox-marked.png
updateShareGroup UserGroup The group of users who are allowed to update the settings for the tag or saved search. If the tag or the saved search can only be updated by its owner, the value for this property is `null`. /help/img/youtrack/2017.3/checkbox-marked.png

Methods


findByName

static findByName(name)

Finds a list of tags with the specified name. The list only includes tags that are visible to the current user. The tags that were created by the current user are returned at the top of the list.

Parameters

NameTypeDescription
name String The name of the tag to search for.

Return Value

TypeDescription
Set.<IssueTag> A list of tags that match the specified name.

 

findTagByName

static findTagByName(name)

Finds the most relevant tag with the specified name that is visible to the current user.

Parameters

NameTypeDescription
name String The name of the tag to search for.

Return Value

TypeDescription
IssueTag The most relevant tag.

 

becomes

becomes(fieldName, expected)

Checks whether a field is set to an expected value in the current transaction.

Parameters

NameTypeDescription
fieldName string The name of the field to check.
expected string The expected value.

Return Value

TypeDescription
boolean If the field is set to the expected value, returns `true`.

 

canBeReadBy

canBeReadBy(fieldName, user)

Checks whether a user has permission to read the field.

Parameters

NameTypeDescription
fieldName string The name of the field.
user User The user for whom the permission to read the field is checked.

Return Value

TypeDescription
boolean If the user can read the field, returns `true`.

 

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks whether a user has permission to update the field.

Parameters

NameTypeDescription
fieldName string The name of the field.
user User The user for whom the permission to update the field is checked.

Return Value

TypeDescription
boolean If the user can update the field, returns `true`.

 

isChanged

isChanged(fieldName)

Checks whether the value of a field is changed in the current transaction.

Parameters

NameTypeDescription
fieldName string The name of the field to check.

Return Value

TypeDescription
boolean If the value of the field is changed in the current transaction, returns `true`.

 

oldValue

oldValue(fieldName)

Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, this value is equal to the current value of the field.

Parameters

NameTypeDescription
fieldName string The name of the field.

Return Value

TypeDescription
Object previous If the field is changed in the current transaction, the previous value of the field. Otherwise, the current value of the field.

 

required

required(fieldName, message)

Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.

Parameters

NameTypeDescription
fieldName string The name of the field to check.
message string The message that is displayed to the user that describes the field requirement.

 

Last modified: 17 October 2017