diff options
Diffstat (limited to 'StoneIsland/platforms/ios/Pods/FirebaseABTesting/FirebaseABTesting/Sources/Public/FIRExperimentController.h')
| -rw-r--r-- | StoneIsland/platforms/ios/Pods/FirebaseABTesting/FirebaseABTesting/Sources/Public/FIRExperimentController.h | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/StoneIsland/platforms/ios/Pods/FirebaseABTesting/FirebaseABTesting/Sources/Public/FIRExperimentController.h b/StoneIsland/platforms/ios/Pods/FirebaseABTesting/FirebaseABTesting/Sources/Public/FIRExperimentController.h new file mode 100644 index 00000000..acff7392 --- /dev/null +++ b/StoneIsland/platforms/ios/Pods/FirebaseABTesting/FirebaseABTesting/Sources/Public/FIRExperimentController.h @@ -0,0 +1,103 @@ +// Copyright 2019 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 ABTExperimentPayload; + +// Forward declaration to avoid importing into the module header +typedef NS_ENUM(int32_t, ABTExperimentPayloadExperimentOverflowPolicy); + +NS_ASSUME_NONNULL_BEGIN + +@class FIRLifecycleEvents; + +/// The default experiment overflow policy, that is to discard the experiment with the oldest start +/// time when users start the experiment on the web console. +extern const ABTExperimentPayloadExperimentOverflowPolicy FIRDefaultExperimentOverflowPolicy; + +/// This class is for Firebase services to handle experiments updates to Firebase Analytics. +/// Experiments can be set, cleared and updated through this controller. +NS_SWIFT_NAME(ExperimentController) +@interface FIRExperimentController : NSObject + +/// Returns the FIRExperimentController singleton. ++ (FIRExperimentController *)sharedInstance; + +/// Updates the list of experiments with an optional completion handler. Experiments already +/// existing in payloads are not affected, whose state and payload is preserved. This method +/// compares whether the experiments have changed or not by their variant ID. This runs in a +/// background queue and calls the completion handler when finished executing. +/// @param origin The originating service affected by the experiment. +/// @param events A list of event names to be used for logging experiment lifecycle events, +/// if they are not defined in the payload. +/// @param policy The policy to handle new experiments when slots are full. +/// @param lastStartTime The last known experiment start timestamp for this affected service. +/// (Timestamps are specified by the number of seconds from 00:00:00 UTC on 1 +/// January 1970.). +/// @param payloads List of experiment metadata. +/// @param completionHandler Code to be executed after experiments are updated in the background +/// thread. +- (void)updateExperimentsWithServiceOrigin:(NSString *)origin + events:(FIRLifecycleEvents *)events + policy:(ABTExperimentPayloadExperimentOverflowPolicy)policy + lastStartTime:(NSTimeInterval)lastStartTime + payloads:(NSArray<NSData *> *)payloads + completionHandler: + (nullable void (^)(NSError *_Nullable error))completionHandler; + +/// Updates the list of experiments. Experiments already +/// existing in payloads are not affected, whose state and payload is preserved. This method +/// compares whether the experiments have changed or not by their variant ID. This runs in a +/// background queue.. +/// @param origin The originating service affected by the experiment. +/// @param events A list of event names to be used for logging experiment lifecycle events, +/// if they are not defined in the payload. +/// @param policy The policy to handle new experiments when slots are full. +/// @param lastStartTime The last known experiment start timestamp for this affected service. +/// (Timestamps are specified by the number of seconds from 00:00:00 UTC on 1 +/// January 1970.). +/// @param payloads List of experiment metadata. +- (void)updateExperimentsWithServiceOrigin:(NSString *)origin + events:(FIRLifecycleEvents *)events + policy:(ABTExperimentPayloadExperimentOverflowPolicy)policy + lastStartTime:(NSTimeInterval)lastStartTime + payloads:(NSArray<NSData *> *)payloads + DEPRECATED_MSG_ATTRIBUTE("Please use updateExperimentsWithServiceOrigin:events:policy:" + "lastStartTime:payloads:completionHandler: instead."); + +/// Returns the latest experiment start timestamp given a current latest timestamp and a list of +/// experiment payloads. Timestamps are specified by the number of seconds from 00:00:00 UTC on 1 +/// January 1970. +/// @param timestamp Current latest experiment start timestamp. If not known, affected service +/// should specify -1; +/// @param payloads List of experiment metadata. +- (NSTimeInterval)latestExperimentStartTimestampBetweenTimestamp:(NSTimeInterval)timestamp + andPayloads:(NSArray<NSData *> *)payloads; + +/// Expires experiments that aren't in the list of running experiment payloads. +/// @param origin The originating service affected by the experiment. +/// @param payloads The list of valid, running experiments. +- (void)validateRunningExperimentsForServiceOrigin:(NSString *)origin + runningExperimentPayloads:(NSArray<ABTExperimentPayload *> *)payloads; + +/// Directly sets a given experiment to be active. +/// @param experimentPayload The payload for the experiment that should be activated. +/// @param origin The originating service affected by the experiment. +- (void)activateExperiment:(ABTExperimentPayload *)experimentPayload + forServiceOrigin:(NSString *)origin; + +@end + +NS_ASSUME_NONNULL_END |