CustomInAppMessageDisplayViewModifier.swift 6.5 KB

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