mirror of
https://github.com/zhigang1992/react-native-firebase.git
synced 2026-04-23 12:06:47 +08:00
docs(dynamic-links): add set up docs (#3624)
* docs(database): forEach docs * docs(app): update 'apps' example * docs(dynamic-links): ios setup * docs(dynamic-links): update setup docs * docs(*): format markdown * docs(dynamic-links): capitalisation of products * docs(dynamic-links): update * docs(dynamic-links): spelling * docs(dynamic-links): spelling
This commit is contained in:
Russell Wheatley
@@ -104,6 +104,7 @@ SDK.
|
||||
SDKs
|
||||
SDKs.
|
||||
SHA1
|
||||
SHA-256
|
||||
SMS
|
||||
SVG
|
||||
TestLab
|
||||
@@ -123,4 +124,5 @@ v6
|
||||
VSCode
|
||||
Wix
|
||||
Xcode
|
||||
Xcode.
|
||||
lifecycle
|
||||
|
||||
@@ -60,7 +60,11 @@ await firebase.initializeApp(credentials, config);
|
||||
Once created, you can confirm the app instance has been created by accessing the `apps` property on the module:
|
||||
|
||||
```js
|
||||
console.log(firebase.apps);
|
||||
const apps = firebase.apps;
|
||||
|
||||
apps.forEach(app => {
|
||||
console.log('App name: ', app.name);
|
||||
});
|
||||
```
|
||||
|
||||
## Switching app instance
|
||||
|
||||
@@ -166,6 +166,8 @@ const scores = database()
|
||||
.once('value');
|
||||
```
|
||||
|
||||
Please note that the ordering will not be respected if you do not use the `forEach` method provided on the `DataSnapshot`.
|
||||
|
||||
#### Limiting
|
||||
|
||||
You can limit the number of results returned from a query by using one of the `limitToX` methods. For example, to limit to the
|
||||
|
||||
@@ -36,6 +36,87 @@ a Dynamic Link on iOS or Android, they can be taken directly to the linked conte
|
||||
|
||||
# Usage
|
||||
|
||||
## Firebase Setup
|
||||
|
||||
1. Open the Dynamic Links tab and configure a new domain for your app. In this test example, I've created one for `https://rnfbtestapplication.page.link`.
|
||||
|
||||
|
||||
|
||||
2. Create a dynamic link with your domain in the Firebase console. The freshly created dynamic link URL will appear in the table.
|
||||
|
||||
|
||||
|
||||
## iOS Setup
|
||||
|
||||
To setup Dynamic Links on iOS, it is a **prerequisite** that you have an Apple developer account [setup](https://developer.apple.com/programs/enroll/).
|
||||
|
||||
1. Add an `App Store ID` & `Team ID` to your app in your Firebase console. If you do not have an `App Store ID` yet, you can put any number in here for now. Your `Team ID` can be found in your Apple developer console.
|
||||
|
||||
|
||||
|
||||
2. Test the domain you created in your Firebase console (first step in `Firebase Setup`). Go to the following location in your browser `[your domain]/apple-app-site-association`. The response will have a `details` array property containing an object that has the property `appID`. That will be your app's app ID (It may take some
|
||||
time for your domain to register). Please ensure it is registered before proceeding.
|
||||
|
||||
3. Once you're sure your domain is registered, you need to head over to your Apple developer console and create a provisioning profile for your app. Please ensure you've enabled the `Associated Domain` capability which you should check before proceeding.
|
||||
|
||||
|
||||
|
||||
4. Open your project in Xcode and open your app under the `TARGETS` header. Click the `Signing & Capabilities` tab. You will need to ensure your `Team` is registered, and your `Provisioning Profile` field is completed. Please add the domain you created in your
|
||||
Firebase console to the `Associated Domains` and prefix with `applinks:`
|
||||
|
||||
|
||||
|
||||
5. Click the `Info` tab, and add a `URL Type` to your project. The `Identifier` can be called `Bundle Id` or whatever you wish. Add your bundle identifier to the `URL Schemes` property.
|
||||
|
||||
|
||||
|
||||
## iOS Testing Your Dynamic Link
|
||||
|
||||
To test your dynamic link, you will need to use a real device as it will not work on a simulator.
|
||||
|
||||
### Application Is Installed On Device
|
||||
|
||||
The iOS Notes app is a good place to paste your dynamic link and test it opens your app. It should work even if it is not a published app.
|
||||
|
||||
### Application Is Not Installed On Device
|
||||
|
||||
1. Switch the `App Store ID` in your Firebase Console project settings to a valid App Store ID e.g. iOS Notes App Store ID.
|
||||
|
||||
2. Generate a new dynamic link and associate with your app.
|
||||
|
||||
3. Paste the link in iOS Notes app. When you press, it should take you to the App Store for the ID you listed in your project settings. Just by making it to the App Store is good enough to indicate your dynamic link is working.
|
||||
|
||||
## iOS Troubleshooting
|
||||
|
||||
1. Ensure you have the right URL in the Associated Domains in Xcode.
|
||||
|
||||
|
||||
|
||||
2. Ensure you have input the correct Team ID in the Firebase console.
|
||||
|
||||
|
||||
|
||||
3. Paste your link into the iOS Notes app. Long press the link which will open the menu and ensure you click "Open in [YOUR APP NAME]". Be sure *not* to press "Open in Safari" as that will disable that dynamic link domain for your device.
|
||||
|
||||
|
||||
|
||||
4. Ensure your dynamic link domain has an Apple app site association file for your app. Check in the browser by going to the following address: `[your domain]/apple-app-site-association`
|
||||
|
||||
|
||||
|
||||
5. There is a known bug that you can follow [here](http://bit.ly/2y8gey4) that stops Apple from downloading the app site association file. The work around is to uninstall your app, restart your device and reinstall your app.
|
||||
|
||||
## Android Setup
|
||||
|
||||
1. Create a SHA-256 fingerprint using these [instructions](https://developers.google.com/android/guides/client-auth) for your app, and add to your app in your Firebase console.
|
||||
|
||||
|
||||
|
||||
2. Test the domain you created in your Firebase console (first step in `Firebase Setup`). Go to the following location in your browser `[your-domain]/.well-known/assetlinks.json`. The response will have a `target` object containing a `package_name` which ought to have your app's package name. Please
|
||||
do not proceed until you see this, it may take a while to register.
|
||||
|
||||
3. Test the dynamic link works via your emulator by pasting it into in a text message, notepad or email, and checking that it does open your application (ensure the app is installed on the emulator).
|
||||
|
||||
## Create a Link
|
||||
|
||||
You can create dynamic links via the Firebase console, your app or even your custom API. Please refer to [Firebase create dynamic link documentation](https://firebase.google.com/docs/dynamic-links/create-links) for further details. Below, we will show how to build links as part of your application code:
|
||||
@@ -46,9 +127,9 @@ import dynamicLinks from '@react-native-firebase/dynamic-links';
|
||||
async function buildLink() {
|
||||
const link = await dynamicLinks().buildLink({
|
||||
link: 'https://invertase.io',
|
||||
// domainUriPrefix is created in your firebase console
|
||||
// domainUriPrefix is created in your Firebase console
|
||||
domainUriPrefix: 'https://xyz.page.link',
|
||||
// optional set up which updates firebase analytics campaign
|
||||
// optional set up which updates Firebase analytics campaign
|
||||
// "banner". This also needs setting up before hand
|
||||
analytics: {
|
||||
campaign: 'banner',
|
||||
|
||||
Reference in New Issue
Block a user