Package-level declarations

Types

Link copied to clipboard

Top level class for all exceptions that are specific to using App Services and Device Sync.

Link copied to clipboard

This exception is considered the top-level or "catch-all" for problems related to user account actions. The exact reason for the error can be found in Throwable.message.

Link copied to clipboard

Thrown when the server does not support one or more of the queries defined in the io.realm.kotlin.mongodb.sync.SubscriptionSet.

Link copied to clipboard

This exception is thrown when parameters sent to Atlas App Services are considered malformed. This can happen if e.g. tokens do not have the required length or contain garbage data. The exact reason will be in the error message.

Link copied to clipboard
class ClientResetRequiredException(appPointer: RealmAppPointer, error: SyncError) : Throwable

Class encapsulating information needed for handling a Client Reset event.

Link copied to clipboard

Thrown when the server undoes one or more client writes. Details on undone writes can be found in writes.

Link copied to clipboard

Exception indicating that something went wrong with the underlying HTTP request to App Services. The exact cause is in the exception message.

Link copied to clipboard

Thrown when attempting to link credentials that are not supported.

Link copied to clipboard

Thrown when opening a Realm and it didn't finish download server data in the allocated timeframe.

Link copied to clipboard

Exception indicating that an Atlas Function failed to execute. The exact reason for the error can be found in Throwable.message.

Link copied to clipboard

Thrown when credentials were rejected by the server when trying to log in. Only some authentication providers will return this error:

Link copied to clipboard

This exception is considered the top-level or "catch-all" for problems related to HTTP requests made towards App Services. This covers both HTTP transport problems, or the server considering the request invalid, for whatever reason.

Link copied to clipboard

This exception is considered the top-level exception or general "catch-all" for problems related to using Device Sync.

Link copied to clipboard

Thrown when something has gone wrong with Device Sync in a way that is not recoverable.

Link copied to clipboard

Thrown when trying to confirm a user that was already confirmed on the server.

Link copied to clipboard

Thrown when trying to register a new user with email and password, and the user already exists.

Link copied to clipboard

Thrown when using an API that also require some kind of user identifier, but the server is not able to find the user.

Link copied to clipboard

Thrown when the type of sync used by the server does not match the one used by the client, i.e. the server and client disagrees whether to use Partition-based or Flexible Sync.