Function: updateProjectAvatar()
ts
function updateProjectAvatar(
client,
parameters,
options?
): Promise<void>;Defined in: src/cloud/api/projectAvatars.ts:19
Sets the avatar displayed for a project.
Use Load project avatar to store avatars against the project, before using this operation to set the displayed avatar.
Permissions required:Administer projects project permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; projectIdOrKey: string; urls?: Record<string, string>; } | - |
parameters.fileName? | string | The file name of the avatar icon. Returned for system avatars. |
parameters.id? | string | The ID of the avatar. |
parameters.isDeletable? | boolean | Whether the avatar can be deleted. |
parameters.isSelected? | boolean | Whether the avatar is used in Jira. For example, shown as a project's avatar. |
parameters.isSystemAvatar? | boolean | Whether the avatar is a system avatar. |
parameters.owner? | string | The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user. |
parameters.projectIdOrKey? | string | The ID or (case-sensitive) key of the project. |
parameters.urls? | Record<string, string> | The list of avatar icon URLs. |
options? | RequestOptions | - |
Returns
Promise<void>