From db5ebae0245949ef422ed21b86300fbd6c3d1a76 Mon Sep 17 00:00:00 2001 From: cbullinger Date: Thu, 4 Apr 2024 11:10:07 -0400 Subject: [PATCH] Baseurl for remaining SDKs --- ...pp-client-details-and-app-config-cache.rst | 10 --------- ...tiple-app-clients-and-app-config-cache.rst | 19 +++++++++++++++++ .../connect-to-app-services-backend.txt | 18 +++++++++++++++- .../flutter/app-services/connect-to-app.txt | 9 ++++---- .../connect-to-app-services-backend.txt | 21 ++++++++++++++++++- .../connect-to-app-services-backend.txt | 10 ++++----- .../api-reference/app-provider.txt | 2 +- .../connect-to-app-services-app.txt | 20 +----------------- 8 files changed, 66 insertions(+), 43 deletions(-) delete mode 100644 source/includes/multiple-app-client-details-and-app-config-cache.rst create mode 100644 source/includes/note-rn-multiple-app-clients-and-app-config-cache.rst diff --git a/source/includes/multiple-app-client-details-and-app-config-cache.rst b/source/includes/multiple-app-client-details-and-app-config-cache.rst deleted file mode 100644 index 8324feb77b4..00000000000 --- a/source/includes/multiple-app-client-details-and-app-config-cache.rst +++ /dev/null @@ -1,10 +0,0 @@ -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:: You Can't Change an App Config After Initializing the App - - When you initialize the App client, the configuration is cached internally. - Attempting to "close" an App and then re-open it with a changed - configuration within the same process has no effect. The client - continues to use the cached configuration. diff --git a/source/includes/note-rn-multiple-app-clients-and-app-config-cache.rst b/source/includes/note-rn-multiple-app-clients-and-app-config-cache.rst new file mode 100644 index 00000000000..3104b6cced5 --- /dev/null +++ b/source/includes/note-rn-multiple-app-clients-and-app-config-cache.rst @@ -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. diff --git a/source/sdk/dotnet/app-services/connect-to-app-services-backend.txt b/source/sdk/dotnet/app-services/connect-to-app-services-backend.txt index be2b3fc2f49..35285f95177 100644 --- a/source/sdk/dotnet/app-services/connect-to-app-services-backend.txt +++ b/source/sdk/dotnet/app-services/connect-to-app-services-backend.txt @@ -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 ` + 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. + diff --git a/source/sdk/flutter/app-services/connect-to-app.txt b/source/sdk/flutter/app-services/connect-to-app.txt index 898c985032c..ef1a66da2cd 100644 --- a/source/sdk/flutter/app-services/connect-to-app.txt +++ b/source/sdk/flutter/app-services/connect-to-app.txt @@ -68,11 +68,10 @@ underlying connection. cached configuration. In Flutter SDK version 1.8.0 and later, the :flutter-sdk:`baseUrl ` - 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: diff --git a/source/sdk/java/app-services/connect-to-app-services-backend.txt b/source/sdk/java/app-services/connect-to-app-services-backend.txt index 0aa29bba708..e9d9fdecad3 100644 --- a/source/sdk/java/app-services/connect-to-app-services-backend.txt +++ b/source/sdk/java/app-services/connect-to-app-services-backend.txt @@ -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 @@ -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 ` + 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. diff --git a/source/sdk/node/app-services/connect-to-app-services-backend.txt b/source/sdk/node/app-services/connect-to-app-services-backend.txt index 2680609bd0d..262e5490b24 100644 --- a/source/sdk/node/app-services/connect-to-app-services-backend.txt +++ b/source/sdk/node/app-services/connect-to-app-services-backend.txt @@ -50,7 +50,8 @@ 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 @@ -58,11 +59,8 @@ underlying connection. 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: diff --git a/source/sdk/react-native/api-reference/app-provider.txt b/source/sdk/react-native/api-reference/app-provider.txt index 3eb27606678..7fc1dbadb0e 100644 --- a/source/sdk/react-native/api-reference/app-provider.txt +++ b/source/sdk/react-native/api-reference/app-provider.txt @@ -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 --------------------------- diff --git a/source/sdk/react-native/app-services/connect-to-app-services-app.txt b/source/sdk/react-native/app-services/connect-to-app-services-app.txt index 8c3283764b7..1cbe022531a 100644 --- a/source/sdk/react-native/app-services/connect-to-app-services-app.txt +++ b/source/sdk/react-native/app-services/connect-to-app-services-app.txt @@ -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: