UserPreferences (INRIX Mobile Client SDK

java.lang.Object
- com.inrix.sdk.utils.UserPreferences

```
public final class UserPreferences
extends Object
```
Utility class to store/retrieve global user preferences for example preferred units.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UserPreferences.Unit
Units for expressing distances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserPreferences.Unit` Units for expressing distances.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`clear()` Clear all user info.
`static boolean`	`getBooleanSetting(String settingName, boolean defaultValue)` Generic get boolean setting.
`static String`	`getInstallationIdHash()` Get the installation ID hash.
`static long`	`getLongSetting(String settingName)` Generic get long setting.
`static long`	`getLongSetting(String settingName, long defaultValue)` Generic get long setting.
`static Locale`	`getPreferredLocale()` Get the preferred `Locale`.
`static UserPreferences.Unit`	`getSettingUnits()` Get the preferred distance units defined by `UserPreferences.Unit`.
`static String`	`getStringSetting(String settingName)` Generic get string setting.
`static String`	`getStringSetting(String settingName, String defaultValue)` Generic get string setting.
`static boolean`	`hasSetting(String settingName)` Checks whether the provided setting is stored within the settings.
`static boolean`	`loaded()` Check if the preferences are loaded into memory.
`static void`	`setBooleanSetting(String settingName, boolean settingValue)` Generic set boolean setting.
`static void`	`setLongSetting(String settingName, long settingValue)` Generic set long setting.
`static void`	`setPreferredLocale(Locale locale)` Set the preferred `Locale`.
`static void`	`setSettingUnits(UserPreferences.Unit unit)` Set the preferred distance units.
`static void`	`setStringSetting(String settingName, String settingValue)` Generic set string setting.

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

- Method Detail
  - loaded
```
public static boolean loaded()
```
    Check if the preferences are loaded into memory.
    
    Returns:
    true if loaded, false otherwise.
  - getInstallationIdHash
```
public static String getInstallationIdHash()
```
    Get the installation ID hash.
    
    Returns:
    The installation ID hash, or null if not persisted.
  - getSettingUnits
```
public static UserPreferences.Unit getSettingUnits()
```
    Get the preferred distance units defined by UserPreferences.Unit. Unless the settings are explicitly set using UserPreferences.setSettingUnits(Unit), this method will return the units appropriate for the current device locale.
    
    Returns:
    The preferred distance units.
  - setSettingUnits
```
public static void setSettingUnits(UserPreferences.Unit unit)
```
    Set the preferred distance units.
    
    Parameters:
    unit - The preferred distance units. null will remove this preference and default to appropriate units based on locale.
  - getPreferredLocale
```
public static Locale getPreferredLocale()
```
    Get the preferred Locale. The preferred Locale is determined in the following priority:
    - Preferred Locale specified with UserPreferences.setPreferredLocale(Locale)
    - Device default specified by Locale.getDefault()
    If no Locale has been specified, the returned value is always the device default.
    Returns:
    The preferred Locale.
  - setPreferredLocale
```
public static void setPreferredLocale(Locale locale)
```
    Set the preferred Locale. Note that this preference will take precedence over the device default if specified. To remove the preference the Locale parameter should be passed in as null.
    
    Parameters:
    locale - The preferred Locale. null will remove this preference and default to appropriate Locale based on device settings.
  - clear
```
public static void clear()
```
    Clear all user info.
  - getStringSetting
```
public static String getStringSetting(String settingName)
```
    Generic get string setting. This method will be used by other classes that want to retrieve a stored String setting.
    
    Parameters:
    settingName - The name of the setting.
    
    Returns:
    The setting value or null if setting not found.
  - getStringSetting
```
public static String getStringSetting(String settingName,
                      String defaultValue)
```
    Generic get string setting. This method will be used by other classes that want to retrieve a stored String setting.
    
    Parameters:
    settingName - The name of the setting.
    defaultValue - The value returned when the setting is not found.
    
    Returns:
    The setting value or the defaultValue if setting not found.
  - setStringSetting
```
public static void setStringSetting(String settingName,
                    String settingValue)
```
    Generic set string setting. This method will be used by other classes that want to store a String setting
    
    Parameters:
    settingName - A non null name of the setting
    settingValue - The setting value
  - getLongSetting
```
public static long getLongSetting(String settingName)
```
    Generic get long setting. This method will be used by other classes that want to retrieve a stored long setting.
    
    Parameters:
    settingName - The name of the setting.
    
    Returns:
    The setting value 0 if setting not found.
  - getLongSetting
```
public static long getLongSetting(String settingName,
                  long defaultValue)
```
    Generic get long setting. This method will be used by other classes that want to retrieve a stored long setting.
    
    Parameters:
    settingName - The name of the setting.
    defaultValue - The value returned when the setting is not found.
    
    Returns:
    The setting value or the defaultValue if setting not found.
  - setLongSetting
```
public static void setLongSetting(String settingName,
                  long settingValue)
```
    Generic set long setting. This method will be used by other classes that want to store a long setting
    
    Parameters:
    settingName - The name of the setting
    settingValue - The long value of the setting
  - getBooleanSetting
```
public static boolean getBooleanSetting(String settingName,
                        boolean defaultValue)
```
    Generic get boolean setting. This method will be used by other classes that want to retrieve a stored boolean setting.
    
    Parameters:
    settingName - The name of the setting.
    defaultValue - The value returned when the setting is not found.
    
    Returns:
    The setting value or the defaultValue if setting not found.
  - setBooleanSetting
```
public static void setBooleanSetting(String settingName,
                     boolean settingValue)
```
    Generic set boolean setting. This method will be used by other classes that want to store a boolean setting
    
    Parameters:
    settingName - The name of the setting
    settingValue - The boolean value of the setting
  - hasSetting
```
public static boolean hasSetting(String settingName)
```
    Checks whether the provided setting is stored within the settings.
    
    Parameters:
    settingName - The name of the setting.
    
    Returns:
    true if the value exists, false otherwise.

Class UserPreferences

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

loaded

getInstallationIdHash

getSettingUnits

setSettingUnits

getPreferredLocale

setPreferredLocale

clear

getStringSetting

getStringSetting

setStringSetting

getLongSetting

getLongSetting

setLongSetting

getBooleanSetting

setBooleanSetting

hasSetting