Skip to content

Commit

Permalink
Incorporate review feedback and add tags
Browse files Browse the repository at this point in the history
  • Loading branch information
dacharyc committed Nov 27, 2023
1 parent df025ed commit 4851c3e
Show file tree
Hide file tree
Showing 8 changed files with 75 additions and 9 deletions.
7 changes: 7 additions & 0 deletions source/sdk/cpp/app-services/call-a-function.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
Call a Function - C++ SDK Preview
=================================

.. meta::
:keywords: code example

.. facet::
:name: genre
:values: reference

.. contents:: On this page
:local:
:backlinks: none
Expand Down
14 changes: 13 additions & 1 deletion source/sdk/cpp/app-services/connect-to-app.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
Connect to App Services - C++ SDK Preview
=========================================

.. meta::
:keywords: code example

.. facet::
:name: genre
:values: reference

.. contents:: On this page
:local:
:backlinks: none
Expand All @@ -20,7 +27,12 @@ your App's functions.
Prerequisites
-------------

#. :ref:`Create an App Services app <create-a-realm-app>`
Before you can connect to Atlas App Services, you need an App Services App
with an App ID. To get started, refer to :ref:`Create an App <create-a-realm-app>`
in the App Services documentation.

To learn how to find your App ID in the App Services UI, refer to
:ref:`Find Your App ID <find-your-app-id>` in the App Services documentation.

.. _cpp-access-the-app-client:

Expand Down
7 changes: 7 additions & 0 deletions source/sdk/cpp/realm-files/configure-and-open-a-realm.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@
Configure & Open a Realm - C++ SDK Preview
==========================================

.. meta::
:keywords: code example

.. facet::
:name: genre
:values: tutorial

.. contents:: On this page
:local:
:backlinks: none
Expand Down
7 changes: 7 additions & 0 deletions source/sdk/cpp/sync/handle-sync-errors.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
Handle Sync Errors - C++ SDK Preview
====================================

.. meta::
:keywords: code example

.. facet::
:name: genre
:values: tutorial

.. contents:: On this page
:local:
:backlinks: none
Expand Down
7 changes: 7 additions & 0 deletions source/sdk/cpp/sync/stream-data-to-atlas.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
Stream Data to Atlas - C++ SDK Preview
======================================

.. meta::
:keywords: code example

.. facet::
:name: genre
:values: tutorial

.. contents:: On this page
:local:
:backlinks: none
Expand Down
7 changes: 7 additions & 0 deletions source/sdk/cpp/sync/sync-subscriptions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@
Manage Sync Subscriptions - C++ SDK Preview
===========================================

.. meta::
:keywords: code example

.. facet::
:name: genre
:values: reference

.. contents:: On this page
:local:
:backlinks: none
Expand Down
28 changes: 20 additions & 8 deletions source/sdk/cpp/sync/write-to-synced-realm.txt
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,22 @@ the ``user.identifier()`` of the logged-in user cannot sync to this realm.
Client Data Model and Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Using the :ref:`object model <cpp-sync-example-object-model>`, the examples
configure the synced realm to synchronize objects matching this subscription query:
The examples on this page configure the synced realm to synchronize objects
matching this subscription query:

.. literalinclude:: /examples/generated/cpp/sync-errors.snippet.compensating-write-setup.cpp
:language: cpp
.. tabs::

.. tab:: Sync Query
:tabid: sync-query

.. literalinclude:: /examples/generated/cpp/sync-errors.snippet.compensating-write-setup.cpp
:language: cpp

.. tab:: Item Object Model
:tabid: item-model

.. literalinclude:: /examples/generated/cpp/sync-errors.snippet.compensating-write-model.cpp
:language: cpp

Any object in the Atlas collection where the ``complexity`` property's
value is greater than ``4`` cannot sync to this realm.
Expand Down Expand Up @@ -173,9 +184,10 @@ In practice, this may look like the write succeeding, but then the
object "disappears" when Realm syncs with the App Services backend and
performs the compensating write.

When this occurs, you can refer to the :ref:`App Services logs <logs-sync>` or use the
:ref:`compensating_writes_info() <cpp-compensating-write-info>` function in the
client to get additional information on the error.
When this occurs, you can refer to the :ref:`App Services logs <logs-sync>`
or use the ``compensating_writes_info()`` function in the client to get
additional information on the error. For more information, refer
to the :ref:`cpp-compensating-write-info` section on this page.

.. _cpp-writes-outside-subscription:

Expand Down Expand Up @@ -287,7 +299,7 @@ about compensating write errors:

- The ``Item`` in this message is ``Item`` object used in the :ref:`object model <cpp-client-data-model-and-configuration>` on this page.
- The ``table "Item"`` refers to the Atlas collection where this object would sync.
- The reason ``object is outside of the current query view`` in this example is because the query subscription was set to require the object's ``complexity`` property to be less than or equal to ``4``, and the client attempted to write an object outside of this boundary.
- The reason ``object is outside of the current query view`` in this message is because the query subscription was set to require the object's ``complexity`` property to be less than or equal to ``4``. The client attempted to write an object outside of this boundary.
- The primary key is the ``objectId`` of the specific object the client attempted to write.

Group Writes for Improved Performance
Expand Down
7 changes: 7 additions & 0 deletions source/sdk/cpp/users/authenticate-users.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
Authenticate Users - C++ SDK Preview
====================================

.. meta::
:keywords: code example

.. facet::
:name: genre
:values: reference

.. contents:: On this page
:local:
:backlinks: none
Expand Down

0 comments on commit 4851c3e

Please sign in to comment.