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

Class CurrentUserPreferencesApi

java.lang.Object

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

public class CurrentUserPreferencesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	deleteLocale(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete locale Deletes the locale of the user, which restores the default setting.
io.reactivex.Single<Locale>	getLocale(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get locale Returns the locale for the user.
io.reactivex.Single<String>	getPreference(Optional<String> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get preference Returns the value of a preference of the current user.
io.reactivex.Completable	removePreference(Optional<String> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete preference Deletes a preference of the user, which restores the default value of system defined settings.
io.reactivex.Single<Object>	setLocale(Locale locale, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set locale Sets the locale of the user.
io.reactivex.Single<Object>	setPreference(String body, Optional<String> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set preference Creates a preference for the user or updates a preference's value by sending a plain text string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CurrentUserPreferencesApi

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

Method Detail

deleteLocale

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

Delete locale

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

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>

getLocale

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

Get locale

Returns the locale for the user.

If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.

This operation can be accessed anonymously.

Permissions required: None.

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

getPreference

public io.reactivex.Single<String> getPreference(Optional<String> key,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get preference

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

Parameters:

key -

The key of the preference.

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

removePreference

public io.reactivex.Completable removePreference(Optional<String> key,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete preference

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

Parameters:

key -

The key of the preference.

(optional)

restRequestEnhancer -

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

Returns:

Completable

setLocale

public io.reactivex.Single<Object> setLocale(Locale locale,
                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set locale

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

Parameters:

locale -

The locale defined in a LocaleBean.

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

setPreference

public io.reactivex.Single<Object> setPreference(String body,
                                                 Optional<String> key,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set preference

Creates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:

• user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
• user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
• jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
• jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
• user.default.share.private Indicates whether new filters are set to private. Defaults to true.
• user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
• user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

Parameters:

body -

The value of the preference as a plain text string. The maximum length is 255 characters.

(required)

key -

The key of the preference. The maximum length is 255 characters.

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