Files
firebase-ios-sdk/FirebaseInAppMessaging/Sources/Private/Data/FIRIAMMessageContentData.h
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

51 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>
NS_ASSUME_NONNULL_BEGIN
/**
* This protocol models the message content (non-ui related) data for an in-app message.
*/
@protocol FIRIAMMessageContentData
@property(nonatomic, readonly, nonnull) NSString *titleText;
@property(nonatomic, readonly, nonnull) NSString *bodyText;
@property(nonatomic, readonly, nullable) NSString *actionButtonText;
@property(nonatomic, readonly, nullable) NSString *secondaryActionButtonText;
@property(nonatomic, readonly, nullable) NSURL *actionURL;
@property(nonatomic, readonly, nullable) NSURL *secondaryActionURL;
@property(nonatomic, readonly, nullable) NSURL *imageURL;
@property(nonatomic, readonly, nullable) NSURL *landscapeImageURL;
// Load image data, which can potentially have two images (one for landscape display). If only
// one image URL exists, that image is loaded and its data is passed in the callback block.
//
// If both standard and landscape URLs exist, then both images are fetched asynchronously. If the
// standard image fails to load, an error will be returned in the callback block and both image data
// slots will be empty.
// If only the landscape image fails to load, the standard image will be returned in the callback
// block and the error will be nil.
// If no error happens and the imageData parameter is nil, it indicates the case that there is no
// image associated with the message.
- (void)loadImageDataWithBlock:(void (^)(NSData *_Nullable imageData,
NSData *_Nullable landscapeImageData,
NSError *_Nullable error))block;
// convert to a description string of the content
- (NSString *)description;
@end
NS_ASSUME_NONNULL_END