Merge branch 'feature-consolidated-sdk-docs' into DOCSP-39514

Author: dacharyc

source/help.txt

@@ -4,16 +4,33 @@
 Get Help
 ========
 
+.. meta::
+   :description: Get help for Atlas Device SDK through community forums, sharing feedback, or professional support.
+   :keywords: Realm, C++ SDK, Flutter SDK, Kotlin SDK, Java SDK, .NET SDK, Node.js SDK, Swift SDK
+
+.. facet::
+  :name: genre
+  :values: reference
+
+.. facet::
+   :name: programming_language
+   :values: cpp, csharp, dart, java, javascript/typescript, kotlin, objective-c, swift
+
 .. contents:: On this page
    :local:
    :backlinks: none
-   :depth: 1
+   :depth: 2
    :class: singlecol
 
-Overview
---------
+.. tabs-selector:: drivers
+
+MongoDB provides various resources for getting help with Atlas Device SDK and
+Atlas App Services.
+
+.. tip:: Atlas Device SDK and Realm
 
-MongoDB provides various resources for getting help with Atlas App Services.
+   While the SDK has been renamed to Atlas Device SDK, some resources still
+   reflect ``Realm`` naming.
 
 Professional Support
 --------------------
@@ -35,9 +52,9 @@ Community Forums
 The official `MongoDB Community Forums
 <https://www.mongodb.com/community/forums/c/realm/9>`__ are a great
 place to meet other developers, ask and answer questions, and stay
-up-to-date with the latest Realm and App Services features and releases. You can also
-interact with MongoDB employees, like our community team, engineers, and
-product managers, who are active forum contributors.
+up-to-date with the latest Atlas Device SDK and App Services features and
+releases. You can also interact with MongoDB employees, like our community
+team, engineers, and product managers, who are active forum contributors.
 
 Stack Overflow
 --------------
@@ -68,62 +85,56 @@ at the bottom right or right side of the page.
 Bug Reporting, and Changelogs
 -----------------------------
 
-.. tabs-realm-sdks::
+You can report bugs or view the changelog in the relevant ``realm-SDK``
+repository in GitHub. While the SDK has been renamed to Atlas Device SDK, the
+GitHub repositories still reflect ``realm`` naming.
 
-   .. tab::
-      :tabid: android
-
-      For the Java SDK:
-
-      - :github:`Report a bug <realm/realm-java/issues/new?template=bug_report.md>`
-      - :github:`View the changelog <realm/realm-java/blob/master/CHANGELOG.md>`
+.. tabs-drivers::
 
    .. tab::
-      :tabid: ios
+      :tabid: cpp-sdk
 
-      For the Swift SDK:
-
-      - :github:`Report a bug <realm/realm-swift/issues/new>`
-      - :github:`View the changelog <realm/realm-swift/blob/master/CHANGELOG.md>`
+      - :github:`Report a bug <realm/realm-cpp/issues/new>`
+      - :github:`View the changelog <realm/realm-cpp/blob/master/CHANGELOG.md>`
 
    .. tab::
-      :tabid: dotnet
-
-      For the .NET SDK:
+      :tabid: csharp
 
       - :github:`Report a bug <realm/realm-dotnet/issues/new>`
       - :github:`View the changelog <realm/realm-dotnet/blob/master/CHANGELOG.md>`
+      
+   .. tab::
+      :tabid: dart
+
+      - :github:`Report a bug <realm/realm-dart/issues/new>`
+      - :github:`View the changelog <realm/realm-dart/blob/master/CHANGELOG.md>`
 
    .. tab::
       :tabid: javascript
 
-      For the Node.js, React Native, or Web SDKs:
-
       - :github:`Report a bug <realm/realm-js/issues/new>`
       - :github:`View the changelog <realm/realm-js/blob/master/CHANGELOG.md>`
 
-   .. tab::
-      :tabid: flutter
-
-      For the Flutter SDK:
-
-      - :github:`Report a bug <realm/realm-dart/issues/new>`
-      - :github:`View the changelog <realm/realm-dart/blob/master/CHANGELOG.md>`
-
    .. tab::
       :tabid: kotlin
 
-      For the Kotlin SDK:
-
       - :github:`Report a bug <realm/realm-kotlin/issues/new>`
       - :github:`View the changelog <realm/realm-kotlin/blob/master/CHANGELOG.md>`
 
    .. tab::
