mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-11 22:55:59 +05:45
christibbsandPaul Beusterien
9b484519f2
* Remove Protobuf dependency, add struct-ish class that mimics ABTExperimentPayload * Remove a lot of the compiler errors, but not all of them. We need to figure out how RC serializes the NSData objects passed to FIRExperimentController in updateExperimentsWithServiceOrigin: * Add ABTExperimentPayload class that replaces generated proto, refactor classes that depend on it * Add unit testing class for ABTExperimentPayload * Updates to ABTExperimentPayload API, tests for ABTConditionalUserPropertyTest, add tests for ABTExperimentPayload * Update podspec to pull in testing resources * Add utility class for parsing test files. Use it in ABTExperimentPayloadTests * Fix FIRExperimentController tests * Better documentation * Run scripts/styles.sh * Fix whitespace * Remove protobuf imports * Bump pod spec version for ABT SDK, depend on new ABT SDK in RC. Fix up RemoteConfigExperiment to use new ABTExperimentPayload object * scripts/style.sh * Update In-app messaging to use new ABTExperimentPayload class, which involves extending the ABTExperimentPayload initializer to accept different values for overflowPolicy and experimentStartTime * Delete test payload * Revert scripts/check_imports.swift * Better initialization tags for ABTExperimentLite * Update CHANGELOGs * Remove private headers in podspec, use integerValue to parse integers * Refactor ABTExperimentPayload header into Private headers. Fix integer types for millisecond metadata * scripts/styles.sh * Fix integer parsing * Fix copyrights * Fix CHANGELOG typo: * Add private_header_files to public_header_files * Try just using NSInteger for experimentStartTimeMillis * Bump FIAM dependency on ABTesting * Use long long for milli parameters (32-bit apps) * Use longlong in test timestamps * Don't cast to nsnumber in tests * Use in64_t * Fix Test Overflow * Bump major version on ABT SDK * Bump ABTesting version in Firebase.podspec Co-authored-by: Paul Beusterien <paulbeusterien@google.com>
80 lines
3.6 KiB
Objective-C
80 lines
3.6 KiB
Objective-C
// 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 <FirebaseABTesting/ABTExperimentPayload.h>
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import "Interop/Analytics/Public/FIRAnalyticsInterop.h"
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
@class FIRLifecycleEvents;
|
|
|
|
/// This class dynamically calls Firebase Analytics API to collect or update experiments
|
|
/// information.
|
|
/// The experiment in Firebase Analytics is named as conditional user property (CUP) object defined
|
|
/// in FIRAConditionalUserProperty.h.
|
|
@interface ABTConditionalUserPropertyController : NSObject
|
|
|
|
/// Returns the ABTConditionalUserPropertyController singleton.
|
|
+ (instancetype)sharedInstanceWithAnalytics:(id<FIRAnalyticsInterop> _Nullable)analytics;
|
|
|
|
/// Returns the list of currently set experiments from Firebase Analytics for the provided origin.
|
|
- (NSArray *)experimentsWithOrigin:(NSString *)origin;
|
|
|
|
/// Returns the experiment ID from Firebase Analytics given an experiment object. Returns empty
|
|
/// string if can't find Firebase Analytics service.
|
|
- (NSString *)experimentIDOfExperiment:(nullable id)experiment;
|
|
|
|
/// Returns the variant ID from Firebase Analytics given an experiment object. Returns empty string
|
|
/// if can't find Firebase Analytics service.
|
|
- (NSString *)variantIDOfExperiment:(nullable id)experiment;
|
|
|
|
/// Returns whether the experiment is the same as the one in the provided payload.
|
|
- (BOOL)isExperiment:(id)experiment theSameAsPayload:(ABTExperimentPayload *)payload;
|
|
|
|
/// Clears the experiment in Firebase Analytics.
|
|
/// @param experimentID Experiment ID to clear.
|
|
/// @param variantID Variant ID to clear.
|
|
/// @param origin Impacted originating service, it is defined at Firebase Analytics
|
|
/// FIREventOrigins.h.
|
|
/// @param payload Payload to overwrite event name in events. DO NOT use payload's experiment
|
|
/// ID and variant ID as the experiment to clear.
|
|
/// @param events Events name for clearing the experiment.
|
|
- (void)clearExperiment:(NSString *)experimentID
|
|
variantID:(NSString *)variantID
|
|
withOrigin:(NSString *)origin
|
|
payload:(nullable ABTExperimentPayload *)payload
|
|
events:(FIRLifecycleEvents *)events;
|
|
|
|
/// Sets the experiment in Firebase Analytics.
|
|
/// @param origin Impacted originating service, it is defined at Firebase Analytics
|
|
/// FIREventOrigins.h.
|
|
/// @param payload Payload to overwrite event name in events. DO NOT use payload's experiment
|
|
/// ID and variant ID as the experiment to set.
|
|
/// @param events Events name for setting the experiment.
|
|
/// @param policy Overflow policy when the number of experiments is over the limit.
|
|
- (void)setExperimentWithOrigin:(NSString *)origin
|
|
payload:(ABTExperimentPayload *)payload
|
|
events:(FIRLifecycleEvents *)events
|
|
policy:(ABTExperimentPayloadExperimentOverflowPolicy)policy;
|
|
|
|
/**
|
|
* Unavailable. Use sharedInstanceWithAnalytics: instead.
|
|
*/
|
|
- (instancetype)init __attribute__((unavailable("Use +sharedInstanceWithAnalytics: instead.")));
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|