Summary: Methods | [Expand All]
@PublicApi public interface

UserPreferencesManager

com.atlassian.jira.user.preferences.UserPreferencesManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A simple manager for retrieving, caching and updating user preferences objects

Summary

Public Methods
@Internal void clearCache(ApplicationUser user)
Clear any cached preferences for a given user.
void clearCache()
Clear all cached preferences.
@Internal void clearCacheByKey(String userKey)
Clear any cached preferences for a given user.
ExtendedPreferences getExtendedPreferences(ApplicationUser user)
Preferences getPreferences(User user)
This method is deprecated. Use getExtendedPreferences(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.
Preferences getPreferences(ApplicationUser user)
This method is deprecated. Use getExtendedPreferences(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.

Public Methods

@Internal public void clearCache (ApplicationUser user)

@Internal

This method is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Clear any cached preferences for a given user.

public void clearCache ()

Clear all cached preferences.

@Internal public void clearCacheByKey (String userKey)

@Internal

This method is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Clear any cached preferences for a given user.

public ExtendedPreferences getExtendedPreferences (ApplicationUser user)

Returns
  • The user preferences for a user, or null if the user is null

public Preferences getPreferences (User user)

This method is deprecated.
Use getExtendedPreferences(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.

Returns
  • The user preferences for a user, or null if the user is null

public Preferences getPreferences (ApplicationUser user)

This method is deprecated.
Use getExtendedPreferences(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.

Returns
  • The user preferences for a user, or null if the user is null