Files
firebase-ios-sdk/FirebaseInAppMessaging/Sources/Private/Runtime/FIRIAMSDKModeManager.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

74 lines
2.8 KiB
Objective-C

/*
* Copyright 2018 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>
NS_ASSUME_NONNULL_BEGIN
extern NSInteger const kFIRIAMMaxFetchInNewlyInstalledMode;
/**
* At runtime a FIAM SDK client can function in one of the following modes:
* 1 Regular. This SDK client instance will conform to regular fetch minimal interval time policy.
* 2 Newly installed. This is a mode a newly installed SDK stays in until the first
* kFIRIAMMaxFetchInNewlyInstalledMode fetches have finished. In this mode, there is no
* minimal time interval between fetches: a fetch would be triggered as long as the app goes
* into foreground state.
* 3 Testing Instance. This app instance is targeted for test on device feature for fiam. When
* it's in this mode, no minimal time interval between fetches is applied. SDK turns itself
* into this mode on seeing test-on-client messages are returned in fetch responses.
*/
typedef NS_ENUM(NSInteger, FIRIAMSDKMode) {
FIRIAMSDKModeRegular,
FIRIAMSDKModeTesting,
FIRIAMSDKModeNewlyInstalled
};
// turn the sdk mode enum integer value into a descriptive string
NSString *FIRIAMDescriptonStringForSDKMode(FIRIAMSDKMode mode);
extern NSString *const kFIRIAMUserDefaultKeyForSDKMode;
extern NSString *const kFIRIAMUserDefaultKeyForServerFetchCount;
extern NSInteger const kFIRIAMMaxFetchInNewlyInstalledMode;
@protocol FIRIAMTestingModeListener <NSObject>
// Triggered when the current app switches into testing mode from a using testing mode
- (void)testingModeSwitchedOn;
@end
// A class for tracking and updating the SDK mode. The tracked mode related info is persisted
// so that it can be restored beyond app restarts
@interface FIRIAMSDKModeManager : NSObject
- (instancetype)init NS_UNAVAILABLE;
// having NSUserDefaults as passed-in to help with unit testing
- (instancetype)initWithUserDefaults:(NSUserDefaults *)userDefaults
testingModeListener:(id<FIRIAMTestingModeListener>)testingModeListener;
// returns the current SDK mode
- (FIRIAMSDKMode)currentMode;
// turn the current SDK into 'Testing Instance' mode.
- (void)becomeTestingInstance;
// inform the manager that one more fetch is done. This is to allow
// the manager to potentially graduate from the newly installed mode.
- (void)registerOneMoreFetch;
@end
NS_ASSUME_NONNULL_END