Skip to content

Commit a2936a0

Browse files
committed
add notes of corss-reference
1 parent aa257d0 commit a2936a0

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

source/sdk/flutter/sync/manage-sync-session.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,9 @@ ranges from ``0.0`` to ``1.0``. At ``1.0``, the progress stream is complete.
119119

120120
.. tip::
121121

122-
Use the ``progressEstimate`` to display a progress indicator or estimated
123-
data transfer percentage.
122+
You can also configure sync monitoring by using the
123+
:ref:`onProgressCallback <flutter-progress-callback>` when you first open a
124+
Realm.
124125

125126
.. _flutter-monitor-network-connection:
126127

source/sdk/flutter/sync/open-synced-realm.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,19 @@ to open a realm immediately and sync data in the background when an internet con
6464
.. literalinclude:: /examples/generated/flutter/open_flexible_sync_realm_test.snippet.async-open.dart
6565
:language: dart
6666

67+
.. _flutter-progress-callback:
68+
6769
To track the state of the synchronization, pass a :flutter-sdk:`ProgressCallback <realm/ProgressCallback.html>`
6870
to the optional named argument ``onProgressCallback``.
6971

7072
.. literalinclude:: /examples/generated/flutter/open_flexible_sync_realm_test.snippet.async-open-track-progress.dart
7173
:language: dart
7274

75+
.. tip::
76+
77+
If you want to configure progress notifications *after* opening a realm, use
78+
:ref:`SyncSession.getProgressStream <flutter-monitor-sync-progress>`.
79+
7380
To be able to cancel a synchronization in progress, pass a `CancellationToken
7481
<https://pub.dev/documentation/cancellation_token/latest/cancellation_token/CancellationToken-class.html>`__
7582
instance to the optional named argument ``cancellationToken``.

0 commit comments

Comments
 (0)