From 767dc93252612ca7fc9b2959641b9d5ecad989d6 Mon Sep 17 00:00:00 2001 From: PoojaB26 Date: Thu, 22 May 2025 02:16:26 +0530 Subject: [PATCH] add warning about link generation failures --- .../deep-dynamic-linking.md | 42 ++++++++++++++++--- 1 file changed, 37 insertions(+), 5 deletions(-) diff --git a/docs/ff-concepts/navigation-routing/deep-dynamic-linking.md b/docs/ff-concepts/navigation-routing/deep-dynamic-linking.md index 13f6f647..42f31545 100644 --- a/docs/ff-concepts/navigation-routing/deep-dynamic-linking.md +++ b/docs/ff-concepts/navigation-routing/deep-dynamic-linking.md @@ -752,10 +752,36 @@ Here’s a quick demo to show how to configure those values inside your library

-**Initialize the Branch SDK** +#### Initialize the Branch SDK Open your `main.dart` file in FlutterFlow and add the `initBranch` custom action under the **Final Actions** section. This ensures the **Branch SDK** is initialized when your app launches. +
+ +
+ ### Handle Branch Deeplink [Custom Action] @@ -847,11 +873,11 @@ Use the link data from this callback to: - Load content from Firestore using a referenced ID. -:::danger[Testing Deeplinks] -It’s recommended to test deep links on a **physical device**, as link verification (especially for Universal Links or App Links) may not consistently work on emulators or simulators. -::: +:::danger[Testing Deeplinks] +It’s recommended to test deep links on a **physical device**, as link verification (especially for Universal Links or App Links) may not consistently work on emulators or simulators. We recommend using **[Local Run](../../testing-deployment-publishing/running-your-app/local-run.md)** to run your apps on physical devices. +::: ### Generate Link [Custom Action] @@ -873,11 +899,17 @@ The action accepts the following parameters: - **`description`** – (Optional) A short description of the content. - **`metadata`** – A dynamic map of custom parameters to include with the link -(e.g., page: "imageDetails", imageRef: "abc123", etc.) +(e.g., page: "imageDetails", imageRef: "abc123", etc.). - **`linkProperties`** – A dynamic map for configuring how the link behaves (e.g., set the `feature`, `channel`, `campaign`, or `stage` for analytics). +:::warning[JSON maps] +Due to a limitation, if you plan to leave map-type variables (like `metadata` or `linkProperties`) empty, you must still pass them as **empty maps**, not `null`. +Ensure all keys and values are **plain strings**, avoid nested JSON or non-string types. +Incorrect structure may cause the Link Generation action to fail silently. +::: + ### Branch Helper Functions These functions help you safely work with deep link data, extract values, and conditionally navigate based on link metadata.