Function: getAttachmentThumbnail()
ts
function getAttachmentThumbnail(
client,
parameters,
options?
): Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>;Defined in: src/cloud/api/issueAttachments.ts:94
Returns the thumbnail of an attachment.
To return the attachment contents, use Get attachment content.
This operation can be accessed anonymously.
Permissions required: For the issue containing the attachment:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- If attachments are added in private comments, the comment-level restriction will be applied.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { fallbackToDefault?: boolean; height?: number; id: string; redirect?: boolean; width?: number; } | - |
parameters.fallbackToDefault? | boolean | Whether a default thumbnail is returned when the requested thumbnail is not found. |
parameters.height? | number | The maximum height to scale the thumbnail to. |
parameters.id? | string | The ID of the attachment. |
parameters.redirect? | boolean | Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment. |
parameters.width? | number | The maximum width to scale the thumbnail to. |
options? | RequestOptions | - |
Returns
Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>