Article
Represents an article in YouTrack.
Extends BaseArticle.
Available since 2021.4.23500
Properties
Name | Type | Description |
---|---|---|
attachments | Set.<BaseArticleAttachment> | Read-only. The set of attachments that are attached to the article. |
author | User | Read-only. The user who created the article. |
becomesRemoved | Boolean | Read-only. When `true`, the entity is removed in the current transaction. Otherwise, `false`. Available since 2017.4.37915 |
comments | Set.<ArticleComment> | Read-only. A list of comments for the article. |
content | String | The text that is entered as the article content. |
created | Number | Read-only. The date when the article was created. |
editedComments | Set.<ArticleComment> | Read-only. The set of comments that are edited in the current transaction. Comments that are added and removed are not considered to be edited. Instead, these are represented by the `article.comments.added` and `article.comments.removed` properties. |
id | String | Read-only. The article ID. |
isNew | Boolean | Read-only. When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351 |
numberInProject | Number | Read-only. The article number in the project. |
project | Project | The project to which the article is assigned. |
summary | String | The article title. |
updated | Number | Read-only. The date when the article was last updated. |
updatedBy | User | Read-only. The user who last updated the article. |
Constructors
Article
Available since 2021.4.23500
Parameters
Name | Type | Description |
---|---|---|
author | User, JsonForArticleConstructor | The author of the article. Alternatively, pass a JSON specified by JsonForArticleConstructor |
project | Project | The project where the new article is created. |
summary | String | The article title. |
Methods
findById
Finds an article by its visible ID.
Parameters
Name | Type | Description |
---|---|---|
id | String | The article ID. |
Return Value
Type | Description |
---|---|
Article | The article that is assigned the specified ID. |
addComment
Adds a comment to the article.
Parameters
Name | Type | Description |
---|---|---|
text | String, JsonForArticleAddComment | The text to add to the article as a comment. Alternatively, pass a JSON specified by JsonForArticleAddComment |
author | User | The author of the comment. |
Return Value
Type | Description |
---|---|
ArticleComment | A newly created comment. |
becomes
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
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
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`. |
is
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
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
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
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
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`. |