Files
firebase-ios-sdk/FirebaseInAppMessaging/Sources/Private/Analytics/FIRIAMClearcutUploader.h
T
christibbs 48aa5ed5ee FIAM Consolidation (#4705)
* Move display SDK source and resources into FIAM SDK

* Change files prefixed with FID to be prefixed FIRIAM

* Restructure example apps in firebase-ios-sdk directory

* Fix directory structure for FIAM

* Move proto files into base directory

* Fix up proto files

* Move unit test files to Firebase/InAppMessaging/Tests

* Move FIRIAMSDKModeManagerTests and require app host in podspec

* Move sample apps to tests folder

* Add empty repo for FIAMDisplay that generates a warning

* Fix up functional tests app

* Fix up default UI test app

* Re-generate protos

* Add warning to remove display pod

* Remove display podspec from .travis.yml

* Remove trailing whitespace

* Fix import in test app

* Add changes to point to the default test app

* Wrap iOS version conditionals

* Add line in podspec about deprecation

* Delete whitespace in podspec

* Delete pods section in project file

* Update changelog with consolidation info

* Fix indentation in podspecs

* Fix some import issues

* Fix indent on FirebaseInAppMessaging.podspec

* Delete FirebaseInAppMessagingDisplay, update podfile for external test app

* Update podfiles, bump iOS min version to 9, remove iOS 9 checks in FIRIAMActionUrlFollowerTests

*  Add line in CHANGELOG referencing deletion of display sdk pod

* Remove unused podfile

* Update min version on Podfiles to iOS 9

* Add back FirebaseInAppMessagingDisplay.h

* Add iOS support message to CHANGELOG.md

* Wrap necessary deprecated iOS 9 call
2020-01-22 10:57:00 -05:00

76 lines
3.0 KiB
Objective-C

/*
* Copyright 2018 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
@class FIRIAMClearcutLogRecord;
@class FIRIAMClearcutHttpRequestSender;
@class FIRIAMClearcutLogStorage;
@protocol FIRIAMTimeFetcher;
NS_ASSUME_NONNULL_BEGIN
// class for defining a number of configs to control clearcut upload behavior
@interface FIRIAMClearcutStrategy : NSObject
// minimalWaitTimeInMills and maximumWaitTimeInMills defines the bottom and
// upper bound of the wait time before next upload if prior upload attempt was
// successful. Clearcut may return a value to give the wait time guidance in
// the upload response, but we also use these two values for sanity check to avoid
// too crazy behavior if the guidance value from server does not make sense
@property(nonatomic, readonly) NSInteger minimalWaitTimeInMills;
@property(nonatomic, readonly) NSInteger maximumWaitTimeInMills;
// back off wait time in mills if a prior upload attempt fails
@property(nonatomic, readonly) NSInteger failureBackoffTimeInMills;
// the maximum number of log records to be sent in one upload attempt
@property(nonatomic, readonly) NSInteger batchSendSize;
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithMinWaitTimeInMills:(NSInteger)minWaitTimeInMills
maxWaitTimeInMills:(NSInteger)maxWaitTimeInMills
failureBackoffTimeInMills:(NSInteger)failureBackoffTimeInMills
batchSendSize:(NSInteger)batchSendSize;
- (NSString *)description;
@end
// A class for accepting new clearcut logs and scheduling the uploading of the logs in batches
// based on defined strategies.
@interface FIRIAMClearcutUploader : NSObject
- (instancetype)init NS_UNAVAILABLE;
/**
*
* @param userDefaults needed for tracking upload timing info persistently.If nil, using
* NSUserDefaults standardUserDefaults. It's defined as a parameter to help with
* unit testing mocking
*/
- (instancetype)initWithRequestSender:(FIRIAMClearcutHttpRequestSender *)requestSender
timeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher
logStorage:(FIRIAMClearcutLogStorage *)retryStorage
usingStrategy:(FIRIAMClearcutStrategy *)strategy
usingUserDefaults:(nullable NSUserDefaults *)userDefaults;
/**
* This should return very quickly without blocking on and actual log uploading to
* clearcut server, which is done asynchronously
*/
- (void)addNewLogRecord:(FIRIAMClearcutLogRecord *)record;
@end
NS_ASSUME_NONNULL_END