kotpref/com.chibatching.kotpref/KotprefModel

KotprefModel

abstract class KotprefModel(contextProvider: ContextProvider, preferencesProvider: PreferencesProvider)

Constructors

KotprefModel

androidJvm

fun KotprefModel(context: Context, preferencesProvider: PreferencesProvider = defaultPreferenceProvider())

Functions

beginBulkEdit

androidJvm

fun beginBulkEdit()

Begin bulk edit mode.

blockingCommitBulkEdit

androidJvm

fun blockingCommitBulkEdit()

Commit values set in the bulk edit mode to preferences immediately, in blocking manner.

cancelBulkEdit

androidJvm

fun cancelBulkEdit()

Cancel bulk edit mode.

clear

androidJvm

@CallSuper()

open fun clear()

Clear all preferences in this model

commitBulkEdit

androidJvm

fun commitBulkEdit()

Commit values set in the bulk edit mode to preferences.

equals

androidJvm

open operator fun equals(other: Any?): Boolean

getPrefKey

androidJvm

fun getPrefKey(property: KProperty<*>): String?

Get preference key for a property.

hashCode

androidJvm

open fun hashCode(): Int

remove

androidJvm

fun remove(property: KProperty<*>)

Remove entry from SharedPreferences

toString

androidJvm

open fun toString(): String

Properties

commitAllPropertiesByDefault

androidJvm

open val commitAllPropertiesByDefault: Boolean = false

commit() all properties in this pref by default instead of apply()

context

androidJvm

val context: Context

Application Context

kotprefMode

androidJvm

open val kotprefMode: Int

Preference read/write mode

kotprefName

androidJvm

open val kotprefName: String

Preference file name

preferences

androidJvm

val preferences: SharedPreferences

SharedPreferences instance exposed.

Sources

(source)