Mark dynamic links as deprecated. (#925)

Co-authored-by: a-maurice <[email protected]>

Author: jonsimantov

docs/readme.md

@@ -6,20 +6,20 @@ features on *iOS*, *tvOS* and *Android*.
 
 Note: Firebase Dynamic Links is not supported on tvOS.
 
-| Feature                            | Unity Package                     |
-|:----------------------------------:|:---------------------------------:|
-| Firebase Analytics                 | FirebaseAnalytics.unitypackage    |
-| Firebase App Check                 | FirebaseAppCheck.unitypackage     |
-| Firebase Authentication            | FirebaseAuth.unitypackage         |
-| Firebase Crashlytics               | FirebaseCrashlytics.unitypackage  |
-| Firebase Dynamic Links             | FirebaseDynamicLinks.unitypackage |
-| Cloud Firestore                    | FirebaseFirestore.unitypackage    |
-| Firebase Functions                 | FirebaseFunctions.unitypackage    |
-| Firebase Installations             | FirebaseInstallations.unitypackage|
-| Firebase Messaging                 | FirebaseMessaging.unitypackage    |
-| Firebase Realtime Database         | FirebaseDatabase.unitypackage     |
-| Firebase Remote Config             | FirebaseRemoteConfig.unitypackage |
-| Firebase Storage                   | FirebaseStorage.unitypackage      |
+| Feature                             | Unity Package                     |
+|:-----------------------------------:|:---------------------------------:|
+| Firebase Analytics                  | FirebaseAnalytics.unitypackage    |
+| Firebase App Check                  | FirebaseAppCheck.unitypackage     |
+| Firebase Authentication             | FirebaseAuth.unitypackage         |
+| Firebase Crashlytics                | FirebaseCrashlytics.unitypackage  |
+| Firebase Dynamic Links (deprecated) | FirebaseDynamicLinks.unitypackage |
+| Cloud Firestore                     | FirebaseFirestore.unitypackage    |
+| Firebase Functions                  | FirebaseFunctions.unitypackage    |
+| Firebase Installations              | FirebaseInstallations.unitypackage|
+| Firebase Messaging                  | FirebaseMessaging.unitypackage    |
+| Firebase Realtime Database          | FirebaseDatabase.unitypackage     |
+| Firebase Remote Config              | FirebaseRemoteConfig.unitypackage |
+| Firebase Storage                    | FirebaseStorage.unitypackage      |
 
 The SDK provides .NET 4.x compatible packages
 
@@ -71,6 +71,12 @@ Support
 
 Release Notes
 -------------
+### Upcoming release
+- Changes
+    - Dynamic Links: The Dynamic Links SDK is now deprecated. See the [support
+      documentation](https://firebase.google.com/support/dynamic-links-faq)
+      for more information.
+
 ### 11.7.0
 - Changes
     - General: Update to Firebase C++ SDK version 11.8.0.

dynamic_links/src/DynamicLinks.cs

@@ -22,6 +22,7 @@ namespace Firebase.DynamicLinks {
 ///
 /// Firebase Dynamic Links is a cross-platform solution for generating and
 /// receiving links, whether or not the app is already installed.
+[System.Obsolete("Firebase Dynamic Links is deprecated and will be removed in a future release..", false)]
 public sealed class DynamicLinks {
   // Keep a reference to FirebaseApp as it initializes this SDK.
   private static Firebase.FirebaseApp app;
@@ -75,6 +76,10 @@ internal static void NotifyDynamicLinkReceived(ReceivedDynamicLink dynamicLink)
   /// and shorten.
   /// @param options Optionally provided options to tweak the short link generation.
   /// If this is not specified the default behavior is for PathLength = PathLength.Unguessable.
+  ///
+  /// @deprecated Dynamic Links is now deprecated. Please see the support
+  /// documentation at https://firebase.google.com/support/dynamic-links-faq
+  /// for more information.
   public static Task<ShortDynamicLink> GetShortLinkAsync(DynamicLinkComponents components,
       DynamicLinkOptions options) {
     return ConvertFromInternalTask(FirebaseDynamicLinks.GetShortLinkInternalAsync(
@@ -85,6 +90,10 @@ public static Task<ShortDynamicLink> GetShortLinkAsync(DynamicLinkComponents com
   ///
   /// @param components The components that define the Dynamic Link to create
   /// and shorten.
+  ///
+  /// @deprecated Dynamic Links is now deprecated. Please see the support
+  /// documentation at https://firebase.google.com/support/dynamic-links-faq
+  /// for more information.
   public static Task<ShortDynamicLink> GetShortLinkAsync(DynamicLinkComponents components) {
     return GetShortLinkAsync(components, new DynamicLinkOptions());
   }
@@ -94,6 +103,10 @@ public static Task<ShortDynamicLink> GetShortLinkAsync(DynamicLinkComponents com
   /// @param url A properly-formatted long Dynamic Link to shorten.
   /// @param options Optionally provided options to tweak the short link generation.
   /// If this is not specified the default behavior is for PathLength = PathLength.Unguessable.
+  ///
+  /// @deprecated Dynamic Links is now deprecated. Please see the support
+  /// documentation at https://firebase.google.com/support/dynamic-links-faq
+  /// for more information.
   public static Task<ShortDynamicLink> GetShortLinkAsync(System.Uri longDynamicLink,
       DynamicLinkOptions options) {
     return ConvertFromInternalTask(FirebaseDynamicLinks.GetShortLinkInternalAsync(
@@ -104,6 +117,10 @@ public static Task<ShortDynamicLink> GetShortLinkAsync(System.Uri longDynamicLin
   /// Creates a shortened Dynamic Link from the given long dynamic link.
   ///
   /// @param url A properly-formatted long Dynamic Link to shorten.
+  ///
+  /// @deprecated Dynamic Links is now deprecated. Please see the support
+  /// documentation at https://firebase.google.com/support/dynamic-links-faq
+  /// for more information.
   public static Task<ShortDynamicLink> GetShortLinkAsync(System.Uri long_dynamic_link) {
     return GetShortLinkAsync(long_dynamic_link, new DynamicLinkOptions());
   }