docs(firebase-firestore): update

packages/firebase-dynamic-links/README.md

@@ -79,23 +79,57 @@ For instructions to confirm that your Firebase project is properly configured to
 
 ### Create a dynamic link from parameters
 
-You can create a dynamic link via the Firebase console, your app or even your custom API. To create a dynamic link from parameters with the plugin, call the [buildLink](#buildlink) method on the [DynamicLinks class](#dynamiclinks-class) instance passing it a literal object of parameters or an instance of [DynamiclinkParameters](#dynamiclinkparameters-class) returned by the [createLink](#createlink) or [createShortLink](#createshortlink) method.
+You can create a dynamic link via the Firebase console, your app or even your custom API. To create a dynamic link from parameters with the plugin, call the [buildLink](#buildlink) method on the [DynamicLinks class](#dynamiclinks-class) instance passing it a literal object of parameters or an instance of [DynamiclinkParameters](#dynamiclinkparameters) returned by the [createLink](#createlink) or [createShortLink](#createshortlink) method.
 
+
+#### ShortLinkType
+```ts
+enum ShortLinkType {
+	DEFAULT = 'default',
+	SHORT = 'short',
+	UNGUESSABLE = 'unguessable',
+}
+```
+---
+#### buildLink()
 ```ts
-const link = firebase().dynamicLinks().createShortLink('https://docs.nativescript.org', 'https://triniwiz.page.link');
+dynamicLinks = firebase().dynamicLinks()
 
-		link.social = new DynamicLinkSocialParameters();
-		link.social.imageUrl = 'https://art.nativescript.org/logo/export/NativeScript_Logo_White_Blue_Rounded.png';
+link: string = dynamicLinks.buildLink(linkParameters)
+```
+Builds a dynamic link from parameters and returns the link as a `string`. Use the returned link to direct the user to your desired content.
+
+| Parameter | Type | Description
+|-----------|------|------------
+| `linkParameters` | [DynamicLinkParameters](#dynamiclinkparameters-class) | The dynamic link parameters used to create a dynamic link.
 
-		firebase()
-			.dynamicLinks()
-			.buildLink(link)
-			.then((link) => {
-				console.log('link', link);
-			})
-			.catch((e) => {
-				console.log('dynamicLinks: build error', e);
-			});
+#### onLink()
+```ts
+dynamicLinks: DynamicLinks = firebase().dynamicLinks()
+listener = (link: DynamicLink | null, error: FirebaseError | null) => {
+	// handle the link event
+}
+dynamicLinks.onLink(listener)
+```
+Allows you to add a callback function that gets called when your app's screen is launched by a dynamic link.
+
+| Parameter | Type | Description
+|-----------|-----|------------
+| `listener` | [OnLinkListener](#onlinklistener-type)| The function to be called when the app's screen is launched by a dynamic link.
+
+##### OnLinkListener type
+
+```ts
+type OnLinkListener = (link: DynamicLink | null, error: FirebaseError | null) => void;
+```
+---
+#### resolveLink()
+```ts
+dynamicLinks: DynamicLinks = firebase().dynamicLinks()
+
+dynamicLinks.resolveLink(link).then((dynamicLink: DynamicLink)=>{
+
+})
 ```
 ### Create the parameters of a dynamic link
 
@@ -172,7 +206,7 @@ dynamicLinks = firebase().dynamicLinks()
 
 dynamicLinkParameters: DynamicLinkParameters = dynamicLinks.createLink(link, domainUri)
 ```
-Creates parameters for a dynamic link and returns a [DynamicLinkParameters](#dynamiclinkparameters-class) object to be passed to the method to create a dynamic link.
+Creates parameters for a dynamic link and returns a [DynamicLinkParameters](#dynamiclinkparameters) object to be passed to the method to create a dynamic link.
 
 | Parameter | Type | Description
 |-----------|------|------------
@@ -186,7 +220,7 @@ dynamicLinks = firebase().dynamicLinks()
 
 dynamicLinkParameters: DynamicLinkParameters = dynamicLinks.createShortLink(link, domainUri, shortLinkType)
 ```
-Creates parameters for a dynamic link and returns a [DynamicLinkParameters](#dynamiclinkparameters-class) object to be passed to the method to create a dynamic link.
+Creates parameters for a dynamic link and returns a [DynamicLinkParameters](#dynamiclinkparameters) object to be passed to the method to create a dynamic link.
 
 
 | Parameter | Type | Description
@@ -214,7 +248,7 @@ Builds a dynamic link from parameters and returns the link as a `string`. Use th
 
 | Parameter | Type | Description
 |-----------|------|------------
-| `linkParameters` | [DynamicLinkParameters](#dynamiclinkparameters-class) | The dynamic link parameters used to create a dynamic link.
+| `linkParameters` | [DynamicLinkParameters](#dynamiclinkparameters) | The dynamic link parameters used to create a dynamic link.
 
 #### onLink()
 ```ts
@@ -376,6 +410,137 @@ utmParameters: Record<string, string> = link.utmParameters
 
 For the description of this property, see the description of [getUtmParameters()](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/PendingDynamicLinkData#getUtmParameters()) on the PendingDynamicLinkData class documentation.
 
+Resolves the passed string and returns it as a [DynamicLink](#dynamiclink-object) if it's valid. Otherwise, it returns an error.
+
+| Parameter | Type | Description
+|-----------|------|------------
+| `link` | `string` | The string to be resolved.
+
+---
+
+### DynamicLinkAnalyticsParameters class
+Used to create Analytics parameters for a dynamic link.
+
+#### ios
+```ts
+ios = dynamicLinkAnalyticsParameters.ios
+```
+
+--
+#### android
+```ts
+android = dynamicLinkAnalyticsParameters.android
+```
+
+---
+#### campaign
+```ts
+campaign: undefined | string = dynamicLinkAnalyticsParameters.campign
+```
+
+---
+#### content
+```ts
+content: undefined | string = dynamicLinkAnalyticsParameters.content
+// or
+```
+
+---
+#### source
+```ts
+source: undefined | string = dynamicLinkAnalyticsParameters.source
+```
+
+---
+#### term
+```ts
+term: undefined | string = dynamicLinkAnalyticsParameters.term
+```
+
+### DynamicLinkParameters class
+
+#### analytics
+```ts
+dynamicAnalytics: DynamicLinkAnalyticsParameters = dynamicLinkParameters.analytics
+```
+
+---
+#### android
+```ts
+dynamicLinkParametersAndroid: DynamicLinkAnalyticsParameters = dynamicLinkParameters.android
+```
+
+---
+#### ios
+```ts
+dynamicLinkParametersIOS: DynamicLinkAnalyticsParameters = dynamicLinkParameters.ios
+```
+
+---
+#### domainUriPrefix
+```ts
+dynamicDomainUriPrefix: string = dynamicLinkParameters.domainUriPrefix
+```
+
+The URL prefix of the dynamic link.
+
+---
+#### itunes
+```ts
+dynamicLinkITunesParameters: DynamicLinkITunesParameters = dynamicLinkParameters.itunes
+```
+
+---
+#### navigation
+```ts
+dynamicLinkNavigationParameters: DynamicLinkNavigationParameters = dynamicLinkParameters.navigation
+```
+
+Gets or sets navigation info parameters.
+
+---
+#### social
+```ts
+dynamicLinkSocialParameters: DynamicLinkSocialParameters = dynamicLinkParameters.social
+```
+
+---
+
+### DynamicLink object
+This object represents data of the link received by your app.
+#### ios
+```ts
+linkIOS: FIRDynamicLink = link.ios
+```
+
+---
+#### android
+```ts
+linkAndroid: com.google.firebase.dynamiclinks.PendingDynamicLinkData  = link.android
+```
+
+---
+#### minimumAppVersion
+```ts
+minimumAppVersion: string = link.minimumAppVersion
+```
+For the description of this property, see the description of [getMinimumAppVersion()](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/PendingDynamicLinkData#getMinimumAppVersion()) on the PendingDynamicLinkData class documentation.
+
+---
+#### url
+```ts
+url: string = link.url
+```
+For the description of this property, see the description of [getUrl()](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/PendingDynamicLinkData#getLink()) on the PendingDynamicLinkData class documentation.
+
+---
+#### utmParameters
+```ts
+utmParameters: Record<string, string> = link.utmParameters
+```
+
+For the description of this property, see the description of [getUtmParameters()](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/PendingDynamicLinkData#getUtmParameters()) on the PendingDynamicLinkData class documentation.
+
 ## License
 
 Apache License Version 2.0