Files
firebase-ios-sdk/Firebase/InAppMessaging/Data/FIRIAMMessageDefinition.h
T
christibbs 16fbcf6116 Fix bug where app launch messages weren't appearing on iOS (#3237)
* Fix bug where messages with `app_launch` as a trigger weren't being parsed correctly

* Add a call to display executor check for app launch messages upon completion of initial app launch message fetch.

* Verify that the check for app launch messages gets called on initial app launch fetch

* Whitespace fix

* Fix duplicated error codes in checkAndDisplayNextAppLaunchMessage

* Refactor out logic for looking into app launch/foreground trigger messages to share more code

* Whitespace fix
2019-06-26 09:14:27 -07:00

63 lines
2.3 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;
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;
- (instancetype)init NS_UNAVAILABLE;
/**
* Create a regular message definition.
*/
- (instancetype)initWithRenderData:(FIRIAMMessageRenderData *)renderData
startTime:(NSTimeInterval)startTime
endTime:(NSTimeInterval)endTime
triggerDefinition:(NSArray<FIRIAMDisplayTriggerDefinition *> *)renderTriggers;
/**
* Create a test message definition.
*/
- (instancetype)initTestMessageWithRenderData:(FIRIAMMessageRenderData *)renderData;
- (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