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

Class ScreensApi

java.lang.Object

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

public class ScreensApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	addFieldToDefaultScreen(String fieldId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add field to default screen Adds a field to the default tab of the default screen.
io.reactivex.Single<ScreenableTab>	addScreenTab(Long screenId, ScreenableTab screenableTab, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create screen tab Creates a tab for a screen.
io.reactivex.Single<ScreenableField>	addScreenTabField(Long screenId, Long tabId, AddFieldBean addFieldBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add screen tab field Adds a field to a screen tab.
io.reactivex.Completable	deleteScreenTab(Long screenId, Long tabId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete screen tab Deletes a screen tab.
io.reactivex.Single<PageBeanScreen>	getAllScreens(Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all screens Returns all screens.
io.reactivex.Single<List<ScreenableField>>	getAllScreenTabFields(Long screenId, Long tabId, Optional<String> projectKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all screen tab fields Returns all fields for a screen tab.
io.reactivex.Single<List<ScreenableTab>>	getAllScreenTabs(Long screenId, Optional<String> projectKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all screen tabs Returns the list of tabs for a screen.
io.reactivex.Single<List<ScreenableField>>	getAvailableScreenFields(Long screenId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get available screen fields Returns the fields that can be added to a tab on a screen.
io.reactivex.Single<Object>	moveScreenTab(Long screenId, Long tabId, Integer pos, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Move screen tab Moves a screen tab.
io.reactivex.Single<Object>	moveScreenTabField(Long screenId, Long tabId, String id, MoveFieldBean moveFieldBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Move screen tab field Moves a screen tab field.
io.reactivex.Completable	removeScreenTabField(Long screenId, Long tabId, String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove screen tab field Removes a field from a screen tab.
io.reactivex.Single<ScreenableTab>	renameScreenTab(Long screenId, Long tabId, ScreenableTab screenableTab, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update screen tab Updates the name of a screen tab.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreensApi

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

Method Detail

addFieldToDefaultScreen

public io.reactivex.Single<Object> addFieldToDefaultScreen(String fieldId,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add field to default screen

Adds a field to the default tab of the default screen.

Permissions required: Administer Jira global permission.

Parameters:

fieldId -

The ID of the field.

(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>

addScreenTab

public io.reactivex.Single<ScreenableTab> addScreenTab(Long screenId,
                                                       ScreenableTab screenableTab,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create screen tab

Creates a tab for a screen.

Permissions required: Administer Jira global permission.

Parameters:

screenId -

The ID of the screen.

(required)

screenableTab - (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<ScreenableTab>

addScreenTabField

public io.reactivex.Single<ScreenableField> addScreenTabField(Long screenId,
                                                              Long tabId,
                                                              AddFieldBean addFieldBean,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add screen tab field

Adds a field to a screen tab.

Permissions required: Administer Jira global permission.

Parameters:

screenId -

The ID of the screen.

(required)

tabId -

The ID of the screen tab.

(required)

addFieldBean - (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<ScreenableField>

deleteScreenTab

public io.reactivex.Completable deleteScreenTab(Long screenId,
                                                Long tabId,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete screen tab

Deletes a screen tab.

Permissions required: Administer Jira global permission.

Parameters:

screenId -

The ID of the screen.

(required)

tabId -

The ID of the screen tab.

(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

getAllScreenTabFields

public io.reactivex.Single<List<ScreenableField>> getAllScreenTabFields(Long screenId,
                                                                        Long tabId,
                                                                        Optional<String> projectKey,
                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all screen tab fields

Returns all fields for a screen tab.

Permissions required:

• Administer Jira global permission.
• Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.

Parameters:

screenId -

The ID of the screen.

(required)

tabId -

The ID of the screen tab.

(required)

projectKey -

The key of the project.

(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<List<ScreenableField>>

getAllScreenTabs

public io.reactivex.Single<List<ScreenableTab>> getAllScreenTabs(Long screenId,
                                                                 Optional<String> projectKey,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all screen tabs

Returns the list of tabs for a screen.

Permissions required:

• Administer Jira global permission.
• Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.

Parameters:

screenId -

The ID of the screen.

(required)

projectKey -

The key of the project.

(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<List<ScreenableTab>>

getAllScreens

public io.reactivex.Single<PageBeanScreen> getAllScreens(Optional<Long> startAt,
                                                         Optional<Integer> maxResults,
                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all screens

Returns all screens.

Permissions required: Administer Jira global permission.

Parameters:

startAt -

The index of the first item to return in a page of results (page offset).

(optional, default to 0l)

maxResults -

The maximum number of items to return per page. The maximum is 100.

(optional, default to 100)

restRequestEnhancer -

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

Returns:

Single<PageBeanScreen>

getAvailableScreenFields

public io.reactivex.Single<List<ScreenableField>> getAvailableScreenFields(Long screenId,
                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get available screen fields

Returns the fields that can be added to a tab on a screen.

Permissions required: Administer Jira global permission.

Parameters:

screenId -

The ID of the screen.

(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<List<ScreenableField>>

moveScreenTab

public io.reactivex.Single<Object> moveScreenTab(Long screenId,
                                                 Long tabId,
                                                 Integer pos,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Move screen tab

Moves a screen tab.

Permissions required: Administer Jira global permission.

Parameters:

screenId -

The ID of the screen.

(required)

tabId -

The ID of the screen tab.

(required)

pos -

The position of tab. The base index is 0.

(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>

moveScreenTabField

public io.reactivex.Single<Object> moveScreenTabField(Long screenId,
                                                      Long tabId,
                                                      String id,
                                                      MoveFieldBean moveFieldBean,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Move screen tab field

Moves a screen tab field.

If after and position are provided in the request, position is ignored.

Permissions required: Administer Jira global permission.

Parameters:

screenId -

The ID of the screen.

(required)

tabId -

The ID of the screen tab.

(required)

id -

The ID of the field.

(required)

moveFieldBean - (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>

removeScreenTabField

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

Remove screen tab field

Removes a field from a screen tab.

Permissions required: Administer Jira global permission.

Parameters:

screenId -

The ID of the screen.

(required)

tabId -

The ID of the screen tab.

(required)

id -

The ID of the field.

(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

renameScreenTab

public io.reactivex.Single<ScreenableTab> renameScreenTab(Long screenId,
                                                          Long tabId,
                                                          ScreenableTab screenableTab,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update screen tab

Updates the name of a screen tab.

Permissions required: Administer Jira global permission.

Parameters:

screenId -

The ID of the screen.

(required)

tabId -

The ID of the screen tab.

(required)

screenableTab - (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<ScreenableTab>