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

Class DynamicModulesApi

java.lang.Object

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

public class DynamicModulesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ConnectModules>	getModules(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get modules Returns all modules registered dynamically by the calling app.
io.reactivex.Completable	registerModules(ConnectModules requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Register modules Registers a list of modules.
io.reactivex.Completable	removeModules(Optional<List<String>> moduleKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove modules Remove all or a list of modules registered by the calling app.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicModulesApi

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

Method Detail

getModules

public io.reactivex.Single<ConnectModules> getModules(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get modules

Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.

Parameters:

restRequestEnhancer -

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

Returns:

Single<ConnectModules>

registerModules

public io.reactivex.Completable registerModules(ConnectModules requestBody,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Register modules

Registers a list of modules.

Permissions required: Only Connect apps can make this request.

Parameters:

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

removeModules

public io.reactivex.Completable removeModules(Optional<List<String>> moduleKey,
                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove modules

Remove all or a list of modules registered by the calling app.

Permissions required: Only Connect apps can make this request.

Parameters:

moduleKey -

The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field. Nonexistent keys are ignored.

(optional, default to new ArrayList<>())

restRequestEnhancer -

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

Returns:

Completable