From ba66828283ca78be102c46777cfb9fb3042f2f49 Mon Sep 17 00:00:00 2001 From: dacharyc Date: Tue, 16 Jul 2024 11:58:49 -0400 Subject: [PATCH] Add info about refreshing realm for C++ and fix snooty build errors --- .../manage-sync-subscriptions-refresh-realm-description.rst | 6 ++++++ ...criptions-access-subscription-set-js-ts-description.rst} | 0 ...manage-sync-subscriptions-add-multiple-subscriptions.rst | 2 ++ .../manage-sync-subscriptions-add-named-subscription.rst | 2 ++ .../sync/manage-sync-subscriptions-add-subscription.rst | 2 ++ .../manage-sync-subscriptions-add-unnamed-subscription.rst | 2 ++ .../manage-sync-subscriptions-change-named-subscription.rst | 2 ++ ...ubscriptions-remove-all-subscriptions-to-object-type.rst | 2 ++ .../manage-sync-subscriptions-remove-all-subscriptions.rst | 2 ++ .../manage-sync-subscriptions-remove-named-subscription.rst | 2 ++ ...-sync-subscriptions-subscribe-to-all-objects-of-type.rst | 2 ++ source/sdk/sync/manage-sync-subscriptions.txt | 2 +- 12 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 source/includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst rename source/includes/api-details/javascript/sync/{manage-sync-subscriptions-access-subscription-js-ts-description.rst => manage-sync-subscriptions-access-subscription-set-js-ts-description.rst} (100%) diff --git a/source/includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst b/source/includes/api-details/cpp/sync/manage-sync-subscriptions-refresh-realm-description.rst new file mode 100644 index 0000000000..7328eaf1a8 --- /dev/null +++ b/source/includes/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 +`. 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/source/includes/api-details/javascript/sync/manage-sync-subscriptions-access-subscription-js-ts-description.rst b/source/includes/api-details/javascript/sync/manage-sync-subscriptions-access-subscription-set-js-ts-description.rst similarity index 100% rename from source/includes/api-details/javascript/sync/manage-sync-subscriptions-access-subscription-js-ts-description.rst rename to source/includes/api-details/javascript/sync/manage-sync-subscriptions-access-subscription-set-js-ts-description.rst diff --git a/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-multiple-subscriptions.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-multiple-subscriptions.rst index 1868a70916..c44c1ec9f4 100644 --- a/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-multiple-subscriptions.rst +++ b/source/includes/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/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-named-subscription.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-named-subscription.rst index 16b8a5a7c5..2f20db692a 100644 --- a/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-named-subscription.rst +++ b/source/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 index 9e5d1d2ef3..ef46ab9d39 100644 --- 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/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-unnamed-subscription.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-unnamed-subscription.rst index 02a7d487b1..668a7e27e3 100644 --- a/source/includes/sdk-examples/sync/manage-sync-subscriptions-add-unnamed-subscription.rst +++ b/source/includes/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/source/includes/sdk-examples/sync/manage-sync-subscriptions-change-named-subscription.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-change-named-subscription.rst index 50b96e269f..60ef5a4379 100644 --- a/source/includes/sdk-examples/sync/manage-sync-subscriptions-change-named-subscription.rst +++ b/source/includes/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/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-all-subscriptions-to-object-type.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-all-subscriptions-to-object-type.rst index ff795f25dc..987b3fcd22 100644 --- a/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-all-subscriptions-to-object-type.rst +++ b/source/includes/sdk-examples/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/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-all-subscriptions.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-all-subscriptions.rst index 65d7fa07e7..1dcdfb1c7a 100644 --- a/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-all-subscriptions.rst +++ b/source/includes/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/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-named-subscription.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-named-subscription.rst index 91a87b0761..e2dd089e55 100644 --- a/source/includes/sdk-examples/sync/manage-sync-subscriptions-remove-named-subscription.rst +++ b/source/includes/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/source/includes/sdk-examples/sync/manage-sync-subscriptions-subscribe-to-all-objects-of-type.rst b/source/includes/sdk-examples/sync/manage-sync-subscriptions-subscribe-to-all-objects-of-type.rst index 937aa11ef7..fe9763db2e 100644 --- a/source/includes/sdk-examples/sync/manage-sync-subscriptions-subscribe-to-all-objects-of-type.rst +++ b/source/includes/sdk-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 index 4bb973981f..97cdc9f316 100644 --- 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