IssueAttachment
Represents a file that is attached to an issue.
Extends PersistentFile.
Properties
Name | Type | Description |
---|---|---|
author | User | Read-only. The user who attached the file to the issue. |
becomesRemoved | Boolean | Read-only. When `true`, the entity is removed in the current transaction. Otherwise, `false`. Available since 2017.4.37915 |
charset | String | Read-only. The charset type of the file. Only applicable to text files. Available since 2019.2.53994 |
content | InputStream | Read-only. The content of the file in binary form. Available since 2019.2.53994 |
created | Number | Read-only. The date and time when the attachment was created as a timestamp. |
extension | String | Read-only. The extension that defines the file type. |
fileUrl | String | Read-only. The URL of the issue attachment. Available since 2019.2.56440 |
isNew | Boolean | Read-only. When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351 |
isRemoved | Boolean | Read-only. If the attachment is removed, this property is `true`. |
issue | Issue | Read-only. The issue that the file is attached to. |
metaData | String | Read-only. The image dimensions. For image files, the value is rw=_width_&rh=_height_. For non-image files, the value is `empty`. |
mimeType | String | Read-only. The MIME type of the file. Available since 2019.2.53994 |
name | String | Read-only. The name of the file. |
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 | Read-only. The size of the attached file in bytes. |
updated | Number | Read-only. The date and time the attachment was last updated as a timestamp. |
Methods
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`. |
delete
Permanently deletes the attachment.
Available since 2018.1.40030
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`. |