FIRAnalyticsConfiguration.h 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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. #import "FIRCoreSwiftNameSupport.h"
  18. NS_ASSUME_NONNULL_BEGIN
  19. /**
  20. * This class provides configuration fields for Firebase Analytics.
  21. */
  22. FIR_SWIFT_NAME(AnalyticsConfiguration)
  23. @interface FIRAnalyticsConfiguration : NSObject
  24. /**
  25. * Returns the shared instance of FIRAnalyticsConfiguration.
  26. */
  27. + (FIRAnalyticsConfiguration *)sharedInstance FIR_SWIFT_NAME(shared());
  28. /**
  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. /**
  34. * Sets the interval of inactivity in seconds that terminates the current session. The default
  35. * value is 1800 seconds (30 minutes).
  36. */
  37. - (void)setSessionTimeoutInterval:(NSTimeInterval)sessionTimeoutInterval;
  38. /**
  39. * Sets whether analytics collection is enabled for this app on this device. This setting is
  40. * persisted across app sessions. By default it is enabled.
  41. */
  42. - (void)setAnalyticsCollectionEnabled:(BOOL)analyticsCollectionEnabled;
  43. @end
  44. NS_ASSUME_NONNULL_END