CustomInAppMessageDisplayViewModifier.swift 7.4 KB

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