stream-video-android-core/io.getstream.video.android.datastore.delegate/StreamUserDataStore

StreamUserDataStore

class StreamUserDataStore(dataStore: DataStore<StreamUserPreferences?>) : DataStore<StreamUserPreferences?>

A DataStore managers to persist Stream user login data safely, consistently, and transactionally.

Parameters

dataStore

A DataStore that contains data type of StreamUserPreferences.

Constructors

StreamUserDataStore

constructor(dataStore: DataStore<StreamUserPreferences?>)

Types

Companion

object Companion

Properties

apiKey

val apiKey: Flow<ApiKey>

A state that contains a persisted ApiKey data.

user

val user: Flow<User?>

A state that contains a persisted User data.

userDevice

val userDevice: Flow<Device?>

A state that contains a persisted Device data.

userToken

val userToken: Flow<UserToken>

A state that contains a persisted UserToken data.

Inherited properties

data

open override val data: Flow<StreamUserPreferences?>

Functions

clear

suspend fun clear(): StreamUserPreferences?

Clear the persisted all user data.

updateApiKey

suspend fun updateApiKey(apiKey: ApiKey)

Update ApiKey information that is used to build a StreamVideo instance for logging in.

updateUser

suspend fun updateUser(user: User?)

Update User information that is used to build a StreamVideo instance for logging in.

updateUserDevice

suspend fun updateUserDevice(userDevice: Device?)

Update Device information that is used to be get push notifications from the Stream server.

updateUserPreferences

suspend fun updateUserPreferences(streamUserPreferences: StreamUserPreferences)

Update user preferences with the give StreamUserPreferences.

updateUserToken

suspend fun updateUserToken(userToken: UserToken)

Update UserToken information that is used to build a StreamVideo instance for logging in.

Inherited functions

updateData

open suspend override fun updateData(transform: suspend (t: StreamUserPreferences?) -> StreamUserPreferences?): StreamUserPreferences?