YouTrack Standalone 2020.3 Help

UserProjectCustomField

Represents a custom field in a project that stores values as a user type.

Extends ProjectCustomField.

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

defaultUsers

Set.<User>

Read-only.  The default value for the custom field.

isNew

Boolean

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

Available since 2018.2.42351

localizedName

String

Read-only.  The localized name of the field.

name

String

Read-only.  The name of the field.

nullValueText

String

Read-only.  The text that is displayed for this field when it is empty.

values

Set.<User>

Read-only.  The list of available values for the custom field.

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

 

becomesInvisibleInIssue

becomesInvisibleInIssue(issue)

Checks if the changes that are applied in the current transaction remove the condition to show the custom field.

Available since 2018.2.42312

Parameters

Name

Type

Description

issue

Issue

The issue for which the condition for showing the field is checked.

Return Value

Type

Description

Boolean

When `true`, the condition for showing the field is removed in the current transaction.

 

becomesVisibleInIssue

becomesVisibleInIssue(issue)

Checks if the changes that are applied in the current transaction satisfy the condition to show the custom field.

Available since 2018.2.42312

Parameters

Name

Type

Description

issue

Issue

The issue for which the condition for showing the field is checked.

Return Value

Type

Description

Boolean

When `true`, the condition for showing the field is met in the current transaction.

 

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

 

findValueByLogin

findValueByLogin(login)

Returns the value that matches the specified login in a custom field that stores values as a user type.

Parameters

Name

Type

Description

login

String

The user login to search for in the set of values for the custom field.

Return Value

Type

Description

User

The user with the specified login. This user can be set as the value for a field that stores a user type.

 

getBackgroundColor

getBackgroundColor(issue)

Returns the background color that is used for this field value in the specified issue. Can return `null`, `"white"`, or a hex color presentation.

Parameters

Name

Type

Description

issue

Issue

The issue for which the background color is returned.

Return Value

Type

Description

String

The background color that is used for this field value in the specified issue.

 

getForegroundColor

getForegroundColor(issue)

Returns the foreground color that is used for this field value in the specified issue. Can return `null`, `"white"`, or a hex color presentation.

Parameters

Name

Type

Description

issue

Issue

The issue for which the foreground color is returned.

Return Value

Type

Description

String

The foreground color that is used for this field value in the specified issue.

 

getValuePresentation

getValuePresentation(issue)

Returns the string presentation of the value that is stored in this field in the specified issue.

Parameters

Name

Type

Description

issue

Issue

The issue for which the value presentation is returned.

Return Value

Type

Description

String

The string presentation of the value.

 

is

is(fieldName, expected)

Checks whether a field is equal to an expected value.

Available since 2019.2.55603

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 equal to the expected value, 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`.

 

isVisibleInIssue

isVisibleInIssue(issue)

Checks if a field is visible in the issue.

Available since 2018.2.42312

Parameters

Name

Type

Description

issue

Issue

The issue for which the condition for showing the field is checked.

Return Value

Type

Description

Boolean

When `true`, the condition for showing the custom field in the issue has been met. It can also mean that the field is not shown on a conditional basis and is always visible.

Example

// The following example checks the issue to see whether a conditional field with the name "Related Activity" // is currently visible, meaning that the conditions for showing the field have been met. // If so, the value for the field is set to "Attendance" action: function (ctx) { if (ctx.RelatedActivity.isVisibleInIssue(ctx.issue)) { ctx.issue.fields.RelatedActivity.add(ctx.RelatedActivity.Attendance); } }, requirements: { RelatedActivity: { name: 'Related Activity', type: entities.EnumField.fieldType, multi: true, Attendance: {} } }

 

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.

 

was

was(fieldName, expected)

Checks whether a field was equal to an expected value prior to the current transaction.

Available since 2019.2.55603

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 was equal to the expected value, returns `true`.

 

Last modified: 28 October 2020