Skip to content

Commit dea7109

Browse files
authored
Create Readme.md file for having release notes (#6023)
Create Readme.md file for having release notes For Dynamic links iOS SDK, we don't have a place to communicate the latest changes in the release to 3p developers. Adding a readme.md file to inform developers on the recent changes in SDK release and other info that developers should be aware of.
1 parent ec018dc commit dea7109

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

FirebaseDynamicLinks/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
- [fixed] Reduce frequency of iOS14 pasteboard notifications by only reading from it when it contains URL(s). (#5905)
55
- [changed] Functionally neutral updated import references for dependencies. (#5824)
66

7+
Refer to the [README.md](https://github.com/firebase/firebase-ios-sdk/blob/master/FirebaseDynamicLinks/README.md) for more details about this release.
8+
79
# v4.1.0
810
- [fixed] Fixing unwanted pending dynamic links checks on subsequent app restarts. (#5665)
911

FirebaseDynamicLinks/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Firebase Dynamic Links SDK for iOS
2+
3+
Firebase Dynamic Links are universal deep links that persist across app installs.
4+
For more info, see the [Firebase website](https://firebase.google.com/products/dynamic-links).
5+
6+
Please visit [our developer site](https://firebase.google.com/docs/dynamic-links/) for integration
7+
instructions, documentations, support information, and terms of service.
8+
9+
## Managing the Pasteboard
10+
11+
Firebase Dynamic Links 4.2.0 and higher use a plist property
12+
`FirebaseDeepLinkPasteboardRetrievalEnabled` that a developer can set to enable/disable the use of
13+
iOS pasteboard by the SDK.
14+
15+
FDL SDK uses the pasteboard for deep-linking post app install (to enable deferred deep-linking,
16+
where the link is copied on the
17+
[app preview page](https://firebase.google.com/docs/dynamic-links/link-previews#app_preview_pages))
18+
and app install attribution; otherwise, FDL does not use the pasteboard for anything else.
19+
20+
Disabling pasteboard access affects the app in the following ways:
21+
* Deferred deep-linking will not work as reliably. At best, your app receives
22+
[weak matches](https://firebase.google.com/docs/reference/unity/namespace/firebase/dynamic-links#linkmatchstrength)
23+
for deep-links.
24+
* App install attribution stats will be less accurate (potentially undercounting app installs).
25+
26+
Enabling pasteboard access affects the app in the following ways:
27+
* On iOS 14, will show a system alert notifying that your app accessed the content in the
28+
pasteboard. This should happen one-time after installation of the app.
29+
* Deferred deep-linking will work as designed. At best, your app receives a
30+
[perfect match](https://firebase.google.com/docs/reference/unity/namespace/firebase/dynamic-links#linkmatchstrength)
31+
for deep-links.
32+
* SDK will be able to more reliably attribute installation stats for links.
33+
34+
For more information, check out the
35+
[iOS documentation](https://firebase.google.com/docs/dynamic-links/ios/receive).

0 commit comments

Comments
 (0)