Files
firebase-ios-sdk/Firebase/InAppMessaging/RenderingObjects/FIRInAppMessagingRenderingDataClasses.m
T
christibbs 93ebe6f9bf FIAM Programmatic triggers (#3081)
* Add card scene to storyboard, use IBDesignable rounded corners view

* Use IBdesignable rounded corners view for modal message

* Add card message type

* Parse card message type, add new fields for secondary actions and landscape URLs to view model classes

* Display a really basic card message

* Naive landscape image loading (needs error handling)

* Quick bug fix

* Wire up Display to show cards

* Wire up Display to show cards

* Fix tablet width

* Pick right image for orientation

* Remove placeholder image sizing constraints at build time

* Add more test functionality

* Better image sizes

* Size message image out

* Switch to body text view rather than body label

* Make the body text view scrollable. Set correct text color on button.

* Hook up buttons and text color

* Include action URL in messageClicked callback

* Fix action URL

* Update pod specs

* Update message clicked delegate to pass an action object, not just the actionURL

* Change podspec versions back, hook up background color

* Don't animate scroll to top on scroll view

* Fix text scrolling bug

* Fix portrait and landscape fetching code. Fix background color bug

* Flesh out FIRIAMMessageContentDataWithImageURLTests

* Fix up FIRIAMFetchFlowTests

* Fix up FIRIAMMessageClientCacheTests

* Fix up FIRIAMMessageDisplayForTesting

* Fix fetching in FIRIAMMessageContentDataWithImageURL

* Tests for message parsing

* Fix up view controllers for banner, modal, image only. Add a view controller for testing card

* Add required vertical compression resistance for primary and secondary action button

* Add UI tests for card view controller

* Add back deprecated messageClicked: method, call it if the newer method isn't implemented. Make all display delegate methods optional.

* Run scripts/styles.sh

* Add FIRIAMDisplayExecutor logic to display an in-app message programmatically.

* Add a public method on FIRInAppMessaging that triggers a message to be shown via the display executor

* Add button to test app that programmatically triggers a message

* Add unit tests for display executor programmatic trigger flow

* Documentation cleanup

* Fix style in FIRIAMMessageContentDataWithImageURLTests.m

* Add missing copyright notices

* Bump versions of both FIAM SDKS

* Remove default.profraw

* Address some logging punctuation nits. Cancel landscape image load if portrait image load fails.

* Add missing error flow in image fetch. A few comment nits.

* Shorten up init method for CardDisplayMessage

* Documentation updates

* Deintegrate cocoa pods

* Include landscape image data in test image load class

* Fix Swift naming for InAppMessagingAction in UItests

* Remove card message initializer from public API, place into a private header

* Mark some properties on the card object as readonly that should've been already, Find a way to initialize a card message in the UI tests.

* Bump dependency on InAppMessaging given changes

* Bump versions in podspecs for both SDKs

* Make all view model properties for message subclasses readonly

* Revert changes to other message subclasses

* Make card view model properties readonly

* Run styles.sh

* Run styles.sh, address some comments about logging

* Reuse analytic trigger method to show programmatic messages. Fix issue with overriding accessibility of card message params
2019-05-28 13:42:06 -04:00

218 lines
7.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>
#import "FIRInAppMessagingRendering.h"
@implementation FIRInAppMessagingDisplayMessage
- (instancetype)initWithMessageID:(NSString *)messageID
campaignName:(NSString *)campaignName
renderAsTestMessage:(BOOL)renderAsTestMessage
messageType:(FIRInAppMessagingDisplayMessageType)messageType
triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType {
if (self = [super init]) {
_campaignInfo = [[FIRInAppMessagingCampaignInfo alloc] initWithMessageID:messageID
campaignName:campaignName
renderAsTestMessage:renderAsTestMessage];
_type = messageType;
_triggerType = triggerType;
}
return self;
}
@end
@implementation FIRInAppMessagingCardDisplay
- (void)setBody:(NSString *_Nullable)body {
_body = body;
}
- (void)setLandscapeImageData:(FIRInAppMessagingImageData *_Nullable)landscapeImageData {
_landscapeImageData = landscapeImageData;
}
- (void)setSecondaryActionButton:(FIRInAppMessagingActionButton *_Nullable)secondaryActionButton {
_secondaryActionButton = secondaryActionButton;
}
- (void)setSecondaryActionURL:(NSURL *_Nullable)secondaryActionURL {
_secondaryActionURL = secondaryActionURL;
}
- (instancetype)initWithMessageID:(NSString *)messageID
campaignName:(NSString *)campaignName
renderAsTestMessage:(BOOL)renderAsTestMessage
triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
titleText:(NSString *)title
textColor:(UIColor *)textColor
portraitImageData:(FIRInAppMessagingImageData *)portraitImageData
backgroundColor:(UIColor *)backgroundColor
primaryActionButton:(FIRInAppMessagingActionButton *)primaryActionButton
primaryActionURL:(NSURL *)primaryActionURL {
if (self = [super initWithMessageID:messageID
campaignName:campaignName
renderAsTestMessage:renderAsTestMessage
messageType:FIRInAppMessagingDisplayMessageTypeCard
triggerType:triggerType]) {
_title = title;
_textColor = textColor;
_portraitImageData = portraitImageData;
_displayBackgroundColor = backgroundColor;
_primaryActionButton = primaryActionButton;
_primaryActionURL = primaryActionURL;
}
return self;
}
@end
@implementation FIRInAppMessagingBannerDisplay
- (instancetype)initWithMessageID:(NSString *)messageID
campaignName:(NSString *)campaignName
renderAsTestMessage:(BOOL)renderAsTestMessage
triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
titleText:(NSString *)title
bodyText:(NSString *)bodyText
textColor:(UIColor *)textColor
backgroundColor:(UIColor *)backgroundColor
imageData:(nullable FIRInAppMessagingImageData *)imageData
actionURL:(nullable NSURL *)actionURL {
if (self = [super initWithMessageID:messageID
campaignName:campaignName
renderAsTestMessage:renderAsTestMessage
messageType:FIRInAppMessagingDisplayMessageTypeBanner
triggerType:triggerType]) {
_title = title;
_bodyText = bodyText;
_textColor = textColor;
_displayBackgroundColor = backgroundColor;
_imageData = imageData;
_actionURL = actionURL;
}
return self;
}
@end
@implementation FIRInAppMessagingModalDisplay
- (instancetype)initWithMessageID:(NSString *)messageID
campaignName:(NSString *)campaignName
renderAsTestMessage:(BOOL)renderAsTestMessage
triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
titleText:(NSString *)title
bodyText:(NSString *)bodyText
textColor:(UIColor *)textColor
backgroundColor:(UIColor *)backgroundColor
imageData:(nullable FIRInAppMessagingImageData *)imageData
actionButton:(nullable FIRInAppMessagingActionButton *)actionButton
actionURL:(nullable NSURL *)actionURL {
if (self = [super initWithMessageID:messageID
campaignName:campaignName
renderAsTestMessage:renderAsTestMessage
messageType:FIRInAppMessagingDisplayMessageTypeModal
triggerType:triggerType]) {
_title = title;
_bodyText = bodyText;
_textColor = textColor;
_displayBackgroundColor = backgroundColor;
_imageData = imageData;
_actionButton = actionButton;
_actionURL = actionURL;
}
return self;
}
@end
@implementation FIRInAppMessagingImageOnlyDisplay
- (instancetype)initWithMessageID:(NSString *)messageID
campaignName:(NSString *)campaignName
renderAsTestMessage:(BOOL)renderAsTestMessage
triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
imageData:(nullable FIRInAppMessagingImageData *)imageData
actionURL:(nullable NSURL *)actionURL {
if (self = [super initWithMessageID:messageID
campaignName:campaignName
renderAsTestMessage:renderAsTestMessage
messageType:FIRInAppMessagingDisplayMessageTypeModal
triggerType:triggerType]) {
_imageData = imageData;
_actionURL = actionURL;
}
return self;
}
@end
@implementation FIRInAppMessagingActionButton
- (instancetype)initWithButtonText:(NSString *)btnText
buttonTextColor:(UIColor *)textColor
backgroundColor:(UIColor *)bkgColor {
if (self = [super init]) {
_buttonText = btnText;
_buttonTextColor = textColor;
_buttonBackgroundColor = bkgColor;
}
return self;
}
@end
@implementation FIRInAppMessagingImageData
- (instancetype)initWithImageURL:(NSString *)imageURL imageData:(NSData *)imageData {
if (self = [super init]) {
_imageURL = imageURL;
_imageRawData = imageData;
}
return self;
}
- (id)copyWithZone:(NSZone *)zone {
FIRInAppMessagingImageData *imageData = [[[self class] allocWithZone:zone] init];
imageData->_imageURL = [_imageURL copyWithZone:zone];
imageData->_imageRawData = [_imageRawData copyWithZone:zone];
return imageData;
}
@end
@implementation FIRInAppMessagingCampaignInfo
- (instancetype)initWithMessageID:(NSString *)messageID
campaignName:(NSString *)campaignName
renderAsTestMessage:(BOOL)renderAsTestMessage {
if (self = [super init]) {
_messageID = messageID;
_campaignName = campaignName;
_renderAsTestMessage = renderAsTestMessage;
}
return self;
}
@end
@implementation FIRInAppMessagingAction
- (instancetype)initWithActionText:(nullable NSString *)actionText actionURL:(NSURL *)actionURL {
if (self = [super init]) {
_actionText = actionText;
_actionURL = actionURL;
}
return self;
}
@end