Package com.zendesk.sdk.storage

Interface SdkSettingsStorage

public interface SdkSettingsStorage

This class contains methods for interacting with the stored SdkSettings.

Method Summary

Modifier and Type	Method and Description
boolean	areSettingsUpToDate(long duration, java.util.concurrent.TimeUnit timeUnit) Determine if the stored settings older than the provided amount of time.
void	deleteStoredSettings() Deletes any stored MobileSettings that may be present in the SharedPreferences.
SafeMobileSettings	getStoredSettings() Gets the stored MobileSettings from the SharedPreferences, wrapped in a SafeMobileSettings.
boolean	hasStoredSdkSettings() This method can check to see if there are any stored MobileSettings in the SharedPreferences
void	setStoredSettings(SafeMobileSettings mobileSettings) Saves the supplied MobileSettings to SharedPreferences.

Method Detail

hasStoredSdkSettings

boolean hasStoredSdkSettings()

This method can check to see if there are any stored MobileSettings in the SharedPreferences

Returns:

true if the storage has MobileSettings stored

areSettingsUpToDate

boolean areSettingsUpToDate(long duration,
                            java.util.concurrent.TimeUnit timeUnit)

Determine if the stored settings older than the provided amount of time.

Parameters:

duration - the time duration in the given timeUnit

timeUnit - the unit of the duration argument

Returns:

true if the settings are loaded in the provided time range, false if they are outdated.

getStoredSettings

SafeMobileSettings getStoredSettings()

Gets the stored MobileSettings from the SharedPreferences, wrapped in a SafeMobileSettings.

If the MobileSettings were found but do not deserialise correctly then the saved settings will be removed using SdkSettingsStorage.deleteStoredSettings() as this is probably due to irrecoverable differences in the stored model and a new one.

Returns:

The SafeMobileSettings which wraps the MobileSettings if they are available in storage or null if there were no saved settings or there was a problem with deserialisation. The SafeMobileSettings will handle the case that the MobileSettings, or any of its properties, are null.

setStoredSettings

void setStoredSettings(SafeMobileSettings mobileSettings)

Saves the supplied MobileSettings to SharedPreferences.

If the supplied MobileSettings is null then this will not save the settings to SharedPreferences. If the intention is to delete them then please use SdkSettingsStorage.deleteStoredSettings()

Parameters:

mobileSettings - The SafeMobileSettings to save.

deleteStoredSettings

void deleteStoredSettings()

Deletes any stored MobileSettings that may be present in the SharedPreferences.

Note that this clears all keys that have been created by this class. Please be wary of this if you are using this class to store more than just the JSON representation of the MobileSettings using the MOBILE_SETTINGS_KEY