From 76c1be461ac626e1bbb0c896e2acfdc08bea7d17 Mon Sep 17 00:00:00 2001 From: Salakar Date: Mon, 22 Jul 2019 08:09:55 +0100 Subject: [PATCH] [types][docs] links() -> dynamicLinks() rename --- docs/dynamic-links/android.md | 2 +- docs/dynamic-links/ios.md | 2 +- docs/dynamic-links/quick-start.md | 12 ++--- packages/dynamic-links/lib/index.d.ts | 64 +++++++++++------------ packages/dynamic-links/lib/index.js.flow | 66 ++++++++++++------------ 5 files changed, 73 insertions(+), 73 deletions(-) diff --git a/docs/dynamic-links/android.md b/docs/dynamic-links/android.md index 80ebea6a..3a33dceb 100644 --- a/docs/dynamic-links/android.md +++ b/docs/dynamic-links/android.md @@ -1,6 +1,6 @@ --- title: Android Setup -description: Manually integrate Messaging into your Android application. +description: Manually integrate Dynamic Links into your Android application. --- # Android Manual Linking diff --git a/docs/dynamic-links/ios.md b/docs/dynamic-links/ios.md index e55ed4be..dc343b00 100644 --- a/docs/dynamic-links/ios.md +++ b/docs/dynamic-links/ios.md @@ -1,6 +1,6 @@ --- title: iOS Setup -description: Manually integrate Messaging into your iOS application. +description: Manually integrate Dynamic Links into your iOS application. --- # iOS Manual Linking diff --git a/docs/dynamic-links/quick-start.md b/docs/dynamic-links/quick-start.md index 2e7271cb..b05d9b52 100644 --- a/docs/dynamic-links/quick-start.md +++ b/docs/dynamic-links/quick-start.md @@ -1,32 +1,32 @@ --- title: Quick Start -description: Get to grips with the basics of Messaging in React Native Firebase +description: Getting started with Dynamic Links in React Native Firebase --- -# Messaging Quick Start +# Dynamic Links Quick Start ## Installation Install this module with Yarn: ```bash -yarn add @react-native-firebase/messaging +yarn add @react-native-firebase/dynamic-links ``` > Integrating manually and not via React Native auto-linking? Check the setup instructions for Android & iOS. ## Module usage -Import the Messaging package into your project: +Import the Dynamic Links package into your project: ```js -import messaging from '@react-native-firebase/messaging'; +import dynamicLinks from '@react-native-firebase/dynamic-links'; ``` The package also provides access to the firebase instance: ```js -import { firebase } from '@react-native-firebase/messaging'; +import { firebase } from '@react-native-firebase/dynamic-links'; ``` ### TODO diff --git a/packages/dynamic-links/lib/index.d.ts b/packages/dynamic-links/lib/index.d.ts index 0071190f..aeb08d08 100644 --- a/packages/dynamic-links/lib/index.d.ts +++ b/packages/dynamic-links/lib/index.d.ts @@ -32,12 +32,12 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .analytics.setCampaign('banner') * .analytics.setContent('Click Me'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkAnalyticsParameters { @@ -87,12 +87,12 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .android.setPackageName('io.invertase.testing') * .android.setMinimumVersion('18'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkAndroidParameters { @@ -129,13 +129,13 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .ios.setBundleId('io.invertase.testing') * .ios.setAppStoreId('123456789') * .ios.setMinimumVersion('18'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkIOSParameters { @@ -201,11 +201,11 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .itunes.setAffiliateToken('ABCDEFG'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkITunesParameters { @@ -238,11 +238,11 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .navigation.setForcedRedirectEnabled(true); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkNavigationParameters { @@ -261,12 +261,12 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .social.setTitle('Social Application') * .social.setDescriptionText('A Social Application'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkSocialParameters { @@ -299,12 +299,12 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkParameters { @@ -346,14 +346,14 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildShortLink( + * const link = await firebase.dynamicLinks().buildShortLink( * linkParams, - * firebase.links.ShortLinkType.UNGUESSABLE, + * firebase.dynamicLinks.ShortLinkType.UNGUESSABLE, * ); * ``` */ @@ -382,7 +382,7 @@ export namespace DynamicLinks { * Firebase Dynamic DynamicLinks Statics * * ```js - * firebase.links.X + * firebase.dynamicLinks.X * ``` */ export interface Statics { @@ -402,7 +402,7 @@ export namespace DynamicLinks { * Get the links instance for the **default app**: * * ```js - * const links = firebase.links(); + * const links = firebase.dynamicLinks(); * ``` */ export class Module extends FirebaseModule { @@ -410,19 +410,19 @@ export namespace DynamicLinks { * Creates new parameters which enhance the functionality of a created link. * * To create a DynamicLinkParameters, first populate it by using the setX methods available on the `DynamicLinkParameters` builder classes, - * then pass it to `firebase.links().buildLink(linkParams)` or `firebase.links().buildShortLink(linkParams, type)`. + * then pass it to `firebase.dynamicLinks().buildLink(linkParams)` or `firebase.dynamicLinks().buildShortLink(linkParams, type)`. * * #### Example * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildShortLink( + * const link = await firebase.dynamicLinks().buildShortLink( * linkParams, - * firebase.links.ShortLinkType.UNGUESSABLE, + * firebase.dynamicLinks.ShortLinkType.UNGUESSABLE, * ); * ``` * @@ -437,12 +437,12 @@ export namespace DynamicLinks { * #### Example * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` * * @param dynamicLinkParams An instance of DynamicLinkParameters created via `newDynamicLinkParameters` @@ -461,19 +461,19 @@ export namespace DynamicLinks { * Builds a short Dynamic Link from the provided DynamicLinkParameters instances. * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildShortLink( + * const link = await firebase.dynamicLinks().buildShortLink( * linkParams, - * firebase.links.ShortLinkType.UNGUESSABLE, + * firebase.dynamicLinks.ShortLinkType.UNGUESSABLE, * ); * ``` * * @param dynamicLinkParams An instance of DynamicLinkParameters created via `newDynamicLinkParameters` - * @param shortLinkType The short link type, one of `ShortLinkType` from `firebase.links.ShortLinkType` + * @param shortLinkType The short link type, one of `ShortLinkType` from `firebase.dynamicLinks.ShortLinkType` */ buildShortLink( dynamicLinkParams: DynamicLinkParameters, @@ -485,7 +485,7 @@ export namespace DynamicLinks { * * @deprecated Use `buildShortLink` with the same args instead. * @param dynamicLinkParams An instance of DynamicLinkParameters created via `newDynamicLinkParameters` - * @param shortLinkType The short link type, one of `ShortLinkType` from `firebase.links.ShortLinkType` + * @param shortLinkType The short link type, one of `ShortLinkType` from `firebase.dynamicLinks.ShortLinkType` */ createShortDynamicLink( dynamicLinkParams: DynamicLinkParameters, @@ -501,7 +501,7 @@ export namespace DynamicLinks { * * ```js * async function bootstrapApp() { - * await initialLink = await firebase.links().getInitialLink(); + * await initialLink = await firebase.dynamicLinks().getInitialLink(); * * if (initialLink) { * // Handle dynamic link inside your own application @@ -528,7 +528,7 @@ export namespace DynamicLinks { * }; * * useEffect(() => { - * const unsubscribe = firebase.links().onLink(handleDynamicLink); + * const unsubscribe = firebase.dynamicLinks().onLink(handleDynamicLink); * // When the component unmounts, remove the listener * return unsubscribe; * }, []); diff --git a/packages/dynamic-links/lib/index.js.flow b/packages/dynamic-links/lib/index.js.flow index 39ab0747..9ad30798 100644 --- a/packages/dynamic-links/lib/index.js.flow +++ b/packages/dynamic-links/lib/index.js.flow @@ -25,12 +25,12 @@ import type { ReactNativeFirebaseModule } from '@react-native-firebase/app-types * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .analytics.setCampaign('banner') * .analytics.setContent('Click Me'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkAnalyticsParameters { @@ -80,12 +80,12 @@ export interface DynamicLinkAnalyticsParameters { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .android.setPackageName('io.invertase.testing') * .android.setMinimumVersion('18'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkAndroidParameters { @@ -122,13 +122,13 @@ export interface DynamicLinkAndroidParameters { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .ios.setBundleId('io.invertase.testing') * .ios.setAppStoreId('123456789') * .ios.setMinimumVersion('18'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkIOSParameters { @@ -194,11 +194,11 @@ export interface DynamicLinkIOSParameters { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .itunes.setAffiliateToken('ABCDEFG'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkITunesParameters { @@ -231,11 +231,11 @@ export interface DynamicLinkITunesParameters { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .navigation.setForcedRedirectEnabled(true); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkNavigationParameters { @@ -254,12 +254,12 @@ export interface DynamicLinkNavigationParameters { * #### Example * * ```js - * const linkParams = firebase.links().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); + * const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * linkParams * .social.setTitle('Social Application') * .social.setDescriptionText('A Social Application'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkSocialParameters { @@ -292,12 +292,12 @@ export interface DynamicLinkSocialParameters { * #### Example * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` */ export interface DynamicLinkParameters { @@ -339,14 +339,14 @@ export interface DynamicLinkParameters { * #### Example * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildShortLink( + * const link = await firebase.dynamicLinks().buildShortLink( * linkParams, - * firebase.links.ShortLinkType.UNGUESSABLE, + * firebase.dynamicLinks.ShortLinkType.UNGUESSABLE, * ); * ``` */ @@ -375,7 +375,7 @@ export interface ShortLinkType { * Firebase Dynamic DynamicLinks Statics * * ```js - * firebase.links.X + * firebase.dynamicLinks.X * ``` */ export interface Statics { @@ -395,7 +395,7 @@ export interface Statics { * Get the links instance for the **default app**: * * ```js - * const links = firebase.links(); + * const links = firebase.dynamicLinks(); * ``` */ export interface Module extends ReactNativeFirebaseModule { @@ -403,19 +403,19 @@ export interface Module extends ReactNativeFirebaseModule { * Creates new parameters which enhance the functionality of a created link. * * To create a DynamicLinkParameters, first populate it by using the setX methods available on the `DynamicLinkParameters` builder classes, - * then pass it to `firebase.links().buildLink(linkParams)` or `firebase.links().buildShortLink(linkParams, type)`. + * then pass it to `firebase.dynamicLinks().buildLink(linkParams)` or `firebase.dynamicLinks().buildShortLink(linkParams, type)`. * * #### Example * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildShortLink( + * const link = await firebase.dynamicLinks().buildShortLink( * linkParams, - * firebase.links.ShortLinkType.UNGUESSABLE, + * firebase.dynamicLinks.ShortLinkType.UNGUESSABLE, * ); * ``` * @@ -430,12 +430,12 @@ export interface Module extends ReactNativeFirebaseModule { * #### Example * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildLink(linkParams); + * const link = await firebase.dynamicLinks().buildLink(linkParams); * ``` * * @param dynamicLinkParams An instance of DynamicLinkParameters created via `newDynamicLinkParameters` @@ -454,19 +454,19 @@ export interface Module extends ReactNativeFirebaseModule { * Builds a short Dynamic Link from the provided DynamicLinkParameters instances. * * ```js - * const linkParams = firebase.links() + * const linkParams = firebase.dynamicLinks() * .newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link'); * * linkParams.analytics.setCampaign('banner'); * - * const link = await firebase.links().buildShortLink( + * const link = await firebase.dynamicLinks().buildShortLink( * linkParams, - * firebase.links.ShortLinkType.UNGUESSABLE, + * firebase.dynamicLinks.ShortLinkType.UNGUESSABLE, * ); * ``` * * @param dynamicLinkParams An instance of DynamicLinkParameters created via `newDynamicLinkParameters` - * @param shortLinkType The short link type, one of `ShortLinkType` from `firebase.links.ShortLinkType` + * @param shortLinkType The short link type, one of `ShortLinkType` from `firebase.dynamicLinks.ShortLinkType` */ buildShortLink( dynamicLinkParams: DynamicLinkParameters, @@ -478,7 +478,7 @@ export interface Module extends ReactNativeFirebaseModule { * * @deprecated Use `buildShortLink` with the same args instead. * @param dynamicLinkParams An instance of DynamicLinkParameters created via `newDynamicLinkParameters` - * @param shortLinkType The short link type, one of `ShortLinkType` from `firebase.links.ShortLinkType` + * @param shortLinkType The short link type, one of `ShortLinkType` from `firebase.dynamicLinks.ShortLinkType` */ createShortDynamicLink( dynamicLinkParams: DynamicLinkParameters, @@ -494,7 +494,7 @@ export interface Module extends ReactNativeFirebaseModule { * * ```js * async function bootstrapApp() { - * await initialLink = await firebase.links().getInitialLink(); + * await initialLink = await firebase.dynamicLinks().getInitialLink(); * * if (initialLink) { * // Handle dynamic link inside your own application @@ -521,7 +521,7 @@ export interface Module extends ReactNativeFirebaseModule { * }; * * useEffect(() => { - * const unsubscribe = firebase.links().onLink(handleDynamicLink); + * const unsubscribe = firebase.dynamicLinks().onLink(handleDynamicLink); * // When the component unmounts, remove the listener * return unsubscribe; * }, []); @@ -545,7 +545,7 @@ declare module '@react-native-firebase/dynamic-links' { * @example * ```js * import { firebase } from '@react-native-firebase/dynamic-links'; - * firebase.links().X(...); + * firebase.dynamicLinks().X(...); * ``` */ declare export var firebase: {} & ReactNativeFirebaseNamespace;