FIRAnalyticsConfiguration.h 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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. @interface FIRAnalyticsConfiguration : NSObject
  23. /**
  24. * Returns the shared instance of FIRAnalyticsConfiguration.
  25. */
  26. + (FIRAnalyticsConfiguration *)sharedInstance NS_SWIFT_NAME(shared());
  27. /**
  28. * Deprecated.
  29. * Sets the minimum engagement time in seconds required to start a new session. The default value
  30. * is 10 seconds.
  31. */
  32. - (void)setMinimumSessionInterval:(NSTimeInterval)minimumSessionInterval
  33. DEPRECATED_MSG_ATTRIBUTE(
  34. "Sessions are started immediately. More information at https://bit.ly/2FU46av");
  35. /**
  36. * Sets the interval of inactivity in seconds that terminates the current session. The default
  37. * value is 1800 seconds (30 minutes).
  38. */
  39. - (void)setSessionTimeoutInterval:(NSTimeInterval)sessionTimeoutInterval;
  40. /**
  41. * Sets whether analytics collection is enabled for this app on this device. This setting is
  42. * persisted across app sessions. By default it is enabled.
  43. */
  44. - (void)setAnalyticsCollectionEnabled:(BOOL)analyticsCollectionEnabled;
  45. @end
  46. NS_ASSUME_NONNULL_END