FIRInAppMessagingRenderingDataClasses.m 15 KB

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