YouTrack Standalone 2019.1 Help

VcsChange

Represents a VCS change that is attached to an issue.

Extends BaseEntity.

Properties

Name

Type

Description

becomesRemoved

Boolean

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

Available since 2017.4.37915

branch

String

Read-only. The name of the branch that the VCS change was committed to.

Available since 2018.1.38923

changesProcessors

Set.<ChangesProcessor>

Read-only. The list of change processors that the VCS change can be retrieved from.

Available since 2018.1.38923

created

Number

Read-only. The date when the change was applied, as returned by the VCS.

Available since 2018.1.39547

date

Number

Read-only. The date when the change was applied, as returned by the VCS. Use `VcsChange.created` instead.

Available since 2018.1.38923

fetched

Number

Read-only. The date when the VCS change was retrieved from the change processor.

Available since 2018.1.39547

id

Number

Read-only. A unique identifier. Used by some CI servers in addition to version.

Available since 2018.1.38923

isNew

Boolean

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

Available since 2018.2.42351

text

String

Read-only. The comment text that was included in the commit message.

Available since 2018.1.38923

user

User

Read-only. The user who authored the VCS change.

Available since 2018.1.38923

userName

String

Read-only. The name of the change author, as returned by the VCS.

Available since 2018.1.38923

version

String

Read-only. The version number of the change. For a Git-based VCS, the revision hash.

Available since 2018.1.38923

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`.

 

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