Skip to content

Commit

Permalink
Add privacy manifest section to Install and Telemetry pages
Browse files Browse the repository at this point in the history
  • Loading branch information
cbullinger committed May 8, 2024
1 parent 94a98fd commit f558680
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 5 deletions.
11 changes: 9 additions & 2 deletions source/sdk/flutter/app-services/call-function.txt
Expand Up @@ -4,15 +4,22 @@
Call an Atlas Function
======================

.. meta::
:description: Call serverless Atlas Functions from a client application with Atlas Device SDK for Flutter.
:keywords: code example

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

.. contents:: On this page
:local:
:backlinks: none
:depth: 3
:class: singlecol


You can call an **Atlas Function** from a client application
using the Realm Flutter SDK.
using the Atlas Device SDK for Flutter.
Functions are serverless JavaScript functions that let you define and execute server-side logic.
These server-side Functions can run in the context
of the authenticated user, and thus honor the rules, roles, and permissions that
Expand Down
45 changes: 45 additions & 0 deletions source/sdk/flutter/install.txt
Expand Up @@ -276,3 +276,48 @@ depending on whether you have a Flutter or Dart standalone app:
and restart the application.
Note that deleting the ``.realm`` file also deletes all data stored in
the database on that client.

.. _flutter-apple-privacy-manifest:

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

.. versionadded:: 2.2.0

Apple requires apps that use required reason APIs to provide details about the
SDK's data collection and use practices when submitting new apps or app updates
to the App Store. For more details about Apple's requirements, refer to
:apple:`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 the privacy manifests in the package or 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.

If you write an app that uses any App Services functionality, you may need to
add additional disclosures to your app's privacy manifest detailing 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:`documentation/bundleresources/privacy_manifest_files` documentation.
17 changes: 17 additions & 0 deletions source/sdk/flutter/telemetry.txt
Expand Up @@ -4,4 +4,21 @@
Telemetry - Flutter SDK
=======================

.. meta::
:description: Atlas Device SDK collects anonymized telemetry during app development but not in production builds.

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

.. include:: /includes/sdk-telemetry.rst

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

The Atlas Device SDK for Flutter does *not* include analytics in builds for the
App Store. Because we do not collect telemetry on those builds, the SDK's Apple
privacy manifest does not mention this telemetry. The SDK's Apple privacy
manifest only covers Apple's API disclosure requirements.

For more details, refer to :ref:`ios-apple-privacy-manifest`.
8 changes: 5 additions & 3 deletions source/sdk/flutter/users.txt
@@ -1,3 +1,5 @@
.. _flutter-work-with-users:

=============================
User Management - Flutter SDK
=============================
Expand Down Expand Up @@ -96,11 +98,11 @@ refer to the following documentation:
Listen for User Changes
-----------------------

You can listen for and react to changes to a user instance. For
example, receive notifications when a user state changes or a user
You can listen for and react to changes to a user instance. For
example, receive notifications when a user state changes or a user
access token is updated.

For more information, refer to
For more information, refer to
:ref:`Register a User Instance Change Listener <flutter-user-change-listener>`.

.. _flutter-app-work-with-custom-user-data:
Expand Down

0 comments on commit f558680

Please sign in to comment.