com.atlassian.stash.rest.client.api

Interface AvatarRequest

All Known Implementing Classes:

AvatarRequest.DefaultAvatarRequest

public interface AvatarRequest

can be used on few methods in StashClient to request remote Stash/Bitbucket instance to return avatar data. Can specify size, URL scheme and URL mode of the avatar links returned

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AvatarRequest.DefaultAvatarRequest

Method Summary

Modifier and Type	Method and Description
static AvatarRequest.DefaultAvatarRequest.DefaultAvatarRequestBuilder	builder()
long	getSize()
String	getUrlMode() Note size must be specified for scheme to be honoured, at least as of Bitbucket 4.10
String	getUrlScheme() Note size must be specified for scheme to be honoured, at least as of Bitbucket 4.10

Method Detail

getSize

long getSize()

Returns:

the height/width of the avatar being requested

getUrlScheme

@Nullable
String getUrlScheme()

Note size must be specified for scheme to be honoured, at least as of Bitbucket 4.10

Returns:

https for secure https URLs, rather than request specific (as of Bitbucket 4.12.0).

getUrlMode

@Nullable
String getUrlMode()

Note size must be specified for scheme to be honoured, at least as of Bitbucket 4.10

Returns:

absolute for absolute URLs, rather than request specific (as of Bitbucket 4.12.0).

builder

static AvatarRequest.DefaultAvatarRequest.DefaultAvatarRequestBuilder builder()