YouTrack Standalone 2017.2 Help

IssueComment

Extends: BaseEntity

Represents an issue comment.

Properties

NameTypeDescriptionRead-only
author User The user who created the comment. /help/img/youtrack/2017.2/checkbox-marked.png
created Number Time the comment was created. /help/img/youtrack/2017.2/checkbox-marked.png
issue Issue The issue the comment belongs to. /help/img/youtrack/2017.2/checkbox-marked.png
permittedGroup UserGroup A group whos members are allowed to access the comment.
permittedGroups Set.<UserGroup> Groups whos members are allowed to access the comment.
permittedUsers Set.<User> Users that are allowed to access the comment.
text String The text of the comment.
updated Number Time the comment was last updated. /help/img/youtrack/2017.2/checkbox-marked.png
updatedBy User The user the comment was last updated by. /help/img/youtrack/2017.2/checkbox-marked.png
url String The comment URL.

user.notify('Somebody has written something', 'Have a look: ' + comment.url);

/help/img/youtrack/2017.2/checkbox-marked.png

Methods

 

becomes

becomes(fieldName, expected)

Checks that a value a field receives in the current transaction is equal to an expected one.

Parameters:

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

Returns:

TypeDescription
boolean `true` in case the expectation is met.

 

canBeReadBy

canBeReadBy(fieldName, user)

Checks if a field can be read by a user.

Parameters:

NameTypeDescription
fieldName string name of the field.
user User to check access for.

Returns:

TypeDescription
boolean `true` in case the field can be read by the user.

 

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks if a field can be written by a user.

Parameters:

NameTypeDescription
fieldName string name of the field.
user User to check access for.

Returns:

TypeDescription
boolean `true` in case the field can be written by the user.

 

isChanged

isChanged(fieldName)

Checks if a field is changed in the current transaction.

Parameters:

NameTypeDescription
fieldName string name of the field (e.g. 'summary') to check.

Returns:

TypeDescription
boolean `true` in case the field is changed in the current transaction.

 

oldValue

oldValue(fieldName)

Returns the previous value of a single-valued field before an update was applied. In case the field is not changedin the transaction, this value is equal to the current value of the field.

Parameters:

NameTypeDescription
fieldName string name of the field (e.g. 'updated') to get previous value of.

Returns:

TypeDescription
Object previous value of the field.

 

required

required(fieldName, message)

Checks if a the entity has a field denoted by field name set, shows error message otherwise.

Parameters:

NameTypeDescription
fieldName string name of the field to check.
message string message to show in case the field is not set.

 

Last modified: 9 August 2017