All Classes

Class	Description
AggregateIterable<ResultT>	Specific iterable for MongoCollection.aggregate(List) operations.
ApiKey	Class representing an API key for a User.
ApiKeyAuth	This class exposes functionality for a user to manage API keys under their control.
App	An App is the main client-side entry point for interacting with a MongoDB Realm App.
App.Callback<T>	Callback for async methods available to the App.
App.Result<T>	Result class representing the result of an async request from this app towards MongoDB Realm.
AppConfiguration	A AppConfiguration is used to setup a MongoDB Realm application.
AppConfiguration.Builder	Builder used to construct instances of a AppConfiguration in a fluent manner.
AppException	This class is a wrapper for all errors happening when communicating with a MongoDB Realm app.
AuthenticationListener	Interface describing events related to Users and their authentication
AutomaticClientResetStrategy	Interface that defines an automatic sync client reset strategy, it could be either DiscardUnsyncedChangesStrategy, RecoverOrDiscardUnsyncedChangesStrategy or RecoverUnsyncedChangesStrategy.
BaseChangeEvent<DocumentT>	Represents the set of properties that exist on all MongoDB realm change events produced by watch streams in this SDK.
BaseChangeEvent.OperationType	Represents the different MongoDB operations that can occur.
Beta	This annotation is added to classes, constructors or methods which are considered in beta phase.
Case	This class describes the Case settings used in Realm queries.
ClientResetRequiredError	Class encapsulating information needed for handling a Client Reset event.
CollectionChange<E extends OrderedRealmCollection>	Container wrapping the result of a OrderedRealmCollectionChangeListener being triggered.
CollectionUtils
CompactOnLaunchCallback	This interface is used to determine if a Realm file should be compacted the first time the file is opened and before the instance is returned.
ConnectionListener	Interface used when reporting changes that happened to the connection used by the session.
ConnectionState	Enum describing the states of the underlying connection used by a SyncSession.
CountOptions	The options for a count operation.
Credentials	Credentials represent a login with a given login provider, and are used by the MongoDB Realm to verify the user and grant access.
Credentials.Provider	This enum contains the list of identity providers supported by MongoDB Realm.
DefaultCompactOnLaunchCallback	The default implementation for determining if a file should be compacted or not.
DeleteResult	The result of a delete operation.
DiscardUnsyncedChangesStrategy	Strategy that automatically resolves a Client Reset by discarding any unsynced data.
DownloadingRealmInterruptedException	Exception class used when a Realm was interrupted while downloading the initial data set.
DynamicRealm	DynamicRealm is a dynamic variant of Realm.
DynamicRealm.Callback	The Callback used when reporting back the result of loading a Realm asynchronously using either Realm.getInstanceAsync(RealmConfiguration, Realm.Callback) or DynamicRealm.getInstanceAsync(RealmConfiguration, DynamicRealm.Callback).
DynamicRealm.Transaction	Encapsulates a Realm transaction.
DynamicRealm.Transaction.Callback	Callback invoked to notify the caller thread.
DynamicRealm.Transaction.OnError	Callback invoked to notify the caller thread about error during the transaction.
DynamicRealm.Transaction.OnSuccess	Callback invoked to notify the caller thread about the success of the transaction.
DynamicRealmObject	Class that wraps a normal RealmObject in order to allow dynamic access instead of a typed interface.
EmailPasswordAuth	Class encapsulating functionality provided when User's are logged in through the Credentials.Provider.EMAIL_PASSWORD provider.
ErrorCode	This class enumerate all potential errors related to using the Object Server or synchronizing data.
ErrorCode.Category
ErrorCode.Type
FieldAttribute	This class contains all Realm attributes for a Realm field.
FindIterable<ResultT>	Specific iterable for MongoCollection.find() operations.
FindOneAndModifyOptions	The options to apply to a findOneAndUpdate, findOneAndReplace, or findOneAndDelete operation (also commonly referred to as findOneAndModify operations).
FindOptions	The options to apply to a find operation (also commonly referred to as a query).
FlowFactory	Factory interface for creating Kotlin Flows for Realm classes.
FrozenPendingRow	A PendingRow that has been frozen.
Functions	A Functions manager to call remote Realm functions for the associated Realm App.
GoogleAuthType	This enum contains the list of Google authentication types supported by MongoDB Realm.
HttpLogObfuscator	The HttpLogObfuscator keeps sensitive information from being displayed in Logcat.
Ignore
ImportFlag	This class describe how data is saved to Realm when saving whole objects.
Index	This annotation will add a search index to the field.
InsertManyResult	The result of an insert many operation.
InsertOneResult	The result of an insert one operation.
LinkingObjects	Annotation for defining a reverse relationship from one class to another.
LogLevel	The Log levels defined and used by Realm when logging events in the API.
ManuallyRecoverUnsyncedChangesStrategy	Strategy to manually resolve a Client Reset, determined by the error code ErrorCode.CLIENT_RESET.
MapChangeListener<K,V>	MapChangeListener can be registered with a RealmMap to receive a notification with a MapChangeSet to describe the details of what have been changed in the map since last time.
MapChangeSet<T>	This interface describes the changes made to a map during the last update.
MongoClient	The remote MongoClient used for working with data in MongoDB remotely via Realm.
MongoCollection<DocumentT>	The MongoCollection interface provides read and write access to documents.
MongoCursor<ResultT>	The Mongo Cursor class is fundamentally an Iterator containing an additional tryNext() method for convenience.
MongoDatabase	The RemoteMongoDatabase provides access to its Document MongoCollections.
MongoIterable<ResultT>	The MongoIterable is the results from an operation, such as a find() or an aggregate() query.
MongoNamespace	A MongoDB namespace, which includes a database name and collection name.
MutableRealmInteger	A MutableRealmInteger is a mutable, Long-like numeric quantity.
MutableSubscriptionSet	A mutable subscription set is available when calling SubscriptionSet.update(UpdateCallback) This is the only way to modify a SubscriptionSet.
ObjectChange<E extends RealmModel>	Container wrapping the result of a RealmObjectChangeListener being triggered.
ObjectChangeSet	Information about the changes made to an object.
OrderedCollectionChangeSet	This interface describes the changes made to a collection during the last update.
OrderedCollectionChangeSet.Range
OrderedCollectionChangeSet.State	State describing the nature of the changeset.
OrderedRealmCollection<E>	An OrderedRealmCollection is a collection which maintains an ordering for its elements.
OrderedRealmCollectionChangeListener<T>	OrderedRealmCollectionChangeListener can be registered with a RealmResults to receive a notification with a OrderedCollectionChangeSet to describe the details of what have been changed in the collection since last time.
OrderedRealmCollectionSnapshot<E>	An OrderedRealmCollectionSnapshot is a special type of OrderedRealmCollection.
PrimaryKey	The @PrimaryKey annotation will mark a field as a primary key inside Realm.
Progress	Class used to encapsulate progress notifications when either downloading or uploading Realm data.
ProgressListener	Interface used when interested in updates on data either being uploaded to or downloaded from a Realm Object Server.
ProgressMode	Enum describing how to listen to progress changes.
ProxyState<E extends RealmModel>	This implements RealmObjectProxy interface, to eliminate copying logic between RealmObject and DynamicRealmObject.
Push	The Push client allows to register/deregister for push notifications from a client app.
Realm	The Realm class is the storage and transactional manager of your object persistent store.
Realm.Callback	The Callback used when reporting back the result of loading a Realm asynchronously using either Realm.getInstanceAsync(RealmConfiguration, Realm.Callback) or DynamicRealm.getInstanceAsync(RealmConfiguration, DynamicRealm.Callback).
Realm.Transaction	Encapsulates a Realm transaction.
Realm.Transaction.Callback	Callback invoked to notify the caller thread.
Realm.Transaction.OnError	Callback invoked to notify the caller thread about error during the transaction.
Realm.Transaction.OnSuccess	Callback invoked to notify the caller thread about the success of the transaction.
RealmAny	RealmAny is used to represent a polymorphic Realm value.
RealmAny.Type	Enum describing all the types supported by RealmAny.
RealmAnyNativeFunctionsImpl
RealmAnyOperator
RealmAsyncTask	Represents a pending asynchronous Realm task, like asynchronous transactions.
RealmChangeListener<T>	RealmChangeListener can be registered with a Realm, RealmResults or RealmObject to receive a notification about updates.
RealmClass	Interface used to mark a class that can be persisted by Realm.
RealmCollection<E>	RealmCollection is the root of the collection hierarchy that Realm supports.
RealmConfiguration	A RealmConfiguration is used to setup a specific Realm instance.
RealmConfiguration.Builder	RealmConfiguration.Builder used to construct instances of a RealmConfiguration in a fluent manner.
RealmDictionary<V>	Specialization of RealmMaps whose keys are strings.
RealmError	RealmError is a Realm specific Error used when unrecoverable problems happen in the underlying storage engine.
RealmEventStreamAsyncTask<T>	The RealmEventStreamAsyncTask is a specific version of RealmAsyncTask that provides a non-blocking mechanism to work with asynchronous operations carried out against MongoDB Realm that yield stream results.
RealmEventStreamTask<T>	The RealmEventStreamTask is a specific version of RealmAsyncTask that provides a blocking mechanism to work with asynchronous operations carried out against MongoDB Realm that yield stream results.
RealmException	RealmException is for Realm specific exceptions.
RealmField	Annotation used on fields in Realm model classes.
RealmFieldType	List of the types used by Realm's underlying storage engine.
RealmFileException	Class for reporting problems when accessing the Realm related files.
RealmFileException.Kind	The specific kind of this RealmFileException.
RealmFlowFactory	Factory class used to create coroutine Flows.
RealmList<E>	RealmList is used to model one-to-many relationships in a RealmObject.
RealmLog	Global logger used by all Realm components.
RealmLogger	Interface for custom loggers that can be registered at RealmLog.add(RealmLogger).
RealmMap<K,V>	RealmMap is used to map keys to values.
RealmMigration	The RealmMigration class is used to perform the migration of one Realm schema to another.
RealmMigrationNeededException
RealmModel	Interface for marking classes as RealmObjects, it can be used instead of extending RealmObject.
RealmModule	By default a Realm can store all classes extending RealmObject in a project.
RealmNamingPolicy	This enum defines the possible ways class and field names can be mapped from what is used in Java to the name used internally in the Realm file.
RealmObject	In Realm you define your RealmObject classes by sub-classing RealmObject and adding fields to be persisted.
RealmObjectChangeListener<T extends RealmModel>	RealmObjectChangeListener can be registered on a RealmModel or RealmObject to receive detailed notifications when an object changes.
RealmObjectSchema	Class for interacting with the schema for a given RealmObject class.
RealmObjectSchema.Function	Function interface, used when traversing all objects of the current class and apply a function on each.
RealmObservableFactory	Factory class for creating Observables for RxJava (<=2.0.*).
RealmPrimaryKeyConstraintException	Class for reporting problems when the primary key constraint is being broken.
RealmQuery<E>	A RealmQuery encapsulates a query on a Realm or a RealmResults using the Builder pattern.
RealmResults<E>	This class holds all the matches of a RealmQuery for a given Realm.
RealmResultTask<T>	The RealmResultTask is a specific version of RealmAsyncTask that provides a mechanism to work with asynchronous operations carried out against MongoDB Realm that yield a result.
RealmSchema	Class for interacting with the Realm schema.
RealmSet<E>	RealmSet is a collection that contains no duplicate elements.
RecoverOrDiscardUnsyncedChangesStrategy	Strategy that attempts to automatically recover any unsynced changes during a Client Reset, if the recovery fails the changes would be discarded.
RecoverUnsyncedChangesStrategy	Strategy that attempts to automatically recover any unsynced changes during a Client Reset.
Required	This annotation will mark the field or the element in io.realm.RealmList as not nullable.
RxObservableFactory	Factory interface for creating Rx Observables for Realm classes.
SetChangeListener<T>	SetChangeListener can be registered with a RealmSet to receive a notification with a SetChangeSet to describe the details of what have been changed in the set since last time.
SetChangeSet	This class describes the changes made to a set during the last update.
Sort	This class describes the sorting order used in Realm queries.
Subscription	A subscription defines a specific server query and its metadata.
SubscriptionSet	A subscription set is an immutable view of all current Subscriptions for a given Realm that has been configured for flexible sync.
SubscriptionSet.State	The possible states a subscription set can be in.
SubscriptionSet.StateChangeCallback	Callback used when asynchronously waiting for the server to process the subscription set.
SubscriptionSet.UpdateAsyncCallback	Callback used when asynchronously updating a subscription set.
SubscriptionSet.UpdateCallback	Interface used when modifying a subscription set.
Sync	A sync manager handling synchronization of local Realms with remote Realm Apps.
Sync.Debug	Debugging related options.
SyncClientResetStrategy	Interface that defines a generic sync client reset strategy, it could be either ManuallyRecoverUnsyncedChangesStrategy or AutomaticClientResetStrategy.
SyncConfiguration	A SyncConfiguration is used to setup a Realm Database that can be synchronized between devices using MongoDB Realm.
SyncConfiguration.Builder	Builder used to construct instances of a SyncConfiguration in a fluent manner.
SyncConfiguration.InitialFlexibleSyncSubscriptions	Interface for configuring the initial set of of subscriptions.
SyncSession	A session controls how data is synchronized between a single Realm on the device and the server Realm on the Realm Object Server.
SyncSession.ClientResetHandler	Deprecated. replaced by ManuallyRecoverUnsyncedChangesStrategy
SyncSession.ErrorHandler	Interface used to report any session errors.
SyncSession.State	Enum describing the states a SyncSession can be in.
UpdateDescription	Indicates which fields have been modified in a given update operation.
UpdateOptions	The options to apply when updating documents.
UpdateResult	The result of an update operation.
User	A user holds the user's meta data and tokens for accessing Realm App functionality.
User.State	The user's potential states.
UserIdentity	Each User is represented by 1 or more identities each defined by an Credentials.Provider.
UserProfile