Skip to content

Commit 66a6d2e

Browse files
Sam3077Salakar
andauthored
docs(firebase_dynamic_links): update readme with up-to-date info (#2692)
Co-authored-by: Mike Diarmid <mike.diarmid@gmail.com>
1 parent 625b7b1 commit 66a6d2e

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

packages/firebase_dynamic_links/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ You can receive a Dynamic Link containing a deep link that takes the user to spe
8181

8282
1. In the [Firebase Console](https://console.firebase.google.com), open the Dynamic Links section.
8383
- Accept the terms of service if you are prompted to do so.
84-
- Take note of your project's Dynamic Links URL prefix, which is displayed at the top of the Dynamic Links page. You need your project's Dynamic Links URL prefix to programmatically create Dynamic Links. A Dynamic Links URL prefix looks like `https://YOUR_SUBDOMAIN.page.link`.
84+
- Take note of your project's Dynamic Links URL prefix, which is displayed at the top of the Dynamic Links page. You need your project's Dynamic Links URL prefix to programmatically create Dynamic Links. Unless you are using a custom domain, a Dynamic Links URL prefix looks like `https://YOUR_SUBDOMAIN.page.link`.
8585

86-
Receiving dynamic links on *iOS* requires a couple more steps than *Android*. If you only want to receive dynamic links on *Android*, skip to step 4. You can also follow a video on the next two steps [here.](https://youtu.be/sFPo296OQqk?t=2m40s)
86+
Receiving dynamic links on *iOS* requires a couple more steps than *Android*. If you only want to receive dynamic links on *Android*, skip to step 5. You can also follow a video on the next two steps [here.](https://youtu.be/KLBjAg6HvG0?t=60)
8787

8888
2. In the **Info** tab of your *iOS* app's Xcode project:
8989
- Create a new **URL Type** to be used for Dynamic Links.
@@ -92,10 +92,23 @@ Receiving dynamic links on *iOS* requires a couple more steps than *Android*. If
9292
3. In the **Capabilities** tab of your app's Xcode project, enable **Associated Domains** and add the following to the **Associated Domains** list:
9393

9494
```
95-
applinks:YOUR_SUBDOMAIN.page.link
95+
applinks:YOUR_URL_PREFIX
9696
```
9797

98-
4. To receive a dynamic link, configure listeners for link callbacks when the application is active or in background calling `onLink` and call the `getInitialLink()` method from `FirebaseDynamicLinks` which gets the link that opened the app (or null if it was not opened via a dynamic link).
98+
Remember not to include `https://` or any slashes or paths in your prefix
99+
100+
4. **If you are using a custom domain** create an key in your `Info.plist` file called `FirebaseDynamicLinksCustomDomains` and set it to your app's Dynamic Link URL prefixes. For example:
101+
102+
```xml
103+
<key>FirebaseDynamicLinksCustomDomains</key>
104+
<array>
105+
<string>https://example.com/promos</string>
106+
<string>https://example.com/links/share</string>
107+
</array>
108+
```
109+
110+
5. To receive a dynamic link, call the `getInitialLink()` method from `FirebaseDynamicLinks` which gets the link that opened the app (or null if it was not opened via a dynamic link)
111+
and configure listeners for link callbacks when the application is active or in background calling `onLink`.
99112

100113
```dart
101114
void main() {

0 commit comments

Comments
 (0)