FIRInAppMessagingRenderingDataClasses.m 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  1. /*
  2. * Copyright 2018 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. #import "FIRInAppMessagingRendering.h"
  18. #import "FIRInAppMessagingRenderingPrivate.h"
  19. @implementation FIRInAppMessagingDisplayMessage
  20. - (instancetype)initWithMessageID:(NSString *)messageID
  21. campaignName:(NSString *)campaignName
  22. experimentPayload:(nullable ABTExperimentPayload *)experimentPayload
  23. renderAsTestMessage:(BOOL)renderAsTestMessage
  24. messageType:(FIRInAppMessagingDisplayMessageType)messageType
  25. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  26. appData:(NSDictionary *)appData {
  27. if (self = [super init]) {
  28. #pragma clang diagnostic push
  29. #pragma clang diagnostic ignored "-Wdeprecated-declarations"
  30. _campaignInfo = [[FIRInAppMessagingCampaignInfo alloc] initWithMessageID:messageID
  31. campaignName:campaignName
  32. experimentPayload:experimentPayload
  33. renderAsTestMessage:renderAsTestMessage];
  34. #pragma clang diagnostic pop
  35. _type = messageType;
  36. _triggerType = triggerType;
  37. _appData = [appData copy];
  38. }
  39. return self;
  40. }
  41. - (instancetype)initWithMessageID:(NSString *)messageID
  42. campaignName:(NSString *)campaignName
  43. renderAsTestMessage:(BOOL)renderAsTestMessage
  44. messageType:(FIRInAppMessagingDisplayMessageType)messageType
  45. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType {
  46. return [self initWithMessageID:messageID
  47. campaignName:campaignName
  48. experimentPayload:nil
  49. renderAsTestMessage:renderAsTestMessage
  50. messageType:messageType
  51. triggerType:triggerType
  52. appData:nil];
  53. }
  54. @end
  55. @implementation FIRInAppMessagingCardDisplay
  56. - (void)setBody:(NSString *_Nullable)body {
  57. _body = body;
  58. }
  59. - (void)setLandscapeImageData:(FIRInAppMessagingImageData *_Nullable)landscapeImageData {
  60. _landscapeImageData = landscapeImageData;
  61. }
  62. - (void)setSecondaryActionButton:(FIRInAppMessagingActionButton *_Nullable)secondaryActionButton {
  63. _secondaryActionButton = secondaryActionButton;
  64. }
  65. - (void)setSecondaryActionURL:(NSURL *_Nullable)secondaryActionURL {
  66. _secondaryActionURL = secondaryActionURL;
  67. }
  68. - (instancetype)initWithMessageID:(NSString *)messageID
  69. campaignName:(NSString *)campaignName
  70. experimentPayload:(nullable ABTExperimentPayload *)experimentPayload
  71. renderAsTestMessage:(BOOL)renderAsTestMessage
  72. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  73. titleText:(NSString *)title
  74. textColor:(UIColor *)textColor
  75. portraitImageData:(FIRInAppMessagingImageData *)portraitImageData
  76. backgroundColor:(UIColor *)backgroundColor
  77. primaryActionButton:(FIRInAppMessagingActionButton *)primaryActionButton
  78. primaryActionURL:(NSURL *)primaryActionURL
  79. appData:(NSDictionary *)appData {
  80. #pragma clang diagnostic push
  81. #pragma clang diagnostic ignored "-Wdeprecated-declarations"
  82. if (self = [super initWithMessageID:messageID
  83. campaignName:campaignName
  84. experimentPayload:experimentPayload
  85. renderAsTestMessage:renderAsTestMessage
  86. messageType:FIRInAppMessagingDisplayMessageTypeCard
  87. triggerType:triggerType
  88. appData:appData]) {
  89. #pragma clang diagnostic pop
  90. _title = title;
  91. _textColor = textColor;
  92. _portraitImageData = portraitImageData;
  93. _displayBackgroundColor = backgroundColor;
  94. _primaryActionButton = primaryActionButton;
  95. _primaryActionURL = primaryActionURL;
  96. }
  97. return self;
  98. }
  99. - (instancetype)initWithMessageID:(NSString *)messageID
  100. campaignName:(NSString *)campaignName
  101. renderAsTestMessage:(BOOL)renderAsTestMessage
  102. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  103. titleText:(NSString *)title
  104. textColor:(UIColor *)textColor
  105. portraitImageData:(FIRInAppMessagingImageData *)portraitImageData
  106. backgroundColor:(UIColor *)backgroundColor
  107. primaryActionButton:(FIRInAppMessagingActionButton *)primaryActionButton
  108. primaryActionURL:(NSURL *)primaryActionURL {
  109. return [self initWithMessageID:messageID
  110. campaignName:campaignName
  111. experimentPayload:nil
  112. renderAsTestMessage:renderAsTestMessage
  113. triggerType:triggerType
  114. titleText:title
  115. textColor:textColor
  116. portraitImageData:portraitImageData
  117. backgroundColor:backgroundColor
  118. primaryActionButton:primaryActionButton
  119. primaryActionURL:primaryActionURL
  120. appData:nil];
  121. }
  122. @end
  123. @implementation FIRInAppMessagingBannerDisplay
  124. - (instancetype)initWithMessageID:(NSString *)messageID
  125. campaignName:(NSString *)campaignName
  126. experimentPayload:(nullable ABTExperimentPayload *)experimentPayload
  127. renderAsTestMessage:(BOOL)renderAsTestMessage
  128. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  129. titleText:(NSString *)title
  130. bodyText:(NSString *)bodyText
  131. textColor:(UIColor *)textColor
  132. backgroundColor:(UIColor *)backgroundColor
  133. imageData:(nullable FIRInAppMessagingImageData *)imageData
  134. actionURL:(nullable NSURL *)actionURL
  135. appData:(NSDictionary *)appData {
  136. if (self = [super initWithMessageID:messageID
  137. campaignName:campaignName
  138. experimentPayload:experimentPayload
  139. renderAsTestMessage:renderAsTestMessage
  140. messageType:FIRInAppMessagingDisplayMessageTypeBanner
  141. triggerType:triggerType
  142. appData:appData]) {
  143. _title = title;
  144. _bodyText = bodyText;
  145. _textColor = textColor;
  146. _displayBackgroundColor = backgroundColor;
  147. _imageData = imageData;
  148. _actionURL = actionURL;
  149. }
  150. return self;
  151. }
  152. - (instancetype)initWithMessageID:(NSString *)messageID
  153. campaignName:(NSString *)campaignName
  154. renderAsTestMessage:(BOOL)renderAsTestMessage
  155. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  156. titleText:(NSString *)title
  157. bodyText:(NSString *)bodyText
  158. textColor:(UIColor *)textColor
  159. backgroundColor:(UIColor *)backgroundColor
  160. imageData:(nullable FIRInAppMessagingImageData *)imageData
  161. actionURL:(nullable NSURL *)actionURL {
  162. return [self initWithMessageID:messageID
  163. campaignName:campaignName
  164. experimentPayload:nil
  165. renderAsTestMessage:renderAsTestMessage
  166. triggerType:triggerType
  167. titleText:title
  168. bodyText:bodyText
  169. textColor:textColor
  170. backgroundColor:backgroundColor
  171. imageData:imageData
  172. actionURL:actionURL
  173. appData:nil];
  174. }
  175. @end
  176. @implementation FIRInAppMessagingModalDisplay
  177. - (instancetype)initWithMessageID:(NSString *)messageID
  178. campaignName:(NSString *)campaignName
  179. experimentPayload:(nullable ABTExperimentPayload *)experimentPayload
  180. renderAsTestMessage:(BOOL)renderAsTestMessage
  181. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  182. titleText:(NSString *)title
  183. bodyText:(NSString *)bodyText
  184. textColor:(UIColor *)textColor
  185. backgroundColor:(UIColor *)backgroundColor
  186. imageData:(nullable FIRInAppMessagingImageData *)imageData
  187. actionButton:(nullable FIRInAppMessagingActionButton *)actionButton
  188. actionURL:(nullable NSURL *)actionURL
  189. appData:(nullable NSDictionary *)appData {
  190. if (self = [super initWithMessageID:messageID
  191. campaignName:campaignName
  192. experimentPayload:experimentPayload
  193. renderAsTestMessage:renderAsTestMessage
  194. messageType:FIRInAppMessagingDisplayMessageTypeModal
  195. triggerType:triggerType
  196. appData:appData]) {
  197. _title = title;
  198. _bodyText = bodyText;
  199. _textColor = textColor;
  200. _displayBackgroundColor = backgroundColor;
  201. _imageData = imageData;
  202. _actionButton = actionButton;
  203. _actionURL = actionURL;
  204. }
  205. return self;
  206. }
  207. - (instancetype)initWithMessageID:(NSString *)messageID
  208. campaignName:(NSString *)campaignName
  209. renderAsTestMessage:(BOOL)renderAsTestMessage
  210. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  211. titleText:(NSString *)title
  212. bodyText:(NSString *)bodyText
  213. textColor:(UIColor *)textColor
  214. backgroundColor:(UIColor *)backgroundColor
  215. imageData:(nullable FIRInAppMessagingImageData *)imageData
  216. actionButton:(nullable FIRInAppMessagingActionButton *)actionButton
  217. actionURL:(nullable NSURL *)actionURL {
  218. return [self initWithMessageID:messageID
  219. campaignName:campaignName
  220. experimentPayload:nil
  221. renderAsTestMessage:renderAsTestMessage
  222. triggerType:triggerType
  223. titleText:title
  224. bodyText:bodyText
  225. textColor:textColor
  226. backgroundColor:backgroundColor
  227. imageData:imageData
  228. actionButton:actionButton
  229. actionURL:actionURL
  230. appData:nil];
  231. }
  232. @end
  233. @implementation FIRInAppMessagingImageOnlyDisplay
  234. - (instancetype)initWithMessageID:(NSString *)messageID
  235. campaignName:(NSString *)campaignName
  236. experimentPayload:(nullable ABTExperimentPayload *)experimentPayload
  237. renderAsTestMessage:(BOOL)renderAsTestMessage
  238. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  239. imageData:(nullable FIRInAppMessagingImageData *)imageData
  240. actionURL:(nullable NSURL *)actionURL
  241. appData:(nullable NSDictionary *)appData {
  242. if (self = [super initWithMessageID:messageID
  243. campaignName:campaignName
  244. experimentPayload:experimentPayload
  245. renderAsTestMessage:renderAsTestMessage
  246. messageType:FIRInAppMessagingDisplayMessageTypeModal
  247. triggerType:triggerType
  248. appData:appData]) {
  249. _imageData = imageData;
  250. _actionURL = actionURL;
  251. }
  252. return self;
  253. }
  254. - (instancetype)initWithMessageID:(NSString *)messageID
  255. campaignName:(NSString *)campaignName
  256. renderAsTestMessage:(BOOL)renderAsTestMessage
  257. triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
  258. imageData:(nullable FIRInAppMessagingImageData *)imageData
  259. actionURL:(nullable NSURL *)actionURL {
  260. return [self initWithMessageID:messageID
  261. campaignName:campaignName
  262. experimentPayload:nil
  263. renderAsTestMessage:renderAsTestMessage
  264. triggerType:triggerType
  265. imageData:imageData
  266. actionURL:actionURL
  267. appData:nil];
  268. }
  269. @end
  270. @implementation FIRInAppMessagingActionButton
  271. - (instancetype)initWithButtonText:(NSString *)btnText
  272. buttonTextColor:(UIColor *)textColor
  273. backgroundColor:(UIColor *)bkgColor {
  274. if (self = [super init]) {
  275. _buttonText = btnText;
  276. _buttonTextColor = textColor;
  277. _buttonBackgroundColor = bkgColor;
  278. }
  279. return self;
  280. }
  281. @end
  282. @implementation FIRInAppMessagingImageData
  283. - (instancetype)initWithImageURL:(NSString *)imageURL imageData:(NSData *)imageData {
  284. if (self = [super init]) {
  285. _imageURL = imageURL;
  286. _imageRawData = imageData;
  287. }
  288. return self;
  289. }
  290. - (id)copyWithZone:(NSZone *)zone {
  291. FIRInAppMessagingImageData *imageData = [[[self class] allocWithZone:zone] init];
  292. imageData->_imageURL = [_imageURL copyWithZone:zone];
  293. imageData->_imageRawData = [_imageRawData copyWithZone:zone];
  294. return imageData;
  295. }
  296. @end
  297. @interface FIRInAppMessagingCampaignInfo ()
  298. /**
  299. * Optional experiment metadata for this message.
  300. */
  301. @property(nonatomic, nullable, copy, readonly) ABTExperimentPayload *experimentPayload;
  302. @end
  303. @implementation FIRInAppMessagingCampaignInfo
  304. - (instancetype)initWithMessageID:(NSString *)messageID
  305. campaignName:(NSString *)campaignName
  306. experimentPayload:(nullable ABTExperimentPayload *)experimentPayload
  307. renderAsTestMessage:(BOOL)renderAsTestMessage {
  308. if (self = [super init]) {
  309. _messageID = messageID;
  310. _campaignName = campaignName;
  311. _experimentPayload = experimentPayload;
  312. _renderAsTestMessage = renderAsTestMessage;
  313. }
  314. return self;
  315. }
  316. - (instancetype)initWithMessageID:(NSString *)messageID
  317. campaignName:(NSString *)campaignName
  318. renderAsTestMessage:(BOOL)renderAsTestMessage {
  319. return [self initWithMessageID:messageID
  320. campaignName:campaignName
  321. experimentPayload:nil
  322. renderAsTestMessage:renderAsTestMessage];
  323. }
  324. @end
  325. @implementation FIRInAppMessagingAction
  326. - (instancetype)initWithActionText:(nullable NSString *)actionText
  327. actionURL:(nullable NSURL *)actionURL {
  328. if (self = [super init]) {
  329. _actionText = actionText;
  330. _actionURL = actionURL;
  331. }
  332. return self;
  333. }
  334. @end