Skip to content

Commit 4ceb7f8

Browse files
committed
Reword note and Realm renaming
1 parent 85711ae commit 4ceb7f8

File tree

1 file changed

+39
-35
lines changed

1 file changed

+39
-35
lines changed

source/sdk/dotnet/compatibility.txt

Lines changed: 39 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -12,41 +12,17 @@ Platform and Framework Compatibility - .NET SDK
1212
:class: singlecol
1313

1414
.. meta::
15-
:description: Compatibility information for Atlas Device SDK for .NET.
15+
:description: Compatibility information when developing with Atlas Device SDK for .NET.
1616

1717
.. facet::
1818
:name: genre
1919
:values: reference
2020

21-
Compatibility
22-
-------------
21+
Target Platforms
22+
----------------
2323

2424
The following table shows which .NET
25-
version(s) you can use with Realm on your target platforms:
26-
27-
.. note::
28-
29-
The source generator models in .NET SDK v10.18.0 and later
30-
require the following:
31-
32-
- .NET Core 2.0 or later (.NET Framework 5.0 or later)
33-
- C# 9.0 or later
34-
35-
If you are targeting an older version of .NET Framework, your object
36-
models must derive from
37-
:dotnet-sdk:`RealmObject <reference/Realms.RealmObject.html>`,
38-
:dotnet-sdk:`EmbeddedObject <reference/Realms.EmbeddedObject.html>`, or
39-
:dotnet-sdk:`AsymmetricObject <reference/Realms.AsymmetricObject.html>`
40-
base classes.
41-
42-
The following example demonstrates how you can adjust your current object
43-
models:
44-
45-
.. code-block:: csharp
46-
47-
public partial class Person : IRealmObject
48-
49-
public class Person : RealmObject // Update to inherit from RealmObject
25+
versions you can use with the SDK on your target platforms:
5026

5127
.. list-table::
5228
:header-rows: 1
@@ -86,10 +62,36 @@ version(s) you can use with Realm on your target platforms:
8662
- | Xamarin and Unity for tvOS 9.0 or later.
8763
| For more information on developing for tvOS, see :ref:`<ios-tvos>`.
8864

65+
.. note:: Compatibility with SDK Object Models
66+
67+
The source generator models in .NET SDK v10.18.0 and later
68+
require the following:
69+
70+
- .NET Core 2.0 or later (.NET Framework 5.0 or later)
71+
- C# 9.0 or later
72+
73+
If you are targeting an older version of .NET Framework, your object models
74+
must derive from the
75+
:dotnet-sdk:`RealmObject <reference/Realms.RealmObject.html>`,
76+
:dotnet-sdk:`EmbeddedObject <reference/Realms.EmbeddedObject.html>`, or
77+
:dotnet-sdk:`AsymmetricObject <reference/Realms.AsymmetricObject.html>`
78+
base classes required by the old source generator.
79+
80+
The following demonstrates how you can adjust your current object
81+
models for compatibility with older .NET Frameworks:
82+
83+
.. code-block:: csharp
84+
85+
public partial class Person : IRealmObject // Current model
86+
87+
public class Person : RealmObject // Adjusted to inherit from RealmObject
88+
89+
For more information, refer to :ref:`dotnet-define-a-realm-object-schema`.
90+
8991
Development Environments
9092
------------------------
9193

92-
You can use the following development environments to build Realm apps with
94+
You can use the following development environments to build apps with
9395
the .NET SDK:
9496

9597
- Visual Studio 2015 Update 2 or higher for Windows
@@ -98,18 +100,19 @@ the .NET SDK:
98100

99101
.. note::
100102

101-
The :doc:`Realm .NET SDK </sdk/dotnet>` may be compatible with
102-
other versions of Unity, but ``2020.3.12f1 (LTS)`` is the version that the
103-
Realm team uses for testing and development. We recommend using
104-
this version to ensure your project works with Realm and that
103+
The :doc:`.NET SDK </sdk/dotnet>` may be compatible with
104+
other versions of Unity, but ``2020.3.12f1 (LTS)`` is the version the
105+
SDK team uses for testing and development. We recommend using
106+
this version to ensure your project works with the .NET SDK and that
105107
the install steps match the :doc:`Integrate Realm with Unity
106108
</sdk/dotnet/unity>` documentation steps because Unity's UI
107109
often changes between versions.
108110

109111

110112
Android Deployment
111113
------------------
112-
Due to some instruction set limitations, Realm does not support
114+
115+
Due to some instruction set limitations, the SDK does not support
113116
deploying Android apps to the ``armeabi`` ABI. Because default templates often
114117
have different ABI settings for Debug and Release modes, your app may throw
115118
a ``System.TypeInitializationException`` exception in Release mode but not when
@@ -125,7 +128,8 @@ checking all of the settings other than ``armeabi``.
125128

126129
Limitations
127130
------------
128-
Realm has limits imposed to balance flexibility with performance. The SDK
131+
132+
The SDK has limits imposed to balance flexibility with performance. The SDK
129133
throws an exception during app initialization if the following limits are
130134
exceeded:
131135

0 commit comments

Comments
 (0)