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

Class TimeTrackingApi

java.lang.Object

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

public class TimeTrackingApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	disableTimeTracking(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<List<TimeTrackingProvider>>	getAvailableTimeTrackingImplementations(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all time tracking providers Returns all time tracking providers.
io.reactivex.Single<TimeTrackingProvider>	getSelectedTimeTrackingImplementation(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get selected time tracking provider Returns the time tracking provider that is currently selected.
io.reactivex.Single<TimeTrackingConfiguration>	getSharedTimeTrackingConfiguration(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get time tracking settings Returns the time tracking settings.
io.reactivex.Single<Object>	selectTimeTrackingImplementation(TimeTrackingProvider timeTrackingProvider, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Select time tracking provider Selects a time tracking provider.
io.reactivex.Single<TimeTrackingConfiguration>	setSharedTimeTrackingConfiguration(TimeTrackingConfiguration timeTrackingConfiguration, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set time tracking settings Sets the time tracking settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeTrackingApi

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

Method Detail

disableTimeTracking

@Deprecated
public io.reactivex.Single<Object> disableTimeTracking(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Deprecated.

Disable time tracking

Disables time tracking.

Permissions required: Administer Jira global permission.

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

getAvailableTimeTrackingImplementations

public io.reactivex.Single<List<TimeTrackingProvider>> getAvailableTimeTrackingImplementations(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all time tracking providers

Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.

Permissions required: Administer Jira global permission.

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<List<TimeTrackingProvider>>

getSelectedTimeTrackingImplementation

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

Get selected time tracking provider

Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.

Permissions required: Administer Jira global permission.

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

getSharedTimeTrackingConfiguration

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

Get time tracking settings

Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.

Permissions required: Administer Jira global permission.

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

selectTimeTrackingImplementation

public io.reactivex.Single<Object> selectTimeTrackingImplementation(TimeTrackingProvider timeTrackingProvider,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Select time tracking provider

Selects a time tracking provider.

Permissions required: Administer Jira global permission.

Parameters:

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

setSharedTimeTrackingConfiguration

public io.reactivex.Single<TimeTrackingConfiguration> setSharedTimeTrackingConfiguration(TimeTrackingConfiguration timeTrackingConfiguration,
                                                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set time tracking settings

Sets the time tracking settings.

Permissions required: Administer Jira global permission.

Parameters:

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