com.atlassian.confluence.user
Class ConfluenceUserPreferences

java.lang.Object
  extended by com.atlassian.confluence.user.ConfluenceUserPreferences

public class ConfluenceUserPreferences
extends java.lang.Object

Provides strongly-typed accessors for Confluence user preferences. Use the no-args constructor for sensible defaults for anonymous user preferences.


Constructor Summary
ConfluenceUserPreferences()
          No-args constructor is used for anonymous user preferences
ConfluenceUserPreferences(com.opensymphony.module.propertyset.PropertySet properties)
           
 
Method Summary
 DateFormatter getDateFormatter(FormatSettingsManager formatSettingsManager)
          Deprecated. 
 DateFormatter getDateFormatter(FormatSettingsManager formatSettingsManager, LocaleManager localeManager)
           
 java.util.Locale getLocale()
          Returns the user's preferred locale, or null if the site default locale should be used.
 TimeZone getTimeZone()
           
 com.atlassian.core.user.preferences.UserPreferences getWrappedPreferences()
           
 boolean isShowDifferencesInNotificationEmails()
           
 boolean isShowFullContentInNotificationEmails()
          Deprecated. 
 boolean isWatchingOwnContent()
           
 void setTimeZone(java.lang.String timeZoneID)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfluenceUserPreferences

public ConfluenceUserPreferences()
No-args constructor is used for anonymous user preferences


ConfluenceUserPreferences

public ConfluenceUserPreferences(com.opensymphony.module.propertyset.PropertySet properties)
Parameters:
properties - the PropertySet containing a user's preferences
Method Detail

getTimeZone

public TimeZone getTimeZone()

getDateFormatter

@Deprecated
public DateFormatter getDateFormatter(FormatSettingsManager formatSettingsManager)
Deprecated. 


getDateFormatter

public DateFormatter getDateFormatter(FormatSettingsManager formatSettingsManager,
                                      LocaleManager localeManager)

setTimeZone

public void setTimeZone(java.lang.String timeZoneID)
                 throws com.atlassian.core.AtlassianCoreException
Throws:
com.atlassian.core.AtlassianCoreException

getLocale

public java.util.Locale getLocale()
Returns the user's preferred locale, or null if the site default locale should be used.


isShowDifferencesInNotificationEmails

public boolean isShowDifferencesInNotificationEmails()

isShowFullContentInNotificationEmails

@Deprecated
public boolean isShowFullContentInNotificationEmails()
Deprecated. 


isWatchingOwnContent

public boolean isWatchingOwnContent()

getWrappedPreferences

public com.atlassian.core.user.preferences.UserPreferences getWrappedPreferences()


Copyright © 2003-2014 Atlassian. All Rights Reserved.