Skip to content

Commit

Permalink
Fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
cbullinger committed May 8, 2024
1 parent 9e5a999 commit 111fccb
Show file tree
Hide file tree
Showing 4 changed files with 93 additions and 37 deletions.
11 changes: 6 additions & 5 deletions source/includes/dotnet-frameworks.rst
@@ -1,5 +1,6 @@
You can use the .NET SDK to develop apps in C# .NET with several frameworks:
`.NET MAUI <https://dotnet.microsoft.com/en-us/apps/maui>`__, `Xamarin
<https://dotnet.microsoft.com/apps/xamarin>`__, `Avalonia UI <https://avaloniaui.net/>`__,
`UWP <https://docs.microsoft.com/en-us/windows/uwp/get-started/>`__, `Unity
<https://unity.com/>`__, and others.
You can use the Atlas Device SDK for .NET to develop apps in C# .NET with several frameworks, including
`.NET MAUI <https://dotnet.microsoft.com/en-us/apps/maui>`__,
`Xamarin <https://dotnet.microsoft.com/apps/xamarin>`__,
`Avalonia UI <https://avaloniaui.net/>`__,
`UWP <https://docs.microsoft.com/en-us/windows/uwp/get-started/>`__,
`Unity <https://unity.com/>`__, and others.
10 changes: 5 additions & 5 deletions source/sdk/flutter/install.txt
Expand Up @@ -5,7 +5,7 @@ Install the Flutter SDK
=======================

.. meta::
:description: Install the Atlas Device SDK with Flutter for Flutter or Dart applications.
:description: Install the Atlas Device SDK for Flutter to use in Flutter or Dart applications.
:keywords: code example

.. facet::
Expand All @@ -15,7 +15,7 @@ Install the Flutter SDK
.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:depth: 1
:class: singlecol

You can use the Atlas Device SDK for Flutter in a Flutter project or in a
Expand Down Expand Up @@ -304,9 +304,9 @@ Apple Privacy Manifest
.. versionadded:: 2.2.0

Apple requires any apps or third-party SDKs that use *required reasons APIs*
to provide a privacy manifest containing details about their data collection
and use practices. The bundled manifest file must be included when submitting
new apps or app updates to the Apple App Store. For more details about these
provide a privacy manifest. The manifest contains details about the app's or SDK's
data collection and use practices, and it must be included when submitting new
apps or app updates to the Apple App Store. For more details about these
requirements, refer to
:apple:`Upcoming third-party SDK requirements <support/third-party-SDK-requirements/>`
on the Apple Developer website.
Expand Down
4 changes: 1 addition & 3 deletions source/sdk/flutter/users.txt
@@ -1,5 +1,3 @@
.. _flutter-work-with-users:

=============================
User Management - Flutter SDK
=============================
Expand Down Expand Up @@ -49,7 +47,7 @@ data from the backend.

.. include:: /includes/apple-account-deletion-requirements.rst

.. _flutter-access-the-app-client:
.. _flutter-log-users-in-and-out:

Log Users In and Out
--------------------
Expand Down
105 changes: 81 additions & 24 deletions source/sdk/react-native/install.txt
Expand Up @@ -10,14 +10,27 @@ Install the React Native SDK
:depth: 2
:class: singlecol

The Atlas Device SDK for React Native enables development of `React Native
The Atlas Device SDK for React Native enables development of `React Native
<https://facebook.github.io/react-native/>`__ applications using the JavaScript
and TypeScript languages. React Native enables you to build cross-platform
iOS and Android apps with a single codebase using the
and TypeScript languages. React Native enables you to build cross-platform
iOS and Android apps with a single codebase using the
`React <https://react.dev/>`__ framework.

Use the SDK with Expo
---------------------

You can use the React Native SDK with a bare React Native app or Expo. This page
and the React Native SDK documentation generally assume that you're using a bare
React Native app and not Expo.

If you want to use the React Native SDK with Expo, check out the :ref:`Bootstrap
with Expo <react-native-client-bootstrap-with-expo>` page.

Install the SDK in a Bare React Native App
------------------------------------------

Prerequisites
-------------
~~~~~~~~~~~~~

Before getting started, ensure your development environment
meets the following prerequisites. These are required for the latest version
Expand All @@ -36,18 +49,8 @@ of the React Native SDK:
:doc:`build your application when using Mac Catalyst
</sdk/react-native/integrations/mac-catalyst>`.

