Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(DOCSP-27391): Add a link to App Services Sync Errors from SDKs #2485

Merged
merged 3 commits into from
Jan 11, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions source/includes/sync-errors-in-app-services.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. tip::

For a list of common Sync Errors and how to handle them, refer to
dacharyc marked this conversation as resolved.
Show resolved Hide resolved
:ref:`sync-errors` in the App Services Device Sync documentation.
2 changes: 2 additions & 0 deletions source/sdk/dotnet/sync/handle-sync-errors.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ strongly typed handling logic.
`HelpLink <https://docs.microsoft.com/en-us/dotnet/api/system.exception.helplink?view=net-6.0#system-exception-helplink>`_
property on the exception contains a link to the associated log entry.

.. include:: /includes/sync-errors-in-app-services.rst

.. _dotnet-reset-a-client-realm-file:

.. Reset a Client Realm File
Expand Down
2 changes: 2 additions & 0 deletions source/sdk/flutter/sync/handle-sync-errors.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ If you do not specify a ``syncErrorHandler``, the default behavior is to print t
.. literalinclude:: /examples/generated/flutter/open_flexible_sync_realm_test.snippet.sync-error-handler.dart
:language: dart

.. include:: /includes/sync-errors-in-app-services.rst

.. _flutter-client-reset:

Client Reset
Expand Down
2 changes: 2 additions & 0 deletions source/sdk/java/examples/sync-changes-between-devices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ builder method:
:language: java
:copyable: false

.. include:: /includes/sync-errors-in-app-services.rst

.. _java-reset-a-client-realm-file:

Reset a Client Realm File
Expand Down
2 changes: 2 additions & 0 deletions source/sdk/kotlin/errors/app.txt
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ Sync errors occur when Device Sync fails.

`SyncException <{+kotlin-sync-prefix+}io.realm.kotlin.mongodb.exceptions/-sync-exception/index.html>`__

.. include:: /includes/sync-errors-in-app-services.rst

Unrecoverable Sync Errors
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions source/sdk/node/examples/sync-changes-between-devices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ Set an error handler by registering an error callback as part of the :js-sdk:`Sy
.. literalinclude:: /examples/generated/node/sync-changes-between-devices.snippet.sync-changes-between-devices-handle-sync-errors.js
:language: javascript

.. include:: /includes/sync-errors-in-app-services.rst

.. _node-perform-a-client-reset:

Expand Down
2 changes: 2 additions & 0 deletions source/sdk/react-native/sync-data/handle-sync-errors.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Set an error handler by registering an error callback as part of the :js-sdk:`Sy
.. literalinclude:: /examples/generated/node/sync-changes-between-devices.snippet.sync-changes-between-devices-handle-sync-errors.js
:language: javascript

.. include:: /includes/sync-errors-in-app-services.rst

.. note:: Client Reset Errors

To learn more about handling client reset errors, read the :ref:`Reset a Client Realm <react-native-client-resets>` documentation.
2 changes: 2 additions & 0 deletions source/sdk/swift/sync/handle-sync-errors.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ While developing an application that uses Device Sync, you should set an error
handler. This error handler will detect and respond to any failed sync-related
API calls.

.. include:: /includes/sync-errors-in-app-services.rst

.. tabs-realm-languages::

.. tab::
Expand Down