Light Novel Reader Api/io.nightfish.lightnovelreader.api.userdata/UserData

UserData

abstract class UserData<T>(val path: String)

用户数据抽象基类提供对单条用户数据的读写和监听能力

Since

Api 2

Parameters

path

用户数据的完整路径字符串(如"reader.fontSize")

Type Parameters

T

该用户数据存储的值类型

Inheritors

BooleanUserData

IntListUserData

StringListUserData

Constructors

constructor(path: String)

Properties

val group: String

该条数据所属的组路径

open val path: String

Functions

asynchronousSet

fun asynchronousSet(value: T)

异步写入用户数据内部会在IO协程中执行set

abstract fun get(): T?

读取用户数据此函数为阻塞函数, 请务必不要在初始化阶段或主线程上调用

abstract fun getFlow(): Flow<T?>

获取用户数据的可观测流

getFlowWithDefault

fun getFlowWithDefault(default: T): Flow<T>

获取用户数据的可观测流, 并提供默认值

fun getOrDefault(default: T): T

读取用户数据, 如果未设置则返回默认值此函数为阻塞函数, 请务必不要在初始化阶段或主线程上调用

abstract fun set(value: T)

写入用户数据此函数为阻塞函数, 请务必不要在初始化阶段或主线程上调用

fun update(updater: (T) -> T, default: T)

读取并修改用户数据此函数为阻塞函数, 请务必不要在初始化阶段或主线程上调用