org.everit.atlassian.restclient.jiracloud.v2.api

Class ProjectAvatarsApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.ProjectAvatarsApi

public class ProjectAvatarsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProjectAvatarsApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Avatar>	createProjectAvatar(String projectIdOrKey, Object body, Optional<Integer> x, Optional<Integer> y, Optional<Integer> size, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Load project avatar Loads an avatar for a project.
io.reactivex.Completable	deleteProjectAvatar(String projectIdOrKey, Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete project avatar Deletes a custom avatar from a project.
io.reactivex.Single<ProjectAvatars>	getAllProjectAvatars(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all project avatars Returns all project avatars, grouped by system and custom avatars.
io.reactivex.Single<Object>	updateProjectAvatar(String projectIdOrKey, Avatar avatar, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set project avatar Sets the avatar displayed for a project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectAvatarsApi

public ProjectAvatarsApi(org.everit.http.restclient.RestClient restClient)

Method Detail

createProjectAvatar

public io.reactivex.Single<Avatar> createProjectAvatar(String projectIdOrKey,
                                                       Object body,
                                                       Optional<Integer> x,
                                                       Optional<Integer> y,
                                                       Optional<Integer> size,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Load project avatar Loads an avatar for a project. Specify the avatar's local file location in the body of the request. Also, include the following headers: * `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers). * `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG. For example: `curl --request POST ` `--user email@example.com: ` `--header 'X-Atlassian-Token: no-check' ` `--header 'Content-Type: image/< image_type>' ` `--data-binary \"<@/path/to/file/with/your/avatar>\" ` `--url 'https://your-domain.atlassian.net/rest/api/2/project/{projectIdOrKey}/avatar2'` 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](#api-rest-api-2-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).

Parameters:

projectIdOrKey - The ID or (case-sensitive) key of the project. (required)

body - (required)

x - The X coordinate of the top-left corner of the crop region. (optional, default to 0)

y - The Y coordinate of the top-left corner of the crop region. (optional, default to 0)

size - The length of each side of the crop region. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Avatar>

deleteProjectAvatar

public io.reactivex.Completable deleteProjectAvatar(String projectIdOrKey,
                                                    Long id,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete project avatar Deletes a custom avatar from a project. Note that system avatars cannot be deleted. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).

Parameters:

projectIdOrKey - The project ID or (case-sensitive) key. (required)

id - The ID of the avatar. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getAllProjectAvatars

public io.reactivex.Single<ProjectAvatars> getAllProjectAvatars(String projectIdOrKey,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all project avatars Returns all project avatars, grouped by system and custom avatars. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.

Parameters:

projectIdOrKey - The ID or (case-sensitive) key of the project. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ProjectAvatars>

updateProjectAvatar

public io.reactivex.Single<Object> updateProjectAvatar(String projectIdOrKey,
                                                       Avatar avatar,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set project avatar Sets the avatar displayed for a project. Use [Load project avatar](#api-rest-api-2-project-projectIdOrKey-avatar2-post) to store avatars against the project, before using this operation to set the displayed avatar. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).

Parameters:

projectIdOrKey - The ID or (case-sensitive) key of the project. (required)

avatar - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>