2.0.0 RC1 - Sync for Windows, partial sync, lists of primitives

This is a major release that includes numerous improvements as well as several highly requested new features. This release is incompatible with the Realm Object Server 1.x series. Comprehensive documentation on migrating an app that uses synchronized Realms from 1.x to 2.x will be published shortly. Apps that are using offline realms only are not affected and can upgrade safely.

• We're releasing sync for Windows (UWP, .NET Core, and classic desktop) as beta. It has a few rough edges, but we believe it's stable enough to start experimenting with and use it in your development workflow. The stable release of Sync for Windows is expected later this month.
• Partial Sync is released as a technical preview and not meant to be used in production. It allows you to specify a query and only objects matching that query will be downloaded by the Realm Object Server. The API is very much work in progress and we expect to change it to something more idiomatic for .NET at a later point. A stable release of Partial Sync is expected early next year.
• We have dropped the constraints of persisted IList<T> properties and you can now specify primitive values as well as RealmObject subtypes.

Below is the full list of changes and enhancements.

Enhancements

• Added support for collections of primitive values. You can now define properties as IList<T> where T can be any
  type supported by Realm, except for another IList. As a result, a lot of methods that previously had constraints on
  RealmObject now accept any type and may throw a runtime exception if used with an unsupported type argument.
  (#1517)
• Added HelpLink pointing to the relevant section of the documentation to most Realm exceptions. (#1521)
• Added RealmObject.GetBacklinks API to dynamically obtain all objects referencing the current one. (#1533)
• Added a new exception type, PermissionDeniedException, to denote permission denied errors when working with synchronized Realms that
  exposes a method - DeleteRealmUserInfo - to inform the binding that the offending Realm's files should be kept or deleted immediately.
  This allows recovering from permission denied errors in a more robust manner. (#1543)
• The keychain service name used by Realm to manage the encryption keys for sync-related metadata on Apple platforms is now set to the
  bundle identifier. Keys that were previously stored within the Realm-specific keychain service will be transparently migrated to the
  per-application keychain service. (#1522)
• Added a new exception type - IncompatibleSyncedFileException - that allows you to handle and perform data migration from a legacy (1.x) Realm file
  to the new 2.x format. It can be thrown when using Realm.GetInstance or Realm.GetInstanceAsync and exposes a GetBackupRealmConfig method
  that allows you to open the old Realm file in a dynamic mode and migrate any required data. (#1552)
• Enable encryption on Windows. (#1570)
• Enable Realm compaction on Windows. (#1571)
• UserInfo has been significantly enhanced. It now contains metadata about a user stored on the Realm Object Server, as well as a list of all user
  account data associated with that user. (#1573)
• Introduced a new method - User.LogOutAsync to replace the now-deprecated synchronous call. (#1574)
• Exposed BacklinksCount property on RealmObject that returns the number of objects that refer to the current object via a to-one or a to-many relationship. (#1578)
• String primary keys now support null as a value. (#1579)
• Add preview support for partial synchronization. Partial synchronization allows a synchronized Realm to be opened in such a way
  that only objects requested by the user are synchronized to the device. You can use it by setting the IsPartial property on a
  SyncConfiguration, opening the Realm, and then calling Realm.SubscribeToObjectsAsync with the type of object you're interested in,
  a string containing a query determining which objects you want to subscribe to, and a callback which will report the results. You may
  add as many subscriptions to a synced Realm as necessary. (#1580)

Bug fixes

• Realm.GetInstance will now advance the Realm to the latest version, so you no longer have to call Refresh manually after that. (#1523)
• Fixed an issue that would prevent iOS Share Extension projects from working. (#1535)

Breaking Changes

• This release requires Realm Object Server 2.x.
• Realm.CreateObject(string className) now has additional parameter object primaryKey. You must pass that when creating a new object using the dynamic API. If the object you're creating doesn't have primary key declared, pass null. (#1381)

1.6.0 - .NET Core and Xamarin.Mac support

.NET Core support

We’re pleased to introduce .NET Core support on Realm. Developers can now build apps with the Realm Mobile Platform using C# on both the client and server side for a complete end-to-end C# developer experience with Realm. Refer to the documentation for more details on supported platforms. Note that support for synchronized Realms on Windows is coming later this year.

Xamarin.Mac support

In addition to .NET Core, we're announcing official Xamarin.Mac support. Both Native UI and Xamarin.Forms applications are fully supported and for Xamarin.Forms, we're shipping a new update to the Realm.DataBinding package to automatically create transactions for two-way data bound properties.

Enhancements

• Exposed Realm.WriteCopy API to copy a Realm file and optionally encrypt it with a different key. (#1464)
• The runtime representations of all Realm collections (IQueryable<T> and IList<T>) now implement the IList interface that is needed for data-binding to ListView in UWP applications. (#1469)
• Exposed User.RetrieveInfoForUserAsync API to allow admin users to lookup other users' identities in the Realm Object Server. This can be used, for example, to find a user by knowing their Facebook id. (#1486)
• Added a check to verify there are no duplicate object names when creating the schema. (#1502)
• Added more comprehensive error messages when passing an invalid url scheme to SyncConfiguration or User.LoginAsync. (#1501)
• Added more meaningful error information to exceptions thrown by Realm.GetInstanceAsync. (#1503)
• Added a new type - RealmInteger<T> to expose Realm-specific API over base integral types. It can be used to implement counter functionality in synced realms. (#1466)
• Added PermissionCondition.Default to apply default permissions for existing and new users. (#1511)

Bug fixes

• Fix an exception being thrown when comparing non-constant character value in a query. (#1471)
• Fix an exception being thrown when comparing non-constant byte or short value in a query. (#1472)
• Fix a bug where calling the non-generic version of IQueryProvider.CreateQuery on Realm's IQueryable results, an exception would be thrown. (#1487)
• Trying to use an IList or IQueryable property in a LINQ query will now throw NotSupportedException rather than crash the app. (#1505)

1.5.0 - new Permission API

1.5.0 (2017-06-20)

Enhancements

• Exposed new API on the User class for working with permissions: (#1361)
  • ApplyPermissionsAsync, OfferPermissionsAsync, and AcceptPermissionOfferAsync allow you to grant, revoke, offer, and accept permissions.
  • GetPermissionOffers, GetPermissionOfferResponses, and GetPermissionChanges allow you to review objects, added via the above mentioned methods.
  • GetGrantedPermissionsAsync allows you to inspect permissions granted to or by the current user.
• When used with RealmConfiguration (i.e. local Realm), Realm.GetInstanceAsync will perform potentially costly operation, such as executing migrations or compaction on a background thread. (#1406)
• Expose User.ChangePasswordAsync(userId, password) API to allow admin users to change other users' passwords. (#1412)
• Expose SyncConfiguration.TrustedCAPath API to allow providing a custom CA that will be used to validate SSL traffic to the Realm Object Server. (#1423)
• Expose Realm.IsInTransaction API to check if there's an active transaction for that Realm. (#1452)

Bug fixes

• Fix a crash when querying over properties that have [MapTo] applied. (#1405)
• Fix an issue where synchronized Realms did not connect to the remote server in certain situations, such as when an application was offline when the Realms were opened but later regained network connectivity. (#1407)
• Fix an issue where incorrect property name will be passed to RealmObject.PropertyChanged subscribers when the actual changed property is below a Backlink property. (#1433)
• Fix an exception being thrown when referencing Realm in a PCL test assembly without actually using it. (#1434)
• Fix a bug when SyncConfiguration.EnableSSLValidation would be ignored when passed to Realm.GetInstanceAsync. (#1423)

Breaking Changes

• The constructors of PermissionChange, PermissionOffer, and PermissionOfferResponse are now private. Use the new User.ApplyPermissionsAsync, User.OfferPermissionsAsync, and User.AcceptPermissionOfferAsync API. (#1361)
• User.GetManagementRealm and User.GetPermissionRealm are now deprecated. Use the new permission related API on User to achieve the same results. (#1361)
• User.ChangePassword(password) has been renamed to User.ChangePasswordAsync(password). (#1412)
• Removed the following obsolete API: (#1425)
  • Realm.ObjectForPrimaryKey<T>(long id)
  • Realm.ObjectForPrimaryKey<T>(string id)
  • Realm.ObjectForPrimaryKey(string className, long id)
  • Realm.ObjectForPrimaryKey(string className, string id)
  • Realm.Manage<T>(T obj, bool update)
  • Realm.Close()
  • Realm.CreateObject<T>()
  • IOrderedQueryable<T>.ToNotifyCollectionChanged<T>(Action<Exception> errorCallback)
  • IOrderedQueryable<T>.ToNotifyCollectionChanged<T>(Action<Exception> errorCallback, bool coalesceMultipleChangesIntoReset)
  • IRealmCollection<T>.ObjectSchema
• Realm.DeleteRealm now throws an exception if called while an instance of that Realm is still open.

1.4.0 - Realm.GetInstanceAsync

Enhancements

• Expose RealmObject.OnManaged virtual method that can be used for init purposes, since the constructor is run before the object has knowledge of its Realm. (#1383)
• Expose Realm.GetInstanceAsync API to asynchronously open a synchronized Realm. It will download all remote content available at the time the operation began on a background thread and then return a usable Realm. It is also the only supported way of opening Realms for which the user has only read permissions. (#1390)

1.3.0 - UWP support

Universal Windows Platform

Introducing Realm Mobile Database for Universal Windows Platform (UWP). With UWP support, you can now build mobile apps using Realm’s object database for the millions of mobile, PC, and Xbox devices powered by Windows 10. The addition of UWP support allows .NET developers to build apps for virtually any modern Windows Platform with Windows Desktop (Win32) or UWP as well as for iOS and Android via Xamarin. Note that sync support is not yet available for UWP, though we are working on it and you can expect it soon.

Enhancements

• Case insensitive queries against a string property now use a new index based search. (#1380)
• Add User.ChangePassword API to change the current user's password if using Realm's 'password' authentication provider. Requires any edition of the Realm Object Server 1.4.0 or later. (#1386)
• SyncConfiguration now has an EnableSSLValidation property (default is true) to allow SSL validation to be specified on a per-server basis. (#1387)
• Add RealmConfiguration.ShouldCompactOnLaunch callback property when configuring a Realm to determine if it should be compacted before being returned. (#1389)
• Silence some benign linker warnings on iOS. (#1263)
• Use reachability API to minimize the reconnection delay if the network connection was lost. (#1380)

Bug fixes

• Fixed a bug where Session.Reconnect would not reconnect all sessions. (#1380)
• Fixed a crash when subscribing for PropertyChanged multiple times. (#1380)
• Fixed a crash when reconnecting to Object Server (#1380)
• Fixed a crash on some Android 7.x devices when opening a realm (#1380)

1.2.1 - Fody update

Bug fixes

• Fixed an issue where EntryPointNotFoundException would be thrown on some Android devices. (#1336)

Enhancements

• Expose IRealmCollection.IsValid to indicate whether the realm collection is valid to use. (#1344)
• Update the Fody reference which adds support for building with Mono 5. (#1364)

Breaking Changes

None

1.2.0 - .NET Standard

Realm is now being distributed as a .NET Standard 1.4 library as this is a requirement for supporting UWP. While internally that is a rather big move, applications using it should not be affected. After the upgrade, you'll see a number of new NuGet dependencies being added - those are reference assemblies, already part of mscorlib, so will not affect your application's size or performance. Additionally, we're releasing a new platform specific DataBinding package that contains helper methods that enable two-way databinding scenarios by automatically creating transactions when setting a property.

If you encounter any issues after the upgrade, we recommend clearing the bin and obj folders and restarting Xamarin Studio. If this doesn't help, please file an issue explaining your solution setup and the type of problems you encounter.

Files written with this version cannot be read by earlier versions of Realm. This version is not compatible with versions of the Realm Object Server lower than 1.3.0.

Bug fixes

• Fixes the RemoveAll(string) overload to work correctly. (#1288)
• Resolved an issue that would lead to crashes when refreshing the token for an invalid session. (#1289)
• The IObservable returned from session.GetProgressObservable will correctly call OnComplete when created with mode: ProgressMode.ForCurrentlyOutstandingWork. (#1292)
• Fixed a memory leak when accessing string properties. (#1318)
• Fixes an issue when using EncryptionKey with synchronized realms. (#1322)

Enhancements

• Introduce APIs for safely passing objects between threads. Create a thread-safe reference to a thread-confined object by passing it to the ThreadSafeReference.Create factory method, which you can then safely pass to another thread to resolve in the new realm with Realm.ResolveReference. (#1300)
• Introduce API for attempting to reconnect all sessions. This could be used in conjunction with the connectivity plugin to monitor for connectivity changes and proactively request reconnecting, rather than rely on the built-in retry mechanism. (#1310)
• Enable sorting over to-one relationships, e.g. realm.All<Parent>().OrderBy(p => p.Child.Age). (#1313)
• Introduce a string.Like extension method that can be used in LINQ queries against the underlying database engine. (#1311)
• Add an User.IsAdmin property that indicates whether a user is a Realm Object Server administrator. (#1320)

Breaking Changes

• DateTimeOffset properties that are not set will now correctly default to 0001-1-1 instead of 1970-1-1 after the object is passed to realm.Add. (#1293)
• Attempting to get an item at index that is out of range should now correctly throw ArgumentOutOfRangeException for all IRealmCollection implementations. (#1295)
• The layout of the .lock file has changed, which may affect scenarios where different processes attempt to write to the same Realm file at the same time. (#1296)
• PropertyChanged notifications use a new, more reliable, mechanism, that behaves slightly differently from the old one. Notifications will be sent only after a transaction is committed (making it consistent with the way collection notifications are handled). To make sure that your UI is promptly updated, you should avoid keeping long lived transactions around. (#1316)

1.1.1 - Fix VS compilation problems

Bug fixes

• Resolved an issue that prevented compiling for iOS on Visual Studio. (#1277)

1.1.0 - Azure AD authentication

Enhancements

• Added Azure Active Directory (AzureAD) credentials provider. (#1254)

Breaking Changes

This is a preparation release for adding UWP support. We have removed all platform-specific logic from the Realm assemblies, and instead weave them in compile time. While this has been tested in all common scenarios, it may create issues with very complex project graphs. If you encounter any of these issues with iOS projects:

• Compilation fails when running Task WeaveRealmAssemblies
• App crashes when first accessing a Realm

please file an issue and explain your solution setup.

1.0.4 - Bug fixes

Bug fixes

• The Realm NuGet package no longer clobbers the path to Win32 native binaries in Realm.Database. (#1239)
• Fixed a bug where garbage collecting an object with PropertyChanged subscribers would cause crashes. (#1237)