Files
firebase-ios-sdk/FirebaseInAppMessaging/Sources/Private/Data/FIRIAMMessageDefinition.h
T
christibbsandPaul Beusterien 9b484519f2 Remove Protobuf from the ABT SDK (#5890)
* 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>
2020-07-06 13:06:39 -04:00

80 lines
3.2 KiB
Objective-C

/*
* Copyright 2017 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>
#import "FIRIAMDisplayTriggerDefinition.h"
#import "FIRIAMMessageRenderData.h"
@class FIRIAMDisplayTriggerDefinition;
@class ABTExperimentPayload;
NS_ASSUME_NONNULL_BEGIN
@interface FIRIAMMessageDefinition : NSObject
@property(nonatomic, nonnull, readonly) FIRIAMMessageRenderData *renderData;
// metadata data that does not affect the rendering content/effect directly
@property(nonatomic, readonly) NSTimeInterval startTime;
@property(nonatomic, readonly) NSTimeInterval endTime;
// a fiam message can have multiple triggers and any of them on its own can cause
// the message to be rendered
@property(nonatomic, readonly) NSArray<FIRIAMDisplayTriggerDefinition *> *renderTriggers;
/// A flag for client-side testing messages
@property(nonatomic, readonly) BOOL isTestMessage;
/// Additional key-value pairs that can be optionally sent along with the FIAM
@property(nonatomic, nullable, readonly) NSDictionary *appData;
@property(nonatomic, nullable, readonly) ABTExperimentPayload *experimentPayload;
- (instancetype)init NS_UNAVAILABLE;
/**
* Create a regular message definition.
*/
- (instancetype)initWithRenderData:(FIRIAMMessageRenderData *)renderData
startTime:(NSTimeInterval)startTime
endTime:(NSTimeInterval)endTime
triggerDefinition:(NSArray<FIRIAMDisplayTriggerDefinition *> *)renderTriggers
appData:(nullable NSDictionary *)appData
experimentPayload:(nullable ABTExperimentPayload *)experimentPayload
isTestMessage:(BOOL)isTestMessage NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithRenderData:(FIRIAMMessageRenderData *)renderData
startTime:(NSTimeInterval)startTime
endTime:(NSTimeInterval)endTime
triggerDefinition:(NSArray<FIRIAMDisplayTriggerDefinition *> *)renderTriggers;
/**
* Create a test message definition.
*/
- (instancetype)initTestMessageWithRenderData:(FIRIAMMessageRenderData *)renderData
experimentPayload:(nullable ABTExperimentPayload *)experimentPayload;
- (BOOL)messageHasExpired;
- (BOOL)messageHasStarted;
// should this message be rendered given the FIAM trigger type? only use this method for app launch
// and foreground trigger, use messageRenderedOnAnalyticsEvent: for analytics triggers
- (BOOL)messageRenderedOnTrigger:(FIRIAMRenderTrigger)trigger;
// should this message be rendered when a given analytics event is fired?
- (BOOL)messageRenderedOnAnalyticsEvent:(NSString *)eventName;
@end
NS_ASSUME_NONNULL_END