YouTrack Standalone 2018.2 Help

IssueAttachment

Represents a file that is attached to an issue.

Extends PersistentFile.

Properties

Name

Type

Description

Read-only

author

User

The user who attached the file to the issue.

checkbox marked

becomesRemoved

Boolean

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

Available since 2017.4.37915

checkbox marked

created

Number

The date and time when the attachment was created as a timestamp.

checkbox marked

extension

String

The extension that defines the file type.

checkbox marked

isNew

Boolean

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

Available since 2018.2.42351

checkbox marked

isRemoved

Boolean

If the attachment is removed, this property is `true`.

checkbox marked

issue

Issue

The issue that the file is attached to.

checkbox marked

metaData

String

The dimentions of an image file. For an image file, the value is `rw=&rh=`, for a non-image file the value is `empty`.

checkbox marked

name

String

The name of the file.

checkbox marked

permittedGroup

UserGroup

The group for which the attachment is visible when the visibility is restricted to a single group.

permittedGroups

Set.<UserGroup>

The groups for which the issue is visible when the visibility is restricted to multiple groups.

permittedUsers

Set.<User>

The list of users for whom the attachment is visible.

size

Number

The size of the attached file in bytes.

checkbox marked

updated

Number

The date and time the attachment was last updated as a timestamp.

checkbox marked

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

 

delete

delete()

Permanently deletes the attachment.

Available since 2018.1.40030

 

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: 9 October 2018