org.everit.atlassian.restclient.jiracloud.v3.api

Class AddonPropertiesApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.AddonPropertiesApi

public class AddonPropertiesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteAddonProperty(String addonKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete app property Deletes an app's property.
io.reactivex.Single<PropertyKeys>	getAddonProperties(String addonKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get app properties Gets all the properties of an app.
io.reactivex.Single<EntityProperty>	getAddonProperty(String addonKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get app property Returns the key and value of an app's property.
io.reactivex.Single<OperationMessage>	putAddonProperty(String addonKey, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set app property Sets the value of an app's property.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddonPropertiesApi

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

Method Detail

deleteAddonProperty

public io.reactivex.Completable deleteAddonProperty(String addonKey,
                                                    String propertyKey,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete app property

Deletes an app's property.

Permissions required: Only a Connect app whose key matches addonKey can make this request.

Parameters:

addonKey -

The key of the app, as defined in its descriptor.

(required)

propertyKey -

The key of the property.

(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

getAddonProperties

public io.reactivex.Single<PropertyKeys> getAddonProperties(String addonKey,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get app properties

Gets all the properties of an app.

Permissions required: Only a Connect app whose key matches addonKey can make this request.

Parameters:

addonKey -

The key of the app, as defined in its descriptor.

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

getAddonProperty

public io.reactivex.Single<EntityProperty> getAddonProperty(String addonKey,
                                                            String propertyKey,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get app property

Returns the key and value of an app's property.

Permissions required: Only a Connect app whose key matches addonKey can make this request.

Parameters:

addonKey -

The key of the app, as defined in its descriptor.

(required)

propertyKey -

The key of the property.

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

putAddonProperty

public io.reactivex.Single<OperationMessage> putAddonProperty(String addonKey,
                                                              String propertyKey,
                                                              Object body,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set app property

Sets the value of an app's property. Use this resource to store custom data for your app.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Only a Connect app whose key matches addonKey can make this request.

Parameters:

addonKey -

The key of the app, as defined in its descriptor.

(required)

propertyKey -

The key of the property.

(required)

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