public class

HeaderSeparatorResouce

extends Object
java.lang.Object
   ↳ com.atlassian.jira.rest.v1.images.HeaderSeparatorResouce

Class Overview

REST endpoint for retrieving a header separator of a given colour.

Summary

Public Constructors
HeaderSeparatorResouce(HeaderSeparatorService headerSeparatorService)
Public Methods
Response getImage(String colorHex, String backgroundColorHex)
Retrieve a header separator for the passed in colors.
Response getImageFromPath(String colorHex, String backgroundColorHex)
Same as the /header-separator?color&bgcolor url, but the colours are specified in the path not the query string.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public HeaderSeparatorResouce (HeaderSeparatorService headerSeparatorService)

Public Methods

public Response getImage (String colorHex, String backgroundColorHex)

Retrieve a header separator for the passed in colors.

Input strings can ontain a leading hash (#) and can be a 3 char or 6 char hex string. See any web tutorial for what colour the string represents.

This is cached effectively forever

Parameters
colorHex The main color of the separator
backgroundColorHex The background colour of the separator.
Returns
  • An array of bytes that represent the returned png. This is cached effectively forever

public Response getImageFromPath (String colorHex, String backgroundColorHex)

Same as the /header-separator?color&bgcolor url, but the colours are specified in the path not the query string. The leading (hash) component of the path is ignored.