FIRAnalyticsConfiguration.h 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. /*
  2. * Copyright 2017 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. NS_ASSUME_NONNULL_BEGIN
  18. /**
  19. * This class provides configuration fields for Firebase Analytics.
  20. */
  21. NS_SWIFT_NAME(AnalyticsConfiguration)
  22. DEPRECATED_MSG_ATTRIBUTE("Use these methods directly on the `Analytics` class.")
  23. @interface FIRAnalyticsConfiguration : NSObject
  24. /**
  25. * Returns the shared instance of FIRAnalyticsConfiguration.
  26. */
  27. + (FIRAnalyticsConfiguration *)sharedInstance NS_SWIFT_NAME(shared());
  28. /**
  29. * Deprecated.
  30. * Sets the minimum engagement time in seconds required to start a new session. The default value
  31. * is 10 seconds.
  32. */
  33. - (void)setMinimumSessionInterval:(NSTimeInterval)minimumSessionInterval
  34. DEPRECATED_MSG_ATTRIBUTE(
  35. "Sessions are started immediately. More information at https://bit.ly/2FU46av");
  36. /**
  37. * Sets the interval of inactivity in seconds that terminates the current session. The default
  38. * value is 1800 seconds (30 minutes).
  39. */
  40. - (void)setSessionTimeoutInterval:(NSTimeInterval)sessionTimeoutInterval;
  41. /**
  42. * Sets whether analytics collection is enabled for this app on this device. This setting is
  43. * persisted across app sessions. By default it is enabled.
  44. */
  45. - (void)setAnalyticsCollectionEnabled:(BOOL)analyticsCollectionEnabled;
  46. @end
  47. NS_ASSUME_NONNULL_END