-      :tabid: cpp
+      :tabid: objectivec
 
-      For the C++ SDK:
+      - :github:`Report a bug <realm/realm-swift/issues/new>`
+      - :github:`View the changelog <realm/realm-swift/blob/master/CHANGELOG.md>`
 
-      - :github:`Report a bug <realm/realm-cpp/issues/new>`
-      - :github:`View the changelog <realm/realm-cpp/blob/master/CHANGELOG.md>`
+   .. tab::
+      :tabid: swift
+
+      - :github:`Report a bug <realm/realm-swift/issues/new>`
+      - :github:`View the changelog <realm/realm-swift/blob/master/CHANGELOG.md>`
 
-   
+   .. tab::
+      :tabid: typescript
+
+      - :github:`Report a bug <realm/realm-js/issues/new>`
+      - :github:`View the changelog <realm/realm-js/blob/master/CHANGELOG.md>`

source/includes/api-details/cpp/crud/delete-all-objects-not-supported.rst

@@ -0,0 +1,3 @@
+C++ does not currently provide a method to delete all objects in the database.
+You can manually iterate through the objects and delete them if you need to
+clear the database.

source/includes/api-details/cpp/crud/delete-all-objects-of-type-not-supported.rst

@@ -0,0 +1 @@
+C++ does not currently provide an API to delete all objects of a type.

source/includes/api-details/cpp/crud/delete-inverse-relationship-description.rst

@@ -0,0 +1,4 @@
+In this example, a ``Person`` has a to-one relationship to a ``Dog``,
+and the ``Dog`` has an inverse relationship to ``Person``.
+Setting the ``Person.dog`` relationship to ``nullptr`` removes the inverse
+relationship from the ``Dog`` object. 

source/includes/api-details/cpp/crud/delete-multiple-objects-description.rst

@@ -0,0 +1 @@
+You can delete multiple objects within a write transaction.

source/includes/api-details/cpp/crud/delete-objects-procedure.rst

@@ -0,0 +1,25 @@
+1. Open a write transaction with :cpp-sdk:`db.write()
+   <structrealm_1_1db.html>`.
+
+#. Pass the object(s) you want to delete into the write block, or query for
+   them inside the block.
+
+   .. important:: Objects Must Be Live
+      
+      You can only delete live objects. If you are working with a frozen
+      object or thread-safe reference, you must ``thaw()`` the object or 
+      ``resolve()`` the thread-safe reference before deleting the object.
+      For more details, refer to :ref:`sdks-threading`.
+
+#. Call the ``remove()`` method with the object you want to delete as an
+   argument.
+
+#. The specified objects are deleted from the database and can no longer be
+   accessed or modified. If you try to use a deleted object, the SDK throws an
+   error.
+   
+   If any deleted objects had a relationship with another object, the SDK
+   only deletes the reference to the other object. The referenced object
+   remains in the database, but it can no longer be queried through the deleted 
+   parent property. Refer to the :ref:`sdks-delete-related-objects` section
+   for more information.

source/includes/api-details/cpp/crud/delete-operations-description.rst

@@ -0,0 +1,3 @@
+To delete an object from the database, pass the object to the
+:cpp-sdk:`db.remove() function <structrealm_1_1db.html>`
+inside of a write transaction.

source/includes/api-details/cpp/crud/delete-remove-dictionary-keys-values-description.rst

@@ -0,0 +1,3 @@
+To delete a :cpp-sdk:`map key
+<structrealm_1_1managed_3_01std_1_1map_3_01std_1_1string_00_01T_01_4_00_01void_01_4.html>`, 
+pass the key name to ``erase()``.

source/includes/api-details/cpp/crud/delete-remove-elements-from-list-description.rst

@@ -0,0 +1,3 @@
+You can delete a :cpp-sdk:`list element 
+<structrealm_1_1managed_3_01std_1_1vector_3_01T_01_5_01_4_01_4.html>` 
+with ``erase()``, or remove all elements from the list with ``clear()``.

source/includes/api-details/cpp/crud/delete-remove-elements-from-set-description.rst

@@ -0,0 +1,3 @@
+You can delete a :cpp-sdk:`set element 
+<structrealm_1_1managed_3_01std_1_1set_3_01T_01_5_01_4_01_4.html>` 
+with ``erase()``, or remove all elements from a set with ``clear()``.