| | |
| | | /// <li>ad_query</li> |
| | | /// <li>ad_reward</li> |
| | | /// <li>adunit_exposure</li> |
| | | /// <li>app_background</li> |
| | | /// <li>app_clear_data</li> |
| | | /// <li>app_exception</li> |
| | | /// <li>app_remove</li> |
| | |
| | | /// "google_", and "ga_" prefixes are reserved and should not be used. Note that event names are |
| | | /// case-sensitive and that logging two events whose names differ only in case will result in |
| | | /// two distinct events. To manually log screen view events, use the `screen_view` event name. |
| | | /// @param parameters The dictionary of event parameters. Passing nil indicates that the event has |
| | | /// @param parameters The dictionary of event parameters. Passing `nil` indicates that the event has |
| | | /// no parameters. Parameter names can be up to 40 characters long and must start with an |
| | | /// alphabetic character and contain only alphanumeric characters and underscores. Only NSString |
| | | /// and NSNumber (signed 64-bit integer and 64-bit floating-point number) parameter types are |
| | | /// supported. NSString parameter values can be up to 100 characters long. The "firebase_", |
| | | /// "google_", and "ga_" prefixes are reserved and should not be used for parameter names. |
| | | /// alphabetic character and contain only alphanumeric characters and underscores. Only String, |
| | | /// Int, and Double parameter types are supported. String parameter values can be up to 100 |
| | | /// characters long for standard Google Analytics properties, and up to 500 characters long for |
| | | /// Google Analytics 360 properties. The "firebase_", "google_", and "ga_" prefixes are reserved |
| | | /// and should not be used for parameter names. |
| | | + (void)logEventWithName:(NSString *)name |
| | | parameters:(nullable NSDictionary<NSString *, id> *)parameters |
| | | NS_SWIFT_NAME(logEvent(_:parameters:)); |
| | |
| | | /// </ul> |
| | | /// |
| | | /// @param value The value of the user property. Values can be up to 36 characters long. Setting the |
| | | /// value to nil removes the user property. |
| | | /// value to `nil` removes the user property. |
| | | /// @param name The name of the user property to set. Should contain 1 to 24 alphanumeric characters |
| | | /// or underscores and must start with an alphabetic character. The "firebase_", "google_", and |
| | | /// "ga_" prefixes are reserved and should not be used for user property names. |
| | |
| | | /// <a href="https://www.google.com/policies/privacy">Google's Privacy Policy</a> |
| | | /// |
| | | /// @param userID The user ID to ascribe to the user of this app on this device, which must be |
| | | /// non-empty and no more than 256 characters long. Setting userID to nil removes the user ID. |
| | | /// non-empty and no more than 256 characters long. Setting userID to `nil` removes the user ID. |
| | | + (void)setUserID:(nullable NSString *)userID; |
| | | |
| | | /// Sets whether analytics collection is enabled for this app on this device. This setting is |
| | |
| | | /// session terminates. |
| | | + (void)setSessionTimeoutInterval:(NSTimeInterval)sessionTimeoutInterval; |
| | | |
| | | /// Returns the unique ID for this instance of the application or nil if |
| | | /// Asynchronously retrieves the identifier of the current app session. |
| | | /// |
| | | /// The session ID retrieval could fail due to Analytics collection disabled, app session expired, |
| | | /// etc. |
| | | /// |
| | | /// @param completion The completion handler to call when the session ID retrieval is complete. This |
| | | /// handler is executed on a system-defined global concurrent queue. |
| | | /// This completion handler takes the following parameters: |
| | | /// <b>sessionID</b> The identifier of the current app session. The value is undefined if the |
| | | /// request failed. |
| | | /// <b>error</b> An error object that indicates why the request failed, or `nil` if the request |
| | | /// was successful. |
| | | + (void)sessionIDWithCompletion:(void (^)(int64_t sessionID, NSError *_Nullable error))completion; |
| | | |
| | | /// Returns the unique ID for this instance of the application or `nil` if |
| | | /// `ConsentType.analyticsStorage` has been set to `ConsentStatus.denied`. |
| | | /// |
| | | /// @see `FIRAnalytics+Consent.h` |
| | | + (nullable NSString *)appInstanceID; |
| | | |
| | | /// Clears all analytics data for this instance from the device and resets the app instance ID. |
| | | /// FIRAnalyticsConfiguration values will be reset to the default values. |
| | | + (void)resetAnalyticsData; |
| | | |
| | | /// Adds parameters that will be set on every event logged from the SDK, including automatic ones. |
| | |
| | | /// |
| | | /// @param parameters Parameters to be added to the dictionary of parameters added to every event. |
| | | /// They will be added to the dictionary of default event parameters, replacing any existing |
| | | /// parameter with the same name. Valid parameters are NSString and NSNumber (signed 64-bit |
| | | /// integer and 64-bit floating-point number). Setting a key's value to [NSNull null] will clear |
| | | /// that parameter. Passing in a nil dictionary will clear all parameters. |
| | | /// parameter with the same name. Valid parameters are String, Int, and Double. Setting a key's |
| | | /// value to `NSNull()` will clear that parameter. Passing in a `nil` dictionary will clear all |
| | | /// parameters. |
| | | + (void)setDefaultEventParameters:(nullable NSDictionary<NSString *, id> *)parameters; |
| | | |
| | | /// Unavailable. |