User

interface User
Content copied to clipboard

A user holds the user's metadata and tokens for accessing Realm App functionality.

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

See also

Types

State
Link copied to clipboard
enum State : Enum<User.State>
Content copied to clipboard
A user's potential states.

Functions

equals
Link copied to clipboard
abstract operator override fun equals(other: Any?): Boolean
Content copied to clipboard
Two Users are considered equal if they have the same user identity and are associated with the same app.
logOut
Link copied to clipboard
abstract suspend fun logOut()
Content copied to clipboard
Log the user out of the Realm App.

Properties

app
Link copied to clipboard
abstract val app: App
Content copied to clipboard
The App this user is associated with.
identity
Link copied to clipboard
abstract val identity: String
Content copied to clipboard
The server id of the user.
loggedIn
Link copied to clipboard
abstract val loggedIn: Boolean
Content copied to clipboard
Returns whether or not this user is still logged into the MongoDB Realm App.
state
Link copied to clipboard
abstract val state: User.State
Content copied to clipboard
The State this user is in.