v6 Implement Cloud Messaging (#2330)

2026-04-24 04:24:52 +08:00 · 2019-07-12 14:06:43 +01:00
parent a966c20be7
commit 85672a479a
114 changed files with 6905 additions and 927 deletions
--- a/docs/admob/android.md
+++ b/docs/admob/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate AdMob into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/admob/ios.md
+++ b/docs/admob/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate AdMob into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/analytics/android.md
+++ b/docs/analytics/android.md
@@ -3,9 +3,7 @@ title: Android Setup
 description: Manually integrate Analytics into your Android application. 
 ---

-# Android Setup
-
-## Manual Android Integration
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking.
--- a/docs/analytics/ios.md
+++ b/docs/analytics/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Analytics into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 ## Manual iOS Integration via CocoaPods

--- a/docs/app/android.md
+++ b/docs/app/android.md
@@ -3,9 +3,7 @@ title: Android Initialization
 description: Initialization Firebase with Android. 
 ---

-# Android Setup
-
-## Manual Android Integration
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking.
--- a/docs/auth/android.md
+++ b/docs/auth/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Authentication into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/auth/ios.md
+++ b/docs/auth/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Authentication into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 ## Manual iOS Integration via CocoaPods

--- a/docs/config/android.md
+++ b/docs/config/android.md
@@ -3,9 +3,7 @@ title: Android Setup
 description: Manually integrate Remote Config into your Android application. 
 ---

-# Android Setup
-
-## Manual Android Integration
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking.
--- a/docs/config/ios.md
+++ b/docs/config/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Remote Config into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 ## Manual iOS Integration via CocoaPods

--- a/docs/crashlytics/android.md
+++ b/docs/crashlytics/android.md
@@ -71,7 +71,7 @@ crashlytics {
 }
 ```

-## Manual Linking
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/crashlytics/ios.md
+++ b/docs/crashlytics/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Crashlytics into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/database/android.md
+++ b/docs/database/android.md
@@ -3,9 +3,7 @@ title: Android Setup
 description: Manually integrate Realtime Database into your Android application. 
 ---

-# Android Setup
-
-## Manual Android Integration
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking.
--- a/docs/database/ios.md
+++ b/docs/database/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Realtime Database into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 ## Manual iOS Integration via CocoaPods

--- a/docs/fiam/android.md
+++ b/docs/fiam/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Firebase In-App Messaging into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/fiam/ios.md
+++ b/docs/fiam/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrateFirebase In-App Messaging into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/functions/android.md
+++ b/docs/functions/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Cloud Functions into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/functions/ios.md
+++ b/docs/functions/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Cloud Functions into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/iid/android.md
+++ b/docs/iid/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Instance ID into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/iid/ios.md
+++ b/docs/iid/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Instance ID into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/indexing/android.md
+++ b/docs/indexing/android.md
@@ -3,7 +3,7 @@ title: Android Setup | App Indexing
 description: Setup your Android application to handle app indexed URLs.
 ---

-# Android Setup
+# Android Manual Linking

 Your Android application needs to be setup to detect whether URLs which a user navigates to on your device are to be
 handled by your application.
--- a/docs/indexing/ios.md
+++ b/docs/indexing/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup | App Indexing
 description: Setup your iOS application to handle app indexed URLs.
 ---

-# iOS Setup
+# iOS Manual Linking

 To handle indexed URLs within your iOS app, the URL definition needs to be added to your project using XCode.

--- a/docs/invites/android.md
+++ b/docs/invites/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Invites into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/invites/ios.md
+++ b/docs/invites/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Invites into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/links/android.md
+++ b/docs/links/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Messaging into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/links/ios.md
+++ b/docs/links/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Messaging into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/messaging/android.md
+++ b/docs/messaging/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Messaging into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/messaging/index.md
+++ b/docs/messaging/index.md
@@ -1,9 +1,9 @@
 ---
-title: Cloud Messaging (FCM)
+title: Firebase Cloud Messaging (FCM)
 description: Firebase Cloud Messaging (FCM) is a cross-platform messaging solution that lets you reliably deliver messages at no cost. 
 ---

-# Cloud Messaging
+# Firebase Cloud Messaging

 React Native Firebase provides native integration of Firebase Cloud Messaging (FCM) for both Android & iOS. FCM is a 
 cost free service, allowing for server-device and device-device communication. The React Native Firebase Messaging
--- a/docs/messaging/ios-configure-apns.md
+++ b/docs/messaging/ios-configure-apns.md
@@ -0,0 +1,52 @@
+---
+title: Configure Apple Push Notification service for FCM
+description: Create an Apple Push Notification authentication key, a provisioning profile and an App ID to use with FCM on iOS.
+---
+
+# Configure APNs for FCM
+
+## Before you begin
+
+This guide makes the following assumptions:
+
+- you have an active [Apple Developer account](https://developer.apple.com/membercenter/index.action)
+- you have an active Firebase project
+
+### Create an Authentication Key
+
+<!-- https://firebase.google.com/docs/cloud-messaging/ios/certs -->
+
+TODO
+
+### Upload your APNs authentication key
+
+<!-- https://firebase.google.com/docs/cloud-messaging/ios/client#upload_your_apns_authentication_key -->
+
+TODO
+
+### Create an App ID
+
+<!-- https://firebase.google.com/docs/cloud-messaging/ios/certs -->
+
+TODO
+
+### Create a Provisioning Profile
+
+<!-- https://firebase.google.com/docs/cloud-messaging/ios/certs -->
+
+TODO
+
+---
+
+## Next
+
+<Grid>
+	<Block
+		title="Configure Xcode Project notification capabilities"
+		to="/messaging/ios-xcode-project-capabilities"
+		icon="tool"
+		color="#2196F3"
+	>
+		Configure your Xcode Project capabilities to support Remote Notifications for FCM.
+  	</Block>
+</Grid>
--- a/docs/messaging/ios-xcode-project-capabilities.md
+++ b/docs/messaging/ios-xcode-project-capabilities.md
@@ -0,0 +1,27 @@
+---
+title: Configure Xcode Project notification capabilities
+description: Configure your Xcode Project capabilities to support Remote Notifications for FCM.
+---
+
+# Configure Xcode Project notification capabilities
+
+TODO
+
+---
+
+## Next
+
+There are no more integration steps for Messaging on iOS. 🎉
+
+## Previous
+
+<Grid>
+	<Block
+		title="Configure Apple Push Notification service for FCM"
+		to="/messaging/ios-configure-apns"
+		icon="tool"
+		color="#2196F3"
+	>
+		Create an Apple Push Notification authentication key, a provisioning profile and an App ID to use with FCM on iOS.
+  	</Block>
+</Grid>
--- a/docs/messaging/ios.md
+++ b/docs/messaging/ios.md
@@ -1,11 +1,47 @@
 ---
 title: iOS Setup
-description: Manually integrate Messaging into your iOS application. 
+description: Manually integrate Messaging into your iOS application.
 ---

-# iOS Setup
+# iOS Manual Linking
+
+## Before you begin
+
+These guides makes the following assumptions:
+
+- you have an active [Apple Developer account](https://developer.apple.com/membercenter/index.action)
+- you have an active Firebase project
+- you have a physical device to test your integration on
+  - Firebase Cloud Messaging uses the [Apple Push Notification service (APNs)](https://developer.apple.com/notifications/) to send messages; therefore to test FCM on iOS you'll need **a real device** - FCM will not work on a iOS simulator
+
+### Integration steps
+
+To integrate FCM for iOS, the following integration steps must be followed;
+
+<Grid>
+	<Block
+		title="Configure Xcode Project notification capabilities"
+		to="/messaging/ios-xcode-project-capabilities"
+		icon="tool"
+		color="#2196F3"
+	>
+		Configure your Xcode Project capabilities to support Remote Notifications for FCM.
+  	</Block>
+	<Block
+		title="Configure Apple Push Notification service for FCM"
+		to="/messaging/ios-configure-apns"
+		icon="tool"
+		color="#2196F3"
+	>
+		Create an Apple Push Notification authentication key, a provisioning profile and an App ID to use with FCM on iOS.
+  	</Block>
+</Grid>
+
+---
+
+## iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
-auto-linking. 
+> auto-linking.

-## TODO
+> TODO
--- a/docs/ml-natural-language/android.md
+++ b/docs/ml-natural-language/android.md
@@ -3,9 +3,7 @@ title: Android Setup
 description: Manually integrate ML Kit Natural Language into your Android application.
 ---

-# Android Setup
-
-## Manual Android Integration
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 > auto-linking.
--- a/docs/ml-natural-language/ios.md
+++ b/docs/ml-natural-language/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate ML Kit into your iOS application.
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 > auto-linking.
--- a/docs/notifications/android.md
+++ b/docs/notifications/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Notifications into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/notifications/ios.md
+++ b/docs/notifications/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Notifications into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/perf/android.md
+++ b/docs/perf/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Performance Monitoring into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/perf/ios.md
+++ b/docs/perf/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Performance Monitoring into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 ## Manual iOS Integration via CocoaPods

--- a/docs/storage/android.md
+++ b/docs/storage/android.md
@@ -3,9 +3,7 @@ title: Android Setup
 description: Manually integrate Cloud Storage into your Android application. 
 ---

-# Android Setup
-
-## Manual Android Integration
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking.
--- a/docs/storage/ios.md
+++ b/docs/storage/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Cloud Storage into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 ## Manual iOS Integration via CocoaPods

--- a/docs/typedoc.json
+++ b/docs/typedoc.json
--- a/docs/typedoc.min.json
+++ b/docs/typedoc.min.json
--- a/docs/utils/android.md
+++ b/docs/utils/android.md
@@ -3,7 +3,7 @@ title: Android Setup
 description: Manually integrate Utils into your Android application. 
 ---

-# Android Setup
+# Android Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking. 
--- a/docs/utils/ios.md
+++ b/docs/utils/ios.md
@@ -3,7 +3,7 @@ title: iOS Setup
 description: Manually integrate Utils into your iOS application. 
 ---

-# iOS Setup
+# iOS Manual Linking

 > The following steps are only required if your environment does not have access to React Native
 auto-linking.