Namespace Realms.Sync.Exceptions

Classes

AuthenticationException

An exception thrown when an error has occurred during authentication. It usually indicates a logical problem with the request that can be investigated by inspecting the ErrorCode property.

ClientResetException

An exception describing a condition where a reset of the local Realm is required.

ErrorCodeExtensions

A set of extensions that simplify checking for common error scenarios.

HttpException

An exception thrown when a transport error occurs during authentication.

IncompatibleSyncedFileException

An exception thrown when attempting to open an incompatible Synchronized Realm file. This usually happens when the Realm file was created with an older version of the SDK and automatic migration to the current version is not possible. When such an exception occurs, the original file is moved to a backup location and a new file is created instead. If you wish to migrate any data from the backup location, you can use GetBackupRealmConfig(Byte[]) to obtain a RealmConfigurationBase that can then be used to open the backup Realm. After that, retry opening the original Realm file (which now should be recreated as an empty file) and copy all data from the backup file to the new one.

PermissionDeniedException

An error that indicates the user does not have permission to perform an operation upon a synced Realm. For example, a user may receive this error if they attempt to open a Realm they do not have at least read access to, or write to a Realm they only have read access to.

This error may also occur if a user incorrectly opens a Realm they have read-only permissions to without using the GetInstanceAsync(RealmConfigurationBase) API. A Realm that suffers a permission denied error is, by default, flagged so that its local copy will be deleted the next time the application starts.

The PermissionDeniedException exposes a method that can be called with a single argument: true to immediately delete the Realm file, or false to not delete the file at all (either now or upon restart). This method should only be called with true if and when your app disposes of every instance of the offending Realm on all threads.

PermissionException

An exception thrown when an error has occurred when changing permissions of a Realm.