Skip to content

Commit

Permalink
Baseurl for remaining SDKs
Browse files Browse the repository at this point in the history
  • Loading branch information
cbullinger committed Apr 4, 2024
1 parent 4a74f14 commit db5ebae
Show file tree
Hide file tree
Showing 8 changed files with 66 additions and 43 deletions.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
You can create multiple App client instances to connect to multiple
Apps. All App client instances that share the same App ID use the same
underlying connection.

.. important:: Changing an App Config After Initializing the App

.. versionchanged:: ``realm@12.6.0``
``baseUrl`` is not cached

When you initialize the App client, the configuration is cached internally.
Attempting to "close" and then re-open an App with a changed configuration
within the same process has no effect. The client continues to use the
cached configuration.

Starting with React Native SDK version 12.6.0, the ``baseUrl`` in the ``AppConfiguration``
is *not* cached. This means that you can change the ``baseUrl``
and the App client will use the updated configuration. In earlier SDK
versions, changes to the ``baseUrl`` in a cached App configuration have no
effect.
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,20 @@ method. The following example sets the LogLevel and the request timeout:
.. literalinclude:: /examples/generated/dotnet/WorkWithRealm.snippet.appConfig.cs
:language: csharp

.. include:: /includes/multiple-app-client-details-and-app-config-cache.rst
You can create multiple App client instances to connect to multiple
Apps. All App client instances that share the same App ID use the same
underlying connection.

.. important:: Changing an App Config After Initializing the App

When you initialize the App client, the configuration is cached internally.
Attempting to "close" and then re-open an App with a changed configuration
within the same process has no effect. The client continues to use the
cached configuration.

In .NET SDK version 11.7.0 and later, the :dotnet-sdk:`BaseUri <reference/Realms.Sync.AppConfiguration.html#Realms_Sync_AppConfiguration_BaseUri>`
is *no longer* cached in the App configuration. This means that you can change the
``BaseUri``, and the App client will use the updated configuration. In
earlier SDK versions, changes to the ``BaseUri`` in a cached App
configuration have no effect.

9 changes: 4 additions & 5 deletions source/sdk/flutter/app-services/connect-to-app.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,10 @@ underlying connection.
cached configuration.

In Flutter SDK version 1.8.0 and later, the :flutter-sdk:`baseUrl <realm/AppConfiguration/baseUrl.html>`
is *not* cached in the App configuration. This means that you can change the
``baseUrl`` - including at runtime - and the App client will use the updated
configuration. In earlier SDK versions, changes to the ``baseUrl`` in a
cached App configuration have no
effect.
is *no longer* cached in the App configuration. This means that you can change the
``baseUrl``, and the App client will use the updated configuration. In
earlier SDK versions, changes to the ``baseUrl`` in a cached App
configuration have no effect.

.. _flutter-app-client-configuration:

Expand Down
21 changes: 20 additions & 1 deletion source/sdk/java/app-services/connect-to-app-services-backend.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
Connect to an Atlas App Services backend - Java SDK
===================================================

.. meta::
:description: Connect your Atlas Device SDK for Java client app to the Atlas App Services backend.
:keywords: code example

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

.. contents:: On this page
:local:
:backlinks: none
Expand Down Expand Up @@ -74,4 +82,15 @@ Builder to control details of your ``App``:
:language: kotlin
:copyable: false

.. include:: /includes/multiple-app-client-details-and-app-config-cache.rst
.. important:: Changing an App Config After Initializing the App

When you initialize the App client, the configuration is cached internally.
Attempting to "close" and then re-open an App with a changed configuration
within the same process has no effect. The client continues to use the
cached configuration.

In Java SDK version 10.18.0 and later, the :ref:`urlPrefix <urlPrefix>`
is *no longer* cached in the App configuration. This means that you can
change the ``urlPrefix``, and the App client will use the updated
configuration. In earlier SDK versions, changes to the ``urlPrefix`` in a
cached App configuration have no effect.
10 changes: 4 additions & 6 deletions source/sdk/node/app-services/connect-to-app-services-backend.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,17 @@ underlying connection.

.. important:: Changing an App Config After Initializing the App

.. versionchanged:: 12.6.0
.. versionchanged:: 12.6.0
``baseUrl`` is not cached

When you initialize the App client, the configuration is cached internally.
Attempting to "close" and then re-open an App with a changed configuration
within the same process has no effect. The client continues to use the
cached configuration.

Starting with Node.js SDK version 12.6.0, the ``baseUrl`` in the ``AppConfiguration``
is *not* cached. This means that you can change the
``baseUrl`` - including at runtime - and the App client will use the updated
configuration. In earlier SDK versions, changes to the ``baseUrl`` in a
cached App configuration have no
effect.
is *not* cached. This means that you can change the ``baseUrl``, and the App
client will use the updated configuration. In earlier SDK versions, changes to the ``baseUrl`` in a cached App configuration have no effect.

.. _node-app-retrieve-client:

Expand Down
2 changes: 1 addition & 1 deletion source/sdk/react-native/api-reference/app-provider.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Wrap any components that need to access the App with ``AppProvider``.
.. literalinclude:: /examples/generated/react-native/ts/app-provider.test.snippet.app-provider.tsx
:language: typescript

.. include:: /includes/multiple-app-client-details-and-app-config-cache.rst
.. include:: /includes/note-rn-multiple-app-clients-and-app-config-cache.rst

Hooks Used with AppProvider
---------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,25 +44,7 @@ in the ``AppProvider`` to authenticate a user.
.. include:: /examples/generated/react-native/v12/use-app.snippet.app-config-imports.tsx.rst
.. include:: /examples/generated/react-native/v12/use-app.snippet.app-config.tsx.rst

You can create multiple App client instances to connect to multiple
Apps. All App client instances that share the same App ID use the same
underlying connection.

.. important:: Changing an App Config After Initializing the App

.. versionchanged:: ``realm@12.6.0``

When you initialize the App client, the configuration is cached internally.
Attempting to "close" and then re-open an App with a changed configuration
within the same process has no effect. The client continues to use the
cached configuration.

Starting with React Native SDK version 12.6.0, the ``baseUrl`` in the ``AppConfiguration``
is *not* cached. This means that you can change the
``baseUrl`` - including at runtime - and the App client will use the updated
configuration. In earlier SDK versions, changes to the ``baseUrl`` in a
cached App configuration have no
effect.
.. include:: /includes/note-rn-multiple-app-clients-and-app-config-cache.rst

.. _react-native-app-retrieve-client:

Expand Down

0 comments on commit db5ebae

Please sign in to comment.