Files
firebase-ios-sdk/FirebaseInAppMessaging/Sources/Analytics/FIRIAMClearcutLogStorage.h
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

53 lines
2.2 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>
NS_ASSUME_NONNULL_BEGIN
@interface FIRIAMClearcutLogRecord : NSObject <NSSecureCoding>
@property(nonatomic, copy, readonly) NSString *eventExtensionJsonString;
@property(nonatomic, readonly) NSInteger eventTimestampInSeconds;
- (instancetype)initWithExtensionJsonString:(NSString *)jsonString
eventTimestampInSeconds:(NSInteger)eventTimestampInSeconds;
@end
@protocol FIRIAMTimeFetcher;
// A local persistent storage for saving FIRIAMClearcutLogRecord objects
// so that they can be delivered to clearcut server.
// Based on the clearcut log structure, our strategy is to store the json string
// for the source extension since it does not need to be modified upon delivery retries.
// The envelope of the clearcut log will be reconstructed when delivery is
// attempted.
@interface FIRIAMClearcutLogStorage : NSObject
- (instancetype)initWithExpireAfterInSeconds:(NSInteger)expireInSeconds
withTimeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher
cachePath:(nullable NSString *)cachePath;
- (instancetype)initWithExpireAfterInSeconds:(NSInteger)expireInSeconds
withTimeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher;
// add new records into the storage
- (void)pushRecords:(NSArray<FIRIAMClearcutLogRecord *> *)newRecords;
// pop all the records that have not expired yet. With this call, these
// records are removed from the book of this local storage object.
// @param upTo the cap on how many records to be popped.
- (NSArray<FIRIAMClearcutLogRecord *> *)popStillValidRecordsForUpTo:(NSInteger)upTo;
@end
NS_ASSUME_NONNULL_END