Namespace Realms
Classes
BacklinkAttribute
An attribute that indicates that the property it decorates is the inverse end of a relationship.
ChangeSet
A ChangeSet describes the changes inside a IRealmCollection<T> since the last time the notification callback was invoked.
CollectionExtensions
A set of extensions methods exposing notification-related functionality over collections.
DictionaryChangeSet
A DictionaryChangeSet describes the changes inside a IDictionary<TKey, TValue> since the last time the notification callback was invoked.
EmbeddedObject
Base for any embedded object that can be persisted in a Realm.
ErrorEventArgs
Provides error information for the Error event.
ExplicitAttribute
An attribute that prevents the decorated class from being included in Realm's default schema.
FrozenObjectsExtensions
A set of extension methods on top of RealmObjectBase.
GeoBox
Represents a rectangle for a geospatial GeoWithin(IEmbeddedObject?, GeoShapeBase) query.
GeoCircle
Represents a circle on the surface of a sphere for a geospatial GeoWithin(IEmbeddedObject?, GeoShapeBase) query.
GeoPolygon
A polygon describes a shape comprised of 3 or more line segments for a geospatial GeoWithin(IEmbeddedObject?, GeoShapeBase) query.
GeoShapeBase
A base class for the geometry types supported by Realm. It should not be used directly - instead you should use one of its inheritors, such as GeoBox, GeoCircle, or GeoPolygon.
IgnoredAttribute
An attribute that indicates an ignored property. Ignored properties will not be persisted in the Realm.
InMemoryConfiguration
A Realm configuration specifying settings for an in-memory Realm. When all in-memory instances with the same identifier are disposed or go out of scope, all data in that Realm is deleted.
IndexedAttribute
An attribute that indicates an indexed property. Indexed properties slightly slow down insertions, but can greatly speed up queries.
KeyPathsCollection
Represents a collection of KeyPath that can be used when subscribing to notifications with SubscribeForNotifications(NotificationCallbackDelegate<T>, KeyPathsCollection?).
A KeyPathsCollection can be obtained by:
- building it explicitly by using the method Of(params KeyPath[]);
- building it implicitly with the conversion from a List<T> or array of KeyPath or strings;
- getting one of the static values Full and Shallow for full and shallow notifications respectively.
MapToAttribute
An attribute that indicates that a property or a class should be persisted under a different name.
Migration
This class is given to you when you migrate your database from one version to another. It contains two properties: OldRealm and NewRealm. The NewRealm is the one you should make sure is up to date. It will contain models corresponding to the configuration you've supplied. You can read from the OldRealm and access properties that have been removed from the classes by using the dynamic API.
PrimaryKeyAttribute
An attribute that indicates the primary key property. It allows quick lookup of objects and enforces uniqueness of the values stored. It may only be applied to a single property in a class.
QueryMethods
Provides methods that get translated into native Realm queries when using LINQ.
Realm
A Realm instance (also referred to as a Realm) represents a Realm database.
Warning: Non-frozen Realm instances are not thread safe and can not be shared across threads.
You must call GetInstance(RealmConfigurationBase?) on each thread in which you want to interact with the Realm.
RealmConfiguration
Realm configuration specifying settings that affect the Realm's behavior.
Its main role is generating a canonical path from whatever absolute, relative subdirectory, or just filename the user supplies.
RealmConfigurationBase
Base class for specifying configuration settings that affect the Realm's behavior.
Its main role is generating a canonical path from whatever absolute, relative subdirectory, or just filename the user supplies.
RealmObject
Base for any object that can be persisted in a Realm.
RealmObjectBase
Base for any object that can be persisted in a Realm. Models inheriting from this class will be processed at compile time by the Fody weaver. It is recommended that you instead inherit from IRealmObject and use the Realm Source Generator to generate your models.
RequiredAttribute
An attribute that indicates a required property. When persisting, the Realm will validate that the value of the property is not null.
ThreadSafeReference
An object intended to be passed between threads containing a thread-safe reference to its thread-confined object.
To resolve a thread-safe reference on a target Realm on a different thread, pass it toRealm.ResolveReference.
ThreadSafeReference.Dictionary<TValue>
A reference to a IDictionary<TKey, TValue> intended to be passed between threads.
To resolve a thread-safe reference on a target Realm on a different thread, pass it to ResolveReference<TValue>(Dictionary<TValue>).ThreadSafeReference.List<T>
A reference to a IList<T> intended to be passed between threads.
To resolve a thread-safe reference on a target Realm on a different thread, pass it to ResolveReference<T>(List<T>).ThreadSafeReference.Object<T>
A reference to a RealmObject or an EmbeddedObject intended to be passed between threads.
To resolve a thread-safe reference on a target Realm on a different thread, pass it to ResolveReference<T>(Object<T>).ThreadSafeReference.Query<T>
A reference to a IQueryable<T> intended to be passed between threads.
To resolve a thread-safe reference on a target Realm on a different thread, pass it to ResolveReference<T>(Query<T>).ThreadSafeReference.Set<T>
A reference to a ISet<T> intended to be passed between threads.
To resolve a thread-safe reference on a target Realm on a different thread, pass it to ResolveReference<T>(Set<T>).Transaction
Provides a scope to safely read and write to a Realm. Must use explicitly via BeginWrite().
Structs
ChangeSet.Move
A ChangeSet.Move contains information about objects that moved within the same IRealmCollection<T>.
Distance
Represents equatorial distance.
DynamicObjectApi
A class that exposes a set of API to access the data in a managed RealmObject dynamically.
GeoPoint
Represents a point geometry.
KeyPath
Represents a key path that can be used as a part of a KeyPathsCollection when subscribing for notifications. A KeyPath can be implicitly built from a string, where the string is the name of a property (e.g "FirstName"), eventually dotted to indicated nested properties. (e.g "Dog.Name"). Wildcards can also be used in key paths to capture all properties at a given level (e.g "", "Friends." or "*.FirstName"). A KeyPath can also be built using the ForExpression<T>(Expression<Func<T, object?>>) method, that creates the KeyPath corresponding to the property path represented by the input expression.
QueryArgument
A type that can represent any valid query argument type. It is typically used when filtering a Realm collection using the string-based query language - e.g. in Filter<T>(IQueryable<T>, string, params QueryArgument[]).
Realm.Dynamic
A class that exposes the dynamic API for a Realm instance.
RealmInteger<T>
A structure representing an integer value in the database. It offers API to increment the value, which produces correct merges during conflicts.
RealmValue
A type that can represent any valid Realm data type. It is a valid type in and of itself, which means that it can be used to declare a property of type RealmValue. Please note that a RealmValue property in a managed realm object cannot contain an embedded object.
Interfaces
IEmbeddedObject
Base interface for any embedded object that can be persisted in a Realm.
IRealmCollection<T>
Iterable, sortable collection that is the base for all collections returned by Realm.
IRealmObject
Base interface for any object that can be persisted in a Realm.
IRealmObjectBase
An interface that is implemented by all objects that can be persisted in Realm. This interface is used only internally for now.
Enums
IndexType
Describes the indexing mode for properties annotated with the IndexedAttribute.
RealmValueType
Represents the type of a value stored in a RealmValue property.
TransactionState
Represents the state of a Transaction.
Delegates
DictionaryNotificationCallbackDelegate<T>
A callback that will be invoked each time the contents of a IDictionary<TKey, TValue> have changed.
NotificationCallbackDelegate<T>
A callback that will be invoked each time the contents of a IRealmCollection<T> have changed.
Realm.RealmChangedEventHandler
Handler type used by RealmChanged.
RealmConfiguration.MigrationCallbackDelegate
In order to handle manual migrations, you need to supply a migration callback to your
RealmConfiguration. It will be called with a Migration instance containing
the pre- and the post-migration Realm. You should make sure that the NewRealm
property on it contains a database that is up to date when returning. The oldSchemaVersion
parameter will tell you which SchemaVersion the user is migrating
from. They should always be migrating to the current SchemaVersion.
RealmConfigurationBase.ShouldCompactDelegate
A callback, invoked when opening a Realm for the first time during the life of a process to determine if it should be compacted before being returned to the user.