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

Class DashboardItemPropertyApi

java.lang.Object

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

public class DashboardItemPropertyApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteDashboardItemProperty(String dashboardId, String itemId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete dashboard item property Deletes a dashboard item property.
io.reactivex.Single<EntityProperty>	getDashboardItemProperty(String dashboardId, String itemId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get dashboard item property Returns the key and value of a dashboard item property.
io.reactivex.Single<PropertyKeys>	getDashboardItemPropertyKeys(String dashboardId, String itemId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get dashboard item property keys Returns the keys of all properties for a dashboard item.
io.reactivex.Single<Object>	setDashboardItemProperty(String dashboardId, String itemId, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set dashboard item property Sets the value of a dashboard item property.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardItemPropertyApi

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

Method Detail

deleteDashboardItemProperty

public io.reactivex.Completable deleteDashboardItemProperty(String dashboardId,
                                                            String itemId,
                                                            String propertyKey,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete dashboard item property

Deletes a dashboard item property.

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

Parameters:

dashboardId -

The ID of the dashboard.

(required)

itemId -

The ID of the dashboard item.

(required)

propertyKey -

The key of the dashboard item 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

getDashboardItemProperty

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

Get dashboard item property

Returns the key and value of a dashboard item property.

A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.

When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.

There is no resource to set or get dashboard items.

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

Parameters:

dashboardId -

The ID of the dashboard.

(required)

itemId -

The ID of the dashboard item.

(required)

propertyKey -

The key of the dashboard item 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>

getDashboardItemPropertyKeys

public io.reactivex.Single<PropertyKeys> getDashboardItemPropertyKeys(String dashboardId,
                                                                      String itemId,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get dashboard item property keys

Returns the keys of all properties for a dashboard item.

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

Parameters:

dashboardId -

The ID of the dashboard.

(required)

itemId -

The ID of the dashboard item.

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

setDashboardItemProperty

public io.reactivex.Single<Object> setDashboardItemProperty(String dashboardId,
                                                            String itemId,
                                                            String propertyKey,
                                                            Object body,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set dashboard item property

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.

When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.

There is no resource to set or get dashboard items.

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

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

Parameters:

dashboardId -

The ID of the dashboard.

(required)

itemId -

The ID of the dashboard item.

(required)

propertyKey -

The key of the dashboard item property. The maximum length is 255 characters.

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