Use the SDK with Expo
~~~~~~~~~~~~~~~~~~~~~

You can use the React Native SDK with a bare React Native app or Expo. This page
and the React Native SDK documentation generally assume that you're using a bare
React Native app and not Expo.

If you want to use the React Native SDK with Expo, check out the :ref:`Bootstrap
with Expo <react-native-client-bootstrap-with-expo>` page.

Install the SDK in a Bare React Native App
------------------------------------------
Install the SDK
~~~~~~~~~~~~~~~

Select the tab below that corresponds to your React Native
version. Follow the steps to create a React Native project
Expand Down Expand Up @@ -142,7 +145,7 @@ and add the React Native SDK to it.

:npm:`@realm/react <package/@realm/react>` is an npm package that
streamlines common SDK operations like querying, writing to a
database, and listening for object change notifications. This reduces
database, and listening for object change notifications. This reduces
boilerplate code, like creating your own listeners and state management.

``@realm/react`` provides access to the SDK through a set of providers
Expand All @@ -167,12 +170,12 @@ and add the React Native SDK to it.
:tabid: rn-pre-v-60

.. note:: @realm/react Version Requirement
The :npm:`@realm/react <package/@realm/react>` library requires
react-native version ``>= 0.59``. If you are developing using older
versions of React Native, you can use the SDK without ``@realm/react``.
Since the React Native SDK documentation makes heavy use of the
``@realm/react`` package, you may want to refer to the

The :npm:`@realm/react <package/@realm/react>` library requires
react-native version ``>= 0.59``. If you are developing using older
versions of React Native, you can use the SDK without ``@realm/react``.
Since the React Native SDK documentation makes heavy use of the
``@realm/react`` package, you may want to refer to the
:ref:`Node.js SDK documentation <node-intro>`.

.. procedure::
Expand Down Expand Up @@ -274,11 +277,65 @@ and add the React Native SDK to it.
.. include:: /includes/react-native-run-the-app.rst

Import the SDK
--------------
~~~~~~~~~~~~~~

Add the following line to the top of your source files where
you want to use the SDK:

.. code-block:: typescript

import Realm from "realm";

.. _react-native-apple-privacy-manifest:

Apple Privacy Manifest
----------------------

.. versionadded:: 2.2.0

Apple requires any apps or third-party SDKs that use *required reasons APIs*
to provide a privacy manifest containing details about their data collection
and use practices. The bundled manifest file must be included when submitting
new apps or app updates to the Apple App Store. For more details about these
requirements, refer to
:apple:`Upcoming third-party SDK requirements <support/third-party-SDK-requirements/>`
on the Apple Developer website.

Starting in Flutter SDK version 2.2.0, the SDK ships with a privacy manifest for
``iOS`` and ``macOS`` environments, contained in the ``realm`` package. Both
privacy manifests contain Apple's required API disclosures and the reasons for
using those APIs.

You can view these privacy manifests in the SDK package or directly in the
``realm-dart`` GitHub repository:

- ``iOS``:
`https://github.com/realm/realm-dart/blob/main/packages/realm/ios/Resources/PrivacyInfo.xcprivacy
<https://github.com/realm/realm-dart/blob/main/packages/realm/ios/Resources/PrivacyInfo.xcprivacy>`__
- ``macOS``:
`https://github.com/realm/realm-dart/blob/main/packages/realm/macos/Resources/PrivacyInfo.xcprivacy
<https://github.com/realm/realm-dart/blob/main/packages/realm/macos/Resources/PrivacyInfo.xcprivacy>`__

The Flutter SDK does *not*:

- Include analytics code in builds for the App Store.
- Log into Atlas on its own behalf.

.. important:: Additional Disclosures May Be Required for App Services

The Flutter SDK privacy manifest does *not* include disclosures for App
Services APIs.

If your app uses any Atlas App Services functionality, such as user
authentication or Device Sync, you may need to provide additional disclosures
that detail your data collection and use practices when using these APIs.
For example, if your app
:ref:`initializes an App client <flutter-access-the-app-client>` to:

- :ref:`Call an Atlas Function <flutter-call-function>`
- :ref:`Authenticate and manage users <flutter-work-with-users>`
- :ref:`Open a synced database <flutter-open-synced-realm>`

For more information, refer to Apple's
:apple:`Privacy Manifest Files <documentation/bundleresources/privacy_manifest_files>`
documentation.

0 comments on commit 111fccb

Please sign in to comment.