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

Class MyselfApi

java.lang.Object

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

public class MyselfApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MyselfApi(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) Deprecated.
io.reactivex.Single<User>	getCurrentUser(Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get current user Returns details for the current user.
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(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(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) Deprecated.
io.reactivex.Single<Object>	setPreference(String key, String body, 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

MyselfApi

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

Method Detail

deleteLocale

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

Deprecated.

Delete locale Deprecated, use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API instead. Deletes the locale of the user, which restores the default setting. **[Permissions](#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>

getCurrentUser

public io.reactivex.Single<User> getCurrentUser(Optional<String> expand,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get current user Returns details for the current user. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

expand - Use [expand](#expansion) to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: * `groups` Returns all groups, including nested groups, the user belongs to. * `applicationRoles` Returns the application roles the user is assigned to. (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<User>

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](#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(String key,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get preference Returns the value of a preference of the current user. Note that these keys are deprecated: * *jira.user.locale* The locale of the user. By default this is not set and the user takes the locale of the instance. * *jira.user.timezone* The time zone of the user. By default this is not set and the user takes the timezone of the instance. Use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API to manage timezone and locale instead. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

key - The key of the preference. (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<String>

removePreference

public io.reactivex.Completable removePreference(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. Note that these keys are deprecated: * *jira.user.locale* The locale of the user. By default, not set. The user takes the instance locale. * *jira.user.timezone* The time zone of the user. By default, not set. The user takes the instance timezone. Use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API to manage timezone and locale instead. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

key - The key of the preference. (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

setLocale

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

Deprecated.

Set locale Deprecated, use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API instead. Sets the locale of the user. The locale must be one supported by the instance of Jira. **[Permissions](#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 key,
                                                 String body,
                                                 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* Whether the user gets notified of their own changes. Defaults to `false`. * *user.default.share.private* Whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private. Defaults to `true`. * *user.keyboard.shortcuts.disabled* Whether keyboard shortcuts are disabled. Defaults to `false`. * *user.autowatch.disabled* Whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting. Note that these keys are deprecated: * *jira.user.locale* The locale of the user. By default, not set. The user takes the instance locale. * *jira.user.timezone* The time zone of the user. By default, not set. The user takes the instance timezone. Use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API to manage timezone and locale instead. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

key - The key of the preference. The maximum length is 255 characters. (required)

body - The value of the preference as a plain text string. The maximum length is 255 characters. (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>