remove

abstract suspend fun remove(): User
Content copied to clipboard

Removes the user and any Realms the user has from the device. No data is removed from the server.

If the user is logged in when calling this method, the user will be logged out before any data is deleted.

Return

the user that was removed.

Throws

if the user was already removed.

if a failure occurred when communicating with App Services. See AppException for details.