YouTrack InCloud 2017.4 Help

VcsChange

Represents a VCS change that is attached to an issue.

Extends BaseEntity.

Properties

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

Available since 2017.4.37915

checkbox marked
branch String The name of the branch that the VCS change was committed to.

Available since 2018.1.38923

checkbox marked
changesProcessors Set.<ChangesProcessor> The list of change processors that the VCS change can be retrieved from.

Available since 2018.1.38923

checkbox marked
created Number The date when the change was applied, as returned by the VCS.

Available since 2018.1.39547

checkbox marked
date Number The date when the change was applied, as returned by the VCS. Deprecated from 2018.1.39547. Use `VcsChange.created` instead.

Available since 2018.1.38923

checkbox marked
fetched Number The date when the VCS change was retrieved from the change processor.

Available since 2018.1.39547

checkbox marked
id Number A unique identifier. Used by some CI servers in addition to version.

Available since 2018.1.38923

checkbox marked
text String The comment text that was included in the commit message.

Available since 2018.1.38923

checkbox marked
user User The user who authored the VCS change.

Available since 2018.1.38923

checkbox marked
userName String The name of the change author, as returned by the VCS.

Available since 2018.1.38923

checkbox marked
version String The version number of the change. For a Git-based VCS, the revision hash.

Available since 2018.1.38923

checkbox marked

Methods


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 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: 28 February 2018