From 7941e71efc47d14df680748e976abc6fd0c1291e Mon Sep 17 00:00:00 2001 From: matinzd <24797481+matinzd@users.noreply.github.com> Date: Thu, 8 Aug 2024 15:29:17 +0200 Subject: [PATCH] chore(docs): update ts docs for more resolution --- packages/analytics/lib/index.d.ts | 30 +++++++++++------------ packages/analytics/lib/modular/index.d.ts | 20 +++++++-------- 2 files changed, 24 insertions(+), 26 deletions(-) diff --git a/packages/analytics/lib/index.d.ts b/packages/analytics/lib/index.d.ts index 47058005e5..cac30af0ce 100644 --- a/packages/analytics/lib/index.d.ts +++ b/packages/analytics/lib/index.d.ts @@ -1755,48 +1755,46 @@ export namespace FirebaseAnalyticsTypes { setDefaultEventParameters(params?: { [key: string]: any }): Promise; /** - * start privacy-sensitive on-device conversion management. + * Start privacy-sensitive on-device conversion management. * This is iOS-only. - * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile + * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile. * - * @platform ios iOS + * @platform ios * @param emailAddress email address, properly formatted complete with domain name e.g, 'user@example.com' */ initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress: string): Promise; /** - * start privacy-sensitive on-device conversion management. + * Start privacy-sensitive on-device conversion management. * This is iOS-only. - * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile + * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile. + * You need to pass the sha256-hashed of normalized email address to this function. See [this link](https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials) for more information. * - * @platform ios iOS - * @param analytics Analytics instance. + * @platform ios * @param hashedEmailAddress sha256-hashed of normalized email address, properly formatted complete with domain name e.g, 'user@example.com' - * @link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials */ initiateOnDeviceConversionMeasurementWithHashedEmailAddress( hashedEmailAddress: string, ): Poromise; /** - * start privacy-sensitive on-device conversion management. + * Start privacy-sensitive on-device conversion management. * This is iOS-only. - * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile + * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile. * - * @platform ios iOS + * @platform ios * @param phoneNumber phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces. */ initiateOnDeviceConversionMeasurementWithPhoneNumber(phoneNumber: string): Promise; /** - * start privacy-sensitive on-device conversion management. + * Start privacy-sensitive on-device conversion management. * This is iOS-only. - * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile + * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile. + * You need to pass the sha256-hashed of phone number in E.164 format. See [this link](https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials) for more information. * - * @platform ios iOS - * @param analytics Analytics instance. + * @platform ios * @param hashedPhoneNumber sha256-hashed of normalized phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces. - * @link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials */ initiateOnDeviceConversionMeasurementWithHashedPhoneNumber( hashedPhoneNumber: string, diff --git a/packages/analytics/lib/modular/index.d.ts b/packages/analytics/lib/modular/index.d.ts index 3721490970..4287318daf 100644 --- a/packages/analytics/lib/modular/index.d.ts +++ b/packages/analytics/lib/modular/index.d.ts @@ -1153,9 +1153,9 @@ export function setDefaultEventParameters( ): Promise; /** - * start privacy-sensitive on-device conversion management. + * Start privacy-sensitive on-device conversion management. * This is iOS-only. - * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile + * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile. * * @platform ios * @param analytics Analytics instance. @@ -1167,14 +1167,14 @@ export function initiateOnDeviceConversionMeasurementWithEmailAddress( ): Promise; /** - * start privacy-sensitive on-device conversion management. + * Start privacy-sensitive on-device conversion management. * This is iOS-only. - * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile + * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile. + * You need to pass the sha256-hashed of normalized email address to this function. See [this link](https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials) for more information. * * @platform ios * @param analytics Analytics instance. * @param hashedEmailAddress sha256-hashed of normalized email address, properly formatted complete with domain name e.g, 'user@example.com' - * @link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials */ export function initiateOnDeviceConversionMeasurementWithHashedEmailAddress( analytics: Analytics, @@ -1182,9 +1182,9 @@ export function initiateOnDeviceConversionMeasurementWithHashedEmailAddress( ): Poromise; /** - * start privacy-sensitive on-device conversion management. + * Start privacy-sensitive on-device conversion management. * This is iOS-only. - * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile + * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile. * * @platform ios * @param analytics Analytics instance. @@ -1196,14 +1196,14 @@ export function initiateOnDeviceConversionMeasurementWithPhoneNumber( ): Promise; /** - * start privacy-sensitive on-device conversion management. + * Start privacy-sensitive on-device conversion management. * This is iOS-only. - * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile + * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile. + * You need to pass the sha256-hashed of phone number in E.164 format. See [this link](https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials) for more information. * * @platform ios * @param analytics Analytics instance. * @param hashedPhoneNumber sha256-hashed of normalized phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces. - * @link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials */ export function initiateOnDeviceConversionMeasurementWithHashedPhoneNumber( analytics: Analytics,