logOut

abstract suspend fun logOut()

Log the user out of the Realm App. This will unregister them on the device and stop any synchronization to and from the users' Realms. Any Realms owned by the user will not be deleted from the device before User.remove is called.

Once the Realm App has confirmed the logout any registered AuthenticationListener will be notified and user credentials will be deleted from this device.

Logging out anonymous users will remove them immediately instead of marking them as User.State.LOGGED_OUT.

Throws

if an error occurred while trying to log the user out of the Realm App.