UserPreferencesHelper (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.preferences.user.UserPreferencesHelper

```
public final class UserPreferencesHelper
extends Object
```
Helper class for accessing user preferences.

Author:

Sergiy Shyrkov

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`areEmailNotificationsDisabled(JahiaUser user)` Returns `true` if the user has explicitly disabled e-mail notification in the profile.
`static boolean`	`areEmailNotificationsDisabled(JCRUserNode user)` Returns `true` if the user has explicitly disabled e-mail notification in the profile.
`static String`	`getEmailAddress(JCRUserNode user)` Returns user's e-mail address or `null` if it is not provided.
`static String`	`getFirstName(JCRUserNode user)` Returns the first name for the specified user or `null` if it is not provided or empty.
`static String`	`getFullName(JCRUserNode user)` Returns the first + last name of the specified user or `null` if none is not provided or both are empty.
`static String`	`getLastName(JCRUserNode user)` Returns the last name for the specified user or `null` if it is not provided or empty.
`static String`	`getPersonalizedEmailAddress(JCRUserNode user)` Returns the e-mail address with the personal name of the specified user.
`static String`	`getPersonalizedEmailAddress(String email, JCRUserNode user)` Returns the e-mail address with the personal name of the specified user.
`static String`	`getPersonalName(JCRUserNode user)` Returns the full user name (first name + last name) or the username if the full name data is not provided.
`static Locale`	`getPreferredLocale(JCRUserNode user)` Returns the preferred locale of the specified user or the first one from the list of available locales.
`static Locale`	`getPreferredLocale(JCRUserNode user, JahiaSite site)` Returns the preferred locale of the specified user or the first one from the list of available locales.
`static Locale`	`getPreferredLocale(JCRUserNode user, Locale fallback)` Returns the preferred locale of the specified user or the first one from the list of available locales.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - areEmailNotificationsDisabled
```
public static boolean areEmailNotificationsDisabled(JahiaUser user)
```
    Returns true if the user has explicitly disabled e-mail notification in the profile.
    
    Parameters:
    
    user - the user to check preferences
    
    Returns:
    
    true if the user has explicitly disabled e-mail notification in the profile
  - areEmailNotificationsDisabled
```
public static boolean areEmailNotificationsDisabled(JCRUserNode user)
```
    Returns true if the user has explicitly disabled e-mail notification in the profile.
    
    Parameters:
    
    user - the user to check preferences
    
    Returns:
    
    true if the user has explicitly disabled e-mail notification in the profile
  - getEmailAddress
```
public static String getEmailAddress(JCRUserNode user)
```
    Returns user's e-mail address or null if it is not provided.
    
    Parameters:
    
    user - the user to retrieve the e-mail address
    
    Returns:
    
    user's e-mail address or null if it is not provided
  - getFirstName
```
public static String getFirstName(JCRUserNode user)
```
    Returns the first name for the specified user or null if it is not provided or empty.
    
    Parameters:
    
    user - the user to retrieve the first name
    
    Returns:
    
    the first name for the specified user or null if it is not provided or empty
  - getFullName
```
public static String getFullName(JCRUserNode user)
```
    Returns the first + last name of the specified user or null if none is not provided or both are empty.
    
    Parameters:
    
    user - the user to retrieve the name
    
    Returns:
    
    the first + last name of the specified user or null if none is not provided or both are empty
  - getLastName
```
public static String getLastName(JCRUserNode user)
```
    Returns the last name for the specified user or null if it is not provided or empty.
    
    Parameters:
    
    user - the user to retrieve the first name
    
    Returns:
    
    the last name for the specified user or null if it is not provided or empty
  - getPersonalizedEmailAddress
```
public static String getPersonalizedEmailAddress(JCRUserNode user)
```
    Returns the e-mail address with the personal name of the specified user.
    
    Parameters:
    
    user - the user to retrieve the personal name
    
    Returns:
    
    the e-mail address with the personal name of the specified user
  - getPersonalizedEmailAddress
```
public static String getPersonalizedEmailAddress(String email,
                                                 JCRUserNode user)
```
    Returns the e-mail address with the personal name of the specified user.
    
    Parameters:
    
    email - the e-mail address itself
    
    user - the user to retrieve the personal name
    
    Returns:
    
    the e-mail address with the personal name of the specified user
  - getPersonalName
```
public static String getPersonalName(JCRUserNode user)
```
    Returns the full user name (first name + last name) or the username if the full name data is not provided.
    
    Parameters:
    
    user - the user to retrieve the name
    
    Returns:
    
    the full user name (first name + last name) or the username if the full name data is not provided
  - getPreferredLocale
```
public static Locale getPreferredLocale(JCRUserNode user)
```
    Returns the preferred locale of the specified user or the first one from the list of available locales.
    
    Parameters:
    
    user - the user to retrieve locale preferences
    
    Returns:
    
    the preferred locale of the specified user or the first one from the list of available locales
  - getPreferredLocale
```
public static Locale getPreferredLocale(JCRUserNode user,
                                        Locale fallback)
```
    Returns the preferred locale of the specified user or the first one from the list of available locales.
    
    Parameters:
    
    user - the user to retrieve locale preferences
    
    fallback - the fallback locale to return if no preferred locale is set for the user
    
    Returns:
    
    the preferred locale of the specified user or the first one from the list of available locales
  - getPreferredLocale
```
public static Locale getPreferredLocale(JCRUserNode user,
                                        JahiaSite site)
```
    Returns the preferred locale of the specified user or the first one from the list of available locales.
    
    Parameters:
    
    user - the user to retrieve locale preferences
    
    site - the site
    
    Returns:
    
    the preferred locale of the specified user or the first one from the list of available locales

Class UserPreferencesHelper

Method Summary

Methods inherited from class java.lang.Object

Method Detail

areEmailNotificationsDisabled

areEmailNotificationsDisabled

getEmailAddress

getFirstName

getFullName

getLastName

getPersonalizedEmailAddress

getPersonalizedEmailAddress

getPersonalName

getPreferredLocale

getPreferredLocale

getPreferredLocale