Skip to content

Commit

Permalink
Apply review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
cbullinger committed Mar 26, 2024
1 parent b799f71 commit 57983c6
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 41 deletions.
2 changes: 1 addition & 1 deletion examples/dart/test/migrate_parts.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// :replace-start: {
// "items": {
// "terms": {
// "migrate_parts": "car"
// }
// }
Expand Down

This file was deleted.

38 changes: 23 additions & 15 deletions source/sdk/flutter/install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.flutter.dev/get-started/install>`__.
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:

Expand Down Expand Up @@ -84,7 +93,6 @@ Install the SDK in a Flutter Project
dependencies:
realm: <latest_version>


.. step:: Import the Package

To use the Flutter SDK within your app, import the package
Expand Down Expand Up @@ -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. <https://dart.dev/server>`_
`See the official documentation. <https://dart.dev/server>`__

.. step:: Add the SDK to the Project

Expand Down
7 changes: 3 additions & 4 deletions source/sdk/flutter/realm-database/model-data/data-types.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://pub.dev/documentation/realm_common/latest/realm_common/RealmValue-class.html>`__
data type is a mixed data type that can represent any other valid
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
14 changes: 7 additions & 7 deletions source/sdk/flutter/upgrade-to-v2.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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``
Expand All @@ -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
Expand All @@ -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``
Expand Down

0 comments on commit 57983c6

Please sign in to comment.