Files
firebase-ios-sdk/FirebaseInAppMessaging/Sources/Private/Flows/FIRIAMDisplayExecutor.h
T
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

66 lines
2.9 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 "FIRIAMActionURLFollower.h"
#import "FIRIAMActivityLogger.h"
#import "FIRIAMBookKeeper.h"
#import "FIRIAMClearcutLogger.h"
#import "FIRIAMMessageClientCache.h"
#import "FIRIAMTimeFetcher.h"
#import "FIRInAppMessaging.h"
#import "FIRInAppMessagingRendering.h"
NS_ASSUME_NONNULL_BEGIN
@interface FIRIAMDisplaySetting : NSObject
@property(nonatomic) NSTimeInterval displayMinIntervalInMinutes;
@end
// The class for checking if there are appropriate messages to be displayed and if so, render it.
// There are other flows that would determine the timing for the checking and then use this class
// instance for the actual check/display.
//
// In addition to fetch eligible message from message cache, this class also ensures certain
// conditions are satisfied for the rendering
// 1 No current in-app message is being displayed
// 2 For non-contextual messages, the display interval in display setting is met.
@interface FIRIAMDisplayExecutor : NSObject
- (instancetype)initWithInAppMessaging:(FIRInAppMessaging *)inAppMessaging
setting:(FIRIAMDisplaySetting *)setting
messageCache:(FIRIAMMessageClientCache *)cache
timeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher
bookKeeper:(id<FIRIAMBookKeeper>)displayBookKeeper
actionURLFollower:(FIRIAMActionURLFollower *)actionURLFollower
activityLogger:(FIRIAMActivityLogger *)activityLogger
analyticsEventLogger:(id<FIRIAMAnalyticsEventLogger>)analyticsEventLogger;
// Check and display next in-app message eligible for app launch trigger
- (void)checkAndDisplayNextAppLaunchMessage;
// Check and display next in-app message eligible for app open trigger
- (void)checkAndDisplayNextAppForegroundMessage;
// Check and display next in-app message eligible for analytics event trigger with given event name.
- (void)checkAndDisplayNextContextualMessageForAnalyticsEvent:(NSString *)eventName;
// a boolean flag that can be used to suppress/resume displaying messages.
@property(nonatomic) BOOL suppressMessageDisplay;
// This is the display component used by display executor for actual message rendering.
@property(nonatomic) id<FIRInAppMessagingDisplay> messageDisplayComponent;
@end
NS_ASSUME_NONNULL_END