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

Class ScreenTabsApi

java.lang.Object

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

public class ScreenTabsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.Completable	deleteScreenTab(Long screenId, Long tabId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete screen tab Deletes 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.Completable	getBulkScreenTabs(Optional<List<Long>> screenId, Optional<List<Long>> tabId, Optional<Long> startAt, Optional<Integer> maxResult, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get bulk screen tabs Returns the list of tabs for a bulk of screens.
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<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

ScreenTabsApi

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

Method Detail

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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

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](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) 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>>

getBulkScreenTabs

public io.reactivex.Completable getBulkScreenTabs(Optional<List<Long>> screenId,
                                                  Optional<List<Long>> tabId,
                                                  Optional<Long> startAt,
                                                  Optional<Integer> maxResult,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get bulk screen tabs Returns the list of tabs for a bulk of screens. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

screenId - The list of screen IDs. To include multiple screen IDs, provide an ampersand-separated list. For example, `screenId=10000&screenId=10001`. (optional, default to new ArrayList<>())

tabId - The list of tab IDs. To include multiple tab IDs, provide an ampersand-separated list. For example, `tabId=10000&tabId=10001`. (optional, default to new ArrayList<>())

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)

maxResult - The maximum number of items to return per page. The maximum number 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:

Completable

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>