CustomInAppMessageDisplayViewModifier.swift 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. // Copyright 2021 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. import FirebaseInAppMessaging
  15. import SwiftUI
  16. // MARK: Image-only messages.
  17. @available(iOS 13, tvOS 13, *)
  18. @available(iOSApplicationExtension, unavailable)
  19. @available(tvOSApplicationExtension, unavailable)
  20. struct ImageOnlyInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
  21. var closure: (InAppMessagingImageOnlyDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
  22. @ObservedObject var delegateBridge = DelegateBridge.shared
  23. func body(content: Content) -> some View {
  24. return content.overlay(overlayView())
  25. }
  26. @ViewBuilder
  27. func overlayView() -> some View {
  28. if let (message, delegate) = delegateBridge.inAppMessageData,
  29. let imageOnlyMessage = message as? InAppMessagingImageOnlyDisplay {
  30. closure(imageOnlyMessage, delegate)
  31. .onAppear { delegate.impressionDetected?(for: imageOnlyMessage) }
  32. } else {
  33. EmptyView()
  34. }
  35. }
  36. }
  37. @available(iOS 13, tvOS 13, *)
  38. @available(iOSApplicationExtension, unavailable)
  39. @available(tvOSApplicationExtension, unavailable)
  40. public extension View {
  41. /// Overrides the default display of an image only in-app message as defined on the Firebase console.
  42. func imageOnlyInAppMessage<Content: View>(closure: @escaping (InAppMessagingImageOnlyDisplay,
  43. InAppMessagingDisplayDelegate)
  44. -> Content)
  45. -> some View {
  46. modifier(ImageOnlyInAppMessageDisplayViewModifier(closure: closure))
  47. }
  48. }
  49. // MARK: Banner messages.
  50. @available(iOS 13, tvOS 13, *)
  51. @available(iOSApplicationExtension, unavailable)
  52. @available(tvOSApplicationExtension, unavailable)
  53. struct BannerInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
  54. var closure: (InAppMessagingBannerDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
  55. @ObservedObject var delegateBridge = DelegateBridge.shared
  56. func body(content: Content) -> some View {
  57. return content.overlay(overlayView())
  58. }
  59. @ViewBuilder
  60. func overlayView() -> some View {
  61. if let (message, delegate) = delegateBridge.inAppMessageData,
  62. let bannerMessage = message as? InAppMessagingBannerDisplay {
  63. closure(bannerMessage, delegate).onAppear { delegate.impressionDetected?(for: bannerMessage) }
  64. } else {
  65. EmptyView()
  66. }
  67. }
  68. }
  69. @available(iOS 13, tvOS 13, *)
  70. @available(iOSApplicationExtension, unavailable)
  71. @available(tvOSApplicationExtension, unavailable)
  72. public extension View {
  73. /// Overrides the default display of a banner in-app message as defined on the Firebase console.
  74. func bannerInAppMessage<Content: View>(closure: @escaping (InAppMessagingBannerDisplay,
  75. InAppMessagingDisplayDelegate)
  76. -> Content)
  77. -> some View {
  78. modifier(BannerInAppMessageDisplayViewModifier(closure: closure))
  79. }
  80. }
  81. // MARK: Modal messages.
  82. @available(iOS 13, tvOS 13, *)
  83. @available(iOSApplicationExtension, unavailable)
  84. @available(tvOSApplicationExtension, unavailable)
  85. struct ModalInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
  86. var closure: (InAppMessagingModalDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
  87. @ObservedObject var delegateBridge = DelegateBridge.shared
  88. func body(content: Content) -> some View {
  89. return content.overlay(overlayView())
  90. }
  91. @ViewBuilder
  92. func overlayView() -> some View {
  93. if let (message, delegate) = delegateBridge.inAppMessageData,
  94. let modalMessage = message as? InAppMessagingModalDisplay {
  95. closure(modalMessage, delegate).onAppear { delegate.impressionDetected?(for: modalMessage) }
  96. } else {
  97. EmptyView()
  98. }
  99. }
  100. }
  101. @available(iOS 13, tvOS 13, *)
  102. @available(iOSApplicationExtension, unavailable)
  103. @available(tvOSApplicationExtension, unavailable)
  104. public extension View {
  105. /// Overrides the default display of a modal in-app message as defined on the Firebase console.
  106. func modalInAppMessage<Content: View>(closure: @escaping (InAppMessagingModalDisplay,
  107. InAppMessagingDisplayDelegate)
  108. -> Content)
  109. -> some View {
  110. modifier(ModalInAppMessageDisplayViewModifier(closure: closure))
  111. }
  112. }
  113. // MARK: Card messages.
  114. @available(iOS 13, tvOS 13, *)
  115. @available(iOSApplicationExtension, unavailable)
  116. @available(tvOSApplicationExtension, unavailable)
  117. struct CardInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
  118. var closure: (InAppMessagingCardDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
  119. @ObservedObject var delegateBridge = DelegateBridge.shared
  120. func body(content: Content) -> some View {
  121. return content.overlay(overlayView())
  122. }
  123. @ViewBuilder
  124. func overlayView() -> some View {
  125. if let (message, delegate) = delegateBridge.inAppMessageData,
  126. let cardMessage = message as? InAppMessagingCardDisplay {
  127. closure(cardMessage, delegate).onAppear { delegate.impressionDetected?(for: cardMessage) }
  128. } else {
  129. EmptyView()
  130. }
  131. }
  132. }
  133. @available(iOS 13, tvOS 13, *)
  134. @available(iOSApplicationExtension, unavailable)
  135. @available(tvOSApplicationExtension, unavailable)
  136. public extension View {
  137. /// Overrides the default display of a card in-app message as defined on the Firebase console.
  138. func cardInAppMessage<Content: View>(closure: @escaping (InAppMessagingCardDisplay,
  139. InAppMessagingDisplayDelegate)
  140. -> Content)
  141. -> some View {
  142. modifier(CardInAppMessageDisplayViewModifier(closure: closure))
  143. }
  144. }
  145. // MARK: Bridge to Firebase In-App Messaging SDK.
  146. /**
  147. * A singleton that acts as the bridge between view modifiers for displaying custom in-app messages and the
  148. * in-app message fetch/display/interaction flow.
  149. */
  150. @available(iOS 13, tvOS 13, *)
  151. @available(iOSApplicationExtension, unavailable)
  152. @available(tvOSApplicationExtension, unavailable)
  153. class DelegateBridge: NSObject, InAppMessagingDisplay, InAppMessagingDisplayDelegate,
  154. ObservableObject {
  155. @Published var inAppMessageData: (InAppMessagingDisplayMessage,
  156. InAppMessagingDisplayDelegate)? = nil
  157. static let shared = DelegateBridge()
  158. override init() {
  159. super.init()
  160. InAppMessaging.inAppMessaging().messageDisplayComponent = self
  161. InAppMessaging.inAppMessaging().delegate = self
  162. }
  163. func displayMessage(_ messageForDisplay: InAppMessagingDisplayMessage,
  164. displayDelegate: InAppMessagingDisplayDelegate) {
  165. DispatchQueue.main.async {
  166. self.inAppMessageData = (messageForDisplay, displayDelegate)
  167. }
  168. }
  169. func messageClicked(_ inAppMessage: InAppMessagingDisplayMessage,
  170. with action: InAppMessagingAction) {
  171. DispatchQueue.main.async {
  172. self.inAppMessageData = nil
  173. }
  174. }
  175. func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
  176. dismissType: FIRInAppMessagingDismissType) {
  177. DispatchQueue.main.async {
  178. self.inAppMessageData = nil
  179. }
  180. }
  181. }