Add info about refreshing realm for C++ and fix snooty build errors

mongodb · Jul 16, 2024 · ba66828 · ba66828
1 parent e9007a8
commit ba66828
Show file tree

Hide file tree

Showing 12 changed files with 25 additions and 1 deletion.
diff --git a/...es/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst b/...es/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
@@ -0,0 +1,6 @@
+After you update subscriptions, call ``refresh()`` on the :cpp-sdk:`realm 
+<structrealm_1_1db.html>`. This updates the database and outstanding objects 
+managed by the database to point to the most recent data.
+
+.. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.refresh-the-realm.cpp
+   :language: cpp
diff --git a/...access-subscription-js-ts-description.rst → ...ss-subscription-set-js-ts-description.rst b/...access-subscription-js-ts-description.rst → ...ss-subscription-set-js-ts-description.rst
diff --git a/...udes/sdk-examples/sync/manage-sync-subscriptions-add-multiple-subscriptions.rst b/...udes/sdk-examples/sync/manage-sync-subscriptions-add-multiple-subscriptions.rst
@@ -8,6 +8,8 @@
             :language: cpp
             :copyable: false
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/...includes/sdk-examples/sync/manage-sync-subscriptions-add-named-subscription.rst b/...includes/sdk-examples/sync/manage-sync-subscriptions-add-named-subscription.rst
@@ -7,6 +7,8 @@
          .. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.subscribe-to-objects-matching-a-query.cpp
             :language: cpp
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-subscription.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-subscription.rst
@@ -7,6 +7,8 @@
          .. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.subscribe-to-all-objects-of-a-type.cpp
             :language: cpp
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/...cludes/sdk-examples/sync/manage-sync-subscriptions-add-unnamed-subscription.rst b/...cludes/sdk-examples/sync/manage-sync-subscriptions-add-unnamed-subscription.rst
@@ -8,6 +8,8 @@
             :language: cpp
             :copyable: false
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/...ludes/sdk-examples/sync/manage-sync-subscriptions-change-named-subscription.rst b/...ludes/sdk-examples/sync/manage-sync-subscriptions-change-named-subscription.rst
@@ -7,6 +7,8 @@
          .. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.change-subscription-query.cpp
             :language: cpp
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/...ples/sync/manage-sync-subscriptions-remove-all-subscriptions-to-object-type.rst b/...ples/sync/manage-sync-subscriptions-remove-all-subscriptions-to-object-type.rst
@@ -7,6 +7,8 @@
          .. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.remove-subscription-by-name.cpp
             :language: cpp
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/...cludes/sdk-examples/sync/manage-sync-subscriptions-remove-all-subscriptions.rst b/...cludes/sdk-examples/sync/manage-sync-subscriptions-remove-all-subscriptions.rst
@@ -7,6 +7,8 @@
          .. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.clear-all-subscriptions.cpp
             :language: cpp
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/...ludes/sdk-examples/sync/manage-sync-subscriptions-remove-named-subscription.rst b/...ludes/sdk-examples/sync/manage-sync-subscriptions-remove-named-subscription.rst
@@ -7,6 +7,8 @@
          .. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.remove-subscription-by-name.cpp
             :language: cpp
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/...dk-examples/sync/manage-sync-subscriptions-subscribe-to-all-objects-of-type.rst b/...dk-examples/sync/manage-sync-subscriptions-subscribe-to-all-objects-of-type.rst
@@ -7,6 +7,8 @@
          .. literalinclude:: /examples/generated/cpp/flexible-sync.snippet.subscribe-to-all-objects-of-a-type.cpp
             :language: cpp
 
+         .. include:: /includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst
+
      - id: csharp
        content: |
 

diff --git a/source/sdk/sync/manage-sync-subscriptions.txt b/source/sdk/sync/manage-sync-subscriptions.txt
@@ -502,7 +502,7 @@ subscriptions through this property.
    .. tab::
       :tabid: swift
 
-      .. include:: /includes/api-details/swift/sync/manage-sync-subscriptions-access-subscription-description.rst
+      .. include:: /includes/api-details/swift/sync/manage-sync-subscriptions-access-subscription-set-description.rst
 
    .. tab::
       :tabid: typescript