Package io.realm

Interface Summary

Interface	Description
AuthenticationListener	Interface describing events related to Users and their authentication
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.
DynamicRealm.Transaction	Encapsulates a Realm transaction.
ObjectChangeSet	Information about the changes made to an object.
OrderedCollectionChangeSet	This interface describes the changes made to a collection during the last update.
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 from last time.
PermissionManager.AcceptOfferCallback	Callback used when accepting a permission offer.
PermissionManager.ApplyPermissionsCallback	Callback used when modifying or creating new permissions.
PermissionManager.MakeOfferCallback	Callback used when making a permission offer for other users.
PermissionManager.OffersCallback	Callback used when loading the list of PermissionOffer's created by the user.
PermissionManager.PermissionsCallback	Callback used when loading a set of permissions.
PermissionManager.RevokeOfferCallback	Callback used when revoking an existing offer.
ProgressListener	Interface used when interested in updates on data either being uploaded to or downloaded from a Realm Object Server.
Realm.Transaction	Encapsulates a Realm transaction.
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.
Realm.UnsubscribeCallback	Interface used when canceling query-based sync subscriptions.
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.
RealmCollection<E>	RealmCollection is the root of the collection hierarchy that Realm supports.
RealmMigration	The RealmMigration class is used to perform the migration of one Realm schema to another.
RealmModel	Interface for marking classes as RealmObjects, it can be used instead of extending RealmObject.
RealmObjectChangeListener<T extends RealmModel>	RealmObjectChangeListener can be registered on a RealmModel or RealmObject to receive detailed notifications when an object changes.
RealmObjectSchema.Function	Function interface, used when traversing all objects of the current class and apply a function on each.
SyncSession.ErrorHandler	Interface used to report any session errors.
SyncUser.Callback<T>
UserStore	Interface for classes responsible for saving and retrieving Object Server users again.

Class Summary

Class	Description
DefaultCompactOnLaunchCallback	The default implementation for determining if a file should be compacted or not.
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).
DynamicRealmObject	Class that wraps a normal RealmObject in order to allow dynamic access instead of a typed interface.
MutableRealmInteger	A MutableRealmInteger is a mutable, Long-like numeric quantity.
OrderedCollectionChangeSet.Range
OrderedRealmCollectionSnapshot<E>	An OrderedRealmCollectionSnapshot is a special type of OrderedRealmCollection.
PermissionManager	Helper class for interacting with Realm Object Server permissions for a SyncUser.
Progress	Class used to encapsulate progress notifications when either downloading or uploading Realm data.
ProxyState<E extends RealmModel>	This implements RealmObjectProxy interface, to eliminate copying logic between RealmObject and DynamicRealmObject.
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.Callback	Callback invoked to notify the caller thread.
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.
RealmFileUserStore	A User Store backed by a Realm file to store users.
RealmList<E>	RealmList is used to model one-to-many relationships in a RealmObject.
RealmObject	In Realm you define your RealmObject classes by sub-classing RealmObject and adding fields to be persisted.
RealmObjectSchema	Class for interacting with the schema for a given RealmObject class.
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.
RealmSchema	Class for interacting with the Realm schema.
SyncConfiguration	A SyncConfiguration is used to setup a Realm that can be synchronized between devices using the Realm Object Server.
SyncConfiguration.Builder	Builder used to construct instances of a SyncConfiguration in a fluent manner.
SyncCredentials	Credentials represent a login with a 3rd party login provider in an OAuth2 login flow, and are used by the Realm Object Server to verify the user and grant access.
SyncCredentials.IdentityProvider	Enumeration of the different types of identity providers.
SyncManager	The SyncManager is the central controller for interacting with the Realm Object Server.
SyncManager.Debug	Debugging related options.
SyncSession	A session controls how data is synchronized between a single Realm on the device and the server Realm on the Realm Object Server.
SyncUser	This class represents a user on the Realm Object Server.
SyncUserInfo	POJO representing information about a user that was retrieved from a user lookup call.

Enum Summary

Enum	Description
Case	This class describes the Case settings used in Realm queries.
ConnectionState	Enum describing the states of the underlying connection used by a SyncSession.
ErrorCode	This class enumerate all potential errors related to using the Object Server or synchronizing data.
ErrorCode.Category
FieldAttribute	This class contains all Realm attributes for a Realm field.
ImportFlag	This class describe how data is saved to Realm when saving whole objects.
OrderedCollectionChangeSet.State	State describing the nature of the changeset.
ProgressMode	Enum describing how to listen to progress changes.
RealmFieldType	List of the types used by Realm's underlying storage engine.
Sort	This class describes the sorting order used in Realm queries.
SyncSession.State	Enum describing the states a SyncSession can be in.

Exception Summary

Exception	Description
ClientResetRequiredError	Class encapsulating information needed for handling a Client Reset event.
ObjectServerError	This class is a wrapper for all errors happening when communicating with the Realm Object Server.