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

Class AvatarsApi

java.lang.Object

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

public class AvatarsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteAvatar(String type, String owningObjectId, Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete avatar Deletes an avatar from a project or issue type.
io.reactivex.Single<SystemAvatars>	getAllSystemAvatars(String type, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get system avatars by type Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.
io.reactivex.Single<Avatars>	getAvatars(String type, String entityId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get avatars Returns the system and custom avatars for a project or issue type.
io.reactivex.Single<Avatar>	storeAvatar(String type, String entityId, Integer size, Object body, Optional<Integer> x, Optional<Integer> y, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Load avatar Loads a custom avatar for a project or issue type.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvatarsApi

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

Method Detail

deleteAvatar

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

Delete avatar Deletes an avatar from a project or issue type. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

type - The avatar type. (required)

owningObjectId - The ID of the item the avatar is associated with. (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

getAllSystemAvatars

public io.reactivex.Single<SystemAvatars> getAllSystemAvatars(String type,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get system avatars by type Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

Parameters:

type - The avatar type. (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<SystemAvatars>

getAvatars

public io.reactivex.Single<Avatars> getAvatars(String type,
                                               String entityId,
                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get avatars Returns the system and custom avatars for a project or issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

Parameters:

type - The avatar type. (required)

entityId - The ID of the item the avatar is associated with. (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<Avatars>

storeAvatar

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

Load avatar Loads a custom avatar for a project or issue type. 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/universal_avatar/type/{type}/owner/{entityId}'` 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: * [Update issue type](#api-rest-api-2-issuetype-id-put) to set it as the issue type's displayed avatar. * [Set project avatar](#api-rest-api-2-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

type - The avatar type. (required)

entityId - The ID of the item the avatar is associated with. (required)

size - The length of each side of the crop region. (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)

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>