Skip to content

Function: getAvatarImageByID() ​

ts
function getAvatarImageByID(
   client, 
   parameters, 
   options?
): Promise<Blob>;

Defined in: src/cloud/api/avatars.ts:178

Returns a project, issue type or priority avatar image by ID.

This operation can be accessed anonymously.

Permissions required:

  • For system avatars, none.
  • For custom project avatars, Browse projects project permission for the project the avatar belongs to.
  • For custom issue type avatars, Browse projects project permission for at least one project the issue type is used in.
  • For priority avatars, none.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ format?: "svg" | string & object | "png"; id: number; size?: "small" | "medium" | string & object | "xsmall" | "large" | "xlarge"; type: "priority" | string & object | "project" | "issuetype"; }-
parameters.format?"svg" | string & object | "png"The format to return the avatar image in. If not provided the original content format is returned.
parameters.id?numberThe ID of the avatar.
parameters.size?"small" | "medium" | string & object | "xsmall" | "large" | "xlarge"The size of the avatar image. If not provided the default size is returned.
parameters.type?"priority" | string & object | "project" | "issuetype"The icon type of the avatar.
options?RequestOptions-

Returns ​

Promise<Blob>