Namespace Realms.Sync

Classes

ApiKey

A class representing an API key for a User. It can be used to represent the user when logging in instead of their regular credentials. These keys are created or fetched through ApiKeys.

App

An App is the main client-side entry point for interacting with a Atlas App Services application.

App.EmailPasswordClient

A class, encapsulating functionality for users, logged in with the EmailPassword provider. It is always scoped to a particular app and can only be accessed via EmailPasswordAuth.

App.SyncClient

A sync manager, handling synchronization of local Realm with MongoDB Atlas. It is always scoped to a particular app and can only be accessed via Sync.

AppConfiguration

A class exposing configuration options for a App.

Credentials

A class, representing the credentials used for authenticating a User.

A FlexibleSyncConfiguration is used to setup a Realm whose data can be synchronized between devices using Atlas Device Sync. Unlike PartitionSyncConfiguration, a Realm opened with FlexibleSyncConfiguration will be initially empty until one or more subscriptions are added via Subscriptions.

MongoClient

The remote MongoClient used for working with data in MongoDB remotely via Realm.

MongoClient.Collection<TDocument>

An object representing a remote MongoDB collection.

MongoClient.Database

An object representing a remote MongoDB database.

PartitionSyncConfiguration

A PartitionSyncConfiguration is used to setup a Realm that can be synchronized between devices using Atlas Device Sync.

RealmSyncExtensions

A set of extension methods that provide Sync-related functionality on top of Realm classes.

Session

An object encapsulating a synchronization session. Sessions represent the communication between the client (and a local Realm file on disk), and MongoDB Atlas. Sessions are always created by the SDK and vended out through various APIs. The lifespans of sessions associated with Realms are managed automatically.

Subscription

A class representing a single query subscription. The server will continuously evaluate the Query that the app subscribed to and will send data that matches it as well as remove data that no longer does.

SubscriptionOptions

A class providing various options to Add<T>(IQueryable<T>, SubscriptionOptions). All the properties in this class are optional.

SubscriptionSet

A collection representing the set of active subscriptions for a Realm instance. This is used in combination with FlexibleSyncConfiguration to declare the set of queries you want to synchronize with the server. You can access and read the subscription set freely, but mutating it must happen in an Update(Action) block.

SyncConfiguration

A SyncConfiguration is used to setup a Realm that can be synchronized between devices using Atlas Device Sync.

SyncConfigurationBase

A SyncConfigurationBase is used to setup a Realm that can be synchronized between devices using Atlas Device Sync. There are two synchronization modes with their respective configurations - "partition" sync with PartitionSyncConfiguration allows you to split your data in separarate partitions and synchronize an entire partition with an entire Realm; "flexible" sync with FlexibleSyncConfiguration allows you to start with an empty Realm and send the server a set of queries which it will run and populate the Realm with all documents matching them.

SyncTimeoutOptions

Options for configuring timeouts and intervals used by the sync client.

User

This class represents a user in a Atlas App Services application. The credentials are provided by various 3rd party providers (Facebook, Google, etc.). A user can log in to the server and, if access is granted, it is possible to synchronize the local and the remote Realm. Moreover, synchronization is halted when the user is logged out. It is possible to persist a user. By retrieving a user, there is no need to log in to the 3rd party provider again. Persisting a user between sessions, the user's credentials are stored locally on the device, and should be treated as sensitive data.

User.ApiKeyClient

A class exposing functionality for users to manage API keys from the client. It is always scoped to a particular User and can only be accessed via ApiKeys.