From bcb704dd1c814896391d166e89b348f8f9190e7d Mon Sep 17 00:00:00 2001 From: Omer Levy Date: Sun, 8 Oct 2017 13:12:01 +0300 Subject: [PATCH] [docs] minor fixes at links docs --- docs/installation-android.md | 2 +- docs/installation-ios.md | 8 ++++---- docs/modules/links.md | 7 ++++--- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/installation-android.md b/docs/installation-android.md index aa1815c5..59eb8600 100644 --- a/docs/installation-android.md +++ b/docs/installation-android.md @@ -210,7 +210,7 @@ dependencies { } ``` -## 5) Dynamic Links (optional) +## 7) Dynamic Links (optional) If you plan on using [Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/): diff --git a/docs/installation-ios.md b/docs/installation-ios.md index c15166cd..4f6ba9cf 100644 --- a/docs/installation-ios.md +++ b/docs/installation-ios.md @@ -162,21 +162,21 @@ https://firebase.googleblog.com/2017/01/debugging-firebase-cloud-messaging-on.ht -## 4) Dynamic Links (optional) +## 5) Dynamic Links (optional) If you plan on using [Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/) then, you need to: -### 4.1) create a new URL type +### 5.1) create a new URL type In the Info tab of your app's Xcode project, create a new URL type to be used for Dynamic Links. Set the Identifier field to a unique value and the URL scheme field to either your bundle identifier or a unique value. -### 4.2) Enable Associated Domains capability +### 5.2) Enable Associated Domains capability In the Capabilities tab of your app's Xcode project, enable Associated Domains and add the following to the Associated Domains list: `applinks:app_code.app.goo.gl` where `app_code` is your dynamic links domain application code. -### 4.3) Update `AppDelegate.m` +### 5.3) Update `AppDelegate.m` Add the following import: diff --git a/docs/modules/links.md b/docs/modules/links.md index 276e5d31..15615aaf 100644 --- a/docs/modules/links.md +++ b/docs/modules/links.md @@ -90,8 +90,9 @@ Only the following parameters are currently supported: } } ``` +?> Please note that when using `androidInfo` or `iosInfo`, `androidPackageName` and `iosBundleId` are mandatory (respectively). -For more information ([see reference](https://firebase.google.com/docs/reference/dynamic-links/link-shortener)) +For more information [see reference](https://firebase.google.com/docs/reference/dynamic-links/link-shortener) ## Receive Dynamic Links @@ -99,7 +100,7 @@ For more information ([see reference](https://firebase.google.com/docs/reference #### `getInitialLink(): Promise` -Call getInitialLink to access the URL that the app has been launched from. +Call getInitialLink to access the URL that the app has been launched from. If the app was not launched from a URL, the return value is null. ```javascript firebase.links().getInitialLink().then((url) => { @@ -111,7 +112,7 @@ firebase.links().getInitialLink().then((url) => { On a new URL, the payload URL is passed to the listener callback. This method is only triggered when the app is running. Use getInitialLink for URLs which cause the app to open. In order to subscribe to the listener, call to the method with a callback and save the returned function. -When you want to unsubscribe, just call the method that returned at subscription. +When you want to unsubscribe, just call the function that returned at subscription. ```javascript // Subscribe