iOS/Pods/FirebaseCore/Firebase/Core/Public/FIRAnalyticsConfiguration.h

   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
  17 #import <Foundation/Foundation.h>
  18
  19 NS_ASSUME_NONNULL_BEGIN
  20
  21 /**
  22  * This class provides configuration fields for Firebase Analytics.
  23  */
  24 NS_SWIFT_NAME(AnalyticsConfiguration)
  25 @interface FIRAnalyticsConfiguration : NSObject
  26
  27 /**
  28  * Returns the shared instance of FIRAnalyticsConfiguration.
  29  */
  30 + (FIRAnalyticsConfiguration *)sharedInstance NS_SWIFT_NAME(shared());
  31
  32 /**
  33  * Sets the minimum engagement time in seconds required to start a new session. The default value
  34  * is 10 seconds.
  35  */
  36 - (void)setMinimumSessionInterval:(NSTimeInterval)minimumSessionInterval;
  37
  38 /**
  39  * Sets the interval of inactivity in seconds that terminates the current session. The default
  40  * value is 1800 seconds (30 minutes).
  41  */
  42 - (void)setSessionTimeoutInterval:(NSTimeInterval)sessionTimeoutInterval;
  43
  44 /**
  45  * Sets whether analytics collection is enabled for this app on this device. This setting is
  46  * persisted across app sessions. By default it is enabled.
  47  */
  48 - (void)setAnalyticsCollectionEnabled:(BOOL)analyticsCollectionEnabled;
  49
  50 @end
  51
  52 NS_ASSUME_NONNULL_END