react-native-firebase/docs.json at main · invertase/react-native-firebase · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
{
  "$schema": "https://docs.page/schema.json",
  "name": "React Native Firebase",
  "description": "A well-tested feature-rich modular Firebase implementation for React Native. Supports both iOS & Android platforms for all Firebase services.",
  "favicon": "/rnfb-logo.png",
  "theme": {
    "primary": "#e88533"
  },
  "logo": {
    "light": "/rnfb-logo.png",
    "dark": "/rnfb-logo.png"
  },
  "social": {
    "x": "@invertaseio",
    "github": "invertase/react-native-firebase"
  },
  "agent": {
    "key": "6e277cd7-0065-4ade-a14a-3ecfa3f369a4",
    "questions": [
      "How do I install react-native-firebase with Expo?",
      "Can I do silent push notifications on iOS and Android?",
      "When does it make sense to use react-native-firebase instead of firebase-js-sdk?"
    ]
  },
  "check": {
    "severityOverrideHosts": {
      "rnfirebase.io": "error"
    }
  },
  "tabs": [
    {
      "id": "root",
      "title": "Documentation",
      "href": "/"
    },
    {
      "id": "reference",
      "title": "Reference API",
      "href": "https://reference.rnfirebase.io/modules.html"
    }
  ],
  "redirects": {
    "reference/analytics": "https://reference.rnfirebase.io/_react-native-firebase/analytics.html",
    "reference/analytics/purchaseeventparameters": "https://reference.rnfirebase.io/_react-native-firebase/analytics/types/analytics/PurchaseEventParameters.html",
    "reference/analytics/purchaserefundeventparameters": "https://reference.rnfirebase.io/_react-native-firebase/analytics/types/analytics/RefundEventParameters.html",
    "reference/app": "https://reference.rnfirebase.io/_react-native-firebase/app.html",
    "reference/app-check/customprovider": "https://reference.rnfirebase.io/_react-native-firebase/app-check/types/appcheck/CustomProviderOptions.html",
    "reference/auth": "https://reference.rnfirebase.io/_react-native-firebase/auth.html",
    "reference/auth/actioncodeinfodata": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/ActionCodeInfoData.html",
    "reference/auth/actioncodesettings": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/ActionCodeSettings.html",
    "reference/auth/additionaluserinfo": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/AdditionalUserInfo.html",
    "reference/auth/authlistenercallback": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/AuthListenerCallback.html",
    "reference/auth/authsettings": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/AuthSettings.html",
    "reference/auth/confirmationresult": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/ConfirmationResult.html",
    "reference/auth/emailauthprovider": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/EmailAuthProvider.html",
    "reference/auth/idtokenresult": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/IdTokenResult.html",
    "reference/auth/multifactoruser": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/MultiFactorUser.html",
    "reference/auth/oidcprovider": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/OAuthProvider.html",
    "reference/auth/phoneauthlistener": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/PhoneAuthListener.html",
    "reference/auth/totpmultifactorgenerator": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/TotpMultiFactorGenerator.html",
    "reference/auth/totpsecret": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/TotpSecret.html",
    "reference/auth/updateprofile": "https://reference.rnfirebase.io/_react-native-firebase/auth/updateProfile.html",
    "reference/auth/user": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/User.html",
    "reference/auth/userinfo": "https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/UserInfo.html",
    "reference/crashlytics": "https://reference.rnfirebase.io/_react-native-firebase/crashlytics.html",
    "reference/database": "https://reference.rnfirebase.io/_react-native-firebase/database.html",
    "reference/database/reference": "https://reference.rnfirebase.io/_react-native-firebase/database/types/database/DatabaseReference.html",
    "reference/dynamic-links/dynamiclinkiosparameters": "https://reference.rnfirebase.io/modules.html",
    "reference/firestore/collectionreference": "https://reference.rnfirebase.io/_react-native-firebase/firestore/types/firestore/CollectionReference.html",
    "reference/firestore/documentdata": "https://reference.rnfirebase.io/_react-native-firebase/firestore/types/firestore/DocumentData.html",
    "reference/firestore/documentreference": "https://reference.rnfirebase.io/_react-native-firebase/firestore/types/firestore/DocumentReference.html",
    "reference/firestore/fieldpath": "https://reference.rnfirebase.io/_react-native-firebase/firestore/modular/FieldPath.html",
    "reference/firestore/geopoint": "https://reference.rnfirebase.io/_react-native-firebase/firestore/modular/GeoPoint.html",
    "reference/firestore/query": "https://reference.rnfirebase.io/_react-native-firebase/firestore/types/firestore/Query.html",
    "reference/firestore/querydocumentsnapshot": "https://reference.rnfirebase.io/_react-native-firebase/firestore/types/firestore/QueryDocumentSnapshot.html",
    "reference/firestore/querysnapshot": "https://reference.rnfirebase.io/_react-native-firebase/firestore/types/firestore/QuerySnapshot.html",
    "reference/firestore/settings": "https://reference.rnfirebase.io/_react-native-firebase/firestore/types/firestore/FirestoreSettings.html",
    "reference/firestore/snapshotlistenoptions": "https://reference.rnfirebase.io/_react-native-firebase/firestore/types/firestore/SnapshotListenOptions.html",
    "reference/firestore/timestamp": "https://reference.rnfirebase.io/_react-native-firebase/firestore/modular/Timestamp.html",
    "reference/installations": "https://reference.rnfirebase.io/_react-native-firebase/installations.html",
    "reference/messaging": "https://reference.rnfirebase.io/_react-native-firebase/messaging.html",
    "reference/messaging/authorizationstatus": "https://reference.rnfirebase.io/_react-native-firebase/messaging/types/messaging/AuthorizationStatus.html",
    "reference/messaging/iospermissions": "https://reference.rnfirebase.io/_react-native-firebase/messaging/types/messaging/IOSPermissions.html",
    "reference/ml": "https://reference.rnfirebase.io/modules.html",
    "reference/ml/mltextblock": "https://reference.rnfirebase.io/modules.html",
    "reference/perf/module": "https://reference.rnfirebase.io/_react-native-firebase/perf.html",
    "reference/remote-config": "https://reference.rnfirebase.io/_react-native-firebase/remote-config.html",
    "reference/remote-config/configupdateobserver": "https://reference.rnfirebase.io/_react-native-firebase/remote-config/types/remote-config/ConfigUpdateObserver.html",
    "reference/storage/fullmetadata": "https://reference.rnfirebase.io/_react-native-firebase/storage/FullMetadata.html",
    "reference/storage/reference": "https://reference.rnfirebase.io/_react-native-firebase/storage/StorageReference.html",
    "ml": "/migrating-to-v27",
    "ml/usage": "/migrating-to-v27",
    "ml/usage/installation/ios": "/migrating-to-v27",
    "ml/usage/installation/android": "/migrating-to-v27"
  },
  "sidebar": [
    {
      "group": "Getting Started",
      "tab": "root",
      "pages": [
        { "title": "Getting Started", "href": "/" },
        { "title": "Migration Guide to v22", "href": "/migrating-to-v22" },
        { "title": "Migration Guide to v23", "href": "/migrating-to-v23" },
        { "title": "Migration Guide to v24", "href": "/migrating-to-v24" },
        { "title": "Migration Guide to v25", "href": "/migrating-to-v25" },
        { "title": "Migration Guide to v26", "href": "/migrating-to-v26" },
        { "title": "Migration Guide to v27", "href": "/migrating-to-v27" },
        { "title": "TypeScript", "href": "/typescript" },
        { "title": "iOS SPM Support", "href": "/ios-spm" },
        { "title": "Platforms", "href": "/platforms" },
        { "title": "FAQs and Tips", "href": "/faqs-and-tips" },
        {
          "title": "Release Notes",
          "href": "https://github.com/invertase/react-native-firebase/blob/main/CHANGELOG.md"
        },
        { "title": "Feature Requests", "href": "https://invertase.canny.io/react-native-firebase" },
        {
          "title": "Contributing",
          "href": "https://github.com/invertase/react-native-firebase/blob/main/CONTRIBUTING.md"
        }
      ]
    },
    {
      "group": "AI Logic",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/icons/firebase-ai-logic.svg",
      "pages": [{ "title": "Usage", "href": "/ai/usage" }]
    },
    {
      "group": "Analytics",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/run_analytics.svg",
      "pages": [
        { "title": "Usage", "href": "/analytics/usage" },
        { "title": "Screen Tracking", "href": "/analytics/screen-tracking" }
      ]
    },
    {
      "group": "App Check",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/build_app_check.svg",
      "pages": [{ "title": "Usage", "href": "/app-check/usage" }]
    },
    {
      "group": "App Distribution",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/run_app_distribution.svg",
      "pages": [{ "title": "Usage", "href": "/app-distribution/usage" }]
    },
    {
      "group": "Authentication",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/build_auth.svg",
      "pages": [
        { "title": "Usage", "href": "/auth/usage" },
        { "title": "Social Auth", "href": "/auth/social-auth" },
        { "title": "Phone Auth", "href": "/auth/phone-auth" },
        { "title": "Email Link Auth", "href": "/auth/email-link-auth" },
        { "title": "OpenID Connect Auth", "href": "/auth/oidc-auth" },
        { "title": "Multi-factor Auth", "href": "/auth/multi-factor-auth" }
      ]
    },
    {
      "group": "Cloud Firestore",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/build_firestore.svg",
      "pages": [
        { "title": "Usage", "href": "/firestore/usage" },
        { "title": "Usage with Emulator", "href": "/firestore/emulator" },
        { "title": "Usage with FlatLists", "href": "/firestore/usage-with-flatlists" },
        { "title": "Implementing Pagination", "href": "/firestore/pagination" },
        { "title": "Pipelines", "href": "/firestore/pipelines" },
        { "title": "currentDocument", "href": "/firestore/pipelines/current-document" },
        { "title": "ifNull", "href": "/firestore/pipelines/if-null" },
        { "title": "switchOn", "href": "/firestore/pipelines/switch-on" },
        { "title": "timestampDiff", "href": "/firestore/pipelines/timestamp-diff" },
        { "title": "timestampExtract", "href": "/firestore/pipelines/timestamp-extract" },
        { "title": "subcollection", "href": "/firestore/pipelines/subcollection" },
        {
          "title": "Pipeline SDK compatibility",
          "href": "/firestore/pipelines/sdk-compatibility"
        },
        {
          "title": "Building a \"TODO\" app",
          "href": "https://invertase.io/blog/getting-started-with-cloud-firestore-on-react-native"
        }
      ]
    },
    {
      "group": "Cloud Functions",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/build_functions.svg",
      "pages": [
        { "title": "Usage", "href": "/functions/usage" },
        {
          "title": "Writing & Deploying Functions",
          "href": "/functions/writing-deploying-functions"
        }
      ]
    },
    {
      "group": "Cloud Messaging",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/run_cloud_messaging.svg",
      "pages": [
        { "title": "Usage", "href": "/messaging/usage" },
        { "title": "iOS Project Setup", "href": "/messaging/usage/ios-setup" },
        { "title": "iOS Permissions", "href": "/messaging/ios-permissions" },
        { "title": "Notifications", "href": "/messaging/notifications" },
        { "title": "iOS Notification Images", "href": "/messaging/ios-notification-images" },
        { "title": "Server Integration", "href": "/messaging/server-integration" },
        {
          "title": "Migrating to Installation ID",
          "href": "/messaging/migrating-to-installation-id"
        }
      ]
    },
    {
      "group": "Cloud Storage",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/build_storage.svg",
      "pages": [{ "title": "Usage", "href": "/storage/usage" }]
    },
    {
      "group": "Core / App",
      "tab": "root",
      "icon": "//static.invertase.io/assets/social/firebase-logo.png",
      "pages": [
        { "title": "Usage", "href": "/app/usage" },
        { "title": "JSON Config", "href": "/app/json-config" },
        { "title": "Utils", "href": "/app/utils" }
      ]
    },
    {
      "group": "Crashlytics",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/run_crashlytics.svg",
      "pages": [
        { "title": "Usage", "href": "/crashlytics/usage" },
        { "title": "Viewing crash reports", "href": "/crashlytics/crash-reports" }
      ]
    },
    {
      "group": "Realtime Database",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/build_realtime_database.svg",
      "pages": [
        { "title": "Usage", "href": "/database/usage" },
        { "title": "Offline Support", "href": "/database/offline-support" },
        { "title": "Presence Detection", "href": "/database/presence-detection" }
      ]
    },
    {
      "group": "In-App Messaging",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/run_in_app_messaging.svg",
      "pages": [{ "title": "Usage", "href": "/in-app-messaging/usage" }]
    },
    {
      "group": "Installations",
      "tab": "root",
      "icon": "//static.invertase.io/assets/social/firebase-logo.png",
      "pages": [{ "title": "Usage", "href": "/installations/usage" }]
    },
    {
      "group": "Remote Config",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/run_remote_config.svg",
      "pages": [{ "title": "Usage", "href": "/remote-config/usage" }]
    },
    {
      "group": "Performance Monitoring",
      "tab": "root",
      "icon": "//firebase.google.com/static/images/products/icons/run_performance.svg",
      "pages": [
        { "title": "Usage", "href": "/perf/usage" },
        { "title": "Axios Integration", "href": "/perf/axios-integration" },
        { "title": "KY Integration", "href": "/perf/ky-integration" }
      ]
    },
    {
      "group": "Phone Number Verification",
      "tab": "root",
      "icon": "//static.invertase.io/assets/social/firebase-logo.png",
      "pages": [{ "title": "Usage", "href": "/phone-number-verification/usage" }]
    },
    {
      "group": "VertexAi",
      "tab": "root",
      "icon": "//static.invertase.io/assets/social/firebase-logo.png",
      "pages": [{ "title": "Usage", "href": "/vertexai/usage" }]
    },
    {
      "group": "Legacy docs",
      "tab": "root",
      "icon": "//static.invertase.io/assets/social/firebase-logo.png",
      "pages": [
        { "title": "Migrating to v6", "href": "/migrating-to-v6" },
        {
          "title": "Legacy Docs (<= v5)",
          "href": "https://v5.rnfirebase.io/docs/v5.x.x/getting-started"
        }
      ]
    }
  ]
}