YouTrack Standalone 2017.2 Help

Project

Extends: BaseEntity

Represents a YouTrack project.

Properties

Name

Type

Description

Read-only

becomesRemoved

Boolean

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

checkbox marked

description

String

The description of the project as shown on the project profile page.

checkbox marked

fields

Set.<ProjectCustomField>

The set of custom fields that are available in the project.

checkbox marked

isArchived

Boolean

If the project is currently archived, this property is `true`.

checkbox marked

isNew

Boolean

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

checkbox marked

issues

Set.<Issue>

A list of all issues that belong to the project.

checkbox marked

key

String

The ID of the project. Use instead of project.shortName, which is deprecated.

checkbox marked

leader

User

The user who is set as the project lead.

checkbox marked

name

String

The name of the project.

checkbox marked

notificationEmail

String

The email address that is used to send notifications for the project.If a 'From' address is not set for the project, the default 'From' address for the YouTrack server is returned.

if (issue.becomesReported) { var lastRelatedEmails = issue.fields['Last message related emails']; if (lastRelatedEmails) { lastRelatedEmails.split(' ').forEach(function (email) { if (email && email.equalsIgnoreCase(issue.project.notificationEmail)) { var allRelatedEmails = issue.fields['All related emails']; if (!allRelatedEmails) { issue.fields['All related emails'] = email; } else if (!(allRelatedEmails.split(' ').has(email))) { issue.fields['All related emails'] = allRelatedEmails + ' ' + email; } } }); issue.fields['Last message related emails'] = null; } }

checkbox marked

team

UserGroup

A UserGroup object that contains the users and members of groups who are assigned to the project team.

checkbox marked

Methods

 

findByKey

static findByKey(key)

Finds a project by ID.

Parameters:

Name

Type

Description

key

String

The ID of the project to search for.

Returns:

Type

Description

Project

The project, or null when there are no projects with the specified ID.

 

findByName

static findByName(name)

Finds a project by name.

Parameters:

Name

Type

Description

name

String

The name of the project to search for.

Returns:

Type

Description

Project

The project, or null when there are no projects with the specified name.

 

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.

Returns:

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.

Returns:

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.

Returns:

Type

Description

boolean

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

 

findFieldByName

findFieldByName(name)

Returns the custom field in the project with the specified name.

Parameters:

Name

Type

Description

name

String

The name of the custom field.

Returns:

Type

Description

ProjectCustomField

The custom field with the specified name.

 

intervalToWorkingMinutes

intervalToWorkingMinutes(start, end)

Gets the number of minutes that occurred during working hours in a specified interval.For example, if the interval is two days and the number of working hours in a day is set to 8, the result is 2 * 8 * 60 = 960

Parameters:

Name

Type

Description

start

Number

Start of the interval.

end

Number

End of the interval.

Returns:

Type

Description

Number

The number of minutes that occurred during working hours in the specified interval.

 

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.

Returns:

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

Parameters:

Name

Type

Description

fieldName

string

The name of the field.

Returns:

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: 7 March 2019