tvOS Reference Docs Changes (#1175)

Update the reference docs to refer to tvOS when discussing particular methods and classes.

Author: DellaBitta

analytics/src/include/firebase/analytics.h

@@ -479,9 +479,9 @@ void LogEvent(const char* name, const Parameter* parameters,
               size_t number_of_parameters);
 
 /// Initiates on-device conversion measurement given a user email address on iOS
-/// (no-op on Android). On iOS, requires dependency
-/// GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a
-/// no-op.
+/// and tvOS (no-op on Android). On iOS and tvOS, this method requires the
+/// dependency GoogleAppMeasurementOnDeviceConversion to be linked in,
+/// otherwise the invocation results in a no-op.
 /// @param[in] email_address User email address. Include a domain name for all
 /// email addresses (e.g. gmail.com or hotmail.co.jp).
 void InitiateOnDeviceConversionMeasurementWithEmailAddress(

auth/src/include/firebase/auth.h

@@ -174,7 +174,7 @@ class Auth {
   void set_language_code(const char* language_code);
 
   /// Sets the user-facing language code to be the default app language. This
-  /// uses a languge associated with the phone's locale data.  On desktop
+  /// uses a language associated with the device's locale data.  On desktop
   /// this will set the language code to the Firebase service's default. You
   /// may subsequently customize the language code again by invoking
   /// set_language_code().
@@ -262,9 +262,9 @@ class Auth {
   ///
   /// @return A Future with the result of the sign-in request.
   ///
-  /// @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.
   Future<SignInResult> SignInWithProvider(FederatedAuthProvider* provider);
 
   /// Asynchronously logs into Firebase with the given credentials.
@@ -883,8 +883,8 @@ class FederatedOAuthProvider : public FederatedAuthProvider {
   ///
   /// An AuthHandler is required on desktop platforms to facilitate custom
   /// implementations of OAuth authentication. The AuthHandler must outlive the
-  /// instance of this OAuthProvider on desktop systems and is ignored on iOS
-  /// and Android platforms.
+  /// instance of this OAuthProvider on desktop systems and is ignored on iOS,
+  /// tvOS, and Android platforms.
   ///
   /// @param[in] provider_data Contains information on the provider to
   /// authenticate with.
@@ -910,7 +910,7 @@ class FederatedOAuthProvider : public FederatedAuthProvider {
   /// @brief Configures the use of an AuthHandler for non-mobile systems.
   ///
   /// The existence of a handler is required for non-mobile systems, and is
-  /// ignored on iOS and Android platforms.
+  /// ignored on iOS, tvOS and Android platforms.
   ///
   /// @param[in] handler An FederatedOAuthProviderData typed
   /// FederatedAuthProvider::Handler which be invoked on non-mobile systems

auth/src/include/firebase/auth/credential.h

@@ -155,7 +155,7 @@ class FacebookAuthProvider {
   static const char* const kProviderId;
 };
 
-/// @brief GameCenter (iOS) auth provider
+/// @brief GameCenter (Apple) auth provider
 class GameCenterAuthProvider {
  public:
   /// Generate a credential from GameCenter for the current user.
@@ -243,7 +243,9 @@ class OAuthProvider {
 /// @brief Use phone number text messages to authenticate.
 ///
 /// Allows developers to use the phone number and SMS verification codes
-/// to authenticate a user.
+/// to authenticate a user on a mobile device.
+///
+/// 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

auth/src/include/firebase/auth/types.h

@@ -238,29 +238,29 @@ enum AuthError {
 
   /// Indicates that the reCAPTCHA token is not valid.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorCaptchaCheckFailed,
 
   /// Indicates that an invalid APNS device token was used in the verifyClient
   /// request.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorInvalidAppCredential,
 
   /// Indicates that the APNS device token is missing in the verifyClient
   /// request.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorMissingAppCredential,
 
   /// Indicates that the clientID used to invoke a web flow is invalid.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorInvalidClientId,
 
   /// Indicates that the domain specified in the continue URI is not valid.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorInvalidContinueUri,
 
   /// Indicates that a continue URI was not provided in a request to the backend
@@ -270,32 +270,32 @@ enum AuthError {
   /// Indicates an error occurred while attempting to access the keychain.
   /// Common error code for all API Methods.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorKeychainError,
 
   /// Indicates that the APNs device token could not be obtained. The app may
   /// not have set up remote notification correctly, or may have failed to
   /// forward the APNs device token to FIRAuth if app delegate swizzling is
   /// disabled.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorMissingAppToken,
 
   /// Indicates that the iOS bundle ID is missing when an iOS App Store ID is
   /// provided.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorMissingIosBundleId,
 
   /// Indicates that the app fails to forward remote notification to FIRAuth.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorNotificationNotForwarded,
 
   /// Indicates that the domain specified in the continue URL is not white-
   /// listed in the Firebase console.
   ///
-  /// @note This error is iOS-specific.
+  /// @note This error is iOS and tvOS-specific.
   kAuthErrorUnauthorizedDomain,
 
   /// Indicates that an attempt was made to present a new web context while one

auth/src/include/firebase/auth/user.h

@@ -291,9 +291,9 @@ class User : public UserInfoInterface {
   /// authenticate with.
   /// @return A Future<SignInResult> with the result of the re-authentication
   /// request.
-  /// @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.
   Future<SignInResult> ReauthenticateWithProvider(
       FederatedAuthProvider* provider) const;
 
@@ -341,9 +341,9 @@ class User : public UserInfoInterface {
   /// @return A Future<SignInResult> with the user data result of the link
   /// request.
   ///
-  /// @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.
   Future<SignInResult> LinkWithProvider(FederatedAuthProvider* provider) const;
 
   /// Unlinks the current user from the provider specified.

database/src/include/firebase/database/query.h

@@ -266,6 +266,7 @@ class Query {
   /// @returns A Query in this same location, filtering out child nodes that
   /// have a different sort value than the sort value specified.
   Query EqualTo(Variant order_value);
+
   /// @brief Get a Query constrained to nodes with the exact given sort value,
   /// and the exact given key.
   ///
@@ -274,7 +275,7 @@ class Query {
   /// as default), and the given key. Note that there is at most one such child
   /// as child key names are unique.
   ///
-  /// <b>Known issue</b> This currently does not work properly on iOS and
+  /// <b>Known issue</b> This currently does not work properly on iOS, tvOS and
   /// desktop. Please use EqualTo(Variant order_value) instead.
   ///
   /// @param[in] order_value The exact sort value the Query should include.

firestore/src/include/firebase/firestore/settings.h

@@ -168,7 +168,7 @@ class Settings final {
    * `set_dispatch_queue()`.
    *
    * @note This method is only available when `__OBJC__` is defined, such as
-   * when compiling for iOS.
+   * when compiling for iOS or tvOS.
    *
    * @see `set_dispatch_queue(dispatch_queue_t)` for information on how to
    * explicitly set the dispatch queue to use.
@@ -184,7 +184,7 @@ class Settings final {
    * @param queue The dispatch queue to use.
    *
    * @note This method is only available when `__OBJC__` is defined, such as
-   * when compiling for iOS.
+   * when compiling for iOS or tvOS.
    *
    * @see `dispatch_queue()` for the "get" counterpart to this method.
    */

functions/src/include/firebase/functions/common.h

@@ -181,10 +181,6 @@ enum Error {
   // HTTP Mapping: 500 Internal Server Error
   kErrorDataLoss = 15,
 
-#ifdef INTERNAL_EXPERIMENTAL
-// LINT.ThenChange(//depot_firebase_cpp/functions/client/cpp/src/ios/\
-  //                 callable_reference_ios.mm)
-#endif  // INTERNAL_EXPERIMENTAL
 };
 
 #ifdef INTERNAL_EXPERIMENTAL

messaging/src/include/firebase/messaging.h

@@ -57,7 +57,7 @@ struct MessagingOptions {
   /// If this prompt has already been accepted once in the past the prompt will
   /// not be displayed again.
   ///
-  /// This option currently only applies to iOS.
+  /// This option currently only applies to iOS and tvOS.
   bool suppress_notification_permission_prompt;
 };
 
@@ -107,8 +107,8 @@ struct Notification {
   /// Destructor.
   ~Notification() { delete android; }
 
-  /// 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.
   std::string title;
 
   /// Indicates notification body text.
@@ -122,12 +122,12 @@ struct 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 iOS and tvOS sound
+  /// files can be in the main bundle of the client app or in the
+  /// Library/Sounds folder of the app’s data container.
   std::string sound;
 
-  /// Indicates the badge on the client app home icon. iOS only.
+  /// Indicates the badge on the client app home icon. iOS and tvOS only.
   std::string badge;
 
   /// Indicates whether each notification results in a new entry in the
@@ -145,12 +145,12 @@ struct 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.
   std::string click_action;
 
   /// 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.
@@ -159,7 +159,7 @@ struct 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].
@@ -170,7 +170,7 @@ struct Notification {
 
   /// 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.
@@ -179,7 +179,7 @@ struct 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].
@@ -306,7 +306,7 @@ struct Message {
   std::string message_type;
 
   /// Sets the priority of the message. Valid values are "normal" and "high." On
-  /// iOS, these correspond to APNs priority 5 and 10.
+  /// iOS and tvOS, these correspond to APNs priority 5 and 10.
   ///
   /// By default, messages are sent with normal priority. Normal priority
   /// optimizes the client app's battery consumption, and should be used unless
@@ -460,7 +460,7 @@ bool IsTokenRegistrationOnInitEnabled();
 /// 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).
+/// manifest (on Android) or Info.plist (on iOS and tvOS).
 ///
 /// <p>By default, token registration during initialization is enabled.
 ///
@@ -480,7 +480,7 @@ bool IsTokenRegistrationOnInitEnabled();
 /// @endcode
 /// @endif
 ///
-/// or on iOS to your Info.plist:
+/// or on iOS or tvOS to your Info.plist:
 ///
 /// @if NOT_DOXYGEN
 ///   <key>FirebaseMessagingAutoInitEnabled</key>
@@ -528,9 +528,9 @@ enum Error {
 /// @brief Displays a prompt to the user requesting permission to display
 ///        notifications.
 ///
-/// The permission prompt only appears on iOS. If the user has already agreed to
-/// allow notifications, no prompt is displayed and the returned future is
-/// completed immediately.
+/// The permission prompt only appears on iOS and tvOS. If the user has
+/// already agreed to allow notifications, no prompt is displayed and the
+/// returned future is completed immediately.
 ///
 /// @return A future that completes when the notification prompt has been
 ///         dismissed.

performance/src/include/firebase/performance.h

@@ -52,8 +52,8 @@ bool GetPerformanceCollectionEnabled();
 /// This setting is persisted across app sessions. By default it is enabled.
 ///
 /// This can be called before firebase::performance::Initialize(const App&
-/// app) on iOS, but that is not true on Android due to the way the SDK is
-/// initialized. If you need to disable firebase performance before that, see
+/// app) on iOS and tvOS, but that is not true on Android due to the way the SDK
+/// is initialized. If you need to disable firebase performance before that, see
 /// <a href="/docs/perf-mon/disable-sdk">the documentation</a>.
 ///
 /// @param[in] enabled true to enable performance collection, false to disable.