Class ProjectAvatars

Index

Constructors

constructor

Methods

createProjectAvatar deleteProjectAvatar getAllProjectAvatars updateProjectAvatar

Constructors

constructor

new ProjectAvatars(client: Client): Version3.ProjectAvatars
Parameters
- client: Client
Returns Version3.ProjectAvatars
- Defined in src/version3/projectAvatars.ts:8

Methods

createProjectAvatar

createProjectAvatar<T = Version3Models.Avatar>(
parameters: Version3Parameters.CreateProjectAvatar,
callback: Callback<T>,
): Promise<void>
Loads an avatar for a project.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar use Set project avatar to set it as the project's displayed avatar.

Permissions required: Administer projects project permission.
Type Parameters
- T = Version3Models.Avatar
Parameters
- parameters: Version3Parameters.CreateProjectAvatar
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectAvatars.ts:94
createProjectAvatar<T = Version3Models.Avatar>(
parameters: Version3Parameters.CreateProjectAvatar,
callback?: undefined,
): Promise<T>
Loads an avatar for a project.

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar use Set project avatar to set it as the project's displayed avatar.

Permissions required: Administer projects project permission.
Type Parameters
- T = Version3Models.Avatar
Parameters
- parameters: Version3Parameters.CreateProjectAvatar
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectAvatars.ts:113

deleteProjectAvatar

deleteProjectAvatar<T = void>(
parameters: Version3Parameters.DeleteProjectAvatar,
callback: Callback<T>,
): Promise<void>
Deletes a custom avatar from a project. Note that system avatars cannot be deleted.

Permissions required: Administer projects project permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteProjectAvatar
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectAvatars.ts:57
deleteProjectAvatar<T = void>(
parameters: Version3Parameters.DeleteProjectAvatar,
callback?: undefined,
): Promise<T>
Deletes a custom avatar from a project. Note that system avatars cannot be deleted.

Permissions required: Administer projects project permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteProjectAvatar
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectAvatars.ts:64

getAllProjectAvatars

getAllProjectAvatars<T = Version3Models.ProjectAvatars>(
parameters: Version3Parameters.GetAllProjectAvatars,
callback: Callback<T>,
): Promise<void>
Returns all project avatars, grouped by system and custom avatars.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project.
Type Parameters
- T = Version3Models.ProjectAvatars
Parameters
- parameters: Version3Parameters.GetAllProjectAvatars
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectAvatars.ts:147
getAllProjectAvatars<T = Version3Models.ProjectAvatars>(
parameters: Version3Parameters.GetAllProjectAvatars,
callback?: undefined,
): Promise<T>
Returns all project avatars, grouped by system and custom avatars.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project.
Type Parameters
- T = Version3Models.ProjectAvatars
Parameters
- parameters: Version3Parameters.GetAllProjectAvatars
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectAvatars.ts:159

updateProjectAvatar

updateProjectAvatar<T = void>(
parameters: Version3Parameters.UpdateProjectAvatar,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateProjectAvatar
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectAvatars.ts:19
updateProjectAvatar<T = void>(
parameters: Version3Parameters.UpdateProjectAvatar,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateProjectAvatar
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectAvatars.ts:29

Class ProjectAvatars

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.ProjectAvatars

Methods

createProjectAvatar

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteProjectAvatar

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllProjectAvatars

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateProjectAvatar

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page