User

interface User

A user holds the user's metadata and tokens for accessing App Services and Device Sync functionality.

User profile and custom data can be accessed using the extension functions User.profileAsBsonDocument and User.customDataAsBsonDocument.

The user is used to configure synchronized realms with SyncConfiguration.Builder.

Types

State

enum State : Enum<User.State>

A user's potential states.

Functions

delete

abstract suspend fun delete()

Permanently deletes this user from your Atlas App Services app.

equals

abstract operator override fun equals(other: Any?): Boolean

Two Users are considered equal if they have the same user identity and are associated with the same app.

linkCredentials

abstract suspend fun linkCredentials(credentials: Credentials): User

Links the current user with a new user identity represented by the given credentials.

logOut

abstract suspend fun logOut()

Log the user out of the Realm App.

refreshCustomData

abstract suspend fun refreshCustomData()

Re-fetch custom user data from the Realm App.

remove

abstract suspend fun remove(): User

Removes the user and any Realms the user has from the device.

Properties

accessToken

abstract val accessToken: String

Returns the current access token for the user.

apiKeyAuth

abstract val apiKeyAuth: ApiKeyAuth

Gives access to the ApiKeyAuth interface so that users can manage their API keys.

app

abstract val app: App

The App this user is associated with.

deviceId

abstract val deviceId: String

Returns a unique identifier for the device the user logged in to.

functions

abstract val functions: Functions

Returns a wrapper for invoking App Services Functions.

abstract val id: String

The server id of the user.

identities

abstract val identities: List<UserIdentity>

Returns a list of the user's identities as defined by the authentication providers enabled for this user.

identity

abstract val identity: String

The server id of the user.

loggedIn

abstract val loggedIn: Boolean

Returns whether or not this user is still logged into the App Services Application.

provider

abstract val provider: AuthenticationProvider

Returns the provider type used to log the user in.

refreshToken

abstract val refreshToken: String

Returns the current refresh token for the user.

state

abstract val state: User.State

The State this user is in.

Extensions

customData

@ExperimentalRealmSerializerApi()

inline fun <T> User.customData(): T?

Returns the custom user data associated with the user in the Realm App as T.

@ExperimentalRealmSerializerApi()

fun <T> User.customData(serializer: KSerializer<T>): T?

Returns the custom user data associated with the user in the Realm App as T.

customDataAsBsonDocument

inline fun User.customDataAsBsonDocument(): BsonDocument?

Return the custom user data associated with the user in the Realm App as BsonDocument.

profile

@ExperimentalRealmSerializerApi()

fun <T> User.profile(serializer: KSerializer<T>): T

Returns the profile for this user as a T.

@ExperimentalRealmSerializerApi()

inline fun <T> User.profile(): T

Returns the profile for this user as a T.

profileAsBsonDocument

inline fun User.profileAsBsonDocument(): BsonDocument

Returns the profile for this user as BsonDocument.

User

See also

Types

Functions

Properties

Extensions