tvOS Reference Doc Changes (#583)

DellaBitta · web-flow · commit c361b8c7a120 · 2023-01-25T13:21:37.000-05:00
Update the reference docs to refer to tvOS when discussing particular methods and classes.
diff --git a/app/src/AppOptions.cs b/app/src/AppOptions.cs
@@ -72,7 +72,7 @@ public void Dispose() { }
   /// file or PROJECT_ID in the GoogleService-Info.plist.
   public string ProjectId { get; set; }
 
-  /// Gets or sets the Android or iOS client project name.
+  /// Gets or sets the Android, iOS or tvOS client project name.
   ///
   /// This is the project_name in the Android google-services.json config
   /// file or BUNDLE_ID in the GoogleService-Info.plist.
diff --git a/app/src/ErrorMessages.cs b/app/src/ErrorMessages.cs
@@ -43,8 +43,9 @@ internal class ErrorMessages {
       "* Rebuild your APK and deploy.\n";
 
   private static string DEPENDENCY_NOT_FOUND_ERROR_IOS =
-      "On iOS+ Firebase requires native (C/C++) and Cocoapod components\n" +
-      "that are distributed with the Firebase SDK and via Cocoapods.\n" +
+      "On iOS and tvOS Firebase requires native (C/C++) and Cocoapod\n" +
+      "components that are distributed with the Firebase SDK and via\n" +
+      "Cocoapods.\n" +
       "\n" +
       "It's likely that you did not include the require Cocoapod\n" +
       "dependencies for Firebase in your Unity project.\n" +
@@ -56,8 +57,8 @@ internal class ErrorMessages {
       "  iOS Resolver -> Settings'\n" +
       "* In the iOS Resolver settings check 'Podfile Generation' and\n" +
       "  'Add Cocoapods to Generated Xcode Project'.\n" +
-      "* Build your iOS project and check the Unity console for any\n" +
-      "  errors associated with Cocoapod tool execution.\n"  +
+      "* Build your iOS or tvOS project and check the Unity console for\n" +
+      "  any errors associated with Cocoapod tool execution.\n"  +
       "  You will need to correctly install Cocoapods tools to generate\n" +
       "  a working build.\n";
 
@@ -84,7 +85,7 @@ internal class ErrorMessages {
 
   private static string DLL_NOT_FOUND_ERROR_IOS =
       "A Firebase static library (e.g libApp.a) was not linked with your\n" +
-      "iOS application.\n";
+      "iOS or tvOS application.\n";
 
   private static string DLL_NOT_FOUND_ERROR_GENERIC =
       "A Firebase shared library (.dll / .so) could not be loaded.\n";
diff --git a/app/src/swig/app.i b/app/src/swig/app.i
@@ -479,7 +479,7 @@ static firebase::AppOptions* AppOptionsLoadFromJsonConfig(const char* config) {
   /// @endcode
   /// @endif
   ///
-  /// or on iOS to your Info.plist:
+  /// or on iOS or tvOS to your Info.plist:
   ///
   /// @if NOT_DOXYGEN
   ///   <key>FirebaseDataCollectionDefaultEnabled</key>
diff --git a/app/src/swig/future.i b/app/src/swig/future.i
@@ -250,7 +250,7 @@ namespace firebase {
 %define %SWIG_FUTURE_FOOTER(CSNAME, CSTYPE, CTYPE)
   public delegate void Action();
 
-  // On iOS, in order to marshal a delegate from C#, it needs both a
+  // On iOS and tvOS, in order to marshal a delegate from C#, it needs both a
   // MonoPInvokeCallback attribute, and be static.
   // Because of this need to be static, the instanced callbacks need to be
   // saved in a way that can be obtained later, hence the use of a static
diff --git a/auth/src/PhoneAuthProvider.cs b/auth/src/PhoneAuthProvider.cs
@@ -23,6 +23,8 @@ namespace Firebase.Auth {
 /// Allows developers to use the phone number and SMS verification codes
 /// to authenticate a user.
 ///
+/// This class is not supported on tvOS and Desktop platforms.
+///
 /// The verification flow results in a Credential that can be used to,
 /// * Sign in to an existing phone number account/sign up with a new
 ///   phone number
diff --git a/auth/src/swig/auth.i b/auth/src/swig/auth.i
@@ -473,9 +473,9 @@ static CppInstanceManager<Auth> g_auth_instances;
 
   /// Sign-in a user authenticated via a federated auth provider.
   ///
-  /// @note: This operation is supported only on iOS and Android platforms. On
-  /// non-mobile platforms this method will return a Future with a preset error
-  /// code: kAuthErrorUnimplemented.
+  /// @note: This operation is supported only on iOS, tvOS and Android
+  /// platforms. On other platforms this method will return a Future with a
+  /// preset error code: kAuthErrorUnimplemented.
   public System.Threading.Tasks.Task<SignInResult> SignInWithProviderAsync(
       FederatedAuthProvider provider) {
     ThrowIfNull();
@@ -1087,9 +1087,9 @@ static CppInstanceManager<Auth> g_auth_instances;
 
   /// Reauthenticate a user via a federated auth provider.
   ///
-  /// @note: This operation is supported only on iOS and Android platforms. On
-  /// non-mobile platforms this method will return a Future with a preset error
-  /// code: kAuthErrorUnimplemented.
+  /// @note: This operation is supported only on iOS, tvOS and Android
+  /// platforms. On other platforms this method will return a Future with a
+  /// preset error code: kAuthErrorUnimplemented.
   public System.Threading.Tasks.Task<SignInResult>
       ReauthenticateWithProviderAsync(FederatedAuthProvider provider) {
     ThrowIfNull();
@@ -1110,9 +1110,9 @@ static CppInstanceManager<Auth> g_auth_instances;
 
   /// Link a user via a federated auth provider.
   ///
-  /// @note: This operation is supported only on iOS and Android platforms. On
-  /// non-mobile platforms this method will return a Future with a preset error
-  /// code: kAuthErrorUnimplemented.
+  /// @note: This operation is supported only on iOS, tvOS and Android
+  /// platforms. On other platforms this method will return a Future with a
+  /// preset error code: kAuthErrorUnimplemented.
   public System.Threading.Tasks.Task<SignInResult> LinkWithProviderAsync(
       FederatedAuthProvider provider) {
     ThrowIfNull();
diff --git a/crashlytics/src/IOSImpl.cs b/crashlytics/src/IOSImpl.cs
@@ -34,7 +34,7 @@ internal struct Frame
   }
   
 
-  // Stub implementation that is not used on iOS.
+  // Stub implementation that is not used on iOS or tvOS.
   internal class AndroidImpl : Impl {}
 
   //TODO(b/112043008): These extern symbols aren't available for Android builds.
diff --git a/crashlytics/src/Metadata.cs b/crashlytics/src/Metadata.cs
@@ -22,7 +22,7 @@ namespace Firebase.Crashlytics {
   /// Represents the Unity-specific metadata object that is transformed into JSON.
   ///
   /// Metadata keys are acronyms to save space as there are limits to the maximum size of Keys in
-  /// the Android and iOS SDK.
+  /// the Android, iOS and tvOS SDKs.
   /// </summary>
   internal class Metadata {
     // unityVersion: Version of Unity Engine
diff --git a/crashlytics/testapp/Assets/Firebase/Sample/Crashlytics/UIHandler.cs b/crashlytics/testapp/Assets/Firebase/Sample/Crashlytics/UIHandler.cs
@@ -63,7 +63,8 @@ void InitializeFirebase() {
     // End our session when the program exits.
     void OnDestroy() { }
 
-    // Causes an error that will crash the app at the platform level (Android or iOS)
+    // Causes an error that will crash the app at the platform level (Android,
+    // iOS or tvOS)
     public void ThrowUncaughtException() {
       DebugLog("Causing a platform crash.");
       throw new InvalidOperationException("Uncaught exception created from UI.");
diff --git a/database/src/Query.cs b/database/src/Query.cs
@@ -351,7 +351,7 @@ public Query EqualTo(bool value) {
     ///   Create a query constrained to only return the child node with the given key and value.
     ///   Note that there is at most one such child as names are unique. <br />
     ///   <br />
-    ///   <b>Known issue</b> This currently does not work properly on iOS. Please use
+    ///   <b>Known issue</b> This currently does not work properly on iOS and tvOS. Please use
     ///   EqualTo(string value) instead.
     /// </remarks>
     /// <param name="value">The value to query for</param>
@@ -368,7 +368,7 @@ public Query EqualTo(string value, string key) {
     ///   Create a query constrained to only return the child node with the given key and value.
     ///   Note that there is at most one such child as keys are unique. <br />
     ///   <br />
-    ///   <b>Known issue</b> This currently does not work properly on iOS. Please use
+    ///   <b>Known issue</b> This currently does not work properly on iOS and tvOS. Please use
     ///   EqualTo(double value) instead.
     /// </remarks>
     /// <param name="value">The value to query for</param>
@@ -385,7 +385,7 @@ public Query EqualTo(double value, string key) {
     ///   Create a query constrained to only return the child node with the given key and value.
     ///   Note that there is at most one such child as keys are unique. <br />
     ///   <br />
-    ///   <b>Known issue</b> This currently does not work properly on iOS. Please use
+    ///   <b>Known issue</b> This currently does not work properly on iOS and tvOS. Please use
     ///   EqualTo(bool value) instead.
     /// </remarks>
     /// <param name="value">The value to query for</param>
diff --git a/docs/readme.md b/docs/readme.md
@@ -2,7 +2,9 @@ Firebase Unity SDK
 ==================
 
 The Firebase Unity SDK provides Unity packages for the following Firebase
-features on *iOS* and *Android*:
+features on *iOS*, *tvOS* and *Android*.
+
+Note: Firebase Dynamic Links is not supported on tvOS.
 
 | Feature                            | Unity Package                     |
 |:----------------------------------:|:---------------------------------:|
@@ -67,8 +69,11 @@ Support
 
 Release Notes
 -------------
-### Upcoming Release
+### 10.4.0
 - Changes
+    - Firebase introduces Unity SDK support for tvOS, for Analytics,
+      Authentication, Crashlytics, Database, Firestore, Cloud Functions,
+      Installations, Messaging, Remote Config and Storage.
     - Analytics: Added `SetConsent()` and `GetSessionIdAsync()` APIs.
     - Crashlytics: Added `ReportUncaughtExceptionsAsFatal` property and `LogExceptionAsFatal` API.
 
diff --git a/firestore/src/swig/firestore.i b/firestore/src/swig/firestore.i
@@ -159,8 +159,8 @@ static void SWIG_CSharpSetPendingExceptionFirestore(const char* msg) {
 // Important: `invalid_argument` is a subclass of `logic_error` -- make sure
 // they are checked in order from most to least derived.
 //
-// The catch-all clause is to work around iOS issues where some exception types
-// aren't getting caught correctly.
+// The catch-all clause is to work around iOS and tvOS issues where some
+// exception types aren't getting caught correctly.
 %exception {
   try {
     $action
diff --git a/installations/src/swig/installations.i b/installations/src/swig/installations.i
@@ -151,7 +151,7 @@ static CppInstanceManager<Installations> g_installations_instances;
   /// `Installations` if required.
   ///
   /// @param[in] app The `App` to create an `Installations` object from. On
-  /// **iOS** this must be the default Firebase `App`.
+  /// **iOS and tvOS** this must be the default Firebase `App`.
   ///
   /// @returns Installations object if successful, null otherwise.
   public static FirebaseInstallations GetInstance(FirebaseApp app) {
diff --git a/messaging/src/swig/messaging.i b/messaging/src/swig/messaging.i
@@ -412,7 +412,7 @@ void* NotificationCopyAndroidNotificationParams(void* notification) {
   /// If this setting is enabled, it triggers the token registration refresh
   /// immediately. This setting is persisted across app restarts and overrides
   /// the setting "firebase_messaging_auto_init_enabled" specified in your
-  /// Android manifest (on Android) or Info.plist (on iOS).
+  /// Android manifest (on Android) or Info.plist (on iOS and tvOS).
   ///
   /// <p>By default, token registration during initialization is enabled.
   ///
@@ -431,7 +431,7 @@ void* NotificationCopyAndroidNotificationParams(void* notification) {
   /// @endcode
   /// @endif
   ///
-  /// or on iOS to your Info.plist:
+  /// or on iOS or tvOS to your Info.plist:
   ///
   /// @if NOT_DOXYGEN
   ///   <key>FirebaseMessagingAutoInitEnabled</key>
@@ -847,8 +847,8 @@ void* NotificationCopyAndroidNotificationParams(void* notification) {
 // The following docs are all here instead of the header due to b/35780150.
 
 %csmethodmodifiers firebase::messaging::Notification::title "
-  /// Indicates notification title. This field is not visible on iOS phones
-  /// and tablets.
+  /// Indicates notification title. This field is not visible on tvOS, iOS
+  /// phones and tablets.
   public"
 
 %csmethodmodifiers firebase::messaging::Notification::body "
@@ -865,13 +865,13 @@ void* NotificationCopyAndroidNotificationParams(void* notification) {
   /// Supports default, or the filename of a sound resource bundled in the
   /// app.
   ///
-  /// Android sound files must reside in /res/raw/, while iOS sound files
-  /// can be in the main bundle of the client app or in the Library/Sounds
-  /// folder of the app’s data container.
+  /// Android sound files must reside in /res/raw/, while tvOS and iOS sound
+  /// files can be in the main bundle of the client app or in the
+  /// Library/Sounds folder of the app’s data container.
   public"
 
 %csmethodmodifiers firebase::messaging::Notification::badge "
-  /// Indicates the badge on the client app home icon. iOS only.
+  /// Indicates the badge on the client app home icon. iOS and tvOS only.
   public"
 
 %csmethodmodifiers firebase::messaging::Notification::tag "
@@ -892,13 +892,13 @@ void* NotificationCopyAndroidNotificationParams(void* notification) {
   /// On Android, if this is set, an activity with a matching intent filter is
   /// launched when user clicks the notification.
   ///
-  /// If set on iOS, corresponds to category in APNS payload.
+  /// If set on iOS or tvOS, corresponds to category in APNS payload.
   public"
 
 %csmethodmodifiers firebase::messaging::Notification::body_loc_key "
   /// Indicates the key to the body string for localization.
   ///
-  /// On iOS, this corresponds to \"loc-key\" in APNS payload.
+  /// On iOS and tvOS, this corresponds to \"loc-key\" in APNS payload.
   ///
   /// On Android, use the key in the app's string resources when populating this
   /// value.
@@ -908,7 +908,7 @@ void* NotificationCopyAndroidNotificationParams(void* notification) {
   /// Indicates the string value to replace format specifiers in body string
   /// for localization.
   ///
-  /// On iOS, this corresponds to \"loc-args\" in APNS payload.
+  /// On iOS and tvOS, this corresponds to \"loc-args\" in APNS payload.
   ///
   /// On Android, these are the format arguments for the string resource. For
   /// more information, see [Formatting strings][1].
@@ -920,7 +920,7 @@ void* NotificationCopyAndroidNotificationParams(void* notification) {
 %csmethodmodifiers firebase::messaging::Notification::title_loc_key "
   /// Indicates the key to the title string for localization.
   ///
-  /// On iOS, this corresponds to \"title-loc-key\" in APNS payload.
+  /// On iOS and tvOS, this corresponds to \"title-loc-key\" in APNS payload.
   ///
   /// On Android, use the key in the app's string resources when populating this
   /// value.
@@ -930,7 +930,7 @@ void* NotificationCopyAndroidNotificationParams(void* notification) {
   /// Indicates the string value to replace format specifiers in title string
   /// for localization.
   ///
-  /// On iOS, this corresponds to \"title-loc-args\" in APNS payload.
+  /// On iOS and tvOS, this corresponds to \"title-loc-args\" in APNS payload.
   ///
   /// On Android, these are the format arguments for the string resource. For
   /// more information, see [Formatting strings][1].

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ internal struct Frame`
`34`	`34`	`}`
`35`	`35`
`36`	`36`
`37`		`- // Stub implementation that is not used on iOS.`
	`37`	`+ // Stub implementation that is not used on iOS or tvOS.`
`38`	`38`	`internal class AndroidImpl : Impl {}`
`39`	`39`
`40`	`40`	`//TODO(b/112043008): These extern symbols aren't available for Android builds.`