Namespace Realms.Sync
Classes
AccountInfo
An object containing information about an account associated with a user.
ClassPermission
An object which describes class-wide permissions.
Credentials
A class, representing the credentials used for authenticating a User.
FullSyncConfiguration
A FullSyncConfiguration is used to setup a Realm that can be synchronized in "full" mode between devices using the Realm Object Server. The entirety of the Realm will be kept in sync between the server and the client.
NamedSubscription
A managed Realm object representing a subscription. Subscriptions are used by Query-based Realms to define which data should be available on the device. It is the persisted version of a Subscription<T> created by calling Subscribe<T>(IQueryable<T>, SubscriptionOptions, Expression<Func<T, IQueryable>>[]).
PathPermission
This model is used to reflect permissions granted to a user. It should be used in conjunction with a User's Permission Realm.
Permission
A permission which can be applied to a Realm, Class, or specific Object.
PermissionCondition
A class describing the condition based on which permissions will be applied.
PermissionExtensions
A set of extension methods that simplify working with object level permissions.
PermissionOffer
Objects of this class are used to offer permissions to owned Realms.
PermissionRole
A Role within the permissions system.
PermissionUser
A representation of a sync user within the permissions system.
QueryBasedSyncConfiguration
A QueryBasedSyncConfiguration is used to setup a Realm that can be synchronized in "query-based" mode between devices using the Realm Object Server. Only objects that match the subscribed queries will be synchronized to the client.
RealmPermission
A singleton object which describes Realm-wide permissions.
RealmSyncExtensions
A set of extension methods that provide Sync-related functionality on top of Realm classes.
Session
An object encapsulating a Realm Object Server 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 URL stored on a Realm Object Server). 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 set of extension methods exposing query-based sync related functionality over collections.
Subscription<T>
A class that represents a subscription to a set of objects in a synced Realm.
When query-based sync is enabled for a synced Realm, the only objects that the server synchronizes to the
client are those that match a sync subscription registered by that client. A subscription consists of
of a query (represented by an IQueryable{T}) and an optional name.
The state of the subscription can be observed by subscribing to the PropertyChanged event handler.
Subscriptions are created by calling Subscribe<T>(IQueryable<T>, SubscriptionOptions, Expression<Func<T, IQueryable>>[]).
SubscriptionOptions
A set of options provided to Subscribe<T>(IQueryable<T>, SubscriptionOptions, Expression<Func<T, IQueryable>>[]) to control the behavior of the subscription.
SyncConfigurationBase
A SyncConfigurationBase is used to setup a Realm that can be synchronized between devices using the Realm Object Server.
User
This class represents a user on the Realm Object Server. The credentials are provided by various 3rd party providers (Facebook, Google, etc.). A user can log in to the Realm Object 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.
UserInfo
An object containing information about a user's identity in Realm's authentication system.
Structs
SyncProgress
A struct containing information about the progress state at a given instant.
Enums
AccessLevel
Access levels which can be granted to Realm Platform users for specific synchronized Realms, using the permissions APIs.
Note that each access level guarantees all allowed actions provided by less permissive access levels.
Specifically, users with write access to a Realm can always read from that Realm, and users with administrative
access can always read or write from the Realm.
ClassPrivileges
A description of the actual privileges which apply to a Class within a Realm.
ClientResyncMode
Enum describing what should happen in case of a Client Resync.
LogLevel
Specifies the criticality level above which messages will be logged by the default sync client logger.
ObjectPrivileges
A description of the actual privileges which apply to a specific Object.
ProgressDirection
The transfer direction (upload or download) tracked by a given progress notification subscription.
ProgressMode
The desired behavior of a progress notification subscription.
RealmPrivileges
A description of the actual privileges which apply to a Realm.
Recipient
The user affected by the permission change.
SessionState
The current state of a sync session object.
SubscriptionState
An enumeration, representing the possible state of a sync subscription.
UserPersistenceMode
Enumeration that specifies how and if logged-in User objects are persisted across application launches.
UserState
The state of the user object.