Class: AttachmentClient

AttachmentClient(jiraClient)

new AttachmentClient(jiraClient)

Used to access Jira REST endpoints in '/rest/api/2/atachment'

Parameters:
Name Type Description
jiraClient JiraClient
Source:

Methods

deleteAttachment(opts, callbackopt) → {Promise}

Remove an attachment from an issue.

Parameters:
Name Type Attributes Description
opts Object

The options for the API request.

Properties
Name Type Description
attachmentId string

The id of the attachment to delete

callback callback <optional>

Called when the attachment is deleted.

Source:
Returns:

Resolved when the attachment is deleted.

Type
Promise

getAttachment(opts, callbackopt) → {Promise}

Returns the meta-data for an attachment, including the URI of the actual attached file.

Parameters:
Name Type Attributes Description
opts Object

The options for the API request.

Properties
Name Type Description
attachmentId string

The id of the attachment to retrieve

callback callback <optional>

Called when the attachment metadata is retrieved.

Source:
Returns:

Resolved when the attachment metadata is retrieved.

Type
Promise

getGlobalAttachmentMetadata(optsopt, callbackopt) → {Promise}

Returns the meta informations for an attachments, specifically if they are enabled and the maximum upload size allowed.

Parameters:
Name Type Attributes Description
opts Object <optional>

This API request actually takes no options; this parameter is ignored.

callback callback <optional>

Called when the metadata is retrieved.

Source:
Returns:

Resolved when the metadata is retrieved.

Type
Promise