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 MongoDB Realm App.
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 remote MongoDB Realm apps. 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.
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.
MongoClient.DeleteResult
The result of DeleteOneAsync(Object) or DeleteManyAsync(Object) operation.
MongoClient.InsertManyResult
The result of InsertManyAsync(IEnumerable<TDocument>) operation.
MongoClient.InsertResult
The result of InsertOneAsync(TDocument) operation.
MongoClient.UpdateResult
The result of UpdateOneAsync(Object, Object, Boolean) or UpdateManyAsync(Object, Object, Boolean) operation.
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 the server (and a remote Realm at a given partition served by a MongoDB Realm Server). Sessions are always created by the SDK and vended out through various APIs. The lifespans of sessions associated with Realms are managed automatically.
SyncConfiguration
A SyncConfiguration is used to setup a Realm that can be synchronized between devices using MongoDB Realm.
User
This class represents a user in a MongoDB Realm app. 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.
User.FunctionsClient
A class exposing functionality for calling remote MongoDB Realm functions.
User.PushClient
The Push client exposes an API to register/deregister for push notifications from a client app.
UserIdentity
A class containing information about an identity associated with a user.
UserProfile
A class containing profile information about User.
Structs
SyncProgress
A struct containing information about the progress state at a given instant.
Enums
Credentials.AuthProvider
An enum containing the possible authentication providers. These have to manually be enabled for your app before they can be used.
LogLevel
Specifies the criticality level above which messages will be logged by the default sync client logger.
MetadataPersistenceMode
Enumeration that specifies how and if logged-in User objects are persisted across application launches.
ProgressDirection
The transfer direction (upload or download) tracked by a given progress notification subscription.
ProgressMode
The desired behavior of a progress notification subscription.
SessionState
The current state of a sync session object.
UserState
The state of the user object.