You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ff-concepts/navigation-routing/deep-dynamic-linking.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,8 +34,8 @@ requires authentication, you'll see a login page. After successful login, you ca
34
34
shared with you.
35
35
36
36
The best thing to note here is that even if the app has a different flow for accessing the page
37
-
content (e.g. Home Page -> All Posts -> Single Post), you can bypass the flow and directly open a
38
-
specific page (e.g. Single Post).
37
+
content (e.g., Home Page -> All Posts -> Single Post), you can bypass the flow and directly open a
38
+
specific page (e.g., Single Post).
39
39
40
40
## Deep Link
41
41
@@ -330,7 +330,7 @@ To share the dynamic link of the page:
330
330
331
331
1. Select the page that you would like to open via a deep link.
332
332
333
-
2. Select any widget (e.g. share button) from the widget tree or the canvas area.
333
+
2. Select any widget (e.g., share button) from the widget tree or the canvas area.
334
334
335
335
3. First, add the action
336
336
to [Generate Current Page Link](generate-current-page-link.md#defining-generate-current-page-link-action).
@@ -799,13 +799,13 @@ the link data, allowing you to perform custom navigation or logic. You can perfo
799
799
800
800
The `handleBranchDeeplink` action receives a `linkData` object that contains all the metadata sent with the link. The `linkData` parameter is a Map containing useful information from the Branch link:
801
801
802
-
- **`$canonical_identifier`:** The original route path used when the link was generated (e.g. `/imageDetails/:id`).
802
+
- **`$canonical_identifier`:** The original route path used when the link was generated (e.g.,`/imageDetails/:id`).
803
803
804
804
- **`~referring_link`:** The full Branch URL that was clicked.
805
805
806
-
- **`page`:** The target page or screen the link is meant to open (e.g. paywall). This is a custom parameter set by the user when generating the link.
806
+
- **`page`:** The target page or screen the link is meant to open (e.g., paywall). This is a custom parameter set by the user when generating the link.
807
807
808
-
- Any custom parameters added during link creation (e.g. `campaign`, `productId`, `referrer`, etc.)
808
+
- Any custom parameters added during link creation (e.g.,`campaign`, `productId`, `referrer`, etc.)
809
809
810
810
This lets you write flexible, conditional navigation logic based on what was shared.
811
811
@@ -863,31 +863,31 @@ This is especially useful when you want to let users:
863
863
864
864
The action accepts the following parameters:
865
865
866
-
- **`canonicalIdentifier`** – A unique path for the content (e.g. `/imageDetails/:id`). This becomes the key reference used when routing the user back into the app.
866
+
- **`canonicalIdentifier`** – A unique path for the content (e.g.,`/imageDetails/:id`). This becomes the key reference used when routing the user back into the app.
867
867
868
868
- **`title`** – The link's title (used in social previews or analytics).
869
869
870
870
- **`description`** – (Optional) A short description of the content.
871
871
872
872
- **`metadata`** – A dynamic map of custom parameters to include with the link
- **`linkProperties`** – A dynamic map for configuring how the link behaves
876
-
(e.g. set the `feature`, `channel`, `campaign`, or `stage` for analytics).
876
+
(e.g., set the `feature`, `channel`, `campaign`, or `stage` for analytics).
877
877
878
878
### Branch Helper Functions
879
879
880
880
These functions help you safely work with deep link data, extract values, and conditionally navigate based on link metadata.
881
881
882
882
- **`isTargetingPage(linkData, targetPage)`** - Checks whether the page value in the link data matches a specific screen name. The `page` parameter is set by the user when generating the link from Branch dashboard or FlutterFlow.
883
883
884
-
- **`getCanonicalIdentifierFromLink(linkData)`** - Returns the canonical path (e.g. `/imageDetails/abc123`) that was originally attached to the smart link. Useful for extracting the base route or content reference associated with the shared link.
884
+
- **`getCanonicalIdentifierFromLink(linkData)`** - Returns the canonical path (e.g.,`/imageDetails/abc123`) that was originally attached to the smart link. Useful for extracting the base route or content reference associated with the shared link.
885
885
886
886
- **`getReferringLinkFromLink(linkData)`** - Retrieves the full Branch smart link URL from the data (typically under the `~referring_link` key). Useful for tracking, analytics, or verifying the source of the link.
887
887
888
-
- **`getLastPathSegmentFromMap(linkData, key)`** - Extracts the last path segment (e.g `abc123`) from a URI stored inside a link data field (e.g. `/imageDetails/abc123`). Useful for extracting the ID from a link.
888
+
- **`getLastPathSegmentFromMap(linkData, key)`** - Extracts the last path segment (e.g.,`abc123`) from a URI stored inside a link data field (e.g.,`/imageDetails/abc123`). Useful for extracting the ID from a link.
889
889
890
-
- **`getLinkValue(linkData, key)`** - Safely retrieves any single value from the link data Map. Returns null if not found. (e.g retrieving `showPromo` attribute value from the `linkData`).
890
+
- **`getLinkValue(linkData, key)`** - Safely retrieves any single value from the link data Map. Returns null if not found. (e.g., retrieving `showPromo` attribute value from the `linkData`).
891
891
892
892
- **`createLinkProperties(...)`** - Returns a Branch Link Properties map used when generating a smart link. You can define values like: feature, campaign, stage, channel, alias or tags or custom fallback URLs. Useful for organizing and tracking generated links for marketing or referrals.
0 commit comments