Realm Kotlin SDK - Sync/io.realm.kotlin.mongodb.exceptions/ClientResetRequiredException

ClientResetRequiredException

class ClientResetRequiredException(appPointer: <ERROR CLASS>, error: <ERROR CLASS>) : Throwable
Content copied to clipboard

Class encapsulating information needed for handling a Client Reset event.

See:Client Reset for more information about when and why Client Reset occurs and how to deal with it.

Constructors

ClientResetRequiredException
Link copied to clipboard
fun ClientResetRequiredException(appPointer: <ERROR CLASS>, error: <ERROR CLASS>)
Content copied to clipboard

Functions

executeClientReset
Link copied to clipboard
fun executeClientReset(): Boolean
Content copied to clipboard

Calling this method will execute the Client Reset manually instead of waiting until the next app restart.

Properties

cause
Link copied to clipboard
open val cause: Throwable?
Content copied to clipboard
message
Link copied to clipboard
open val message: String?
Content copied to clipboard
originalFilePath
Link copied to clipboard
val originalFilePath: String
Content copied to clipboard

Path to the original (local) copy of the realm when the Client Reset event was triggered. This realm may contain unsynced changes.

recoveryFilePath
Link copied to clipboard
val recoveryFilePath: String
Content copied to clipboard

Path to the recovery (remote) copy of the realm downloaded from the backend.