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.

Credentials.Provider

A class, containing the names for the built in providers.

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.

PermissionChange

Objects of this class allow to change permissions of owned Realms. They are created exclusively by the client and are processed by the server as indicated by the status fields.

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. They are created exclusively by the client and are processed by the server as indicated by the status fields.

PermissionOfferResponse

Objects of this class are used to accept a PermissionOffer using a provided Token.

PermissionUser

A representation of a sync user within the permissions system.

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.

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 helper methods exposing partial-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>, String).

SyncConfiguration

A SyncConfiguration is used to setup a Realm that can be synchronized between devices using the Realm Object Server. A valid User is required to create a SyncConfiguration.

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.

UserPermissionsExtensions

A set of extensions methods over the User class that expose functionality for managing synchronized Realm permissions.

Structs

SyncProgress

A struct containing information about the progress state at a given instant.

Interfaces

IPermissionObject

Interface that describes the shared base model of all Permission classes.

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.