mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
christibbs
48aa5ed5ee
* 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
92 lines
3.7 KiB
Objective-C
92 lines
3.7 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>
|
|
|
|
@class FIRApp;
|
|
|
|
#import "FIRInAppMessagingRendering.h"
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
/**
|
|
* The root object for in-app messaging iOS SDK.
|
|
*
|
|
* Note: Firebase InApp Messaging depends on using a Firebase Instance ID & token pair to be able
|
|
* to retrieve FIAM messages defined for the current app instance. By default, Firebase in-app
|
|
* messaging SDK would obtain the ID & token pair on app/SDK startup. As a result of using
|
|
* ID & token pair, some device client data (linked to the instance ID) would be collected and sent
|
|
* over to Firebase backend periodically.
|
|
*
|
|
* The app can tune the default data collection behavior via certain controls. They are listed in
|
|
* descending order below. If a higher-priority setting exists, lower level settings are ignored.
|
|
*
|
|
* 1. Dynamically turn on/off data collection behavior by setting the
|
|
* `automaticDataCollectionEnabled` property on the `FIRInAppMessaging` instance to true/false
|
|
* Swift or YES/NO (objective-c).
|
|
* 2. Set `FirebaseInAppMessagingAutomaticDataCollectionEnabled` to false in the app's plist file.
|
|
* 3. Global Firebase data collection setting.
|
|
**/
|
|
NS_SWIFT_NAME(InAppMessaging)
|
|
@interface FIRInAppMessaging : NSObject
|
|
/** @fn inAppMessaging
|
|
@brief Gets the singleton FIRInAppMessaging object constructed from default Firebase App
|
|
settings.
|
|
*/
|
|
+ (FIRInAppMessaging *)inAppMessaging NS_SWIFT_NAME(inAppMessaging());
|
|
|
|
/**
|
|
* Unavailable. Use +inAppMessaging instead.
|
|
*/
|
|
- (instancetype)init __attribute__((unavailable("Use +inAppMessaging instead.")));
|
|
|
|
/**
|
|
* A boolean flag that can be used to suppress messaging display at runtime. It's
|
|
* initialized to false at app startup. Once set to true, fiam SDK would stop rendering any
|
|
* new messages until it's set back to false.
|
|
*/
|
|
@property(nonatomic) BOOL messageDisplaySuppressed;
|
|
|
|
/**
|
|
* A boolean flag that can be set at runtime to allow/disallow fiam SDK automatically
|
|
* collect user data on app startup. Settings made via this property is persisted across app
|
|
* restarts and has higher priority over FirebaseInAppMessagingAutomaticDataCollectionEnabled
|
|
* flag (if present) in plist file.
|
|
*/
|
|
@property(nonatomic) BOOL automaticDataCollectionEnabled;
|
|
|
|
/**
|
|
* This is the display component that will be used by FirebaseInAppMessaging to render messages.
|
|
* If it's nil (the default case when FirebaseIAppMessaging SDK starts), FirebaseInAppMessaging
|
|
* would only perform other non-rendering flows (fetching messages for example). SDK
|
|
* FirebaseInAppMessagingDisplay would set itself as the display component if it's included by
|
|
* the app. Any other custom implementation of FIRInAppMessagingDisplay would need to set this
|
|
* property so that it can be used for rendering fiam message UIs.
|
|
*/
|
|
@property(nonatomic) id<FIRInAppMessagingDisplay> messageDisplayComponent;
|
|
|
|
/**
|
|
* Directly requests an in-app message with the given trigger to be shown.
|
|
*/
|
|
- (void)triggerEvent:(NSString *)eventName;
|
|
|
|
/**
|
|
* This delegate should be set on the app side to receive message lifecycle events in app runtime.
|
|
*/
|
|
@property(nonatomic, weak) id<FIRInAppMessagingDisplayDelegate> delegate;
|
|
|
|
@end
|
|
NS_ASSUME_NONNULL_END
|