diff --git a/examples/dart/test/migrate_parts.dart b/examples/dart/test/migrate_parts.dart index 7ba78caab5..300ad0d496 100644 --- a/examples/dart/test/migrate_parts.dart +++ b/examples/dart/test/migrate_parts.dart @@ -1,5 +1,5 @@ // :replace-start: { -// "items": { +// "terms": { // "migrate_parts": "car" // } // } diff --git a/source/examples/generated/flutter/migrate_parts.snippet.migrate-model-dart-old.dart b/source/examples/generated/flutter/migrate_parts.snippet.migrate-model-dart-old.dart deleted file mode 100644 index 6415dbd32d..0000000000 --- a/source/examples/generated/flutter/migrate_parts.snippet.migrate-model-dart-old.dart +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:realm_dart/realm.dart'; - -part 'car.g.dart'; - -@RealmModel() -class _Car { - @PrimaryKey() - late ObjectId id; - - late String make; - late String? model; - late int? miles; -} diff --git a/source/sdk/flutter/install.txt b/source/sdk/flutter/install.txt index 6c872a4558..20e5c8ffb4 100644 --- a/source/sdk/flutter/install.txt +++ b/source/sdk/flutter/install.txt @@ -4,40 +4,49 @@ Install the Flutter SDK ======================= +.. meta:: + :description: Install the Atlas Device SDK with Flutter for Flutter or Dart applications. + :keywords: code example + +.. facet:: + :name: genre + :values: tutorial + .. contents:: On this page :local: :backlinks: none :depth: 2 :class: singlecol - Prerequisites ------------- - `Install Flutter in your development environment `__. - To use the latest version of the Atlas Device SDK for Flutter, you must use Flutter version 3.10.2 or later and Dart version 3.0.2 or later. - -.. warning:: Incompatible with Dart 2.17.3 - - The Flutter SDK and Dart standalone SDK are not compatible with - Dart 2.17.3 due to an issue with the Dart virtual machine in this version. - You may use Dart 2.17.5 version or later with the SDK. + + To use the latest version of the Atlas Device SDK for Flutter, you must use: + + - Flutter version 3.10.0 or later. + - Dart version 3.0.0 or later. Supported Platforms ~~~~~~~~~~~~~~~~~~~ -You can use the Flutter SDK on the following platforms: +The Flutter SDK supports the following platforms: - iOS - Android - macOS -- Windows +- Windows running on 64-bit architecture - Linux running on 64-bit architecture -You **cannot** use the Flutter SDK on the following platforms: +.. important:: Unsupported Platforms + + The Flutter SDK does *not* support the following platforms: + + - Web + - Windows running on ARM64 or 32-bit architectures + - Linux running on ARM64 or 32-bit architectures -- Web -- Linux running on ARM64 or 32-bit architectures .. _flutter-install-steps: @@ -84,7 +93,6 @@ Install the SDK in a Flutter Project dependencies: realm: - .. step:: Import the Package To use the Flutter SDK within your app, import the package @@ -125,7 +133,7 @@ except where otherwise noted. The official Dart docs have helpful getting started material for using Dart without Flutter for CLI and server use cases. - `See the official documentation. `_ + `See the official documentation. `__ .. step:: Add the SDK to the Project diff --git a/source/sdk/flutter/realm-database/model-data/data-types.txt b/source/sdk/flutter/realm-database/model-data/data-types.txt index 49e32632d2..555110a0fd 100644 --- a/source/sdk/flutter/realm-database/model-data/data-types.txt +++ b/source/sdk/flutter/realm-database/model-data/data-types.txt @@ -368,14 +368,13 @@ RealmValue for more information. This update also includes the following breaking changes, which may affect - your app when updating to v2.0.0 or later: + your app when upgrading to v2.0.0 or later: - ``RealmValue.type`` is now an enum of ``RealmValueType`` instead of ``Type``. - ``RealmValue.uint8List`` is renamed to ``RealmValue.binary``. -.. TODO: Add this back to above note once upgrade page is available -.. For more information on how to update an existing app from an earlier -.. version to v2.0.0 or later, refer to :ref:`flutter-upgrade-v2`. + For more information on how to upgrade an existing app from an earlier + version to v2.0.0 or later, refer to :ref:`flutter-upgrade-v2`. The `RealmValue `__ data type is a mixed data type that can represent any other valid diff --git a/source/sdk/flutter/realm-database/model-data/define-realm-object-schema.txt b/source/sdk/flutter/realm-database/model-data/define-realm-object-schema.txt index 0aa23c45f4..05af385eb2 100644 --- a/source/sdk/flutter/realm-database/model-data/define-realm-object-schema.txt +++ b/source/sdk/flutter/realm-database/model-data/define-realm-object-schema.txt @@ -276,7 +276,7 @@ data when modeling a variable event log object: .. literalinclude:: /examples/generated/flutter/define_realm_model_test.snippet.unstructured-data-model.dart :language: dart - :emphasize-lines: 9 + :emphasize-lines: 10 :caption: Data model .. io-code-block:: diff --git a/source/sdk/flutter/upgrade-to-v2.txt b/source/sdk/flutter/upgrade-to-v2.txt index f94351d2b4..806a65ef7d 100644 --- a/source/sdk/flutter/upgrade-to-v2.txt +++ b/source/sdk/flutter/upgrade-to-v2.txt @@ -43,9 +43,8 @@ Builder Changes Flutter SDK version 2.0.0 updates the SDK's ``realm_generator`` to use a ``PartBuilder`` instead of a ``SharedPartBuilder``. - -As a result of this update, the generated ``RealmModel`` data model files -use a new ``.realm.dart`` file extension: +This updated builder generates ``RealmModel`` data model files with a new +``.realm.dart`` file extension: .. list-table:: :header-rows: 1 @@ -150,7 +149,7 @@ when upgrading an app that used the removed class or member, if any: - Use ``SyncErrorCode`` enum. * - ``Realm.logger.level`` - - Replaced by ``Realm.logger.setLogLevel()``. + - Replaced by ``Realm.logger.setLogLevel``. - Replace any instances. See also :ref:`flutter-logging`. * - ``RealmProperty.indexed`` @@ -165,8 +164,8 @@ when upgrading an app that used the removed class or member, if any: - Renamed to ``RealmValue.binary``. - Replace any instances. See also :ref:`flutter-realm-value`. - * - ``SchemaObject.properties`` and ``SyncProgress.transferableBytes`` - - Replaced by the more accurate ``SyncProgress.progressEstimate``. + * - ``SchemaObject.properties`` + - ``SchemaObject`` changed to an iterable collection of ``SchemaProperty``. - Replace any instances. * - ``SyncError`` constructor and ``SyncError.create`` factory @@ -186,7 +185,8 @@ when upgrading an app that used the removed class or member, if any: - Remove any category or message instances. Replace ``SyncError.codeValue`` with ``SyncError.code.code``. * - ``SyncProgress.transferredBytes`` and ``SyncProgress.transferableBytes`` - - Consolidated into ``SyncProgress.progressEstimate``. + - Reported transferred and transferable values were incorrect. Consolidated + into a new ``SyncProgress.progressEstimate`` metric. - Use ``SyncProgress.progressEstimate``. * - ``User.provider``