YouTrack Standalone 2019.2 Help

IssueComment

Represents a comment that is added to an issue.

Extends BaseComment.

Properties

Name

Type

Description

attachments

Set.<IssueAttachment> Read-only. The set of attachments that are attached to the comment.

Available since 2018.1.40030

author

User

Read-only. The user who created the comment.

becomesRemoved

Boolean Read-only. When `true`, the entity is removed in the current transaction. Otherwise, `false`.

Available since 2017.4.37915

created

Number

Read-only. Time the comment was created.

isNew

Boolean Read-only. When `true`, the entity is created in the current transaction. Otherwise, `false`.

Available since 2018.2.42351

isUsingMarkdown

Boolean When `true`, the comment text is parsed as Markdown. When `false`, the comment text is parsed as YouTrack Wiki. Changing this value does not transform the markup from one syntax to another.

Available since 2017.4.38870

issue

Issue

Read-only. The issue the comment belongs to.

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

Read-only. Time the comment was last updated.

updatedBy

User

Read-only. The user who last updated the comment.

url

String Read-only. The absolute URL (permalink) that points to the comment.
user.notify('Somebody has written something', 'Have a look: ' + comment.url);

Methods


becomes

becomes(fieldName, expected)

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

Parameters

Name

Type

Description

fieldName

string

The name of the field to check.

expected

string

The expected value.

Return Value

Type

Description

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

Name

Type

Description

fieldName

string

The name of the field.

user

User

The user for whom the permission to read the field is checked.

Return Value

Type

Description

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

Name

Type

Description

fieldName

string

The name of the field.

user

User

The user for whom the permission to update the field is checked.

Return Value

Type

Description

boolean

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

 

delete

delete()

Logically deletes the comment. This means that the comment is marked as deleted, but remains in the database. Users with sufficient permissions can restore the comment or delete the comment permanently from the user interface. The option to delete comments permanently has not been implemented in this API.

Available since 2018.1.38923

 

isChanged

isChanged(fieldName)

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

Parameters

Name

Type

Description

fieldName

string

The name of the field to check.

Return Value

Type

Description

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, returns null.

Parameters

Name

Type

Description

fieldName

string

The name of the field.

Return Value

Type

Description

Object

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

 

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

Name

Type

Description

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 July 2019