CustomInAppMessageDisplayViewModifier.swift 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  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 SwiftUI
  15. #if SWIFT_PACKAGE
  16. @_exported import FirebaseInAppMessagingInternal
  17. #endif // SWIFT_PACKAGE
  18. // MARK: Image-only messages.
  19. @available(iOS 13, tvOS 13, *)
  20. @available(iOSApplicationExtension, unavailable)
  21. @available(tvOSApplicationExtension, unavailable)
  22. struct ImageOnlyInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
  23. var closure: (InAppMessagingImageOnlyDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
  24. @ObservedObject var delegateBridge = DelegateBridge.shared
  25. func body(content: Content) -> some View {
  26. return content.overlay(overlayView())
  27. }
  28. @ViewBuilder
  29. func overlayView() -> some View {
  30. if let (message, delegate) = delegateBridge.inAppMessageData,
  31. let imageOnlyMessage = message as? InAppMessagingImageOnlyDisplay {
  32. closure(imageOnlyMessage, delegate)
  33. .onAppear { delegate.impressionDetected?(for: imageOnlyMessage) }
  34. } else {
  35. EmptyView()
  36. }
  37. }
  38. }
  39. @available(iOS 13, tvOS 13, *)
  40. @available(iOSApplicationExtension, unavailable)
  41. @available(tvOSApplicationExtension, unavailable)
  42. public extension View {
  43. /// Overrides the default display of an image only in-app message as defined on the Firebase
  44. /// console.
  45. func imageOnlyInAppMessage<Content: View>(closure: @escaping (InAppMessagingImageOnlyDisplay,
  46. InAppMessagingDisplayDelegate)
  47. -> Content)
  48. -> some View {
  49. modifier(ImageOnlyInAppMessageDisplayViewModifier(closure: closure))
  50. }
  51. }
  52. // MARK: Banner messages.
  53. @available(iOS 13, tvOS 13, *)
  54. @available(iOSApplicationExtension, unavailable)
  55. @available(tvOSApplicationExtension, unavailable)
  56. struct BannerInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
  57. var closure: (InAppMessagingBannerDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
  58. @ObservedObject var delegateBridge = DelegateBridge.shared
  59. func body(content: Content) -> some View {
  60. return content.overlay(overlayView())
  61. }
  62. @ViewBuilder
  63. func overlayView() -> some View {
  64. if let (message, delegate) = delegateBridge.inAppMessageData,
  65. let bannerMessage = message as? InAppMessagingBannerDisplay {
  66. closure(bannerMessage, delegate).onAppear { delegate.impressionDetected?(for: bannerMessage) }
  67. } else {
  68. EmptyView()
  69. }
  70. }
  71. }
  72. @available(iOS 13, tvOS 13, *)
  73. @available(iOSApplicationExtension, unavailable)
  74. @available(tvOSApplicationExtension, unavailable)
  75. public extension View {
  76. /// Overrides the default display of a banner in-app message as defined on the Firebase console.
  77. func bannerInAppMessage<Content: View>(closure: @escaping (InAppMessagingBannerDisplay,
  78. InAppMessagingDisplayDelegate)
  79. -> Content)
  80. -> some View {
  81. modifier(BannerInAppMessageDisplayViewModifier(closure: closure))
  82. }
  83. }
  84. // MARK: Modal messages.
  85. @available(iOS 13, tvOS 13, *)
  86. @available(iOSApplicationExtension, unavailable)
  87. @available(tvOSApplicationExtension, unavailable)
  88. struct ModalInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
  89. var closure: (InAppMessagingModalDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
  90. @ObservedObject var delegateBridge = DelegateBridge.shared
  91. func body(content: Content) -> some View {
  92. return content.overlay(overlayView())
  93. }
  94. @ViewBuilder
  95. func overlayView() -> some View {
  96. if let (message, delegate) = delegateBridge.inAppMessageData,
  97. let modalMessage = message as? InAppMessagingModalDisplay {
  98. closure(modalMessage, delegate).onAppear { delegate.impressionDetected?(for: modalMessage) }
  99. } else {
  100. EmptyView()
  101. }
  102. }
  103. }
  104. @available(iOS 13, tvOS 13, *)
  105. @available(iOSApplicationExtension, unavailable)
  106. @available(tvOSApplicationExtension, unavailable)
  107. public extension View {
  108. /// Overrides the default display of a modal in-app message as defined on the Firebase console.
  109. func modalInAppMessage<Content: View>(closure: @escaping (InAppMessagingModalDisplay,
  110. InAppMessagingDisplayDelegate)
  111. -> Content)
  112. -> some View {
  113. modifier(ModalInAppMessageDisplayViewModifier(closure: closure))
  114. }
  115. }
  116. // MARK: Card messages.
  117. @available(iOS 13, tvOS 13, *)
  118. @available(iOSApplicationExtension, unavailable)
  119. @available(tvOSApplicationExtension, unavailable)
  120. struct CardInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
  121. var closure: (InAppMessagingCardDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
  122. @ObservedObject var delegateBridge = DelegateBridge.shared
  123. func body(content: Content) -> some View {
  124. return content.overlay(overlayView())
  125. }
  126. @ViewBuilder
  127. func overlayView() -> some View {
  128. if let (message, delegate) = delegateBridge.inAppMessageData,
  129. let cardMessage = message as? InAppMessagingCardDisplay {
  130. closure(cardMessage, delegate).onAppear { delegate.impressionDetected?(for: cardMessage) }
  131. } else {
  132. EmptyView()
  133. }
  134. }
  135. }
  136. @available(iOS 13, tvOS 13, *)
  137. @available(iOSApplicationExtension, unavailable)
  138. @available(tvOSApplicationExtension, unavailable)
  139. public extension View {
  140. /// Overrides the default display of a card in-app message as defined on the Firebase console.
  141. func cardInAppMessage<Content: View>(closure: @escaping (InAppMessagingCardDisplay,
  142. InAppMessagingDisplayDelegate)
  143. -> Content)
  144. -> some View {
  145. modifier(CardInAppMessageDisplayViewModifier(closure: closure))
  146. }
  147. }
  148. // MARK: Bridge to Firebase In-App Messaging SDK.
  149. /**
  150. * A singleton that acts as the bridge between view modifiers for displaying custom in-app messages and the
  151. * in-app message fetch/display/interaction flow.
  152. */
  153. @available(iOS 13, tvOS 13, *)
  154. @available(iOSApplicationExtension, unavailable)
  155. @available(tvOSApplicationExtension, unavailable)
  156. class DelegateBridge: NSObject, InAppMessagingDisplay, InAppMessagingDisplayDelegate,
  157. ObservableObject {
  158. @Published var inAppMessageData: (InAppMessagingDisplayMessage,
  159. InAppMessagingDisplayDelegate)? = nil
  160. static let shared = DelegateBridge()
  161. override init() {
  162. super.init()
  163. InAppMessaging.inAppMessaging().messageDisplayComponent = self
  164. InAppMessaging.inAppMessaging().delegate = self
  165. }
  166. func displayMessage(_ messageForDisplay: InAppMessagingDisplayMessage,
  167. displayDelegate: InAppMessagingDisplayDelegate) {
  168. DispatchQueue.main.async {
  169. self.inAppMessageData = (messageForDisplay, displayDelegate)
  170. }
  171. }
  172. func messageClicked(_ inAppMessage: InAppMessagingDisplayMessage,
  173. with action: InAppMessagingAction) {
  174. DispatchQueue.main.async {
  175. self.inAppMessageData = nil
  176. }
  177. }
  178. func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
  179. dismissType: InAppMessagingDismissType) {
  180. DispatchQueue.main.async {
  181. self.inAppMessageData = nil
  182. }
  183. }
  184. }