CustomInAppMessageDisplayViewModifier.swift 7.0 KB

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