Skip to content

Branch: add warning about link generation failures #358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 21, 2025
Merged

Branch: add warning about link generation failures #358

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 37 additions & 5 deletions docs/ff-concepts/navigation-routing/deep-dynamic-linking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,10 +752,36 @@ Here’s a quick demo to show how to configure those values inside your library

<p></p>

**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.

<div style={{
position: 'relative',
paddingBottom: 'calc(56.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding
height: 0,
width: '100%'
}}>
<iframe
src="https://demo.arcade.software/sAGP2IBXMbHMPP4rXRaQ?embed&show_copy_link=true"
title=""
style={{
position: 'absolute',
top: 0,
left: 0,
width: '100%',
height: '100%',
colorScheme: 'light'
}}
frameborder="0"
loading="lazy"
webkitAllowFullScreen
mozAllowFullScreen
allowFullScreen
allow="clipboard-write">
</iframe>
</div>


### Handle Branch Deeplink [Custom Action]

Expand Down Expand Up @@ -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]
Expand All @@ -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.
Expand Down