Skip to content

docs(fdl-ktx): document the Kotlin destructuring declarations #1879

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.

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
Nov 10, 2020
Merged
Changes from all commits
Commits
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
37 changes: 33 additions & 4 deletions docs/ktx/dynamic-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ FirebaseDynamicLinks.getInstance().createDynamicLink()
// Short link created
val shortLink = result.shortLink
val flowchartLink = result.previewLink
val warnings = result.warnings

// do something with the links and warnings
showLinks(shortLink, flowchartLink)
displayWarnings(warnings)
}
.addOnFailureListener {
// Error
Expand All @@ -114,10 +119,10 @@ FirebaseDynamicLinks.getInstance().createDynamicLink()
Firebase.dynamicLinks.shortLinkAsync {
longLink = Uri.parse("https://example.page.link/?link=" +
"https://www.example.com/&apn=com.example.android&ibn=com.example.ios")
}.addOnSuccessListener { result ->
// Short link created
val shortLink = result.shortLink
val flowchartLink = result.previewLink
}.addOnSuccessListener { (shortLink, flowchartLink, warnings) ->
// do something with the links and warnings
showLinks(shortLink, flowchartLink)
displayWarnings(warnings)
}.addOnFailureListener {
// Error
// ...
Expand All @@ -139,3 +144,27 @@ val shortLinkTask = Firebase.dynamicLinks.shortLinkAsync(ShortDynamicLink.Suffix
// ...
}
```

### Receive deep links

**Kotlin**
```kotlin
Firebase.dynamicLinks
.getDynamicLink(intent)
.addOnSuccessListener(this) { pendingDynamicLinkData ->
val deepLink = pendingDynamicLinkData.link
val minAppVersion = pendingDynamicLinkData.minimumAppVersion
val clickTimestamp = pendingDynamicLinkData.clickTimestamp

// TODO(developer): handle the deepLink
}.addOnFailureListener { /* ... */ }
```

**Kotlin + KTX**
```kotlin
Firebase.dynamicLinks
.getDynamicLink(intent)
.addOnSuccessListener(this) { (deepLink, minAppVersion, clickTimestamp) ->
// TODO(developer): handle the deepLink
}.addOnFailureListener { /* ... */ }
```