Update FIAM to use NS_UNAVAILABLE (#8480)

* Update fiam to use ns_unavailable

* add pr number

* Add missing doc comment

* fix test

Author: morganchen12

FirebaseInAppMessaging/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 2021-8 -- v8.6.0
+- [changed] Replaced conditionally-compiled APIs with `API_UNAVAILABLE` annotations on unsupported platforms (#8480).
+
 # 2021-8 -- v.8.5.0
 - [added] Added support for unit testing with in-app message data objects (#8351).
 - [added] Added support for prototyping custom in-app message views in SwiftUI (#8351).

FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessaging.h

@@ -14,9 +14,6 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if TARGET_OS_IOS || TARGET_OS_TV
-
 #import <Foundation/Foundation.h>
 
 @class FIRApp;
@@ -41,9 +38,12 @@ NS_ASSUME_NONNULL_BEGIN
  *      Swift or YES/NO (objective-c).
  *   2. Set `FirebaseInAppMessagingAutomaticDataCollectionEnabled` to false in the app's plist file.
  *   3. Global Firebase data collection setting.
+ *
+ * This class is unavailable on macOS, macOS Catalyst, and watchOS.
  **/
 
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessaging)
 @interface FIRInAppMessaging : NSObject
 /** @fn inAppMessaging
@@ -94,5 +94,3 @@ NS_SWIFT_NAME(InAppMessaging)
 
 @end
 NS_ASSUME_NONNULL_END
-
-#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingRendering.h

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if TARGET_OS_IOS || TARGET_OS_TV
+#import <Foundation/Foundation.h>
 
-#import <UIKit/UIKit.h>
+@class UIColor;
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// The type and UI style of an in-app message.
+/// The type and UI style of an in-app message. This enum is unavailable on macOS, macOS Catalyst,
+/// and watchOS.
 typedef NS_ENUM(NSInteger, FIRInAppMessagingDisplayMessageType) {
   /// Modal style.
   FIRInAppMessagingDisplayMessageTypeModal,
@@ -31,18 +31,21 @@ typedef NS_ENUM(NSInteger, FIRInAppMessagingDisplayMessageType) {
   FIRInAppMessagingDisplayMessageTypeImageOnly,
   /// Card style.
   FIRInAppMessagingDisplayMessageTypeCard
-};
+} API_UNAVAILABLE(macos, watchos);
 
-/// Represents how an in-app message should be triggered to appear.
+/// Represents how an in-app message should be triggered to appear.  This enum is unavailable on
+/// macOS, macOS Catalyst, and watchOS.
 typedef NS_ENUM(NSInteger, FIRInAppMessagingDisplayTriggerType) {
   /// Triggered on app foreground.
   FIRInAppMessagingDisplayTriggerTypeOnAppForeground,
   /// Triggered from an analytics event being fired.
   FIRInAppMessagingDisplayTriggerTypeOnAnalyticsEvent
-};
+} API_UNAVAILABLE(macos, watchos);
 
-/** Contains the display information for an action button.
+/** Contains the display information for an action button.  This class is unavailable on macOS,
+ * macOS Catalyst, and watchOS.
  */
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingActionButton)
 @interface FIRInAppMessagingActionButton : NSObject
 
@@ -73,8 +76,10 @@ NS_SWIFT_NAME(InAppMessagingActionButton)
 @end
 
 /** Contain display data for an image for a fiam message.
+ *  This class is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingImageData)
 @interface FIRInAppMessagingImageData : NSObject
 
@@ -98,8 +103,10 @@ NS_SWIFT_NAME(InAppMessagingImageData)
 @end
 
 /** Defines the metadata for the campaign to which a FIAM message belongs.
+ *  This class is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingCampaignInfo)
 @interface FIRInAppMessagingCampaignInfo : NSObject
 
@@ -124,8 +131,10 @@ NS_SWIFT_NAME(InAppMessagingCampaignInfo)
 @end
 
 /** Defines the metadata for a FIAM action.
+ *  This class is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingAction)
 @interface FIRInAppMessagingAction : NSObject
 
@@ -151,8 +160,10 @@ NS_SWIFT_NAME(InAppMessagingAction)
 /**
  * Base class representing a FIAM message to be displayed. Don't create instance
  * of this class directly. Instantiate one of its subclasses instead.
+ * This class is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingDisplayMessage)
 @interface FIRInAppMessagingDisplayMessage : NSObject
 
@@ -188,7 +199,12 @@ NS_SWIFT_NAME(InAppMessagingDisplayMessage)
 
 @end
 
+/**
+ * A displayable in-app card message.
+ * This class is unavailable on macOS, macOS Catalyst, and watchOS.
+ */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingCardDisplay)
 @interface FIRInAppMessagingCardDisplay : FIRInAppMessagingDisplayMessage
 
@@ -262,9 +278,12 @@ NS_SWIFT_NAME(InAppMessagingCardDisplay)
 
 @end
 
-/** Class for defining a modal message for display.
+/**
+ * Class for defining a modal message for display.
+ * This class is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingModalDisplay)
 @interface FIRInAppMessagingModalDisplay : FIRInAppMessagingDisplayMessage
 
@@ -320,9 +339,12 @@ NS_SWIFT_NAME(InAppMessagingModalDisplay)
 
 @end
 
-/** Class for defining a banner message for display.
+/**
+ * Class for defining a banner message for display.
+ * This class is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingBannerDisplay)
 @interface FIRInAppMessagingBannerDisplay : FIRInAppMessagingDisplayMessage
 
@@ -372,9 +394,12 @@ NS_SWIFT_NAME(InAppMessagingBannerDisplay)
 
 @end
 
-/** Class for defining a image-only message for display.
+/**
+ * Class for defining a image-only message for display.
+ * This class is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingImageOnlyDisplay)
 @interface FIRInAppMessagingImageOnlyDisplay : FIRInAppMessagingDisplayMessage
 
@@ -401,6 +426,7 @@ NS_SWIFT_NAME(InAppMessagingImageOnlyDisplay)
 @end
 
 /// The way that an in-app message was dismissed.
+/// This enum is unavailable on macOS, macOS Catalyst, and watchOS.
 typedef NS_ENUM(NSInteger, FIRInAppMessagingDismissType) {
   /// Message was swiped away (only valid for banner messages).
   FIRInAppMessagingDismissTypeUserSwipe,
@@ -410,21 +436,24 @@ typedef NS_ENUM(NSInteger, FIRInAppMessagingDismissType) {
   FIRInAppMessagingDismissTypeAuto,
   /// Dismiss method unknown.
   FIRInAppMessagingDismissUnspecified,
-};
+} API_UNAVAILABLE(macos, watchos);
 
 /// Error code for an in-app message that failed to display.
+/// This enum is unavailable on macOS, macOS Catalyst, and watchOS.
 typedef NS_ENUM(NSInteger, FIAMDisplayRenderErrorType) {
   /// The image data for this in-app message is invalid.
   FIAMDisplayRenderErrorTypeImageDataInvalid,
   /// Unexpected error.
   FIAMDisplayRenderErrorTypeUnspecifiedError,
-};
+} API_UNAVAILABLE(macos, watchos);
 
 /**
  * A protocol defining those callbacks to be triggered by the message display component
  * under appropriate conditions.
+ * This protocol is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingDisplayDelegate)
 @protocol FIRInAppMessagingDisplayDelegate <NSObject>
 
@@ -481,8 +510,10 @@ NS_SWIFT_NAME(InAppMessagingDisplayDelegate)
 
 /**
  * The protocol that a FIAM display component must implement.
+ * This protocol is unavailable on macOS, macOS Catalyst, and watchOS.
  */
 NS_EXTENSION_UNAVAILABLE("Firebase In App Messaging is not supported for iOS extensions.")
+API_UNAVAILABLE(macos, watchos)
 NS_SWIFT_NAME(InAppMessagingDisplay)
 @protocol FIRInAppMessagingDisplay
 
@@ -497,5 +528,3 @@ NS_SWIFT_NAME(InAppMessagingDisplay)
        displayDelegate:(id<FIRInAppMessagingDisplayDelegate>)displayDelegate;
 @end
 NS_ASSUME_NONNULL_END
-
-#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Tests/Integration/DefaultUITestApp/FiamDisplaySwiftExample/CommonMessageTestVC.swift

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import Foundation
+import UIKit
 
 class CommonMessageTestVC: UIViewController, InAppMessagingDisplayDelegate {
   var messageClosedWithClick = false