@react-native-firebase/analytics 20.3.0 → 20.5.0

package/lib/modular/index.d.ts

@@ -1143,6 +1143,7 @@ export function logViewSearchResults(
  * For Web, the values passed persist on the current page and are passed with all
  * subsequent events.
  *
+ * @platform ios
  * @param analytics Analytics instance.
  * @param params Parameters to be added to the map of parameters added to every event.
  */
@@ -1152,10 +1153,11 @@ export function setDefaultEventParameters(
 ): Promise<void>;
 
 /**
- * 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.
  * @param emailAddress email address, properly formatted complete with domain name e.g, 'user@example.com'
  */
@@ -1165,10 +1167,26 @@ export function initiateOnDeviceConversionMeasurementWithEmailAddress(
 ): Promise<void>;
 
 /**
- * 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'
+ */
+export function initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
+  analytics: Analytics,
+  hashedEmailAddress: string,
+): Poromise<void>;
+
+/**
+ * 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.
+ *
+ * @platform ios
  * @param analytics Analytics instance.
  * @param phoneNumber phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
  */
@@ -1177,6 +1195,21 @@ export function initiateOnDeviceConversionMeasurementWithPhoneNumber(
   phoneNumber: string,
 ): Promise<void>;
 
+/**
+ * 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.
+ * 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.
+ */
+export function initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
+  analytics: Analytics,
+  hashedPhoneNumber: string,
+): Promise<void>;
+
 /**
  * Checks four different things.
  * 1. Checks if it's not a browser extension environment.
@@ -1210,3 +1243,13 @@ export function setConsent(
  * @returns {void}
  */
 export function settings(options: FirebaseAnalyticsTypes.SettingsOptions): void;
+
+/**
+ * Retrieves the session id from the client.
+ * On iOS, Firebase SDK may return an error that is handled internally and may take many minutes to return a valid value. Check native debug logs for more details.
+ *
+ * Returns the session id or null if session is expired, null on android if FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE has been set to FirebaseAnalytics.ConsentStatus.DENIED and null on iOS if ConsentType.analyticsStorage has been set to ConsentStatus.denied.
+ * @param {Analytics} instance.
+ * @returns {Promise<number | null>}
+ */
+export function getSessionId(analytics: Analytics): Promise<number | null>;