Package com.atlassian.confluence.api.model.people

Class UserSettings

java.lang.Object

com.atlassian.confluence.api.model.people.UserSettings

public class UserSettings
extends Object

Represents user settings data for API operations.

Since:

10.2

See Also:

• UserSettingsService

Constructor Summary

Constructors

Constructor	Description
UserSettings(String username)
UserSettings(String username, String locale)	Creates a new UserSettings instance.

Method Summary

Modifier and Type	Method	Description
String	getLocale()	Gets the user's locale preference.
String	getUsername()	Gets the username of the target user.
void	setLocale(String locale)	Sets the user's locale.

Methods inherited from class java.lang.Object

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

Constructor Details

UserSettings

public UserSettings(String username,
 String locale)

Creates a new UserSettings instance.

Parameters:

username - the username of the user whose settings are being updated

locale - the locale preference for the user (can be null or empty)

UserSettings

public UserSettings(String username)

Method Details

getLocale

public String getLocale()

Gets the user's locale preference.

Returns:

the locale string (e.g. "en_GB", "fr_FR")

getUsername

public String getUsername()

Gets the username of the target user.

Returns:

the username string

setLocale

public void setLocale(String locale)

Sets the user's locale. The value "None" will clear the setting for the user, and they will see application's default locale. Empty or null values will trigger no change.

Parameters:

locale - the locale string