Data/arc.data.source.local.preference/SharedPreferenceManager

SharedPreferenceManager

class SharedPreferenceManager(context: Context, preferenceName: String, encrypted: Boolean = false, val gson: Gson = Gson())

SharedPreferenceManager is android.content.SharedPreferences class within Arc

Author

jimlyas

Since

06 Nov 2023

Parameters

context

Context used to create the instance of android.content.SharedPreferences

preferenceName

String name for the android.content.SharedPreferences

encrypted

Boolean to define does the android.content.SharedPreferences is encrypted or not, if true, will use EncryptedSharedPreferences. And if not, will use default android.content.SharedPreferences from Context

gson

Gson instance that used for parsing object to String

Constructors

SharedPreferenceManager

constructor(context: Context, preferenceName: String, encrypted: Boolean = false, gson: Gson = Gson())

Functions

fun clear()

Function to clear all values from the preference

inline fun <model> get(key: String): model?

Function to get model value from preference

fun getBoolean(key: String, defaultValue: Boolean = false): Boolean

Function to get Boolean value from preference

fun getFloat(key: String, defaultValue: Float = MIN_VALUE): Float

Function to get Float value from preference

fun getInt(key: String, defaultValue: Int = 0): Int

Function to get Int value from preference

fun getLong(key: String, defaultValue: Long = 0): Long

Function to get Long value from preference

fun getString(key: String, defaultValue: String = ""): String?

Function to get String value from preference

fun remove(key: String)

Function to remove value from preference based on given key

fun <model> set(key: String, value: model)

Function to set a Object value to preference

fun setBoolean(key: String, value: Boolean)

Function to set a Boolean value to preference

fun setFloat(key: String, value: Float)

Function to set a Float value to preference

fun setInt(key: String, value: Int)

Function to set a Int value to preference

fun setLong(key: String, value: Long)

Function to set a Long value to preference

fun setString(key: String, value: String)

Function to set a String value to preference

Properties

val gson: Gson