From 628e624e57d4dd9e4be9ee4c76672dcfec815bb5 Mon Sep 17 00:00:00 2001 From: Elliot Hesp Date: Tue, 7 May 2019 17:44:34 +0100 Subject: [PATCH] [skip ci] auth TS updates --- docs/typedoc.json | 3611 +++++++++++++++++++--------------- packages/auth/lib/index.d.ts | 777 +++++++- 2 files changed, 2706 insertions(+), 1682 deletions(-) diff --git a/docs/typedoc.json b/docs/typedoc.json index a5778b33..c9398b44 100644 --- a/docs/typedoc.json +++ b/docs/typedoc.json @@ -30,7 +30,7 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", @@ -228,14 +228,14 @@ ] }, { - "id": 339, + "id": 338, "name": "auth", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 340, + "id": 339, "name": "auth", "kind": 4096, "kindString": "Call signature", @@ -253,20 +253,20 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 561, + "line": 1246, "character": 8 } ] }, { - "id": 393, + "id": 392, "name": "config", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 394, + "id": 393, "name": "config", "kind": 4096, "kindString": "Call signature", @@ -277,7 +277,7 @@ "type": { "type": "reference", "name": "Module", - "id": 358 + "id": 357 } } ], @@ -290,14 +290,14 @@ ] }, { - "id": 435, + "id": 434, "name": "crashlytics", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 436, + "id": 435, "name": "crashlytics", "kind": 4096, "kindString": "Call signature", @@ -308,7 +308,7 @@ "type": { "type": "reference", "name": "Module", - "id": 397 + "id": 396 } } ], @@ -321,14 +321,14 @@ ] }, { - "id": 454, + "id": 453, "name": "fiam", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 455, + "id": 454, "name": "fiam", "kind": 4096, "kindString": "Call signature", @@ -339,7 +339,7 @@ "type": { "type": "reference", "name": "Module", - "id": 439 + "id": 438 } } ], @@ -352,14 +352,14 @@ ] }, { - "id": 465, + "id": 464, "name": "firestore", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 466, + "id": 465, "name": "firestore", "kind": 4096, "kindString": "Call signature", @@ -370,7 +370,7 @@ "type": { "type": "reference", "name": "Module", - "id": 458 + "id": 457 } } ], @@ -383,7 +383,7 @@ ] }, { - "id": 514, + "id": 513, "name": "functions", "kind": 2048, "kindString": "Method", @@ -392,7 +392,7 @@ }, "signatures": [ { - "id": 515, + "id": 514, "name": "functions", "kind": 4096, "kindString": "Call signature", @@ -402,7 +402,7 @@ }, "parameters": [ { - "id": 516, + "id": 515, "name": "region", "kind": 32768, "kindString": "Parameter", @@ -430,7 +430,7 @@ "type": { "type": "reference", "name": "Module", - "id": 500 + "id": 499 } } ], @@ -443,14 +443,14 @@ ] }, { - "id": 538, + "id": 537, "name": "iid", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 539, + "id": 538, "name": "iid", "kind": 4096, "kindString": "Call signature", @@ -462,7 +462,7 @@ "type": { "type": "reference", "name": "Module", - "id": 519 + "id": 518 } } ], @@ -475,14 +475,14 @@ ] }, { - "id": 605, + "id": 604, "name": "invites", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 606, + "id": 605, "name": "invites", "kind": 4096, "kindString": "Call signature", @@ -493,7 +493,7 @@ "type": { "type": "reference", "name": "Module", - "id": 582 + "id": 581 } } ], @@ -506,14 +506,14 @@ ] }, { - "id": 616, + "id": 615, "name": "mlkit", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 617, + "id": 616, "name": "mlkit", "kind": 4096, "kindString": "Call signature", @@ -524,7 +524,7 @@ "type": { "type": "reference", "name": "Module", - "id": 609 + "id": 608 } } ], @@ -537,14 +537,14 @@ ] }, { - "id": 705, + "id": 704, "name": "perf", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 706, + "id": 705, "name": "perf", "kind": 4096, "kindString": "Call signature", @@ -555,7 +555,7 @@ "type": { "type": "reference", "name": "Module", - "id": 683 + "id": 682 } } ], @@ -568,7 +568,7 @@ ] }, { - "id": 881, + "id": 880, "name": "storage", "kind": 2048, "kindString": "Method", @@ -577,14 +577,14 @@ }, "signatures": [ { - "id": 882, + "id": 881, "name": "storage", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 883, + "id": 882, "name": "bucket", "kind": 32768, "kindString": "Parameter", @@ -609,7 +609,7 @@ "type": { "type": "reference", "name": "Module", - "id": 856 + "id": 855 } } ], @@ -658,7 +658,7 @@ } }, { - "id": 893, + "id": 892, "name": "utils", "kind": 4096, "kindString": "Call signature", @@ -669,7 +669,7 @@ "type": { "type": "reference", "name": "Module", - "id": 886 + "id": 885 } } ], @@ -693,17 +693,17 @@ "kind": 2048, "children": [ 48, - 339, - 393, - 435, - 454, - 465, - 514, - 538, - 605, - 616, - 705, - 881, + 338, + 392, + 434, + 453, + 464, + 513, + 537, + 604, + 615, + 704, + 880, 56 ] } @@ -721,7 +721,7 @@ }, { "fileName": "auth/lib/index.d.ts", - "line": 557, + "line": 1242, "character": 23 }, { @@ -804,7 +804,7 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", @@ -820,7 +820,7 @@ } }, { - "id": 338, + "id": 337, "name": "auth", "kind": 1024, "kindString": "Property", @@ -831,14 +831,14 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 554, + "line": 1239, "character": 8 } ], "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", @@ -854,7 +854,7 @@ } }, { - "id": 392, + "id": 391, "name": "config", "kind": 1024, "kindString": "Property", @@ -872,23 +872,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 358 + "id": 357 }, { "type": "reference", "name": "Statics", - "id": 342 + "id": 341 } ] } }, { - "id": 434, + "id": 433, "name": "crashlytics", "kind": 1024, "kindString": "Property", @@ -906,23 +906,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 397 + "id": 396 }, { "type": "reference", "name": "Statics", - "id": 396 + "id": 395 } ] } }, { - "id": 453, + "id": 452, "name": "fiam", "kind": 1024, "kindString": "Property", @@ -940,23 +940,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 439 + "id": 438 }, { "type": "reference", "name": "Statics", - "id": 438 + "id": 437 } ] } }, { - "id": 464, + "id": 463, "name": "firestore", "kind": 1024, "kindString": "Property", @@ -974,23 +974,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 458 + "id": 457 }, { "type": "reference", "name": "Statics", - "id": 457 + "id": 456 } ] } }, { - "id": 513, + "id": 512, "name": "functions", "kind": 1024, "kindString": "Property", @@ -1008,23 +1008,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStaticsWithApp", - "id": 966, + "id": 965, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 500 + "id": 499 }, { "type": "reference", "name": "Statics", - "id": 498 + "id": 497 } ] } }, { - "id": 537, + "id": 536, "name": "iid", "kind": 1024, "kindString": "Property", @@ -1043,23 +1043,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStaticsWithApp", - "id": 966, + "id": 965, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 519 + "id": 518 }, { "type": "reference", "name": "Statics", - "id": 518 + "id": 517 } ] } }, { - "id": 604, + "id": 603, "name": "invites", "kind": 1024, "kindString": "Property", @@ -1077,23 +1077,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 582 + "id": 581 }, { "type": "reference", "name": "Statics", - "id": 541 + "id": 540 } ] } }, { - "id": 615, + "id": 614, "name": "mlkit", "kind": 1024, "kindString": "Property", @@ -1111,23 +1111,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 609 + "id": 608 }, { "type": "reference", "name": "Statics", - "id": 608 + "id": 607 } ] } }, { - "id": 704, + "id": 703, "name": "perf", "kind": 1024, "kindString": "Property", @@ -1145,23 +1145,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 683 + "id": 682 }, { "type": "reference", "name": "Statics", - "id": 682 + "id": 681 } ] } }, { - "id": 880, + "id": 879, "name": "storage", "kind": 1024, "kindString": "Property", @@ -1176,17 +1176,17 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 856 + "id": 855 }, { "type": "reference", "name": "Statics", - "id": 731 + "id": 730 } ] } @@ -1217,17 +1217,17 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 886 + "id": 885 }, { "type": "reference", "name": "Statics", - "id": 885 + "id": 884 } ] } @@ -1239,17 +1239,17 @@ "kind": 1024, "children": [ 46, - 338, - 392, - 434, - 453, - 464, - 513, - 537, - 604, - 615, - 704, - 880, + 337, + 391, + 433, + 452, + 463, + 512, + 536, + 603, + 614, + 703, + 879, 52 ] } @@ -1267,7 +1267,7 @@ }, { "fileName": "auth/lib/index.d.ts", - "line": 550, + "line": 1235, "character": 40 }, { @@ -1351,7 +1351,7 @@ }, { "fileName": "auth/lib/index.d.ts", - "line": 549, + "line": 1234, "character": 49 }, { @@ -1412,14 +1412,14 @@ ] }, { - "id": 334, + "id": 333, "name": "\"@react-native-firebase/auth\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 337, + "id": 336, "name": "AuthDefaultExport", "kind": 32, "kindString": "Variable", @@ -1430,14 +1430,14 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 535, + "line": 1220, "character": 25 } ], "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", @@ -1453,7 +1453,7 @@ } }, { - "id": 335, + "id": 334, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -1463,7 +1463,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 524, + "line": 1209, "character": 31 } ], @@ -1482,7 +1482,7 @@ } }, { - "id": 336, + "id": 335, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -1501,7 +1501,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 533, + "line": 1218, "character": 23 } ], @@ -1517,29 +1517,29 @@ "title": "Variables", "kind": 32, "children": [ - 337, - 335, - 336 + 336, + 334, + 335 ] } ], "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 521, + "line": 1206, "character": 44 } ] }, { - "id": 388, + "id": 387, "name": "\"@react-native-firebase/config\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 391, + "id": 390, "name": "ConfigDefaultExport", "kind": 32, "kindString": "Variable", @@ -1557,23 +1557,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 358 + "id": 357 }, { "type": "reference", "name": "Statics", - "id": 342 + "id": 341 } ] } }, { - "id": 389, + "id": 388, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -1602,7 +1602,7 @@ } }, { - "id": 390, + "id": 389, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -1637,9 +1637,9 @@ "title": "Variables", "kind": 32, "children": [ - 391, - 389, - 390 + 390, + 388, + 389 ] } ], @@ -1652,14 +1652,14 @@ ] }, { - "id": 430, + "id": 429, "name": "\"@react-native-firebase/crashlytics\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 433, + "id": 432, "name": "CrashlyticsDefaultExport", "kind": 32, "kindString": "Variable", @@ -1677,23 +1677,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 397 + "id": 396 }, { "type": "reference", "name": "Statics", - "id": 396 + "id": 395 } ] } }, { - "id": 431, + "id": 430, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -1722,7 +1722,7 @@ } }, { - "id": 432, + "id": 431, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -1757,9 +1757,9 @@ "title": "Variables", "kind": 32, "children": [ - 433, - 431, - 432 + 432, + 430, + 431 ] } ], @@ -1772,14 +1772,14 @@ ] }, { - "id": 449, + "id": 448, "name": "\"@react-native-firebase/fiam\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 452, + "id": 451, "name": "FiamDefaultExport", "kind": 32, "kindString": "Variable", @@ -1797,23 +1797,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 439 + "id": 438 }, { "type": "reference", "name": "Statics", - "id": 438 + "id": 437 } ] } }, { - "id": 450, + "id": 449, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -1842,7 +1842,7 @@ } }, { - "id": 451, + "id": 450, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -1877,9 +1877,9 @@ "title": "Variables", "kind": 32, "children": [ - 452, - 450, - 451 + 451, + 449, + 450 ] } ], @@ -1892,14 +1892,14 @@ ] }, { - "id": 460, + "id": 459, "name": "\"@react-native-firebase/firestore\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 461, + "id": 460, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -1928,7 +1928,7 @@ } }, { - "id": 463, + "id": 462, "name": "FirestoreDefaultExport", "kind": 32, "kindString": "Variable", @@ -1946,23 +1946,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 458 + "id": 457 }, { "type": "reference", "name": "Statics", - "id": 457 + "id": 456 } ] } }, { - "id": 462, + "id": 461, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -1997,9 +1997,9 @@ "title": "Variables", "kind": 32, "children": [ - 461, - 463, - 462 + 460, + 462, + 461 ] } ], @@ -2012,14 +2012,14 @@ ] }, { - "id": 509, + "id": 508, "name": "\"@react-native-firebase/functions\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 512, + "id": 511, "name": "FunctionsDefaultExport", "kind": 32, "kindString": "Variable", @@ -2037,23 +2037,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStaticsWithApp", - "id": 966, + "id": 965, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 500 + "id": 499 }, { "type": "reference", "name": "Statics", - "id": 498 + "id": 497 } ] } }, { - "id": 510, + "id": 509, "name": "HttpsErrorCode", "kind": 32, "kindString": "Variable", @@ -2078,13 +2078,13 @@ { "type": "reference", "name": "HttpsErrorCode", - "id": 480 + "id": 479 } ] } }, { - "id": 511, + "id": 510, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -2127,9 +2127,9 @@ "title": "Variables", "kind": 32, "children": [ - 512, - 510, - 511 + 511, + 509, + 510 ] } ], @@ -2142,14 +2142,14 @@ ] }, { - "id": 533, + "id": 532, "name": "\"@react-native-firebase/iid\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 534, + "id": 533, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -2178,7 +2178,7 @@ } }, { - "id": 536, + "id": 535, "name": "IidDefaultExport", "kind": 32, "kindString": "Variable", @@ -2196,23 +2196,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStaticsWithApp", - "id": 966, + "id": 965, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 519 + "id": 518 }, { "type": "reference", "name": "Statics", - "id": 518 + "id": 517 } ] } }, { - "id": 535, + "id": 534, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -2247,9 +2247,9 @@ "title": "Variables", "kind": 32, "children": [ - 534, - 536, - 535 + 533, + 535, + 534 ] } ], @@ -2262,14 +2262,14 @@ ] }, { - "id": 600, + "id": 599, "name": "\"@react-native-firebase/invites\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 601, + "id": 600, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -2298,7 +2298,7 @@ } }, { - "id": 603, + "id": 602, "name": "InvitesDefaultExport", "kind": 32, "kindString": "Variable", @@ -2316,23 +2316,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 582 + "id": 581 }, { "type": "reference", "name": "Statics", - "id": 541 + "id": 540 } ] } }, { - "id": 602, + "id": 601, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -2367,9 +2367,9 @@ "title": "Variables", "kind": 32, "children": [ - 601, - 603, - 602 + 600, + 602, + 601 ] } ], @@ -2382,14 +2382,14 @@ ] }, { - "id": 611, + "id": 610, "name": "\"@react-native-firebase/mlkit\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 612, + "id": 611, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -2418,7 +2418,7 @@ } }, { - "id": 614, + "id": 613, "name": "MlkitDefaultExport", "kind": 32, "kindString": "Variable", @@ -2436,23 +2436,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 609 + "id": 608 }, { "type": "reference", "name": "Statics", - "id": 608 + "id": 607 } ] } }, { - "id": 613, + "id": 612, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -2487,9 +2487,9 @@ "title": "Variables", "kind": 32, "children": [ - 612, - 614, - 613 + 611, + 613, + 612 ] } ], @@ -2502,14 +2502,14 @@ ] }, { - "id": 700, + "id": 699, "name": "\"@react-native-firebase/perf\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 701, + "id": 700, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -2538,7 +2538,7 @@ } }, { - "id": 703, + "id": 702, "name": "PerfDefaultExport", "kind": 32, "kindString": "Variable", @@ -2556,23 +2556,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 683 + "id": 682 }, { "type": "reference", "name": "Statics", - "id": 682 + "id": 681 } ] } }, { - "id": 702, + "id": 701, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -2607,9 +2607,9 @@ "title": "Variables", "kind": 32, "children": [ - 701, - 703, - 702 + 700, + 702, + 701 ] } ], @@ -2622,14 +2622,14 @@ ] }, { - "id": 876, + "id": 875, "name": "\"@react-native-firebase/storage\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 877, + "id": 876, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -2658,7 +2658,7 @@ } }, { - "id": 879, + "id": 878, "name": "StorageDefaultExport", "kind": 32, "kindString": "Variable", @@ -2676,23 +2676,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 856 + "id": 855 }, { "type": "reference", "name": "Statics", - "id": 731 + "id": 730 } ] } }, { - "id": 878, + "id": 877, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -2719,9 +2719,9 @@ "title": "Variables", "kind": 32, "children": [ - 877, - 879, - 878 + 876, + 878, + 877 ] } ], @@ -2734,14 +2734,14 @@ ] }, { - "id": 889, + "id": 888, "name": "\"@react-native-firebase/utils\"", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 890, + "id": 889, "name": "FirebaseNamespaceExport", "kind": 32, "kindString": "Variable", @@ -2770,7 +2770,7 @@ } }, { - "id": 892, + "id": 891, "name": "UtilsDefaultExport", "kind": 32, "kindString": "Variable", @@ -2788,23 +2788,23 @@ "type": { "type": "reference", "name": "ReactNativeFirebaseModuleAndStatics", - "id": 960, + "id": 959, "typeArguments": [ { "type": "reference", "name": "Module", - "id": 886 + "id": 885 }, { "type": "reference", "name": "Statics", - "id": 885 + "id": 884 } ] } }, { - "id": 891, + "id": 890, "name": "firebase", "kind": 32, "kindString": "Variable", @@ -2839,9 +2839,9 @@ "title": "Variables", "kind": 32, "children": [ - 890, - 892, - 891 + 889, + 891, + 890 ] } ], @@ -3651,7 +3651,7 @@ ] }, { - "id": 941, + "id": 940, "name": "App", "kind": 2, "kindString": "Module", @@ -3668,7 +3668,7 @@ }, "children": [ { - "id": 942, + "id": 941, "name": "FirebaseApp", "kind": 256, "kindString": "Interface", @@ -3677,7 +3677,7 @@ }, "children": [ { - "id": 943, + "id": 942, "name": "name", "kind": 1024, "kindString": "Property", @@ -3700,7 +3700,7 @@ } }, { - "id": 944, + "id": 943, "name": "options", "kind": 1024, "kindString": "Property", @@ -3720,11 +3720,11 @@ "type": { "type": "reference", "name": "FirebaseOptions", - "id": 927 + "id": 926 } }, { - "id": 945, + "id": 944, "name": "delete", "kind": 2048, "kindString": "Method", @@ -3733,7 +3733,7 @@ }, "signatures": [ { - "id": 946, + "id": 945, "name": "delete", "kind": 4096, "kindString": "Call signature", @@ -3767,15 +3767,15 @@ "title": "Properties", "kind": 1024, "children": [ - 943, - 944 + 942, + 943 ] }, { "title": "Methods", "kind": 2048, "children": [ - 945 + 944 ] } ], @@ -3788,7 +3788,7 @@ ] }, { - "id": 947, + "id": 946, "name": "ReactNativeFirebaseNamespace", "kind": 256, "kindString": "Interface", @@ -3797,7 +3797,7 @@ }, "children": [ { - "id": 959, + "id": 958, "name": "SDK_VERSION", "kind": 1024, "kindString": "Property", @@ -3820,7 +3820,7 @@ } }, { - "id": 958, + "id": 957, "name": "apps", "kind": 1024, "kindString": "Property", @@ -3842,12 +3842,12 @@ "elementType": { "type": "reference", "name": "FirebaseApp", - "id": 942 + "id": 941 } } }, { - "id": 955, + "id": 954, "name": "app", "kind": 2048, "kindString": "Method", @@ -3856,7 +3856,7 @@ }, "signatures": [ { - "id": 956, + "id": 955, "name": "app", "kind": 4096, "kindString": "Call signature", @@ -3872,7 +3872,7 @@ }, "parameters": [ { - "id": 957, + "id": 956, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -3900,7 +3900,7 @@ "type": { "type": "reference", "name": "FirebaseApp", - "id": 942 + "id": 941 } } ], @@ -3913,7 +3913,7 @@ ] }, { - "id": 948, + "id": 947, "name": "initializeApp", "kind": 2048, "kindString": "Method", @@ -3922,7 +3922,7 @@ }, "signatures": [ { - "id": 949, + "id": 948, "name": "initializeApp", "kind": 4096, "kindString": "Call signature", @@ -3932,7 +3932,7 @@ }, "parameters": [ { - "id": 950, + "id": 949, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -3943,11 +3943,11 @@ "type": { "type": "reference", "name": "FirebaseOptions", - "id": 927 + "id": 926 } }, { - "id": 951, + "id": 950, "name": "config", "kind": 32768, "kindString": "Parameter", @@ -3960,18 +3960,18 @@ "type": { "type": "reference", "name": "FirebaseAppConfig", - "id": 903 + "id": 902 } } ], "type": { "type": "reference", "name": "FirebaseApp", - "id": 942 + "id": 941 } }, { - "id": 952, + "id": 951, "name": "initializeApp", "kind": 4096, "kindString": "Call signature", @@ -3981,7 +3981,7 @@ }, "parameters": [ { - "id": 953, + "id": 952, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -3992,11 +3992,11 @@ "type": { "type": "reference", "name": "FirebaseOptions", - "id": 927 + "id": 926 } }, { - "id": 954, + "id": 953, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -4024,7 +4024,7 @@ "type": { "type": "reference", "name": "FirebaseApp", - "id": 942 + "id": 941 } } ], @@ -4047,16 +4047,16 @@ "title": "Properties", "kind": 1024, "children": [ - 959, - 958 + 958, + 957 ] }, { "title": "Methods", "kind": 2048, "children": [ - 955, - 948 + 954, + 947 ] } ], @@ -4074,8 +4074,8 @@ "title": "Interfaces", "kind": 256, "children": [ - 942, - 947 + 941, + 946 ] } ], @@ -4120,7 +4120,7 @@ }, "children": [ { - "id": 329, + "id": 328, "name": "app", "kind": 1024, "kindString": "Property", @@ -4144,7 +4144,31 @@ } }, { - "id": 254, + "id": 252, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Returns the current `AuthSettings`." + }, + "sources": [ + { + "fileName": "auth/lib/index.d.ts", + "line": 864, + "character": 12 + } + ], + "type": { + "type": "reference", + "name": "AuthSettings", + "id": 194 + } + }, + { + "id": 253, "name": "currentUser", "kind": 262144, "kindString": "Accessor", @@ -4152,17 +4176,19 @@ "isExported": true }, "comment": { - "shortText": "Returns the currently signed-in user (or null if no user signed in). See the User interface documentation for detailed usage." + "shortText": "Returns the currently signed-in user (or null if no user signed in). See the User interface documentation for detailed usage.", + "text": "#### Example\n\n```js\nconst user = firebase.auth().currentUser;\n```\n\n> It is recommended to use {@link auth#onAuthStateChanged} to track whether the user is currently signed in.\n" }, "getSignature": [ { - "id": 255, + "id": 254, "name": "__get", "kind": 524288, "kindString": "Get signature", "flags": {}, "comment": { - "shortText": "Returns the currently signed-in user (or null if no user signed in). See the User interface documentation for detailed usage." + "shortText": "Returns the currently signed-in user (or null if no user signed in). See the User interface documentation for detailed usage.", + "text": "#### Example\n\n```js\nconst user = firebase.auth().currentUser;\n```\n\n> It is recommended to use {@link auth#onAuthStateChanged} to track whether the user is currently signed in.\n" }, "type": { "type": "union", @@ -4183,43 +4209,88 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 377, + "line": 877, "character": 19 } ] }, { - "id": 252, - "name": "settings", + "id": 248, + "name": "languageCode", "kind": 262144, "kindString": "Accessor", "flags": { "isExported": true }, + "comment": { + "shortText": "Gets the current language code.\nSets the language code.", + "text": "#### Example\n\n```js\nconst language = firebase.auth().languageCode;\n```\n\n#### Example\n\n```js\n// Set language to French\nfirebase.auth().languageCode = 'fr';\n```\n" + }, "getSignature": [ { - "id": 253, + "id": 249, "name": "__get", "kind": 524288, "kindString": "Get signature", "flags": {}, + "comment": { + "shortText": "Gets the current language code.", + "text": "#### Example\n\n```js\nconst language = firebase.auth().languageCode;\n```\n" + }, "type": { - "type": "reference", - "name": "AuthSettings", - "id": 194 + "type": "intrinsic", + "name": "string" + } + } + ], + "setSignature": [ + { + "id": 250, + "name": "__set", + "kind": 1048576, + "kindString": "Set signature", + "flags": {}, + "comment": { + "shortText": "Sets the language code.", + "text": "#### Example\n\n```js\n// Set language to French\nfirebase.auth().languageCode = 'fr';\n```\n" + }, + "parameters": [ + { + "id": 251, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "An ISO language code.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" } } ], "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 372, - "character": 16 + "line": 845, + "character": 20 + }, + { + "fileName": "auth/lib/index.d.ts", + "line": 859, + "character": 20 } ] }, { - "id": 317, + "id": 316, "name": "applyActionCode", "kind": 2048, "kindString": "Method", @@ -4228,23 +4299,24 @@ }, "signatures": [ { - "id": 318, + "id": 317, "name": "applyActionCode", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Applies a verification code sent to the user by email or other out-of-band mechanism." + "shortText": "Applies a verification code sent to the user by email or other out-of-band mechanism.", + "text": "#### Example\n\n```js\nawait firebase.auth().applyActionCode('ABCD');\n```\n" }, "parameters": [ { - "id": 319, + "id": 318, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "A verification code sent to the user.\n" }, "type": { "type": "intrinsic", @@ -4267,13 +4339,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 497, + "line": 1157, "character": 19 } ] }, { - "id": 320, + "id": 319, "name": "checkActionCode", "kind": 2048, "kindString": "Method", @@ -4282,23 +4354,24 @@ }, "signatures": [ { - "id": 321, + "id": 320, "name": "checkActionCode", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Checks a verification code sent to the user by email or other out-of-band mechanism." + "shortText": "Checks a verification code sent to the user by email or other out-of-band mechanism.", + "text": "#### Example\n\n```js\nconst actionCodeInfo = await firebase.auth().checkActionCode('ABCD');\nconsole.log('Action code operation: ', actionCodeInfo.operation);\n```\n" }, "parameters": [ { - "id": 322, + "id": 321, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "A verification code sent to the user.\n" }, "type": { "type": "intrinsic", @@ -4322,13 +4395,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 504, + "line": 1171, "character": 19 } ] }, { - "id": 313, + "id": 312, "name": "confirmPasswordReset", "kind": 2048, "kindString": "Method", @@ -4337,35 +4410,38 @@ }, "signatures": [ { - "id": 314, + "id": 313, "name": "confirmPasswordReset", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Completes the password reset process with the confirmation code and new password." + "shortText": "Completes the password reset process with the confirmation code and new password, via\n{@link auth#sendPasswordResetEmail}.", + "text": "#### Example\n\n```js\nawait firebase.auth().confirmPasswordReset('ABCD', '1234567');\n```\n" }, "parameters": [ { - "id": 315, + "id": 314, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": {}, + "comment": { + "text": "The code from the password reset email." + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 316, + "id": 315, "name": "newPassword", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "The users new password.\n" }, "type": { "type": "intrinsic", @@ -4388,13 +4464,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 490, + "line": 1144, "character": 24 } ] }, { - "id": 284, + "id": 283, "name": "createUserWithEmailAndPassword", "kind": 2048, "kindString": "Method", @@ -4403,33 +4479,38 @@ }, "signatures": [ { - "id": 285, + "id": 284, "name": "createUserWithEmailAndPassword", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": {}, + "comment": { + "shortText": "Creates a new user with an email and password.", + "text": "This method also signs the user in once the account has been created.\n\n#### Example\n\n```js\nconst userCredential = await firebase.auth().createUserWithEmailAndPassword('joe.bloggs@example.com', '123456');\n```\n" + }, "parameters": [ { - "id": 286, + "id": 285, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": {}, + "comment": { + "text": "The users email address." + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 287, + "id": 286, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "The users password.\n" }, "type": { "type": "intrinsic", @@ -4453,13 +4534,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 434, + "line": 1026, "character": 34 } ] }, { - "id": 323, + "id": 322, "name": "fetchSignInMethodsForEmail", "kind": 2048, "kindString": "Method", @@ -4468,23 +4549,24 @@ }, "signatures": [ { - "id": 324, + "id": 323, "name": "fetchSignInMethodsForEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns a list of authentication methods that can be used to sign in a given user (identified by its main email address)." + "shortText": "Returns a list of authentication methods that can be used to sign in a given user (identified by its main email address).", + "text": "#### Example\n\n```js\nconst methods = await firebase.auth().fetchSignInMethodsForEmail('joe.bloggs@example.com');\n\nmethods.forEach((method) => {\n console.log(method);\n});\n```\n" }, "parameters": [ { - "id": 325, + "id": 324, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "The users email address.\n" }, "type": { "type": "intrinsic", @@ -4513,13 +4595,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 511, + "line": 1188, "character": 30 } ] }, { - "id": 306, + "id": 305, "name": "isSignInWithEmailLink", "kind": 2048, "kindString": "Method", @@ -4528,21 +4610,24 @@ }, "signatures": [ { - "id": 307, + "id": 306, "name": "isSignInWithEmailLink", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": {}, + "comment": { + "shortText": "Returns whether the user signed in with a given email link.", + "text": "#### Example\n\n```js\nconst signedInWithLink = firebase.auth().isSignInWithEmailLink(link);\n```\n" + }, "parameters": [ { - "id": 308, + "id": 307, "name": "emailLink", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "The email link to check whether the user signed in with it.\n" }, "type": { "type": "intrinsic", @@ -4559,73 +4644,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 475, + "line": 1115, "character": 25 } ] }, { - "id": 248, - "name": "languageCode", - "kind": 2048, - "kindString": "Method", - "flags": { - "isExported": true - }, - "signatures": [ - { - "id": 249, - "name": "languageCode", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "setSignature": [ - { - "id": 250, - "name": "__set", - "kind": 1048576, - "kindString": "Set signature", - "flags": {}, - "parameters": [ - { - "id": 251, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ], - "sources": [ - { - "fileName": "auth/lib/index.d.ts", - "line": 368, - "character": 16 - }, - { - "fileName": "auth/lib/index.d.ts", - "line": 370, - "character": 20 - } - ] - }, - { - "id": 256, + "id": 255, "name": "onAuthStateChanged", "kind": 2048, "kindString": "Method", @@ -4634,39 +4659,43 @@ }, "signatures": [ { - "id": 257, + "id": 256, "name": "onAuthStateChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Listen for changes in the users auth state (logging in and out).\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use." + "shortText": "Listen for changes in the users auth state (logging in and out).\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.", + "text": "#### Example\n\n```js\nconst unsubscribe = firebase.auth().onAuthStateChanged((user) => {\n if (user) {\n // Signed in\n } else {\n // Signed out\n }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n" }, "parameters": [ { - "id": 258, + "id": 257, "name": "listener", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "A listener function which triggers when auth state changed (for example signing out).\n" + }, "type": { "type": "reference", "name": "AuthListenerCallback", - "id": 330 + "id": 329 } } ], "type": { "type": "reflection", "declaration": { - "id": 259, + "id": 258, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 260, + "id": 259, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -4680,7 +4709,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 384, + "line": 901, "character": 55 } ] @@ -4691,13 +4720,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 384, + "line": 901, "character": 22 } ] }, { - "id": 261, + "id": 260, "name": "onIdTokenChanged", "kind": 2048, "kindString": "Method", @@ -4706,39 +4735,43 @@ }, "signatures": [ { - "id": 262, + "id": 261, "name": "onIdTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Listen for changes in id token.\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use." + "shortText": "Listen for changes in id token.\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.", + "text": " * #### Example\n\n```js\nconst unsubscribe = firebase.auth().onIdTokenChanged((user) => {\n if (user) {\n // User is signed in or token was refreshed.\n }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n" }, "parameters": [ { - "id": 263, + "id": 262, "name": "listener", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "A listener function which triggers when the users ID token changes.\n" + }, "type": { "type": "reference", "name": "AuthListenerCallback", - "id": 330 + "id": 329 } } ], "type": { "type": "reflection", "declaration": { - "id": 264, + "id": 263, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 265, + "id": 264, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -4752,7 +4785,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 391, + "line": 923, "character": 53 } ] @@ -4763,13 +4796,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 391, + "line": 923, "character": 20 } ] }, { - "id": 266, + "id": 265, "name": "onUserChanged", "kind": 2048, "kindString": "Method", @@ -4778,39 +4811,49 @@ }, "signatures": [ { - "id": 267, + "id": 266, "name": "onUserChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Listen for changes in the user.\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use." + "shortText": "Adds a listener to observe changes to the User object. This is a superset of everything from\n{@link auth#onAuthStateChanged}, {@ auth#onIdTokenChanged} and user changes. The goal of this\nmethod is to provide easier listening to all user changes, such as when credentials are\nlinked and unlinked, without manually having to call {@link auth.User#reload}.", + "text": "#### Example\n\n```js\nconst unsubscribe = firebase.auth().onUserChanged((user) => {\n if (user) {\n // User is signed in or token was refreshed.\n }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n\n> This is an experimental feature and is only part of React Native Firebase.\n", + "tags": [ + { + "tag": "react-native-firebase", + "text": "" + } + ] }, "parameters": [ { - "id": 268, + "id": 267, "name": "listener", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "A listener function which triggers when the users data changes.\n" + }, "type": { "type": "reference", "name": "AuthListenerCallback", - "id": 330 + "id": 329 } } ], "type": { "type": "reflection", "declaration": { - "id": 269, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 270, + "id": 269, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -4824,7 +4867,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 398, + "line": 949, "character": 50 } ] @@ -4835,13 +4878,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 398, + "line": 949, "character": 17 } ] }, { - "id": 298, + "id": 297, "name": "sendPasswordResetEmail", "kind": 2048, "kindString": "Method", @@ -4850,29 +4893,32 @@ }, "signatures": [ { - "id": 299, + "id": 298, "name": "sendPasswordResetEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a password reset email to the given email address.\nUnlike the web SDK, the email will contain a password reset link rather than a code." + "shortText": "Sends a password reset email to the given email address.\nUnlike the web SDK, the email will contain a password reset link rather than a code.", + "text": "#### Example\n\n```js\nawait firebase.auth().sendPasswordResetEmail('joe.bloggs@example.com');\n```\n" }, "parameters": [ { - "id": 300, + "id": 299, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": {}, + "comment": { + "text": "The users email address." + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 301, + "id": 300, "name": "actionCodeSettings", "kind": 32768, "kindString": "Parameter", @@ -4880,7 +4926,7 @@ "isOptional": true }, "comment": { - "text": "\n" + "text": "Additional settings to be set before sending the reset email.\n" }, "type": { "type": "reference", @@ -4904,13 +4950,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 462, + "line": 1088, "character": 26 } ] }, { - "id": 302, + "id": 301, "name": "sendSignInLinkToEmail", "kind": 2048, "kindString": "Method", @@ -4919,27 +4965,32 @@ }, "signatures": [ { - "id": 303, + "id": 302, "name": "sendSignInLinkToEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": {}, + "comment": { + "shortText": "Sends a sign in link to the user.", + "text": "#### Example\n\n```js\nawait firebase.auth().sendSignInLinkToEmail('joe.bloggs@example.com');\n```\n" + }, "parameters": [ { - "id": 304, + "id": 303, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": {}, + "comment": { + "text": "The users email address." + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 305, + "id": 304, "name": "actionCodeSettings", "kind": 32768, "kindString": "Parameter", @@ -4947,7 +4998,7 @@ "isOptional": true }, "comment": { - "text": "\n" + "text": "Additional settings to be set before sending the sign in email.\n" }, "type": { "type": "reference", @@ -4971,13 +5022,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 469, + "line": 1102, "character": 25 } ] }, { - "id": 273, + "id": 272, "name": "signInAnonymously", "kind": 2048, "kindString": "Method", @@ -4986,13 +5037,14 @@ }, "signatures": [ { - "id": 274, + "id": 273, "name": "signInAnonymously", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sign in a user anonymously. If the user has already signed in, that user will be returned." + "shortText": "Sign in a user anonymously. If the user has already signed in, that user will be returned.", + "text": "#### Example\n\n```js\nconst userCredential = firebase.auth().signInAnonymously();\n```\n" }, "type": { "type": "reference", @@ -5010,13 +5062,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 405, + "line": 974, "character": 21 } ] }, { - "id": 295, + "id": 294, "name": "signInWithCredential", "kind": 2048, "kindString": "Method", @@ -5025,25 +5077,29 @@ }, "signatures": [ { - "id": 296, + "id": 295, "name": "signInWithCredential", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": {}, + "comment": { + "shortText": "Signs the user in with a generated credential.", + "text": "#### Example\n\n```js\n// Generate a Firebase credential\nconst credential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\n// Sign the user in with the credential\nconst userCredential = await firebase.auth().signInWithCredential(credential);\n```\n" + }, "parameters": [ { - "id": 297, + "id": 296, "name": "credential", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "A generated `AuthCredential`, for example from social auth.\n" }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "name": "AuthCredential", + "id": 60 } } ], @@ -5063,13 +5119,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 453, + "line": 1073, "character": 24 } ] }, { - "id": 292, + "id": 291, "name": "signInWithCustomToken", "kind": 2048, "kindString": "Method", @@ -5078,21 +5134,24 @@ }, "signatures": [ { - "id": 293, + "id": 292, "name": "signInWithCustomToken", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": {}, + "comment": { + "shortText": "Signs a user in with a custom token.", + "text": "#### Example\n\n```js\n// Create a custom token via the Firebase Admin SDK.\nconst token = await firebase.auth().createCustomToken(uid, customClaims);\n...\n// Use the token on the device to sign in.\nconst userCredential = await firebase.auth().signInWithCustomToken(token);\n```\n" + }, "parameters": [ { - "id": 294, + "id": 293, "name": "customToken", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "A custom token generated from the Firebase Admin SDK.\n" }, "type": { "type": "intrinsic", @@ -5116,13 +5175,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 447, + "line": 1057, "character": 25 } ] }, { - "id": 288, + "id": 287, "name": "signInWithEmailAndPassword", "kind": 2048, "kindString": "Method", @@ -5131,33 +5190,38 @@ }, "signatures": [ { - "id": 289, + "id": 288, "name": "signInWithEmailAndPassword", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": {}, + "comment": { + "shortText": "Signs a user in with an email and password.", + "text": "#### Example\n\n```js\nconst userCredential = await firebase.auth().signInWithEmailAndPassword('joe.bloggs@example.com', '123456');\n````\n" + }, "parameters": [ { - "id": 290, + "id": 289, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": {}, + "comment": { + "text": "The users email address." + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 291, + "id": 290, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "The users password.\n" }, "type": { "type": "intrinsic", @@ -5181,13 +5245,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 441, + "line": 1040, "character": 30 } ] }, { - "id": 309, + "id": 308, "name": "signInWithEmailLink", "kind": 2048, "kindString": "Method", @@ -5196,33 +5260,38 @@ }, "signatures": [ { - "id": 310, + "id": 309, "name": "signInWithEmailLink", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": {}, + "comment": { + "shortText": "Signs the user in with an email link.", + "text": "#### Example\n\n```js\nconst userCredential = await firebase.auth().signInWithEmailLink('joe.bloggs@example.com', link);\n```\n" + }, "parameters": [ { - "id": 311, + "id": 310, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": {}, + "comment": { + "text": "The users email to sign in with." + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 312, + "id": 311, "name": "emailLink", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "An email link.\n" }, "type": { "type": "intrinsic", @@ -5246,13 +5315,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 482, + "line": 1129, "character": 23 } ] }, { - "id": 275, + "id": 274, "name": "signInWithPhoneNumber", "kind": 2048, "kindString": "Method", @@ -5261,29 +5330,32 @@ }, "signatures": [ { - "id": 276, + "id": 275, "name": "signInWithPhoneNumber", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Signs in the user using their phone number." + "shortText": "Signs in the user using their phone number.", + "text": "#### Example\n\n```js\n// Force a new message to be sent\nconst result = await firebase.auth().signInWithPhoneNumber('#4423456789', true);\n```\n" }, "parameters": [ { - "id": 277, + "id": 276, "name": "phoneNumber", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": {}, + "comment": { + "text": "The devices phone number." + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 278, + "id": 277, "name": "forceResend", "kind": 32768, "kindString": "Parameter", @@ -5291,7 +5363,7 @@ "isOptional": true }, "comment": { - "text": "\n" + "text": "Forces a new message to be sent if it was already recently sent.\n" }, "type": { "type": "union", @@ -5328,13 +5400,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 412, + "line": 989, "character": 25 } ] }, { - "id": 271, + "id": 270, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -5343,11 +5415,15 @@ }, "signatures": [ { - "id": 272, + "id": 271, "name": "signOut", "kind": 4096, "kindString": "Call signature", "flags": {}, + "comment": { + "shortText": "Signs the user out.", + "text": "Triggers the {@link auth#onAuthStateChanged} listener.\n\n#### Example\n\n```js\nawait firebase.auth().currentUser.signOut();\n```\n\n" + }, "type": { "type": "reference", "name": "Promise", @@ -5363,13 +5439,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 400, + "line": 963, "character": 11 } ] }, { - "id": 326, + "id": 325, "name": "verifyPasswordResetCode", "kind": 2048, "kindString": "Method", @@ -5378,21 +5454,24 @@ }, "signatures": [ { - "id": 327, + "id": 326, "name": "verifyPasswordResetCode", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": {}, + "comment": { + "shortText": "Checks a password reset code sent to the user by email or other out-of-band mechanism.\nTODO salakar: confirm return behavior (Returns the user's email address if valid.)", + "text": "#### Example\n\n```js\nawait firebase.auth().verifyPasswordResetCode('ABCD');\n```\n" + }, "parameters": [ { - "id": 328, + "id": 327, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "text": "\n" + "text": "A password reset code.\n" }, "type": { "type": "intrinsic", @@ -5415,13 +5494,13 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 517, + "line": 1202, "character": 27 } ] }, { - "id": 279, + "id": 278, "name": "verifyPhoneNumber", "kind": 2048, "kindString": "Method", @@ -5430,17 +5509,18 @@ }, "signatures": [ { - "id": 280, + "id": 279, "name": "verifyPhoneNumber", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns a PhoneAuthListener to listen to phone verification events,\non the final completion event a PhoneAuthCredential can be generated for\nauthentication purposes." + "shortText": "Returns a PhoneAuthListener to listen to phone verification events,\non the final completion event a PhoneAuthCredential can be generated for\nauthentication purposes.", + "text": "#### Example\n\n```js\nTODO ehesp\n```\n" }, "parameters": [ { - "id": 281, + "id": 280, "name": "phoneNumber", "kind": 32768, "kindString": "Parameter", @@ -5452,7 +5532,7 @@ } }, { - "id": 282, + "id": 281, "name": "autoVerifyTimeoutOrForceResend", "kind": 32768, "kindString": "Parameter", @@ -5475,7 +5555,7 @@ } }, { - "id": 283, + "id": 282, "name": "forceResend", "kind": 32768, "kindString": "Parameter", @@ -5514,7 +5594,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 423, + "line": 1006, "character": 21 } ] @@ -5525,49 +5605,49 @@ "title": "Properties", "kind": 1024, "children": [ - 329 + 328, + 252 ] }, { "title": "Accessors", "kind": 262144, "children": [ - 254, - 252 + 253, + 248 ] }, { "title": "Methods", "kind": 2048, "children": [ - 317, - 320, - 313, - 284, - 323, - 306, - 248, - 256, - 261, - 266, - 298, - 302, - 273, - 295, - 292, - 288, - 309, - 275, - 271, - 326, - 279 + 316, + 319, + 312, + 283, + 322, + 305, + 255, + 260, + 265, + 297, + 301, + 272, + 294, + 291, + 287, + 308, + 274, + 270, + 325, + 278 ] } ], "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 367, + "line": 835, "character": 21 } ], @@ -5586,6 +5666,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 143, @@ -5598,7 +5679,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 158, + "line": 446, "character": 8 } ], @@ -5619,7 +5700,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 159, + "line": 447, "character": 13 } ], @@ -5663,7 +5744,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 157, + "line": 445, "character": 33 } ] @@ -5676,6 +5757,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 140, @@ -5689,7 +5771,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 153, + "line": 438, "character": 9 } ], @@ -5719,7 +5801,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 154, + "line": 439, "character": 13 } ], @@ -5751,7 +5833,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 152, + "line": 437, "character": 37 } ] @@ -5764,6 +5846,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 148, @@ -5776,7 +5859,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 167, + "line": 461, "character": 11 } ], @@ -5798,7 +5881,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 168, + "line": 462, "character": 19 } ], @@ -5831,7 +5914,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 169, + "line": 463, "character": 7 } ], @@ -5852,7 +5935,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 170, + "line": 464, "character": 7 } ], @@ -5877,7 +5960,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 166, + "line": 460, "character": 37 } ] @@ -5890,6 +5973,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 136, @@ -5903,7 +5987,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 147, + "line": 429, "character": 14 } ], @@ -5937,7 +6021,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 148, + "line": 430, "character": 18 } ], @@ -5966,7 +6050,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 149, + "line": 431, "character": 15 } ], @@ -5990,7 +6074,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 146, + "line": 428, "character": 44 } ] @@ -6003,6 +6087,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 146, @@ -6016,7 +6101,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 163, + "line": 454, "character": 12 } ], @@ -6047,7 +6132,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 162, + "line": 453, "character": 40 } ] @@ -6060,6 +6145,10 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "A structure containing additional user information from a federated identity provider via {@link auth.UserCredential}.", + "text": "#### Example\n\n```js\nconst userCredential = await firebase.auth().signInAnonymously();\nconsole.log('Additional user info: ', userCredential.additionalUserInfo);\n```\n" + }, "children": [ { "id": 100, @@ -6069,10 +6158,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Returns whether the user is new or existing." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 100, + "line": 278, "character": 13 } ], @@ -6090,10 +6182,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Returns a Object containing IDP-specific user data if the provider is one of Facebook,\nGitHub, Google, Twitter, Microsoft, or Yahoo." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 101, + "line": 283, "character": 11 } ], @@ -6110,10 +6205,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Returns the provider ID for specifying which provider the information in `profile` is for." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 102, + "line": 287, "character": 14 } ], @@ -6131,10 +6229,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Returns the username if the provider is GitHub or Twitter." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 103, + "line": 291, "character": 12 } ], @@ -6168,11 +6269,107 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 99, + "line": 274, "character": 37 } ] }, + { + "id": 60, + "name": "AuthCredential", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Interface that represents the credentials returned by an auth provider. Implementations specify the details\nabout each auth provider's credential requirements.", + "text": "TODO Missing; signInMethod, toJSON, fromJSON\n\n#### Example\n\n```js\nconst provider = firebase.auth.EmailAuthProvider;\nconst authCredential = provider.credential('foo@bar.com', '123456');\n\nawait firebase.auth().linkWithCredential(authCredential);\n```\n" + }, + "children": [ + { + "id": 61, + "name": "providerId", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'." + }, + "sources": [ + { + "fileName": "auth/lib/index.d.ts", + "line": 82, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 63, + "name": "secret", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "auth/lib/index.d.ts", + "line": 84, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 62, + "name": "token", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "auth/lib/index.d.ts", + "line": 83, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 61, + 63, + 62 + ] + } + ], + "sources": [ + { + "fileName": "auth/lib/index.d.ts", + "line": 78, + "character": 33 + } + ] + }, { "id": 64, "name": "AuthProvider", @@ -6181,6 +6378,9 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Interface that represents an auth provider. Implemented by other providers." + }, "children": [ { "id": 65, @@ -6190,10 +6390,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "The provider ID of the provider." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 69, + "line": 94, "character": 15 } ], @@ -6210,10 +6413,29 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Creates a new `AuthCredential`.", + "tags": [ + { + "tag": "returns", + "text": "." + }, + { + "tag": "param", + "text": "A provider token.", + "param": "token" + }, + { + "tag": "param", + "text": "A provider secret.\n", + "param": "secret" + } + ] + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 70, + "line": 102, "character": 14 } ], @@ -6278,7 +6500,7 @@ ], "type": { "type": "reference", - "name": "AuthProviderCredential", + "name": "AuthCredential", "id": 60 } } @@ -6286,7 +6508,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 70, + "line": 102, "character": 15 } ] @@ -6307,100 +6529,11 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 68, + "line": 90, "character": 31 } ] }, - { - "id": 60, - "name": "AuthProviderCredential", - "kind": 256, - "kindString": "Interface", - "flags": { - "isExported": true - }, - "children": [ - { - "id": 61, - "name": "providerId", - "kind": 1024, - "kindString": "Property", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "auth/lib/index.d.ts", - "line": 63, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 63, - "name": "secret", - "kind": 1024, - "kindString": "Property", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "auth/lib/index.d.ts", - "line": 65, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 62, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "auth/lib/index.d.ts", - "line": 64, - "character": 9 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 61, - 63, - 62 - ] - } - ], - "sources": [ - { - "fileName": "auth/lib/index.d.ts", - "line": 62, - "character": 41 - } - ] - }, { "id": 194, "name": "AuthSettings", @@ -6435,7 +6568,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 212, + "line": 532, "character": 37 } ], @@ -6511,7 +6644,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 226, + "line": 546, "character": 41 } ] @@ -6536,7 +6669,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 205, + "line": 525, "character": 31 } ] @@ -6549,6 +6682,9 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "TODO" + }, "children": [ { "id": 134, @@ -6561,7 +6697,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 143, + "line": 422, "character": 18 } ], @@ -6632,7 +6768,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 142, + "line": 421, "character": 11 } ] @@ -6657,7 +6793,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 141, + "line": 420, "character": 37 } ] @@ -6670,6 +6806,9 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Email and password auth provider implementation." + }, "children": [ { "id": 73, @@ -6679,10 +6818,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "This corresponds to the sign-in method identifier as returned in {@link auth.#fetchSignInMethodsForEmail}.", + "text": "#### Example\n\n```js\nconst signInMethods = await firebase.auth().fetchSignInMethodsForEmail('...');\nif (signInMethods.indexOf(firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD) != -1) {\n // User can sign in with email/link\n}\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 75, + "line": 125, "character": 29 } ], @@ -6699,10 +6842,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "This corresponds to the sign-in method identifier as returned in {@link auth.#fetchSignInMethodsForEmail}.", + "text": "#### Example\n\n```js\nconst signInMethods = await firebase.auth().fetchSignInMethodsForEmail('...');\nif (signInMethods.indexOf(firebase.auth.EmailAuthProvider.EMAIL_PASSWORD_SIGN_IN_METHOD) != -1) {\n // User can sign in with email/password\n}\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 76, + "line": 138, "character": 33 } ], @@ -6719,10 +6866,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "The provider ID. Always returns `password`." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 74, + "line": 112, "character": 15 } ], @@ -6739,10 +6889,30 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Returns the auth provider credential.", + "text": "#### Example\n\n```js\nconst authCredential = firebase.auth.EmailAuthProvider.credential('joe.bloggs@example.com', '123456');\n```\n", + "tags": [ + { + "tag": "returns", + "text": "" + }, + { + "tag": "param", + "text": "Users email address.", + "param": "email" + }, + { + "tag": "param", + "text": "User account password.\n", + "param": "password" + } + ] + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 77, + "line": 152, "character": 14 } ], @@ -6787,7 +6957,7 @@ ], "type": { "type": "reference", - "name": "AuthProviderCredential", + "name": "AuthCredential", "id": 60 } } @@ -6795,7 +6965,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 77, + "line": 152, "character": 15 } ] @@ -6810,10 +6980,26 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Initialize an `EmailAuthProvider` credential using an email and an email link after a sign in with email link operation.", + "text": "#### Example\n\n```js\nconst authCredential = firebase.auth.EmailAuthProvider.credentialWithLink('joe.bloggs@example.com', 'https://myexample.com/invite');\n```\n", + "tags": [ + { + "tag": "param", + "text": "Users email address.", + "param": "email" + }, + { + "tag": "param", + "text": "Sign-in email link.\n", + "param": "emailLink" + } + ] + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 78, + "line": 165, "character": 22 } ], @@ -6858,7 +7044,7 @@ ], "type": { "type": "reference", - "name": "AuthProviderCredential", + "name": "AuthCredential", "id": 60 } } @@ -6866,7 +7052,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 78, + "line": 165, "character": 23 } ] @@ -6890,7 +7076,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 73, + "line": 108, "character": 36 } ] @@ -6903,6 +7089,9 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "TODO" + }, "children": [ { "id": 119, @@ -6915,7 +7104,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 127, + "line": 383, "character": 12 } ], @@ -6935,7 +7124,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 131, + "line": 387, "character": 10 } ], @@ -6976,7 +7165,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 131, + "line": 387, "character": 11 } ] @@ -6994,7 +7183,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 129, + "line": 385, "character": 18 } ], @@ -7014,7 +7203,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 128, + "line": 384, "character": 16 } ], @@ -7034,7 +7223,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 130, + "line": 386, "character": 18 } ], @@ -7063,7 +7252,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 126, + "line": 382, "character": 9 } ], @@ -7090,7 +7279,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 125, + "line": 381, "character": 32 } ] @@ -7103,6 +7292,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 158, @@ -7115,7 +7305,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 183, + "line": 500, "character": 8 } ], @@ -7144,7 +7334,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 185, + "line": 502, "character": 11 } ], @@ -7173,7 +7363,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 186, + "line": 503, "character": 9 } ], @@ -7202,7 +7392,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 184, + "line": 501, "character": 18 } ], @@ -7227,7 +7417,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 182, + "line": 499, "character": 33 } ] @@ -7240,6 +7430,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 188, @@ -7300,7 +7491,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 202, + "line": 522, "character": 21 } ] @@ -7323,7 +7514,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 202, + "line": 522, "character": 9 } ] @@ -7399,7 +7590,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 192, + "line": 512, "character": 15 } ] @@ -7527,7 +7718,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 190, + "line": 510, "character": 6 } ] @@ -7597,7 +7788,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 198, + "line": 518, "character": 19 } ] @@ -7658,7 +7849,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 199, + "line": 519, "character": 18 } ] @@ -7687,7 +7878,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 197, + "line": 517, "character": 8 } ] @@ -7707,7 +7898,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 189, + "line": 509, "character": 36 } ] @@ -7720,6 +7911,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 155, @@ -7732,7 +7924,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 178, + "line": 492, "character": 8 } ], @@ -7761,7 +7953,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 179, + "line": 493, "character": 9 } ], @@ -7790,7 +7982,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 176, + "line": 490, "character": 9 } ], @@ -7827,7 +8019,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 177, + "line": 491, "character": 18 } ], @@ -7852,7 +8044,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 175, + "line": 489, "character": 36 } ] @@ -7865,6 +8057,7 @@ "flags": { "isExported": true }, + "comment": {}, "children": [ { "id": 88, @@ -7877,7 +8070,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 84, + "line": 174, "character": 17 } ], @@ -7897,7 +8090,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 83, + "line": 173, "character": 23 } ], @@ -7917,7 +8110,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 82, + "line": 172, "character": 13 } ], @@ -7937,7 +8130,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 85, + "line": 175, "character": 9 } ], @@ -7962,7 +8155,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 81, + "line": 171, "character": 33 } ] @@ -7975,6 +8168,9 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "firebase.auth.X" + }, "children": [ { "id": 91, @@ -7984,10 +8180,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Email and password auth provider implementation.", + "text": "#### Example\n\n```js\nfirebase.auth.EmailAuthProvider;\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 89, + "line": 191, "character": 21 } ], @@ -8005,10 +8205,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Facebook auth provider implementation.", + "text": "#### Example\n\n```js\nfirebase.auth.FacebookAuthProvider;\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 94, + "line": 241, "character": 24 } ], @@ -8026,10 +8230,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Github auth provider implementation.", + "text": "#### Example\n\n```js\nfirebase.auth.GithubAuthProvider;\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 92, + "line": 221, "character": 22 } ], @@ -8047,10 +8255,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Google auth provider implementation.", + "text": "#### Example\n\n```js\nfirebase.auth.GoogleAuthProvider;\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 91, + "line": 211, "character": 22 } ], @@ -8068,10 +8280,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Custom OAuth auth provider implementation.", + "text": "#### Example\n\n```js\nfirebase.auth.OAuthProvider;\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 95, + "line": 251, "character": 17 } ], @@ -8089,10 +8305,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Phone auth provider implementation.", + "text": "#### Example\n\n```js\nfirebase.auth.PhoneAuthProvider;\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 90, + "line": 201, "character": 21 } ], @@ -8110,10 +8330,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "A PhoneAuthState interface.", + "text": "#### Example\n\n```js\nfirebase.auth.PhoneAuthState;\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 96, + "line": 261, "character": 18 } ], @@ -8131,10 +8355,14 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Twitter auth provider implementation.", + "text": "#### Example\n\n```js\nfirebase.auth.TwitterAuthProvider;\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 93, + "line": 231, "character": 23 } ], @@ -8164,7 +8392,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 88, + "line": 181, "character": 26 } ] @@ -8177,6 +8405,10 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Request used to update user profile information.", + "text": "#### Example\n\n```js\nconst update = {\n displayName: 'Alias',\n photoURL: 'https://my-cdn.com/assets/user/123.png',\n};\n\nawait firebase.auth().currentUser.updateProfile(update);\n```\n" + }, "children": [ { "id": 128, @@ -8187,10 +8419,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "An optional display name for the user." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 137, + "line": 410, "character": 15 } ], @@ -8217,10 +8452,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "An optional photo URL for the user." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 138, + "line": 414, "character": 12 } ], @@ -8252,7 +8490,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 136, + "line": 406, "character": 32 } ] @@ -8265,6 +8503,10 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Represents a user's profile information in your Firebase project's user database. It also\ncontains helper methods to change or retrieve profile information, as well as to manage that user's authentication state.", + "text": "#### Example 1\n\nSubscribing to the users authentication state.\n\n```js\nfirebase.auth().onAuthStateChanged((user) => {\n if (user) {\n console.log('User email: ', user.email');\n }\n});\n```\n\n#### Example 2\n\n```js\nconst user = firebase.auth().currentUser;\n\nif (user) {\n console.log('User email: ', user.email');\n}\n```\n" + }, "children": [ { "id": 201, @@ -8280,7 +8522,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 233, + "line": 579, "character": 15 } ], @@ -8312,7 +8554,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 237, + "line": 583, "character": 9 } ], @@ -8344,7 +8586,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 241, + "line": 587, "character": 17 } ], @@ -8361,11 +8603,13 @@ "flags": { "isExported": true }, - "comment": {}, + "comment": { + "shortText": "Returns true if the user is anonymous; that is, the user account was created with\n{@link auth#signInAnonymously()} and has not been linked to another account\nwith {@link auth#linkWithCredential}." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 245, + "line": 593, "character": 15 } ], @@ -8382,10 +8626,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Returns the {@link auth.UserMetadata} associated with this user." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 247, + "line": 598, "character": 12 } ], @@ -8403,10 +8650,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Returns the phone number of the user, as stored in the Firebase project's user database,\nor null if none exists. This can be updated at any time by calling {@link auth.User#updatePhoneNumber}." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 249, + "line": 604, "character": 15 } ], @@ -8433,12 +8683,12 @@ "isExported": true }, "comment": { - "shortText": "- The URL of the user's profile picture (if available)." + "shortText": "The URL of the user's profile picture (if available)." }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 254, + "line": 609, "character": 12 } ], @@ -8465,12 +8715,12 @@ "isExported": true }, "comment": { - "shortText": "- Additional provider-specific information about the user." + "shortText": "Additional provider-specific information about the user." }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 259, + "line": 614, "character": 16 } ], @@ -8495,12 +8745,12 @@ "isExported": true }, "comment": { - "shortText": " - The authentication provider ID for the current user.\n For example, 'facebook.com', or 'google.com'." + "shortText": " The authentication provider ID for the current user.\n For example, 'facebook.com', or 'google.com'." }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 265, + "line": 620, "character": 14 } ], @@ -8523,7 +8773,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 270, + "line": 625, "character": 7 } ], @@ -8548,7 +8798,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Delete the current user." + "shortText": "Delete the current user.", + "text": "#### Example\n\n```js\nawait firebase.auth().currentUser.delete();\n```\n" }, "type": { "type": "reference", @@ -8565,7 +8816,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 275, + "line": 636, "character": 10 } ] @@ -8586,7 +8837,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the users authentication token." + "shortText": "Returns the users authentication token.", + "text": "#### Example\n\n```js\n// Force a token refresh\nconst idToken = await firebase.auth().currentUser.getIdToken(true);\n```\n" }, "parameters": [ { @@ -8597,6 +8849,9 @@ "flags": { "isOptional": true }, + "comment": { + "text": "A boolean value which forces Firebase to refresh the token.\n" + }, "type": { "type": "union", "types": [ @@ -8631,7 +8886,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 282, + "line": 650, "character": 14 } ] @@ -8652,7 +8907,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns a firebase.auth.IdTokenResult object which contains the ID token JWT string and\nother helper properties for getting different data associated with the token as well as\nall the decoded payload claims." + "shortText": "Returns a firebase.auth.IdTokenResult object which contains the ID token JWT string and\nother helper properties for getting different data associated with the token as well as\nall the decoded payload claims.", + "text": "#### Example\n\n```js\n// Force a token refresh\nconst idTokenResult = await firebase.auth().currentUser.getIdTokenResult(true);\n```\n" }, "parameters": [ { @@ -8701,7 +8957,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 291, + "line": 666, "character": 20 } ] @@ -8722,7 +8978,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Link the user with a 3rd party credential provider." + "shortText": "Link the user with a 3rd party credential provider.", + "text": "#### Example\n\n```js\nconst facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\nconst userCredential = await firebase.auth().currentUser.linkWithCredential(facebookCredential);\n```\n" }, "parameters": [ { @@ -8731,9 +8988,12 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "A created {@link auth.AuthCredential}.\n" + }, "type": { "type": "reference", - "name": "AuthProviderCredential", + "name": "AuthCredential", "id": 60 } } @@ -8754,7 +9014,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 296, + "line": 680, "character": 22 } ] @@ -8775,7 +9035,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Re-authenticate a user with a third-party authentication provider" + "shortText": "Re-authenticate a user with a third-party authentication provider.", + "text": "#### Example\n\n```js\nconst facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\nconst userCredential = await firebase.auth().currentUser.reauthenticateWithCredential(facebookCredential);\n```\n" }, "parameters": [ { @@ -8784,9 +9045,12 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "A created {@link auth.AuthCredential}.\n" + }, "type": { "type": "reference", - "name": "AuthProviderCredential", + "name": "AuthCredential", "id": 60 } } @@ -8807,7 +9071,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 301, + "line": 694, "character": 32 } ] @@ -8828,7 +9092,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Refreshes the current user." + "shortText": "Refreshes the current user.", + "text": "#### Example\n\n```js\nawait firebase.auth().currentUser.reload();\n```\n" }, "type": { "type": "reference", @@ -8845,7 +9110,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 306, + "line": 705, "character": 10 } ] @@ -8866,7 +9131,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a verification email to a user.\nThis will Promise reject is the user is anonymous." + "shortText": "Sends a verification email to a user.", + "text": "#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n handleCodeInApp: true,\n});\n```\n\n> This will Promise reject is the user is anonymous.\n" }, "parameters": [ { @@ -8877,6 +9143,9 @@ "flags": { "isOptional": true }, + "comment": { + "text": "Any optional additional settings to be set before sending the verification email.\n" + }, "type": { "type": "reference", "name": "ActionCodeSettings", @@ -8899,7 +9168,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 312, + "line": 722, "character": 25 } ] @@ -8919,6 +9188,10 @@ "kind": 4096, "kindString": "Call signature", "flags": {}, + "comment": { + "shortText": "Returns a JSON-serializable representation of this object.", + "text": "#### Example\n\n```js\nconst user = firebase.auth().currentUser.toJSON();\n```\n" + }, "type": { "type": "intrinsic", "name": "object" @@ -8928,7 +9201,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 314, + "line": 733, "character": 10 } ] @@ -8948,6 +9221,10 @@ "kind": 4096, "kindString": "Call signature", "flags": {}, + "comment": { + "shortText": "Unlinks a provider from a user account.", + "text": "#### Example\n\n```js\nconst user = await firebase.auth().currentUser.unlink('facebook.com');\n```\n" + }, "parameters": [ { "id": 234, @@ -8955,6 +9232,9 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "\n" + }, "type": { "type": "intrinsic", "name": "string" @@ -8977,7 +9257,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 316, + "line": 746, "character": 10 } ] @@ -8998,7 +9278,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user's email address.\nSee Firebase docs for more information on security & email validation.\nThis will Promise reject is the user is anonymous." + "shortText": "Updates the user's email address.", + "text": "See Firebase docs for more information on security & email validation.\n\n#### Example\n\n```js\nawait firebase.auth().currentUser.updateEmail('joe.bloggs@new-email.com');\n```\n\n> This will Promise reject is the user is anonymous.\n" }, "parameters": [ { @@ -9007,6 +9288,9 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "The users new email address.\n" + }, "type": { "type": "intrinsic", "name": "string" @@ -9028,7 +9312,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 323, + "line": 763, "character": 15 } ] @@ -9049,7 +9333,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Important: this is a security sensitive operation that requires the user to have recently signed in.\nIf this requirement isn't met, ask the user to authenticate again and then call firebase.User#reauthenticate.\nThis will Promise reject is the user is anonymous." + "shortText": "Updates the users password.", + "text": "Important: this is a security sensitive operation that requires the user to have recently signed in.\nIf this requirement isn't met, ask the user to authenticate again and then call firebase.User#reauthenticate.\n\n#### Example\n\n```js\nawait firebase.auth().currentUser.updatePassword('654321');\n```\n\n> This will Promise reject is the user is anonymous.\n" }, "parameters": [ { @@ -9058,6 +9343,9 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "The users new password.\n" + }, "type": { "type": "intrinsic", "name": "string" @@ -9079,7 +9367,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 330, + "line": 781, "character": 18 } ] @@ -9100,7 +9388,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user's phone number.\nSee Firebase docs for more information on security & email validation.\nThis will Promise reject is the user is anonymous." + "shortText": "Updates the user's phone number.", + "text": "See Firebase docs for more information on security & email validation.\n\n#### Example\n\n```js\nTODO ehesp\n```\n\n> This will Promise reject is the user is anonymous.\n" }, "parameters": [ { @@ -9109,9 +9398,12 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "text": "A created `AuthCredential`.\n" + }, "type": { "type": "reference", - "name": "AuthProviderCredential", + "name": "AuthCredential", "id": 60 } } @@ -9131,7 +9423,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 337, + "line": 798, "character": 21 } ] @@ -9152,7 +9444,8 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates a user's profile data.\nProfile data should be an object of fields to update:" + "shortText": "Updates a user's profile data.", + "text": "#### Example\n\n```js\nawait firebase.auth().currentUser.updateProfile({\n displayName: 'Alias',\n});\n```\n" }, "parameters": [ { @@ -9183,7 +9476,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 343, + "line": 811, "character": 17 } ] @@ -9229,7 +9522,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 229, + "line": 575, "character": 23 } ] @@ -9242,6 +9535,10 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "A structure containing a User, an AuthCredential, the operationType, and any additional user\ninformation that was returned from the identity provider. operationType could be 'signIn' for\na sign-in operation, 'link' for a linking operation and 'reauthenticate' for a reauthentication operation.", + "text": "TODO @salakar; missing credential, operationType\n" + }, "children": [ { "id": 105, @@ -9252,10 +9549,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Any additional user information assigned to the user." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 107, + "line": 305, "character": 22 } ], @@ -9273,10 +9573,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Returns the {@link auth.User} interface of this credential." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 108, + "line": 309, "character": 8 } ], @@ -9300,7 +9603,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 106, + "line": 301, "character": 33 } ] @@ -9313,6 +9616,10 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Represents a collection of standard profile information for a user. Can be used to expose\nprofile information returned by an identity provider, such as Google Sign-In or Facebook Login.", + "text": "TODO @salakar: isEmailVerified\n\n#### Example\n\n```js\nconst user = firebase.auth().currentUser;\n\nuser.providerData.forEach((userInfo) => {\n console.log('User info for provider: ', userInfo);\n});\n```\n" + }, "children": [ { "id": 111, @@ -9323,10 +9630,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Returns the user's display name, if available." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 117, + "line": 355, "character": 15 } ], @@ -9353,10 +9663,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Returns the email address corresponding to the user's account in the specified provider, if available." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 118, + "line": 359, "character": 9 } ], @@ -9383,10 +9696,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Returns the phone number corresponding to the user's account, if available, or `null` if none exists." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 119, + "line": 363, "character": 15 } ], @@ -9413,10 +9729,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Returns a url to the user's profile picture, if available." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 120, + "line": 367, "character": 12 } ], @@ -9442,10 +9761,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Returns the unique identifier of the provider type that this instance corresponds to." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 121, + "line": 371, "character": 14 } ], @@ -9462,10 +9784,13 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Returns a user identifier as specified by the authentication provider." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 122, + "line": 375, "character": 7 } ], @@ -9492,7 +9817,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 116, + "line": 351, "character": 27 } ] @@ -9505,6 +9830,10 @@ "flags": { "isExported": true }, + "comment": { + "shortText": "Holds the user metadata for the current {@link auth.User}.", + "text": "#### Example\n\n```js\nconst user = firebase.auth().currentUser;\nconsole.log('User metadata: ', user.metadata);\n```\n" + }, "children": [ { "id": 108, @@ -9515,10 +9844,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Returns the timestamp at which this account was created as dictated by the server clock\nas an ISO Date string." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 112, + "line": 327, "character": 16 } ], @@ -9545,10 +9877,13 @@ "isExported": true, "isOptional": true }, + "comment": { + "shortText": "Returns the last signin timestamp as dictated by the server clock as an ISO Date string.\nThis is only accurate up to a granularity of 2 minutes for consecutive sign-in attempts." + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 113, + "line": 332, "character": 18 } ], @@ -9580,44 +9915,48 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 111, + "line": 322, "character": 31 } ] }, { - "id": 330, + "id": 329, "name": "AuthListenerCallback", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, + "comment": { + "shortText": "An auth listener callback function for {@link auth#onAuthStateChanged}.", + "text": "#### Example\n\n```js\nfunction listener(user) {\n if (user) {\n // Signed in\n } else {\n // Signed out\n }\n}\n\nfirebase.auth().onAuthStateChanged(listener);\n```\n" + }, "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 173, + "line": 484, "character": 34 } ], "type": { "type": "reflection", "declaration": { - "id": 331, + "id": 330, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 332, + "id": 331, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 333, + "id": 332, "name": "user", "kind": 32768, "kindString": "Parameter", @@ -9647,7 +9986,7 @@ "sources": [ { "fileName": "auth/lib/index.d.ts", - "line": 173, + "line": 484, "character": 36 } ] @@ -9673,8 +10012,8 @@ 135, 145, 99, - 64, 60, + 64, 194, 130, 71, @@ -9695,7 +10034,7 @@ "title": "Type aliases", "kind": 4194304, "children": [ - 330 + 329 ] } ], @@ -9708,7 +10047,7 @@ ] }, { - "id": 341, + "id": 340, "name": "Config", "kind": 2, "kindString": "Module", @@ -9727,7 +10066,7 @@ }, "children": [ { - "id": 358, + "id": 357, "name": "Module", "kind": 128, "kindString": "Class", @@ -9740,7 +10079,7 @@ }, "children": [ { - "id": 387, + "id": 386, "name": "app", "kind": 1024, "kindString": "Property", @@ -9764,7 +10103,7 @@ } }, { - "id": 359, + "id": 358, "name": "activateFetched", "kind": 2048, "kindString": "Method", @@ -9773,7 +10112,7 @@ }, "signatures": [ { - "id": 360, + "id": 359, "name": "activateFetched", "kind": 4096, "kindString": "Call signature", @@ -9803,7 +10142,7 @@ ] }, { - "id": 361, + "id": 360, "name": "fetch", "kind": 2048, "kindString": "Method", @@ -9812,7 +10151,7 @@ }, "signatures": [ { - "id": 362, + "id": 361, "name": "fetch", "kind": 4096, "kindString": "Call signature", @@ -9823,7 +10162,7 @@ }, "parameters": [ { - "id": 363, + "id": 362, "name": "cacheExpirationSeconds", "kind": 32768, "kindString": "Parameter", @@ -9869,7 +10208,7 @@ ] }, { - "id": 364, + "id": 363, "name": "fetchAndActivate", "kind": 2048, "kindString": "Method", @@ -9878,7 +10217,7 @@ }, "signatures": [ { - "id": 365, + "id": 364, "name": "fetchAndActivate", "kind": 4096, "kindString": "Call signature", @@ -9889,7 +10228,7 @@ }, "parameters": [ { - "id": 366, + "id": 365, "name": "cacheExpirationSeconds", "kind": 32768, "kindString": "Parameter", @@ -9935,7 +10274,7 @@ ] }, { - "id": 367, + "id": 366, "name": "getConfigSettings", "kind": 2048, "kindString": "Method", @@ -9944,7 +10283,7 @@ }, "signatures": [ { - "id": 368, + "id": 367, "name": "getConfigSettings", "kind": 4096, "kindString": "Call signature", @@ -9960,7 +10299,7 @@ { "type": "reference", "name": "ConfigSettingsRead", - "id": 351 + "id": 350 } ] } @@ -9975,7 +10314,7 @@ ] }, { - "id": 369, + "id": 368, "name": "getKeysByPrefix", "kind": 2048, "kindString": "Method", @@ -9984,7 +10323,7 @@ }, "signatures": [ { - "id": 370, + "id": 369, "name": "getKeysByPrefix", "kind": 4096, "kindString": "Call signature", @@ -9995,7 +10334,7 @@ }, "parameters": [ { - "id": 371, + "id": 370, "name": "prefix", "kind": 32768, "kindString": "Parameter", @@ -10044,7 +10383,7 @@ ] }, { - "id": 375, + "id": 374, "name": "getValue", "kind": 2048, "kindString": "Method", @@ -10053,7 +10392,7 @@ }, "signatures": [ { - "id": 376, + "id": 375, "name": "getValue", "kind": 4096, "kindString": "Call signature", @@ -10064,7 +10403,7 @@ }, "parameters": [ { - "id": 377, + "id": 376, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -10085,7 +10424,7 @@ { "type": "reference", "name": "ConfigValue", - "id": 343 + "id": 342 } ] } @@ -10100,7 +10439,7 @@ ] }, { - "id": 372, + "id": 371, "name": "getValuesByKeysPrefix", "kind": 2048, "kindString": "Method", @@ -10109,7 +10448,7 @@ }, "signatures": [ { - "id": 373, + "id": 372, "name": "getValuesByKeysPrefix", "kind": 4096, "kindString": "Call signature", @@ -10120,7 +10459,7 @@ }, "parameters": [ { - "id": 374, + "id": 373, "name": "prefix", "kind": 32768, "kindString": "Parameter", @@ -10152,7 +10491,7 @@ { "type": "reference", "name": "ConfigValues", - "id": 346 + "id": 345 } ] } @@ -10167,7 +10506,7 @@ ] }, { - "id": 378, + "id": 377, "name": "setConfigSettings", "kind": 2048, "kindString": "Method", @@ -10176,7 +10515,7 @@ }, "signatures": [ { - "id": 379, + "id": 378, "name": "setConfigSettings", "kind": 4096, "kindString": "Call signature", @@ -10187,7 +10526,7 @@ }, "parameters": [ { - "id": 380, + "id": 379, "name": "configSettings", "kind": 32768, "kindString": "Parameter", @@ -10198,7 +10537,7 @@ "type": { "type": "reference", "name": "ConfigSettingsWrite", - "id": 349 + "id": 348 } } ], @@ -10209,7 +10548,7 @@ { "type": "reference", "name": "ConfigSettingsRead", - "id": 351 + "id": 350 } ] } @@ -10224,7 +10563,7 @@ ] }, { - "id": 381, + "id": 380, "name": "setDefaults", "kind": 2048, "kindString": "Method", @@ -10233,7 +10572,7 @@ }, "signatures": [ { - "id": 382, + "id": 381, "name": "setDefaults", "kind": 4096, "kindString": "Call signature", @@ -10244,7 +10583,7 @@ }, "parameters": [ { - "id": 383, + "id": 382, "name": "defaults", "kind": 32768, "kindString": "Parameter", @@ -10255,7 +10594,7 @@ "type": { "type": "reference", "name": "ConfigDefaults", - "id": 355 + "id": 354 } } ], @@ -10280,7 +10619,7 @@ ] }, { - "id": 384, + "id": 383, "name": "setDefaultsFromResource", "kind": 2048, "kindString": "Method", @@ -10289,7 +10628,7 @@ }, "signatures": [ { - "id": 385, + "id": 384, "name": "setDefaultsFromResource", "kind": 4096, "kindString": "Call signature", @@ -10300,7 +10639,7 @@ }, "parameters": [ { - "id": 386, + "id": 385, "name": "resourceName", "kind": 32768, "kindString": "Parameter", @@ -10340,23 +10679,23 @@ "title": "Properties", "kind": 1024, "children": [ - 387 + 386 ] }, { "title": "Methods", "kind": 2048, "children": [ - 359, - 361, - 364, - 367, - 369, - 375, - 372, - 378, - 381, - 384 + 358, + 360, + 363, + 366, + 368, + 374, + 371, + 377, + 380, + 383 ] } ], @@ -10375,7 +10714,7 @@ ] }, { - "id": 355, + "id": 354, "name": "ConfigDefaults", "kind": 256, "kindString": "Interface", @@ -10388,7 +10727,7 @@ }, "indexSignature": [ { - "id": 356, + "id": 355, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -10399,7 +10738,7 @@ }, "parameters": [ { - "id": 357, + "id": 356, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -10438,7 +10777,7 @@ ] }, { - "id": 351, + "id": 350, "name": "ConfigSettingsRead", "kind": 256, "kindString": "Interface", @@ -10451,7 +10790,7 @@ }, "children": [ { - "id": 353, + "id": 352, "name": "isDeveloperModeEnabled", "kind": 1024, "kindString": "Property", @@ -10474,7 +10813,7 @@ } }, { - "id": 354, + "id": 353, "name": "lastFetchStatus", "kind": 1024, "kindString": "Property", @@ -10514,7 +10853,7 @@ } }, { - "id": 352, + "id": 351, "name": "lastFetchTime", "kind": 1024, "kindString": "Property", @@ -10542,9 +10881,9 @@ "title": "Properties", "kind": 1024, "children": [ + 352, 353, - 354, - 352 + 351 ] } ], @@ -10557,7 +10896,7 @@ ] }, { - "id": 349, + "id": 348, "name": "ConfigSettingsWrite", "kind": 256, "kindString": "Interface", @@ -10570,7 +10909,7 @@ }, "children": [ { - "id": 350, + "id": 349, "name": "isDeveloperModeEnabled", "kind": 1024, "kindString": "Property", @@ -10598,7 +10937,7 @@ "title": "Properties", "kind": 1024, "children": [ - 350 + 349 ] } ], @@ -10611,7 +10950,7 @@ ] }, { - "id": 343, + "id": 342, "name": "ConfigValue", "kind": 256, "kindString": "Interface", @@ -10623,7 +10962,7 @@ }, "children": [ { - "id": 344, + "id": 343, "name": "source", "kind": 1024, "kindString": "Property", @@ -10660,7 +10999,7 @@ } }, { - "id": 345, + "id": 344, "name": "value", "kind": 1024, "kindString": "Property", @@ -10706,8 +11045,8 @@ "title": "Properties", "kind": 1024, "children": [ - 344, - 345 + 343, + 344 ] } ], @@ -10720,7 +11059,7 @@ ] }, { - "id": 346, + "id": 345, "name": "ConfigValues", "kind": 256, "kindString": "Interface", @@ -10733,7 +11072,7 @@ }, "indexSignature": [ { - "id": 347, + "id": 346, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -10744,7 +11083,7 @@ }, "parameters": [ { - "id": 348, + "id": 347, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -10758,7 +11097,7 @@ "type": { "type": "reference", "name": "ConfigValue", - "id": 343 + "id": 342 } } ], @@ -10771,7 +11110,7 @@ ] }, { - "id": 342, + "id": 341, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -10792,19 +11131,19 @@ "title": "Classes", "kind": 128, "children": [ - 358 + 357 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 355, - 351, - 349, - 343, - 346, - 342 + 354, + 350, + 348, + 342, + 345, + 341 ] } ], @@ -10817,7 +11156,7 @@ ] }, { - "id": 395, + "id": 394, "name": "Crashlytics", "kind": 2, "kindString": "Module", @@ -10836,7 +11175,7 @@ }, "children": [ { - "id": 397, + "id": 396, "name": "Module", "kind": 128, "kindString": "Class", @@ -10849,7 +11188,7 @@ }, "children": [ { - "id": 429, + "id": 428, "name": "app", "kind": 1024, "kindString": "Property", @@ -10873,7 +11212,7 @@ } }, { - "id": 398, + "id": 397, "name": "isCrashlyticsCollectionEnabled", "kind": 1024, "kindString": "Property", @@ -10897,7 +11236,7 @@ } }, { - "id": 399, + "id": 398, "name": "crash", "kind": 2048, "kindString": "Method", @@ -10906,7 +11245,7 @@ }, "signatures": [ { - "id": 400, + "id": 399, "name": "crash", "kind": 4096, "kindString": "Call signature", @@ -10930,7 +11269,7 @@ ] }, { - "id": 401, + "id": 400, "name": "log", "kind": 2048, "kindString": "Method", @@ -10939,7 +11278,7 @@ }, "signatures": [ { - "id": 402, + "id": 401, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -10950,7 +11289,7 @@ }, "parameters": [ { - "id": 403, + "id": 402, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -10979,7 +11318,7 @@ ] }, { - "id": 404, + "id": 403, "name": "recordError", "kind": 2048, "kindString": "Method", @@ -10988,7 +11327,7 @@ }, "signatures": [ { - "id": 405, + "id": 404, "name": "recordError", "kind": 4096, "kindString": "Call signature", @@ -10999,7 +11338,7 @@ }, "parameters": [ { - "id": 406, + "id": 405, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -11028,7 +11367,7 @@ ] }, { - "id": 416, + "id": 415, "name": "setAttribute", "kind": 2048, "kindString": "Method", @@ -11037,7 +11376,7 @@ }, "signatures": [ { - "id": 417, + "id": 416, "name": "setAttribute", "kind": 4096, "kindString": "Call signature", @@ -11048,7 +11387,7 @@ }, "parameters": [ { - "id": 418, + "id": 417, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -11062,7 +11401,7 @@ } }, { - "id": 419, + "id": 418, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -11097,7 +11436,7 @@ ] }, { - "id": 420, + "id": 419, "name": "setAttributes", "kind": 2048, "kindString": "Method", @@ -11106,7 +11445,7 @@ }, "signatures": [ { - "id": 421, + "id": 420, "name": "setAttributes", "kind": 4096, "kindString": "Call signature", @@ -11117,7 +11456,7 @@ }, "parameters": [ { - "id": 422, + "id": 421, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -11128,21 +11467,21 @@ "type": { "type": "reflection", "declaration": { - "id": 423, + "id": 422, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { - "id": 424, + "id": 423, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 425, + "id": 424, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -11191,7 +11530,7 @@ ] }, { - "id": 426, + "id": 425, "name": "setCrashlyticsCollectionEnabled", "kind": 2048, "kindString": "Method", @@ -11200,7 +11539,7 @@ }, "signatures": [ { - "id": 427, + "id": 426, "name": "setCrashlyticsCollectionEnabled", "kind": 4096, "kindString": "Call signature", @@ -11211,7 +11550,7 @@ }, "parameters": [ { - "id": 428, + "id": 427, "name": "enabled", "kind": 32768, "kindString": "Parameter", @@ -11246,7 +11585,7 @@ ] }, { - "id": 413, + "id": 412, "name": "setUserEmail", "kind": 2048, "kindString": "Method", @@ -11255,7 +11594,7 @@ }, "signatures": [ { - "id": 414, + "id": 413, "name": "setUserEmail", "kind": 4096, "kindString": "Call signature", @@ -11266,7 +11605,7 @@ }, "parameters": [ { - "id": 415, + "id": 414, "name": "userEmail", "kind": 32768, "kindString": "Parameter", @@ -11301,7 +11640,7 @@ ] }, { - "id": 407, + "id": 406, "name": "setUserId", "kind": 2048, "kindString": "Method", @@ -11310,7 +11649,7 @@ }, "signatures": [ { - "id": 408, + "id": 407, "name": "setUserId", "kind": 4096, "kindString": "Call signature", @@ -11321,7 +11660,7 @@ }, "parameters": [ { - "id": 409, + "id": 408, "name": "userId", "kind": 32768, "kindString": "Parameter", @@ -11356,7 +11695,7 @@ ] }, { - "id": 410, + "id": 409, "name": "setUserName", "kind": 2048, "kindString": "Method", @@ -11365,7 +11704,7 @@ }, "signatures": [ { - "id": 411, + "id": 410, "name": "setUserName", "kind": 4096, "kindString": "Call signature", @@ -11376,7 +11715,7 @@ }, "parameters": [ { - "id": 412, + "id": 411, "name": "userName", "kind": 32768, "kindString": "Parameter", @@ -11416,23 +11755,23 @@ "title": "Properties", "kind": 1024, "children": [ - 429, - 398 + 428, + 397 ] }, { "title": "Methods", "kind": 2048, "children": [ - 399, - 401, - 404, - 416, - 420, - 426, - 413, - 407, - 410 + 398, + 400, + 403, + 415, + 419, + 425, + 412, + 406, + 409 ] } ], @@ -11451,7 +11790,7 @@ ] }, { - "id": 396, + "id": 395, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -11472,14 +11811,14 @@ "title": "Classes", "kind": 128, "children": [ - 397 + 396 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 396 + 395 ] } ], @@ -11492,7 +11831,7 @@ ] }, { - "id": 437, + "id": 436, "name": "Fiam", "kind": 2, "kindString": "Module", @@ -11511,7 +11850,7 @@ }, "children": [ { - "id": 439, + "id": 438, "name": "Module", "kind": 128, "kindString": "Class", @@ -11524,7 +11863,7 @@ }, "children": [ { - "id": 448, + "id": 447, "name": "app", "kind": 1024, "kindString": "Property", @@ -11548,7 +11887,7 @@ } }, { - "id": 444, + "id": 443, "name": "isAutomaticDataCollectionEnabled", "kind": 1024, "kindString": "Property", @@ -11572,7 +11911,7 @@ } }, { - "id": 440, + "id": 439, "name": "isMessagesDisplaySuppressed", "kind": 1024, "kindString": "Property", @@ -11596,7 +11935,7 @@ } }, { - "id": 445, + "id": 444, "name": "setAutomaticDataCollectionEnabled", "kind": 2048, "kindString": "Method", @@ -11605,7 +11944,7 @@ }, "signatures": [ { - "id": 446, + "id": 445, "name": "setAutomaticDataCollectionEnabled", "kind": 4096, "kindString": "Call signature", @@ -11616,7 +11955,7 @@ }, "parameters": [ { - "id": 447, + "id": 446, "name": "enabled", "kind": 32768, "kindString": "Parameter", @@ -11651,7 +11990,7 @@ ] }, { - "id": 441, + "id": 440, "name": "setMessagesDisplaySuppressed", "kind": 2048, "kindString": "Method", @@ -11660,7 +11999,7 @@ }, "signatures": [ { - "id": 442, + "id": 441, "name": "setMessagesDisplaySuppressed", "kind": 4096, "kindString": "Call signature", @@ -11671,7 +12010,7 @@ }, "parameters": [ { - "id": 443, + "id": 442, "name": "enabled", "kind": 32768, "kindString": "Parameter", @@ -11711,17 +12050,17 @@ "title": "Properties", "kind": 1024, "children": [ - 448, - 444, - 440 + 447, + 443, + 439 ] }, { "title": "Methods", "kind": 2048, "children": [ - 445, - 441 + 444, + 440 ] } ], @@ -11740,7 +12079,7 @@ ] }, { - "id": 438, + "id": 437, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -11761,14 +12100,14 @@ "title": "Classes", "kind": 128, "children": [ - 439 + 438 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 438 + 437 ] } ], @@ -11781,7 +12120,7 @@ ] }, { - "id": 456, + "id": 455, "name": "Firestore", "kind": 2, "kindString": "Module", @@ -11800,7 +12139,7 @@ }, "children": [ { - "id": 458, + "id": 457, "name": "Module", "kind": 128, "kindString": "Class", @@ -11813,7 +12152,7 @@ }, "children": [ { - "id": 459, + "id": 458, "name": "app", "kind": 1024, "kindString": "Property", @@ -11842,7 +12181,7 @@ "title": "Properties", "kind": 1024, "children": [ - 459 + 458 ] } ], @@ -11861,7 +12200,7 @@ ] }, { - "id": 457, + "id": 456, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -11882,14 +12221,14 @@ "title": "Classes", "kind": 128, "children": [ - 458 + 457 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 457 + 456 ] } ], @@ -11902,7 +12241,7 @@ ] }, { - "id": 467, + "id": 466, "name": "Functions", "kind": 2, "kindString": "Module", @@ -11921,7 +12260,7 @@ }, "children": [ { - "id": 500, + "id": 499, "name": "Module", "kind": 128, "kindString": "Class", @@ -11934,7 +12273,7 @@ }, "children": [ { - "id": 507, + "id": 506, "name": "app", "kind": 1024, "kindString": "Property", @@ -11958,7 +12297,7 @@ } }, { - "id": 501, + "id": 500, "name": "httpsCallable", "kind": 2048, "kindString": "Method", @@ -11967,7 +12306,7 @@ }, "signatures": [ { - "id": 502, + "id": 501, "name": "httpsCallable", "kind": 4096, "kindString": "Call signature", @@ -11979,7 +12318,7 @@ }, "parameters": [ { - "id": 503, + "id": 502, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -11996,7 +12335,7 @@ "type": { "type": "reference", "name": "HttpsCallable", - "id": 470 + "id": 469 } } ], @@ -12009,7 +12348,7 @@ ] }, { - "id": 504, + "id": 503, "name": "useFunctionsEmulator", "kind": 2048, "kindString": "Method", @@ -12018,7 +12357,7 @@ }, "signatures": [ { - "id": 505, + "id": 504, "name": "useFunctionsEmulator", "kind": 4096, "kindString": "Call signature", @@ -12029,7 +12368,7 @@ }, "parameters": [ { - "id": 506, + "id": 505, "name": "origin", "kind": 32768, "kindString": "Parameter", @@ -12063,15 +12402,15 @@ "title": "Properties", "kind": 1024, "children": [ - 507 + 506 ] }, { "title": "Methods", "kind": 2048, "children": [ - 501, - 504 + 500, + 503 ] } ], @@ -12090,7 +12429,7 @@ ] }, { - "id": 470, + "id": 469, "name": "HttpsCallable", "kind": 256, "kindString": "Interface", @@ -12103,7 +12442,7 @@ }, "signatures": [ { - "id": 471, + "id": 470, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -12114,7 +12453,7 @@ }, "parameters": [ { - "id": 472, + "id": 471, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -12134,7 +12473,7 @@ { "type": "reference", "name": "HttpsCallableResult", - "id": 468 + "id": 467 } ] } @@ -12149,7 +12488,7 @@ ] }, { - "id": 468, + "id": 467, "name": "HttpsCallableResult", "kind": 256, "kindString": "Interface", @@ -12161,7 +12500,7 @@ }, "children": [ { - "id": 469, + "id": 468, "name": "data", "kind": 1024, "kindString": "Property", @@ -12186,7 +12525,7 @@ "title": "Properties", "kind": 1024, "children": [ - 469 + 468 ] } ], @@ -12199,7 +12538,7 @@ ] }, { - "id": 473, + "id": 472, "name": "HttpsError", "kind": 256, "kindString": "Interface", @@ -12212,7 +12551,7 @@ }, "children": [ { - "id": 479, + "id": 478, "name": "Error", "kind": 1024, "kindString": "Property", @@ -12221,7 +12560,7 @@ }, "sources": [ { - "fileName": "/Volumes/Projects/Projects/@react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", + "fileName": "/Users/elliot/Documents/react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 974, "character": 19 } @@ -12232,7 +12571,7 @@ } }, { - "id": 474, + "id": 473, "name": "code", "kind": 1024, "kindString": "Property", @@ -12253,11 +12592,11 @@ "type": { "type": "reference", "name": "FunctionsErrorCode", - "id": 508 + "id": 507 } }, { - "id": 475, + "id": 474, "name": "details", "kind": 1024, "kindString": "Property", @@ -12282,7 +12621,7 @@ } }, { - "id": 477, + "id": 476, "name": "message", "kind": 1024, "kindString": "Property", @@ -12291,7 +12630,7 @@ }, "sources": [ { - "fileName": "/Volumes/Projects/Projects/@react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", + "fileName": "/Users/elliot/Documents/react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 964, "character": 11 } @@ -12306,7 +12645,7 @@ } }, { - "id": 476, + "id": 475, "name": "name", "kind": 1024, "kindString": "Property", @@ -12315,7 +12654,7 @@ }, "sources": [ { - "fileName": "/Volumes/Projects/Projects/@react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", + "fileName": "/Users/elliot/Documents/react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 963, "character": 8 } @@ -12330,7 +12669,7 @@ } }, { - "id": 478, + "id": 477, "name": "stack", "kind": 1024, "kindString": "Property", @@ -12340,7 +12679,7 @@ }, "sources": [ { - "fileName": "/Volumes/Projects/Projects/@react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", + "fileName": "/Users/elliot/Documents/react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 965, "character": 9 } @@ -12373,12 +12712,12 @@ "title": "Properties", "kind": 1024, "children": [ - 479, + 478, + 473, 474, - 475, - 477, 476, - 478 + 475, + 477 ] } ], @@ -12397,7 +12736,7 @@ ] }, { - "id": 480, + "id": 479, "name": "HttpsErrorCode", "kind": 256, "kindString": "Interface", @@ -12410,7 +12749,7 @@ }, "children": [ { - "id": 492, + "id": 491, "name": "ABORTED", "kind": 1024, "kindString": "Property", @@ -12430,7 +12769,7 @@ } }, { - "id": 487, + "id": 486, "name": "ALREADY_EXISTS", "kind": 1024, "kindString": "Property", @@ -12450,7 +12789,7 @@ } }, { - "id": 482, + "id": 481, "name": "CANCELLED", "kind": 1024, "kindString": "Property", @@ -12470,7 +12809,7 @@ } }, { - "id": 497, + "id": 496, "name": "DATA_LOSS", "kind": 1024, "kindString": "Property", @@ -12490,7 +12829,7 @@ } }, { - "id": 485, + "id": 484, "name": "DEADLINE_EXCEEDED", "kind": 1024, "kindString": "Property", @@ -12510,7 +12849,7 @@ } }, { - "id": 491, + "id": 490, "name": "FAILED_PRECONDITION", "kind": 1024, "kindString": "Property", @@ -12530,7 +12869,7 @@ } }, { - "id": 495, + "id": 494, "name": "INTERNAL", "kind": 1024, "kindString": "Property", @@ -12550,7 +12889,7 @@ } }, { - "id": 484, + "id": 483, "name": "INVALID_ARGUMENT", "kind": 1024, "kindString": "Property", @@ -12570,7 +12909,7 @@ } }, { - "id": 486, + "id": 485, "name": "NOT_FOUND", "kind": 1024, "kindString": "Property", @@ -12590,7 +12929,7 @@ } }, { - "id": 481, + "id": 480, "name": "OK", "kind": 1024, "kindString": "Property", @@ -12610,7 +12949,7 @@ } }, { - "id": 493, + "id": 492, "name": "OUT_OF_RANGE", "kind": 1024, "kindString": "Property", @@ -12630,7 +12969,7 @@ } }, { - "id": 488, + "id": 487, "name": "PERMISSION_DENIED", "kind": 1024, "kindString": "Property", @@ -12650,7 +12989,7 @@ } }, { - "id": 490, + "id": 489, "name": "RESOURCE_EXHAUSTED", "kind": 1024, "kindString": "Property", @@ -12670,7 +13009,7 @@ } }, { - "id": 489, + "id": 488, "name": "UNAUTHENTICATED", "kind": 1024, "kindString": "Property", @@ -12690,7 +13029,7 @@ } }, { - "id": 496, + "id": 495, "name": "UNAVAILABLE", "kind": 1024, "kindString": "Property", @@ -12710,7 +13049,7 @@ } }, { - "id": 494, + "id": 493, "name": "UNIMPLEMENTED", "kind": 1024, "kindString": "Property", @@ -12730,7 +13069,7 @@ } }, { - "id": 483, + "id": 482, "name": "UNKNOWN", "kind": 1024, "kindString": "Property", @@ -12755,23 +13094,23 @@ "title": "Properties", "kind": 1024, "children": [ - 492, - 487, - 482, - 497, - 485, 491, - 495, - 484, 486, 481, - 493, - 488, - 490, - 489, 496, + 484, + 490, 494, - 483 + 483, + 485, + 480, + 492, + 487, + 489, + 488, + 495, + 493, + 482 ] } ], @@ -12784,7 +13123,7 @@ ] }, { - "id": 498, + "id": 497, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -12796,7 +13135,7 @@ }, "children": [ { - "id": 499, + "id": 498, "name": "HttpsErrorCode", "kind": 1024, "kindString": "Property", @@ -12817,7 +13156,7 @@ "type": { "type": "reference", "name": "HttpsErrorCode", - "id": 480 + "id": 479 } } ], @@ -12826,7 +13165,7 @@ "title": "Properties", "kind": 1024, "children": [ - 499 + 498 ] } ], @@ -12839,7 +13178,7 @@ ] }, { - "id": 508, + "id": 507, "name": "FunctionsErrorCode", "kind": 4194304, "kindString": "Type alias", @@ -12942,25 +13281,25 @@ "title": "Classes", "kind": 128, "children": [ - 500 + 499 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 470, - 468, - 473, - 480, - 498 + 469, + 467, + 472, + 479, + 497 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ - 508 + 507 ] } ], @@ -12973,7 +13312,7 @@ ] }, { - "id": 517, + "id": 516, "name": "Iid", "kind": 2, "kindString": "Module", @@ -12992,7 +13331,7 @@ }, "children": [ { - "id": 519, + "id": 518, "name": "Module", "kind": 128, "kindString": "Class", @@ -13005,7 +13344,7 @@ }, "children": [ { - "id": 532, + "id": 531, "name": "app", "kind": 1024, "kindString": "Property", @@ -13029,7 +13368,7 @@ } }, { - "id": 522, + "id": 521, "name": "delete", "kind": 2048, "kindString": "Method", @@ -13038,7 +13377,7 @@ }, "signatures": [ { - "id": 523, + "id": 522, "name": "delete", "kind": 4096, "kindString": "Call signature", @@ -13068,7 +13407,7 @@ ] }, { - "id": 528, + "id": 527, "name": "deleteToken", "kind": 2048, "kindString": "Method", @@ -13077,7 +13416,7 @@ }, "signatures": [ { - "id": 529, + "id": 528, "name": "deleteToken", "kind": 4096, "kindString": "Call signature", @@ -13088,7 +13427,7 @@ }, "parameters": [ { - "id": 530, + "id": 529, "name": "authorizedEntity", "kind": 32768, "kindString": "Parameter", @@ -13113,7 +13452,7 @@ } }, { - "id": 531, + "id": 530, "name": "scope", "kind": 32768, "kindString": "Parameter", @@ -13159,7 +13498,7 @@ ] }, { - "id": 520, + "id": 519, "name": "get", "kind": 2048, "kindString": "Method", @@ -13168,7 +13507,7 @@ }, "signatures": [ { - "id": 521, + "id": 520, "name": "get", "kind": 4096, "kindString": "Call signature", @@ -13198,7 +13537,7 @@ ] }, { - "id": 524, + "id": 523, "name": "getToken", "kind": 2048, "kindString": "Method", @@ -13207,7 +13546,7 @@ }, "signatures": [ { - "id": 525, + "id": 524, "name": "getToken", "kind": 4096, "kindString": "Call signature", @@ -13218,7 +13557,7 @@ }, "parameters": [ { - "id": 526, + "id": 525, "name": "authorizedEntity", "kind": 32768, "kindString": "Parameter", @@ -13243,7 +13582,7 @@ } }, { - "id": 527, + "id": 526, "name": "scope", "kind": 32768, "kindString": "Parameter", @@ -13294,17 +13633,17 @@ "title": "Properties", "kind": 1024, "children": [ - 532 + 531 ] }, { "title": "Methods", "kind": 2048, "children": [ - 522, - 528, - 520, - 524 + 521, + 527, + 519, + 523 ] } ], @@ -13323,7 +13662,7 @@ ] }, { - "id": 518, + "id": 517, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -13344,14 +13683,14 @@ "title": "Classes", "kind": 128, "children": [ - 519 + 518 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 518 + 517 ] } ], @@ -13364,7 +13703,7 @@ ] }, { - "id": 540, + "id": 539, "name": "Invites", "kind": 2, "kindString": "Module", @@ -13383,7 +13722,7 @@ }, "children": [ { - "id": 546, + "id": 545, "name": "AndroidInviteBuilder", "kind": 128, "kindString": "Class", @@ -13395,7 +13734,7 @@ }, "children": [ { - "id": 547, + "id": 546, "name": "setAdditionalReferralParameters", "kind": 2048, "kindString": "Method", @@ -13404,7 +13743,7 @@ }, "signatures": [ { - "id": 548, + "id": 547, "name": "setAdditionalReferralParameters", "kind": 4096, "kindString": "Call signature", @@ -13415,7 +13754,7 @@ }, "parameters": [ { - "id": 549, + "id": 548, "name": "additionalReferralParameters", "kind": 32768, "kindString": "Parameter", @@ -13426,14 +13765,14 @@ "type": { "type": "reference", "name": "AdditionalReferralParameters", - "id": 543 + "id": 542 } } ], "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13446,7 +13785,7 @@ ] }, { - "id": 550, + "id": 549, "name": "setEmailHtmlContent", "kind": 2048, "kindString": "Method", @@ -13455,7 +13794,7 @@ }, "signatures": [ { - "id": 551, + "id": 550, "name": "setEmailHtmlContent", "kind": 4096, "kindString": "Call signature", @@ -13472,7 +13811,7 @@ }, "parameters": [ { - "id": 552, + "id": 551, "name": "emailHtmlContent", "kind": 32768, "kindString": "Parameter", @@ -13489,7 +13828,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13502,7 +13841,7 @@ ] }, { - "id": 553, + "id": 552, "name": "setEmailSubject", "kind": 2048, "kindString": "Method", @@ -13511,7 +13850,7 @@ }, "signatures": [ { - "id": 554, + "id": 553, "name": "setEmailSubject", "kind": 4096, "kindString": "Call signature", @@ -13522,7 +13861,7 @@ }, "parameters": [ { - "id": 555, + "id": 554, "name": "emailSubject", "kind": 32768, "kindString": "Parameter", @@ -13539,7 +13878,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13552,7 +13891,7 @@ ] }, { - "id": 556, + "id": 555, "name": "setGoogleAnalyticsTrackingId", "kind": 2048, "kindString": "Method", @@ -13561,7 +13900,7 @@ }, "signatures": [ { - "id": 557, + "id": 556, "name": "setGoogleAnalyticsTrackingId", "kind": 4096, "kindString": "Call signature", @@ -13572,7 +13911,7 @@ }, "parameters": [ { - "id": 558, + "id": 557, "name": "gaTrackingId", "kind": 32768, "kindString": "Parameter", @@ -13589,7 +13928,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13607,10 +13946,10 @@ "title": "Methods", "kind": 2048, "children": [ - 547, - 550, - 553, - 556 + 546, + 549, + 552, + 555 ] } ], @@ -13623,7 +13962,7 @@ ] }, { - "id": 559, + "id": 558, "name": "InviteBuilder", "kind": 128, "kindString": "Class", @@ -13635,7 +13974,7 @@ }, "children": [ { - "id": 560, + "id": 559, "name": "android", "kind": 1024, "kindString": "Property", @@ -13656,11 +13995,11 @@ "type": { "type": "reference", "name": "AndroidInviteBuilder", - "id": 546 + "id": 545 } }, { - "id": 561, + "id": 560, "name": "setAndroidClientId", "kind": 2048, "kindString": "Method", @@ -13669,7 +14008,7 @@ }, "signatures": [ { - "id": 562, + "id": 561, "name": "setAndroidClientId", "kind": 4096, "kindString": "Call signature", @@ -13680,7 +14019,7 @@ }, "parameters": [ { - "id": 563, + "id": 562, "name": "androidClientId", "kind": 32768, "kindString": "Parameter", @@ -13697,7 +14036,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13710,7 +14049,7 @@ ] }, { - "id": 564, + "id": 563, "name": "setAndroidMinimumVersionCode", "kind": 2048, "kindString": "Method", @@ -13719,7 +14058,7 @@ }, "signatures": [ { - "id": 565, + "id": 564, "name": "setAndroidMinimumVersionCode", "kind": 4096, "kindString": "Call signature", @@ -13730,7 +14069,7 @@ }, "parameters": [ { - "id": 566, + "id": 565, "name": "androidMinimumVersionCode", "kind": 32768, "kindString": "Parameter", @@ -13747,7 +14086,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13760,7 +14099,7 @@ ] }, { - "id": 567, + "id": 566, "name": "setCallToActionText", "kind": 2048, "kindString": "Method", @@ -13769,7 +14108,7 @@ }, "signatures": [ { - "id": 568, + "id": 567, "name": "setCallToActionText", "kind": 4096, "kindString": "Call signature", @@ -13785,7 +14124,7 @@ }, "parameters": [ { - "id": 569, + "id": 568, "name": "callToActionText", "kind": 32768, "kindString": "Parameter", @@ -13802,7 +14141,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13815,7 +14154,7 @@ ] }, { - "id": 570, + "id": 569, "name": "setCustomImage", "kind": 2048, "kindString": "Method", @@ -13824,7 +14163,7 @@ }, "signatures": [ { - "id": 571, + "id": 570, "name": "setCustomImage", "kind": 4096, "kindString": "Call signature", @@ -13835,7 +14174,7 @@ }, "parameters": [ { - "id": 572, + "id": 571, "name": "customImage", "kind": 32768, "kindString": "Parameter", @@ -13852,7 +14191,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13865,7 +14204,7 @@ ] }, { - "id": 573, + "id": 572, "name": "setDeepLink", "kind": 2048, "kindString": "Method", @@ -13874,7 +14213,7 @@ }, "signatures": [ { - "id": 574, + "id": 573, "name": "setDeepLink", "kind": 4096, "kindString": "Call signature", @@ -13885,7 +14224,7 @@ }, "parameters": [ { - "id": 575, + "id": 574, "name": "deepLink", "kind": 32768, "kindString": "Parameter", @@ -13902,7 +14241,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13915,7 +14254,7 @@ ] }, { - "id": 576, + "id": 575, "name": "setIOSClientId", "kind": 2048, "kindString": "Method", @@ -13924,7 +14263,7 @@ }, "signatures": [ { - "id": 577, + "id": 576, "name": "setIOSClientId", "kind": 4096, "kindString": "Call signature", @@ -13935,7 +14274,7 @@ }, "parameters": [ { - "id": 578, + "id": 577, "name": "iOSClientId", "kind": 32768, "kindString": "Parameter", @@ -13952,7 +14291,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -13970,19 +14309,19 @@ "title": "Properties", "kind": 1024, "children": [ - 560 + 559 ] }, { "title": "Methods", "kind": 2048, "children": [ - 561, - 564, - 567, - 570, - 573, - 576 + 560, + 563, + 566, + 569, + 572, + 575 ] } ], @@ -13995,7 +14334,7 @@ ] }, { - "id": 582, + "id": 581, "name": "Module", "kind": 128, "kindString": "Class", @@ -14008,7 +14347,7 @@ }, "children": [ { - "id": 595, + "id": 594, "name": "app", "kind": 1024, "kindString": "Property", @@ -14032,7 +14371,7 @@ } }, { - "id": 583, + "id": 582, "name": "createInvitation", "kind": 2048, "kindString": "Method", @@ -14041,7 +14380,7 @@ }, "signatures": [ { - "id": 584, + "id": 583, "name": "createInvitation", "kind": 4096, "kindString": "Call signature", @@ -14052,7 +14391,7 @@ }, "parameters": [ { - "id": 585, + "id": 584, "name": "title", "kind": 32768, "kindString": "Parameter", @@ -14066,7 +14405,7 @@ } }, { - "id": 586, + "id": 585, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -14083,7 +14422,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -14096,7 +14435,7 @@ ] }, { - "id": 590, + "id": 589, "name": "getInitialInvitation", "kind": 2048, "kindString": "Method", @@ -14105,7 +14444,7 @@ }, "signatures": [ { - "id": 591, + "id": 590, "name": "getInitialInvitation", "kind": 4096, "kindString": "Call signature", @@ -14121,7 +14460,7 @@ { "type": "reference", "name": "NativeInvite", - "id": 579 + "id": 578 } ] } @@ -14136,7 +14475,7 @@ ] }, { - "id": 587, + "id": 586, "name": "onInvitation", "kind": 2048, "kindString": "Method", @@ -14145,7 +14484,7 @@ }, "signatures": [ { - "id": 588, + "id": 587, "name": "onInvitation", "kind": 4096, "kindString": "Call signature", @@ -14156,7 +14495,7 @@ }, "parameters": [ { - "id": 589, + "id": 588, "name": "listener", "kind": 32768, "kindString": "Parameter", @@ -14167,7 +14506,7 @@ "type": { "type": "reference", "name": "InviteListener", - "id": 596 + "id": 595 } } ], @@ -14186,7 +14525,7 @@ ] }, { - "id": 592, + "id": 591, "name": "sendInvitation", "kind": 2048, "kindString": "Method", @@ -14195,7 +14534,7 @@ }, "signatures": [ { - "id": 593, + "id": 592, "name": "sendInvitation", "kind": 4096, "kindString": "Call signature", @@ -14206,7 +14545,7 @@ }, "parameters": [ { - "id": 594, + "id": 593, "name": "invite", "kind": 32768, "kindString": "Parameter", @@ -14217,7 +14556,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -14250,17 +14589,17 @@ "title": "Properties", "kind": 1024, "children": [ - 595 + 594 ] }, { "title": "Methods", "kind": 2048, "children": [ - 583, - 590, - 587, - 592 + 582, + 589, + 586, + 591 ] } ], @@ -14279,7 +14618,7 @@ ] }, { - "id": 543, + "id": 542, "name": "AdditionalReferralParameters", "kind": 256, "kindString": "Interface", @@ -14292,7 +14631,7 @@ }, "indexSignature": [ { - "id": 544, + "id": 543, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -14303,7 +14642,7 @@ }, "parameters": [ { - "id": 545, + "id": 544, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -14329,7 +14668,7 @@ ] }, { - "id": 579, + "id": 578, "name": "NativeInvite", "kind": 256, "kindString": "Interface", @@ -14342,7 +14681,7 @@ }, "children": [ { - "id": 580, + "id": 579, "name": "deepLink", "kind": 1024, "kindString": "Property", @@ -14365,7 +14704,7 @@ } }, { - "id": 581, + "id": 580, "name": "invitationId", "kind": 1024, "kindString": "Property", @@ -14393,8 +14732,8 @@ "title": "Properties", "kind": 1024, "children": [ - 580, - 581 + 579, + 580 ] } ], @@ -14407,7 +14746,7 @@ ] }, { - "id": 541, + "id": 540, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -14419,7 +14758,7 @@ }, "children": [ { - "id": 542, + "id": 541, "name": "Invitation", "kind": 1024, "kindString": "Property", @@ -14439,7 +14778,7 @@ "type": { "type": "reference", "name": "InviteBuilder", - "id": 559 + "id": 558 } } ], @@ -14448,7 +14787,7 @@ "title": "Properties", "kind": 1024, "children": [ - 542 + 541 ] } ], @@ -14461,7 +14800,7 @@ ] }, { - "id": 596, + "id": 595, "name": "InviteListener", "kind": 4194304, "kindString": "Type alias", @@ -14482,21 +14821,21 @@ "type": { "type": "reflection", "declaration": { - "id": 597, + "id": 596, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 598, + "id": 597, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 599, + "id": 598, "name": "nativeInvite", "kind": 32768, "kindString": "Parameter", @@ -14504,7 +14843,7 @@ "type": { "type": "reference", "name": "NativeInvite", - "id": 579 + "id": 578 } } ], @@ -14530,25 +14869,25 @@ "title": "Classes", "kind": 128, "children": [ - 546, - 559, - 582 + 545, + 558, + 581 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 543, - 579, - 541 + 542, + 578, + 540 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ - 596 + 595 ] } ], @@ -14561,7 +14900,7 @@ ] }, { - "id": 607, + "id": 606, "name": "Mlkit", "kind": 2, "kindString": "Module", @@ -14580,7 +14919,7 @@ }, "children": [ { - "id": 609, + "id": 608, "name": "Module", "kind": 128, "kindString": "Class", @@ -14593,7 +14932,7 @@ }, "children": [ { - "id": 610, + "id": 609, "name": "app", "kind": 1024, "kindString": "Property", @@ -14622,7 +14961,7 @@ "title": "Properties", "kind": 1024, "children": [ - 610 + 609 ] } ], @@ -14641,7 +14980,7 @@ ] }, { - "id": 608, + "id": 607, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -14662,14 +15001,14 @@ "title": "Classes", "kind": 128, "children": [ - 609 + 608 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 608 + 607 ] } ], @@ -14682,7 +15021,7 @@ ] }, { - "id": 618, + "id": 617, "name": "Perf", "kind": 2, "kindString": "Module", @@ -14701,7 +15040,7 @@ }, "children": [ { - "id": 650, + "id": 649, "name": "HttpMetric", "kind": 128, "kindString": "Class", @@ -14713,7 +15052,7 @@ }, "children": [ { - "id": 651, + "id": 650, "name": "getAttribute", "kind": 2048, "kindString": "Method", @@ -14722,7 +15061,7 @@ }, "signatures": [ { - "id": 652, + "id": 651, "name": "getAttribute", "kind": 4096, "kindString": "Call signature", @@ -14733,7 +15072,7 @@ }, "parameters": [ { - "id": 653, + "id": 652, "name": "attribute", "kind": 32768, "kindString": "Parameter", @@ -14771,7 +15110,7 @@ ] }, { - "id": 654, + "id": 653, "name": "getAttributes", "kind": 2048, "kindString": "Method", @@ -14780,7 +15119,7 @@ }, "signatures": [ { - "id": 655, + "id": 654, "name": "getAttributes", "kind": 4096, "kindString": "Call signature", @@ -14792,21 +15131,21 @@ "type": { "type": "reflection", "declaration": { - "id": 656, + "id": 655, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { - "id": 657, + "id": 656, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 658, + "id": 657, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -14843,7 +15182,7 @@ ] }, { - "id": 659, + "id": 658, "name": "putAttribute", "kind": 2048, "kindString": "Method", @@ -14852,7 +15191,7 @@ }, "signatures": [ { - "id": 660, + "id": 659, "name": "putAttribute", "kind": 4096, "kindString": "Call signature", @@ -14863,7 +15202,7 @@ }, "parameters": [ { - "id": 661, + "id": 660, "name": "attribute", "kind": 32768, "kindString": "Parameter", @@ -14877,7 +15216,7 @@ } }, { - "id": 662, + "id": 661, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -14906,7 +15245,7 @@ ] }, { - "id": 663, + "id": 662, "name": "removeAttribute", "kind": 2048, "kindString": "Method", @@ -14915,7 +15254,7 @@ }, "signatures": [ { - "id": 664, + "id": 663, "name": "removeAttribute", "kind": 4096, "kindString": "Call signature", @@ -14926,7 +15265,7 @@ }, "parameters": [ { - "id": 665, + "id": 664, "name": "attribute", "kind": 32768, "kindString": "Parameter", @@ -14955,7 +15294,7 @@ ] }, { - "id": 666, + "id": 665, "name": "setHttpResponseCode", "kind": 2048, "kindString": "Method", @@ -14964,7 +15303,7 @@ }, "signatures": [ { - "id": 667, + "id": 666, "name": "setHttpResponseCode", "kind": 4096, "kindString": "Call signature", @@ -14981,7 +15320,7 @@ }, "parameters": [ { - "id": 668, + "id": 667, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -15019,7 +15358,7 @@ ] }, { - "id": 669, + "id": 668, "name": "setRequestPayloadSize", "kind": 2048, "kindString": "Method", @@ -15028,7 +15367,7 @@ }, "signatures": [ { - "id": 670, + "id": 669, "name": "setRequestPayloadSize", "kind": 4096, "kindString": "Call signature", @@ -15039,7 +15378,7 @@ }, "parameters": [ { - "id": 671, + "id": 670, "name": "bytes", "kind": 32768, "kindString": "Parameter", @@ -15077,7 +15416,7 @@ ] }, { - "id": 675, + "id": 674, "name": "setResponseContentType", "kind": 2048, "kindString": "Method", @@ -15086,7 +15425,7 @@ }, "signatures": [ { - "id": 676, + "id": 675, "name": "setResponseContentType", "kind": 4096, "kindString": "Call signature", @@ -15097,7 +15436,7 @@ }, "parameters": [ { - "id": 677, + "id": 676, "name": "contentType", "kind": 32768, "kindString": "Parameter", @@ -15135,7 +15474,7 @@ ] }, { - "id": 672, + "id": 671, "name": "setResponsePayloadSize", "kind": 2048, "kindString": "Method", @@ -15144,7 +15483,7 @@ }, "signatures": [ { - "id": 673, + "id": 672, "name": "setResponsePayloadSize", "kind": 4096, "kindString": "Call signature", @@ -15155,7 +15494,7 @@ }, "parameters": [ { - "id": 674, + "id": 673, "name": "bytes", "kind": 32768, "kindString": "Parameter", @@ -15193,7 +15532,7 @@ ] }, { - "id": 678, + "id": 677, "name": "start", "kind": 2048, "kindString": "Method", @@ -15202,7 +15541,7 @@ }, "signatures": [ { - "id": 679, + "id": 678, "name": "start", "kind": 4096, "kindString": "Call signature", @@ -15232,7 +15571,7 @@ ] }, { - "id": 680, + "id": 679, "name": "stop", "kind": 2048, "kindString": "Method", @@ -15241,7 +15580,7 @@ }, "signatures": [ { - "id": 681, + "id": 680, "name": "stop", "kind": 4096, "kindString": "Call signature", @@ -15276,16 +15615,16 @@ "title": "Methods", "kind": 2048, "children": [ - 651, - 654, - 659, - 663, - 666, - 669, - 675, - 672, - 678, - 680 + 650, + 653, + 658, + 662, + 665, + 668, + 674, + 671, + 677, + 679 ] } ], @@ -15298,7 +15637,7 @@ ] }, { - "id": 683, + "id": 682, "name": "Module", "kind": 128, "kindString": "Class", @@ -15311,7 +15650,7 @@ }, "children": [ { - "id": 698, + "id": 697, "name": "app", "kind": 1024, "kindString": "Property", @@ -15335,7 +15674,7 @@ } }, { - "id": 684, + "id": 683, "name": "isPerformanceCollectionEnabled", "kind": 1024, "kindString": "Property", @@ -15359,7 +15698,7 @@ } }, { - "id": 694, + "id": 693, "name": "newHttpMetric", "kind": 2048, "kindString": "Method", @@ -15368,7 +15707,7 @@ }, "signatures": [ { - "id": 695, + "id": 694, "name": "newHttpMetric", "kind": 4096, "kindString": "Call signature", @@ -15379,7 +15718,7 @@ }, "parameters": [ { - "id": 696, + "id": 695, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -15393,7 +15732,7 @@ } }, { - "id": 697, + "id": 696, "name": "httpMethod", "kind": 32768, "kindString": "Parameter", @@ -15404,14 +15743,14 @@ "type": { "type": "reference", "name": "HttpMethod", - "id": 699 + "id": 698 } } ], "type": { "type": "reference", "name": "HttpMetric", - "id": 650 + "id": 649 } } ], @@ -15424,7 +15763,7 @@ ] }, { - "id": 688, + "id": 687, "name": "newTrace", "kind": 2048, "kindString": "Method", @@ -15433,7 +15772,7 @@ }, "signatures": [ { - "id": 689, + "id": 688, "name": "newTrace", "kind": 4096, "kindString": "Call signature", @@ -15444,7 +15783,7 @@ }, "parameters": [ { - "id": 690, + "id": 689, "name": "identifier", "kind": 32768, "kindString": "Parameter", @@ -15461,7 +15800,7 @@ "type": { "type": "reference", "name": "Trace", - "id": 619 + "id": 618 } } ], @@ -15474,7 +15813,7 @@ ] }, { - "id": 685, + "id": 684, "name": "setPerformanceCollectionEnabled", "kind": 2048, "kindString": "Method", @@ -15483,7 +15822,7 @@ }, "signatures": [ { - "id": 686, + "id": 685, "name": "setPerformanceCollectionEnabled", "kind": 4096, "kindString": "Call signature", @@ -15494,7 +15833,7 @@ }, "parameters": [ { - "id": 687, + "id": 686, "name": "enabled", "kind": 32768, "kindString": "Parameter", @@ -15529,7 +15868,7 @@ ] }, { - "id": 691, + "id": 690, "name": "startTrace", "kind": 2048, "kindString": "Method", @@ -15538,7 +15877,7 @@ }, "signatures": [ { - "id": 692, + "id": 691, "name": "startTrace", "kind": 4096, "kindString": "Call signature", @@ -15549,7 +15888,7 @@ }, "parameters": [ { - "id": 693, + "id": 692, "name": "identifier", "kind": 32768, "kindString": "Parameter", @@ -15570,7 +15909,7 @@ { "type": "reference", "name": "Trace", - "id": 619 + "id": 618 } ] } @@ -15590,18 +15929,18 @@ "title": "Properties", "kind": 1024, "children": [ - 698, - 684 + 697, + 683 ] }, { "title": "Methods", "kind": 2048, "children": [ - 694, - 688, - 685, - 691 + 693, + 687, + 684, + 690 ] } ], @@ -15620,7 +15959,7 @@ ] }, { - "id": 619, + "id": 618, "name": "Trace", "kind": 128, "kindString": "Class", @@ -15632,7 +15971,7 @@ }, "children": [ { - "id": 620, + "id": 619, "name": "getAttribute", "kind": 2048, "kindString": "Method", @@ -15641,7 +15980,7 @@ }, "signatures": [ { - "id": 621, + "id": 620, "name": "getAttribute", "kind": 4096, "kindString": "Call signature", @@ -15652,7 +15991,7 @@ }, "parameters": [ { - "id": 622, + "id": 621, "name": "attribute", "kind": 32768, "kindString": "Parameter", @@ -15690,7 +16029,7 @@ ] }, { - "id": 627, + "id": 626, "name": "getMetric", "kind": 2048, "kindString": "Method", @@ -15699,7 +16038,7 @@ }, "signatures": [ { - "id": 628, + "id": 627, "name": "getMetric", "kind": 4096, "kindString": "Call signature", @@ -15710,7 +16049,7 @@ }, "parameters": [ { - "id": 629, + "id": 628, "name": "metricName", "kind": 32768, "kindString": "Parameter", @@ -15739,7 +16078,7 @@ ] }, { - "id": 630, + "id": 629, "name": "getMetrics", "kind": 2048, "kindString": "Method", @@ -15748,7 +16087,7 @@ }, "signatures": [ { - "id": 631, + "id": 630, "name": "getMetrics", "kind": 4096, "kindString": "Call signature", @@ -15760,21 +16099,21 @@ "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 631, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { - "id": 633, + "id": 632, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 634, + "id": 633, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -15811,7 +16150,7 @@ ] }, { - "id": 639, + "id": 638, "name": "incrementMetric", "kind": 2048, "kindString": "Method", @@ -15820,7 +16159,7 @@ }, "signatures": [ { - "id": 640, + "id": 639, "name": "incrementMetric", "kind": 4096, "kindString": "Call signature", @@ -15831,7 +16170,7 @@ }, "parameters": [ { - "id": 641, + "id": 640, "name": "metricName", "kind": 32768, "kindString": "Parameter", @@ -15845,7 +16184,7 @@ } }, { - "id": 642, + "id": 641, "name": "incrementBy", "kind": 32768, "kindString": "Parameter", @@ -15874,7 +16213,7 @@ ] }, { - "id": 623, + "id": 622, "name": "putAttribute", "kind": 2048, "kindString": "Method", @@ -15883,7 +16222,7 @@ }, "signatures": [ { - "id": 624, + "id": 623, "name": "putAttribute", "kind": 4096, "kindString": "Call signature", @@ -15894,7 +16233,7 @@ }, "parameters": [ { - "id": 625, + "id": 624, "name": "attribute", "kind": 32768, "kindString": "Parameter", @@ -15908,7 +16247,7 @@ } }, { - "id": 626, + "id": 625, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -15937,7 +16276,7 @@ ] }, { - "id": 635, + "id": 634, "name": "putMetric", "kind": 2048, "kindString": "Method", @@ -15946,7 +16285,7 @@ }, "signatures": [ { - "id": 636, + "id": 635, "name": "putMetric", "kind": 4096, "kindString": "Call signature", @@ -15957,7 +16296,7 @@ }, "parameters": [ { - "id": 637, + "id": 636, "name": "metricName", "kind": 32768, "kindString": "Parameter", @@ -15971,7 +16310,7 @@ } }, { - "id": 638, + "id": 637, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -16000,7 +16339,7 @@ ] }, { - "id": 643, + "id": 642, "name": "removeMetric", "kind": 2048, "kindString": "Method", @@ -16009,7 +16348,7 @@ }, "signatures": [ { - "id": 644, + "id": 643, "name": "removeMetric", "kind": 4096, "kindString": "Call signature", @@ -16020,7 +16359,7 @@ }, "parameters": [ { - "id": 645, + "id": 644, "name": "metricName", "kind": 32768, "kindString": "Parameter", @@ -16049,7 +16388,7 @@ ] }, { - "id": 646, + "id": 645, "name": "start", "kind": 2048, "kindString": "Method", @@ -16058,7 +16397,7 @@ }, "signatures": [ { - "id": 647, + "id": 646, "name": "start", "kind": 4096, "kindString": "Call signature", @@ -16088,7 +16427,7 @@ ] }, { - "id": 648, + "id": 647, "name": "stop", "kind": 2048, "kindString": "Method", @@ -16097,7 +16436,7 @@ }, "signatures": [ { - "id": 649, + "id": 648, "name": "stop", "kind": 4096, "kindString": "Call signature", @@ -16132,15 +16471,15 @@ "title": "Methods", "kind": 2048, "children": [ - 620, - 627, - 630, - 639, - 623, - 635, - 643, - 646, - 648 + 619, + 626, + 629, + 638, + 622, + 634, + 642, + 645, + 647 ] } ], @@ -16153,7 +16492,7 @@ ] }, { - "id": 682, + "id": 681, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -16169,7 +16508,7 @@ ] }, { - "id": 699, + "id": 698, "name": "HttpMethod", "kind": 4194304, "kindString": "Type alias", @@ -16235,23 +16574,23 @@ "title": "Classes", "kind": 128, "children": [ - 650, - 683, - 619 + 649, + 682, + 618 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 682 + 681 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ - 699 + 698 ] } ], @@ -16264,7 +16603,7 @@ ] }, { - "id": 707, + "id": 706, "name": "Storage", "kind": 2, "kindString": "Module", @@ -16283,7 +16622,7 @@ }, "children": [ { - "id": 856, + "id": 855, "name": "Module", "kind": 128, "kindString": "Class", @@ -16296,7 +16635,7 @@ }, "children": [ { - "id": 875, + "id": 874, "name": "app", "kind": 1024, "kindString": "Property", @@ -16320,7 +16659,7 @@ } }, { - "id": 861, + "id": 860, "name": "maxDownloadRetryTime", "kind": 1024, "kindString": "Property", @@ -16344,7 +16683,7 @@ } }, { - "id": 865, + "id": 864, "name": "maxOperationRetryTime", "kind": 1024, "kindString": "Property", @@ -16368,7 +16707,7 @@ } }, { - "id": 857, + "id": 856, "name": "maxUploadRetryTime", "kind": 1024, "kindString": "Property", @@ -16392,7 +16731,7 @@ } }, { - "id": 869, + "id": 868, "name": "ref", "kind": 2048, "kindString": "Method", @@ -16401,7 +16740,7 @@ }, "signatures": [ { - "id": 870, + "id": 869, "name": "ref", "kind": 4096, "kindString": "Call signature", @@ -16412,7 +16751,7 @@ }, "parameters": [ { - "id": 871, + "id": 870, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -16440,7 +16779,7 @@ "type": { "type": "reference", "name": "Reference", - "id": 765 + "id": 764 } } ], @@ -16453,7 +16792,7 @@ ] }, { - "id": 872, + "id": 871, "name": "refFromURL", "kind": 2048, "kindString": "Method", @@ -16462,7 +16801,7 @@ }, "signatures": [ { - "id": 873, + "id": 872, "name": "refFromURL", "kind": 4096, "kindString": "Call signature", @@ -16473,7 +16812,7 @@ }, "parameters": [ { - "id": 874, + "id": 873, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -16490,7 +16829,7 @@ "type": { "type": "reference", "name": "Reference", - "id": 765 + "id": 764 } } ], @@ -16503,7 +16842,7 @@ ] }, { - "id": 862, + "id": 861, "name": "setMaxDownloadRetryTime", "kind": 2048, "kindString": "Method", @@ -16512,7 +16851,7 @@ }, "signatures": [ { - "id": 863, + "id": 862, "name": "setMaxDownloadRetryTime", "kind": 4096, "kindString": "Call signature", @@ -16523,7 +16862,7 @@ }, "parameters": [ { - "id": 864, + "id": 863, "name": "time", "kind": 32768, "kindString": "Parameter", @@ -16558,7 +16897,7 @@ ] }, { - "id": 866, + "id": 865, "name": "setMaxOperationRetryTime", "kind": 2048, "kindString": "Method", @@ -16567,7 +16906,7 @@ }, "signatures": [ { - "id": 867, + "id": 866, "name": "setMaxOperationRetryTime", "kind": 4096, "kindString": "Call signature", @@ -16578,7 +16917,7 @@ }, "parameters": [ { - "id": 868, + "id": 867, "name": "time", "kind": 32768, "kindString": "Parameter", @@ -16613,7 +16952,7 @@ ] }, { - "id": 858, + "id": 857, "name": "setMaxUploadRetryTime", "kind": 2048, "kindString": "Method", @@ -16622,7 +16961,7 @@ }, "signatures": [ { - "id": 859, + "id": 858, "name": "setMaxUploadRetryTime", "kind": 4096, "kindString": "Call signature", @@ -16633,7 +16972,7 @@ }, "parameters": [ { - "id": 860, + "id": 859, "name": "time", "kind": 32768, "kindString": "Parameter", @@ -16673,21 +17012,21 @@ "title": "Properties", "kind": 1024, "children": [ - 875, - 861, - 865, - 857 + 874, + 860, + 864, + 856 ] }, { "title": "Methods", "kind": 2048, "children": [ - 869, - 872, - 862, - 866, - 858 + 868, + 871, + 861, + 865, + 857 ] } ], @@ -16706,7 +17045,7 @@ ] }, { - "id": 746, + "id": 745, "name": "FullMetadata", "kind": 256, "kindString": "Interface", @@ -16718,7 +17057,7 @@ }, "children": [ { - "id": 748, + "id": 747, "name": "bucket", "kind": 1024, "kindString": "Property", @@ -16742,7 +17081,7 @@ } }, { - "id": 756, + "id": 755, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -16777,11 +17116,11 @@ "inheritedFrom": { "type": "reference", "name": "SettableMetadata.cacheControl", - "id": 737 + "id": 736 } }, { - "id": 757, + "id": 756, "name": "contentDisposition", "kind": 1024, "kindString": "Property", @@ -16816,11 +17155,11 @@ "inheritedFrom": { "type": "reference", "name": "SettableMetadata.contentDisposition", - "id": 738 + "id": 737 } }, { - "id": 758, + "id": 757, "name": "contentEncoding", "kind": 1024, "kindString": "Property", @@ -16855,11 +17194,11 @@ "inheritedFrom": { "type": "reference", "name": "SettableMetadata.contentEncoding", - "id": 739 + "id": 738 } }, { - "id": 759, + "id": 758, "name": "contentLanguage", "kind": 1024, "kindString": "Property", @@ -16894,11 +17233,11 @@ "inheritedFrom": { "type": "reference", "name": "SettableMetadata.contentLanguage", - "id": 740 + "id": 739 } }, { - "id": 760, + "id": 759, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -16933,11 +17272,11 @@ "inheritedFrom": { "type": "reference", "name": "SettableMetadata.contentType", - "id": 741 + "id": 740 } }, { - "id": 761, + "id": 760, "name": "customMetadata", "kind": 1024, "kindString": "Property", @@ -16962,21 +17301,21 @@ { "type": "reflection", "declaration": { - "id": 762, + "id": 761, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { - "id": 763, + "id": 762, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 764, + "id": 763, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -17011,11 +17350,11 @@ "inheritedFrom": { "type": "reference", "name": "SettableMetadata.customMetadata", - "id": 742 + "id": 741 } }, { - "id": 749, + "id": 748, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -17039,7 +17378,7 @@ } }, { - "id": 750, + "id": 749, "name": "generation", "kind": 1024, "kindString": "Property", @@ -17063,7 +17402,7 @@ } }, { - "id": 747, + "id": 746, "name": "md5Hash", "kind": 1024, "kindString": "Property", @@ -17095,7 +17434,7 @@ } }, { - "id": 751, + "id": 750, "name": "metageneration", "kind": 1024, "kindString": "Property", @@ -17119,7 +17458,7 @@ } }, { - "id": 752, + "id": 751, "name": "name", "kind": 1024, "kindString": "Property", @@ -17143,7 +17482,7 @@ } }, { - "id": 753, + "id": 752, "name": "size", "kind": 1024, "kindString": "Property", @@ -17166,7 +17505,7 @@ } }, { - "id": 754, + "id": 753, "name": "timeCreated", "kind": 1024, "kindString": "Property", @@ -17190,7 +17529,7 @@ } }, { - "id": 755, + "id": 754, "name": "updated", "kind": 1024, "kindString": "Property", @@ -17219,21 +17558,21 @@ "title": "Properties", "kind": 1024, "children": [ - 748, + 747, + 755, 756, 757, 758, 759, 760, - 761, + 748, 749, + 746, 750, - 747, 751, 752, 753, - 754, - 755 + 754 ] } ], @@ -17248,12 +17587,12 @@ { "type": "reference", "name": "SettableMetadata", - "id": 736 + "id": 735 } ] }, { - "id": 721, + "id": 720, "name": "Path", "kind": 256, "kindString": "Interface", @@ -17266,7 +17605,7 @@ }, "children": [ { - "id": 723, + "id": 722, "name": "CachesDirectory", "kind": 1024, "kindString": "Property", @@ -17290,7 +17629,7 @@ } }, { - "id": 724, + "id": 723, "name": "DocumentDirectory", "kind": 1024, "kindString": "Property", @@ -17314,7 +17653,7 @@ } }, { - "id": 727, + "id": 726, "name": "ExternalDirectory", "kind": 1024, "kindString": "Property", @@ -17353,7 +17692,7 @@ } }, { - "id": 728, + "id": 727, "name": "ExternalStorageDirectory", "kind": 1024, "kindString": "Property", @@ -17392,7 +17731,7 @@ } }, { - "id": 726, + "id": 725, "name": "LibraryDirectory", "kind": 1024, "kindString": "Property", @@ -17416,7 +17755,7 @@ } }, { - "id": 722, + "id": 721, "name": "MainBundle", "kind": 1024, "kindString": "Property", @@ -17446,7 +17785,7 @@ } }, { - "id": 730, + "id": 729, "name": "MoviesDirectory", "kind": 1024, "kindString": "Property", @@ -17470,7 +17809,7 @@ } }, { - "id": 729, + "id": 728, "name": "PicturesDirectory", "kind": 1024, "kindString": "Property", @@ -17494,7 +17833,7 @@ } }, { - "id": 725, + "id": 724, "name": "TempDirectory", "kind": 1024, "kindString": "Property", @@ -17523,15 +17862,15 @@ "title": "Properties", "kind": 1024, "children": [ - 723, - 724, - 727, - 728, - 726, 722, - 730, + 723, + 726, + 727, + 725, + 721, 729, - 725 + 728, + 724 ] } ], @@ -17544,7 +17883,7 @@ ] }, { - "id": 765, + "id": 764, "name": "Reference", "kind": 256, "kindString": "Interface", @@ -17557,7 +17896,7 @@ }, "children": [ { - "id": 766, + "id": 765, "name": "bucket", "kind": 1024, "kindString": "Property", @@ -17577,7 +17916,7 @@ } }, { - "id": 768, + "id": 767, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -17597,7 +17936,7 @@ } }, { - "id": 769, + "id": 768, "name": "name", "kind": 1024, "kindString": "Property", @@ -17617,7 +17956,7 @@ } }, { - "id": 767, + "id": 766, "name": "parent", "kind": 1024, "kindString": "Property", @@ -17637,7 +17976,7 @@ { "type": "reference", "name": "Reference", - "id": 765 + "id": 764 }, { "type": "intrinsic", @@ -17647,7 +17986,7 @@ } }, { - "id": 770, + "id": 769, "name": "root", "kind": 1024, "kindString": "Property", @@ -17664,11 +18003,11 @@ "type": { "type": "reference", "name": "Reference", - "id": 765 + "id": 764 } }, { - "id": 771, + "id": 770, "name": "storage", "kind": 1024, "kindString": "Property", @@ -17685,11 +18024,11 @@ "type": { "type": "reference", "name": "Module", - "id": 856 + "id": 855 } }, { - "id": 774, + "id": 773, "name": "child", "kind": 2048, "kindString": "Method", @@ -17698,14 +18037,14 @@ }, "signatures": [ { - "id": 775, + "id": 774, "name": "child", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 776, + "id": 775, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -17719,7 +18058,7 @@ "type": { "type": "reference", "name": "Reference", - "id": 765 + "id": 764 } } ], @@ -17732,7 +18071,7 @@ ] }, { - "id": 777, + "id": 776, "name": "delete", "kind": 2048, "kindString": "Method", @@ -17741,7 +18080,7 @@ }, "signatures": [ { - "id": 778, + "id": 777, "name": "delete", "kind": 4096, "kindString": "Call signature", @@ -17767,7 +18106,7 @@ ] }, { - "id": 779, + "id": 778, "name": "getDownloadURL", "kind": 2048, "kindString": "Method", @@ -17776,7 +18115,7 @@ }, "signatures": [ { - "id": 780, + "id": 779, "name": "getDownloadURL", "kind": 4096, "kindString": "Call signature", @@ -17802,7 +18141,7 @@ ] }, { - "id": 781, + "id": 780, "name": "getMetadata", "kind": 2048, "kindString": "Method", @@ -17811,7 +18150,7 @@ }, "signatures": [ { - "id": 782, + "id": 781, "name": "getMetadata", "kind": 4096, "kindString": "Call signature", @@ -17823,7 +18162,7 @@ { "type": "reference", "name": "FullMetadata", - "id": 746 + "id": 745 } ] } @@ -17838,7 +18177,7 @@ ] }, { - "id": 787, + "id": 786, "name": "put", "kind": 2048, "kindString": "Method", @@ -17847,14 +18186,14 @@ }, "signatures": [ { - "id": 788, + "id": 787, "name": "put", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 789, + "id": 788, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -17878,7 +18217,7 @@ } }, { - "id": 790, + "id": 789, "name": "metadata", "kind": 32768, "kindString": "Parameter", @@ -17888,14 +18227,14 @@ "type": { "type": "reference", "name": "SettableMetadata", - "id": 736 + "id": 735 } } ], "type": { "type": "reference", "name": "Task", - "id": 811 + "id": 810 } } ], @@ -17908,7 +18247,7 @@ ] }, { - "id": 783, + "id": 782, "name": "putFile", "kind": 2048, "kindString": "Method", @@ -17917,14 +18256,14 @@ }, "signatures": [ { - "id": 784, + "id": 783, "name": "putFile", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 785, + "id": 784, "name": "localFilePath", "kind": 32768, "kindString": "Parameter", @@ -17935,7 +18274,7 @@ } }, { - "id": 786, + "id": 785, "name": "metadata", "kind": 32768, "kindString": "Parameter", @@ -17945,14 +18284,14 @@ "type": { "type": "reference", "name": "SettableMetadata", - "id": 736 + "id": 735 } } ], "type": { "type": "reference", "name": "Task", - "id": 811 + "id": 810 } } ], @@ -17965,7 +18304,7 @@ ] }, { - "id": 791, + "id": 790, "name": "putString", "kind": 2048, "kindString": "Method", @@ -17974,14 +18313,14 @@ }, "signatures": [ { - "id": 792, + "id": 791, "name": "putString", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 793, + "id": 792, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -17992,7 +18331,7 @@ } }, { - "id": 794, + "id": 793, "name": "format", "kind": 32768, "kindString": "Parameter", @@ -18002,11 +18341,11 @@ "type": { "type": "reference", "name": "StringFormat", - "id": 708 + "id": 707 } }, { - "id": 795, + "id": 794, "name": "metadata", "kind": 32768, "kindString": "Parameter", @@ -18016,14 +18355,14 @@ "type": { "type": "reference", "name": "SettableMetadata", - "id": 736 + "id": 735 } } ], "type": { "type": "reference", "name": "Task", - "id": 811 + "id": 810 } } ], @@ -18036,7 +18375,7 @@ ] }, { - "id": 772, + "id": 771, "name": "toString", "kind": 2048, "kindString": "Method", @@ -18045,7 +18384,7 @@ }, "signatures": [ { - "id": 773, + "id": 772, "name": "toString", "kind": 4096, "kindString": "Call signature", @@ -18065,7 +18404,7 @@ ] }, { - "id": 796, + "id": 795, "name": "updateMetadata", "kind": 2048, "kindString": "Method", @@ -18074,14 +18413,14 @@ }, "signatures": [ { - "id": 797, + "id": 796, "name": "updateMetadata", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 798, + "id": 797, "name": "metadata", "kind": 32768, "kindString": "Parameter", @@ -18089,7 +18428,7 @@ "type": { "type": "reference", "name": "SettableMetadata", - "id": 736 + "id": 735 } } ], @@ -18100,7 +18439,7 @@ { "type": "reference", "name": "FullMetadata", - "id": 746 + "id": 745 } ] } @@ -18120,27 +18459,27 @@ "title": "Properties", "kind": 1024, "children": [ - 766, - 768, - 769, + 765, 767, - 770, - 771 + 768, + 766, + 769, + 770 ] }, { "title": "Methods", "kind": 2048, "children": [ - 774, - 777, - 779, - 781, - 787, - 783, - 791, - 772, - 796 + 773, + 776, + 778, + 780, + 786, + 782, + 790, + 771, + 795 ] } ], @@ -18153,7 +18492,7 @@ ] }, { - "id": 736, + "id": 735, "name": "SettableMetadata", "kind": 256, "kindString": "Interface", @@ -18166,7 +18505,7 @@ }, "children": [ { - "id": 737, + "id": 736, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -18200,7 +18539,7 @@ } }, { - "id": 738, + "id": 737, "name": "contentDisposition", "kind": 1024, "kindString": "Property", @@ -18234,7 +18573,7 @@ } }, { - "id": 739, + "id": 738, "name": "contentEncoding", "kind": 1024, "kindString": "Property", @@ -18268,7 +18607,7 @@ } }, { - "id": 740, + "id": 739, "name": "contentLanguage", "kind": 1024, "kindString": "Property", @@ -18302,7 +18641,7 @@ } }, { - "id": 741, + "id": 740, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -18336,7 +18675,7 @@ } }, { - "id": 742, + "id": 741, "name": "customMetadata", "kind": 1024, "kindString": "Property", @@ -18361,21 +18700,21 @@ { "type": "reflection", "declaration": { - "id": 743, + "id": 742, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { - "id": 744, + "id": 743, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 745, + "id": 744, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -18414,12 +18753,12 @@ "title": "Properties", "kind": 1024, "children": [ + 736, 737, 738, 739, 740, - 741, - 742 + 741 ] } ], @@ -18434,12 +18773,12 @@ { "type": "reference", "name": "FullMetadata", - "id": 746 + "id": 745 } ] }, { - "id": 731, + "id": 730, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -18452,7 +18791,7 @@ }, "children": [ { - "id": 735, + "id": 734, "name": "Path", "kind": 1024, "kindString": "Property", @@ -18473,11 +18812,11 @@ "type": { "type": "reference", "name": "Path", - "id": 721 + "id": 720 } }, { - "id": 732, + "id": 731, "name": "StringFormat", "kind": 1024, "kindString": "Property", @@ -18498,11 +18837,11 @@ "type": { "type": "reference", "name": "StringFormat", - "id": 708 + "id": 707 } }, { - "id": 734, + "id": 733, "name": "TaskEvent", "kind": 1024, "kindString": "Property", @@ -18523,11 +18862,11 @@ "type": { "type": "reference", "name": "TaskEvent", - "id": 713 + "id": 712 } }, { - "id": 733, + "id": 732, "name": "TaskState", "kind": 1024, "kindString": "Property", @@ -18548,7 +18887,7 @@ "type": { "type": "reference", "name": "TaskState", - "id": 715 + "id": 714 } } ], @@ -18557,10 +18896,10 @@ "title": "Properties", "kind": 1024, "children": [ - 735, - 732, 734, - 733 + 731, + 733, + 732 ] } ], @@ -18573,7 +18912,7 @@ ] }, { - "id": 708, + "id": 707, "name": "StringFormat", "kind": 256, "kindString": "Interface", @@ -18586,7 +18925,7 @@ }, "children": [ { - "id": 710, + "id": 709, "name": "BASE64", "kind": 1024, "kindString": "Property", @@ -18610,7 +18949,7 @@ } }, { - "id": 711, + "id": 710, "name": "BASE64URL", "kind": 1024, "kindString": "Property", @@ -18634,7 +18973,7 @@ } }, { - "id": 712, + "id": 711, "name": "DATA_URL", "kind": 1024, "kindString": "Property", @@ -18658,7 +18997,7 @@ } }, { - "id": 709, + "id": 708, "name": "RAW", "kind": 1024, "kindString": "Property", @@ -18687,10 +19026,10 @@ "title": "Properties", "kind": 1024, "children": [ + 709, 710, 711, - 712, - 709 + 708 ] } ], @@ -18703,7 +19042,7 @@ ] }, { - "id": 811, + "id": 810, "name": "Task", "kind": 256, "kindString": "Interface", @@ -18716,7 +19055,7 @@ }, "children": [ { - "id": 816, + "id": 815, "name": "cancel", "kind": 2048, "kindString": "Method", @@ -18725,7 +19064,7 @@ }, "signatures": [ { - "id": 817, + "id": 816, "name": "cancel", "kind": 4096, "kindString": "Call signature", @@ -18755,7 +19094,7 @@ ] }, { - "id": 842, + "id": 841, "name": "catch", "kind": 2048, "kindString": "Method", @@ -18764,14 +19103,14 @@ }, "signatures": [ { - "id": 843, + "id": 842, "name": "catch", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 844, + "id": 843, "name": "onRejected", "kind": 32768, "kindString": "Parameter", @@ -18779,21 +19118,21 @@ "type": { "type": "reflection", "declaration": { - "id": 845, + "id": 844, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 846, + "id": 845, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 847, + "id": 846, "name": "a", "kind": 32768, "kindString": "Parameter", @@ -18842,7 +19181,7 @@ ] }, { - "id": 818, + "id": 817, "name": "on", "kind": 2048, "kindString": "Method", @@ -18851,7 +19190,7 @@ }, "signatures": [ { - "id": 819, + "id": 818, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -18859,7 +19198,7 @@ "comment": {}, "parameters": [ { - "id": 820, + "id": 819, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -18871,7 +19210,7 @@ } }, { - "id": 821, + "id": 820, "name": "nextOrObserver", "kind": 32768, "kindString": "Parameter", @@ -18885,7 +19224,7 @@ { "type": "reference", "name": "TaskSnapshotObserver", - "id": 799 + "id": 798 }, { "type": "intrinsic", @@ -18894,21 +19233,21 @@ { "type": "reflection", "declaration": { - "id": 822, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 823, + "id": 822, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 824, + "id": 823, "name": "a", "kind": 32768, "kindString": "Parameter", @@ -18916,7 +19255,7 @@ "type": { "type": "reference", "name": "TaskSnapshot", - "id": 848 + "id": 847 } } ], @@ -18939,7 +19278,7 @@ } }, { - "id": 825, + "id": 824, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -18953,21 +19292,21 @@ { "type": "reflection", "declaration": { - "id": 826, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 827, + "id": 826, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 828, + "id": 827, "name": "a", "kind": 32768, "kindString": "Parameter", @@ -19001,7 +19340,7 @@ } }, { - "id": 829, + "id": 828, "name": "complete", "kind": 32768, "kindString": "Parameter", @@ -19017,14 +19356,14 @@ { "type": "reflection", "declaration": { - "id": 830, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 831, + "id": 830, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -19067,7 +19406,7 @@ ] }, { - "id": 812, + "id": 811, "name": "pause", "kind": 2048, "kindString": "Method", @@ -19076,7 +19415,7 @@ }, "signatures": [ { - "id": 813, + "id": 812, "name": "pause", "kind": 4096, "kindString": "Call signature", @@ -19106,7 +19445,7 @@ ] }, { - "id": 814, + "id": 813, "name": "resume", "kind": 2048, "kindString": "Method", @@ -19115,7 +19454,7 @@ }, "signatures": [ { - "id": 815, + "id": 814, "name": "resume", "kind": 4096, "kindString": "Call signature", @@ -19145,7 +19484,7 @@ ] }, { - "id": 832, + "id": 831, "name": "then", "kind": 2048, "kindString": "Method", @@ -19154,14 +19493,14 @@ }, "signatures": [ { - "id": 833, + "id": 832, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 834, + "id": 833, "name": "onFulfilled", "kind": 32768, "kindString": "Parameter", @@ -19174,21 +19513,21 @@ { "type": "reflection", "declaration": { - "id": 835, + "id": 834, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 836, + "id": 835, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 837, + "id": 836, "name": "a", "kind": 32768, "kindString": "Parameter", @@ -19196,7 +19535,7 @@ "type": { "type": "reference", "name": "TaskSnapshot", - "id": 848 + "id": 847 } } ], @@ -19223,7 +19562,7 @@ } }, { - "id": 838, + "id": 837, "name": "onRejected", "kind": 32768, "kindString": "Parameter", @@ -19236,21 +19575,21 @@ { "type": "reflection", "declaration": { - "id": 839, + "id": 838, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 840, + "id": 839, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 841, + "id": 840, "name": "a", "kind": 32768, "kindString": "Parameter", @@ -19310,12 +19649,12 @@ "title": "Methods", "kind": 2048, "children": [ - 816, - 842, - 818, - 812, - 814, - 832 + 815, + 841, + 817, + 811, + 813, + 831 ] } ], @@ -19328,7 +19667,7 @@ ] }, { - "id": 713, + "id": 712, "name": "TaskEvent", "kind": 256, "kindString": "Interface", @@ -19341,7 +19680,7 @@ }, "children": [ { - "id": 714, + "id": 713, "name": "STATE_CHANGED", "kind": 1024, "kindString": "Property", @@ -19370,7 +19709,7 @@ "title": "Properties", "kind": 1024, "children": [ - 714 + 713 ] } ], @@ -19383,7 +19722,7 @@ ] }, { - "id": 848, + "id": 847, "name": "TaskSnapshot", "kind": 256, "kindString": "Interface", @@ -19396,7 +19735,7 @@ }, "children": [ { - "id": 849, + "id": 848, "name": "bytesTransferred", "kind": 1024, "kindString": "Property", @@ -19419,7 +19758,7 @@ } }, { - "id": 855, + "id": 854, "name": "error", "kind": 1024, "kindString": "Property", @@ -19440,11 +19779,11 @@ "type": { "type": "reference", "name": "NativeFirebaseError", - "id": 894 + "id": 893 } }, { - "id": 850, + "id": 849, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -19464,11 +19803,11 @@ "type": { "type": "reference", "name": "FullMetadata", - "id": 746 + "id": 745 } }, { - "id": 851, + "id": 850, "name": "ref", "kind": 1024, "kindString": "Property", @@ -19488,11 +19827,11 @@ "type": { "type": "reference", "name": "Reference", - "id": 765 + "id": 764 } }, { - "id": 852, + "id": 851, "name": "state", "kind": 1024, "kindString": "Property", @@ -19536,7 +19875,7 @@ } }, { - "id": 853, + "id": 852, "name": "task", "kind": 1024, "kindString": "Property", @@ -19556,11 +19895,11 @@ "type": { "type": "reference", "name": "Task", - "id": 811 + "id": 810 } }, { - "id": 854, + "id": 853, "name": "totalBytes", "kind": 1024, "kindString": "Property", @@ -19588,13 +19927,13 @@ "title": "Properties", "kind": 1024, "children": [ + 848, + 854, 849, - 855, 850, 851, 852, - 853, - 854 + 853 ] } ], @@ -19607,7 +19946,7 @@ ] }, { - "id": 799, + "id": 798, "name": "TaskSnapshotObserver", "kind": 256, "kindString": "Interface", @@ -19616,7 +19955,7 @@ }, "children": [ { - "id": 808, + "id": 807, "name": "complete", "kind": 1024, "kindString": "Property", @@ -19633,14 +19972,14 @@ "type": { "type": "reflection", "declaration": { - "id": 809, + "id": 808, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 810, + "id": 809, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -19662,7 +20001,7 @@ } }, { - "id": 804, + "id": 803, "name": "error", "kind": 1024, "kindString": "Property", @@ -19679,21 +20018,21 @@ "type": { "type": "reflection", "declaration": { - "id": 805, + "id": 804, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 806, + "id": 805, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 807, + "id": 806, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19721,7 +20060,7 @@ } }, { - "id": 800, + "id": 799, "name": "next", "kind": 1024, "kindString": "Property", @@ -19738,21 +20077,21 @@ "type": { "type": "reflection", "declaration": { - "id": 801, + "id": 800, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 802, + "id": 801, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 803, + "id": 802, "name": "taskSnapshot", "kind": 32768, "kindString": "Parameter", @@ -19760,7 +20099,7 @@ "type": { "type": "reference", "name": "TaskSnapshot", - "id": 848 + "id": 847 } } ], @@ -19786,9 +20125,9 @@ "title": "Properties", "kind": 1024, "children": [ - 808, - 804, - 800 + 807, + 803, + 799 ] } ], @@ -19801,7 +20140,7 @@ ] }, { - "id": 715, + "id": 714, "name": "TaskState", "kind": 256, "kindString": "Interface", @@ -19814,7 +20153,7 @@ }, "children": [ { - "id": 716, + "id": 715, "name": "CANCELLED", "kind": 1024, "kindString": "Property", @@ -19837,7 +20176,7 @@ } }, { - "id": 717, + "id": 716, "name": "ERROR", "kind": 1024, "kindString": "Property", @@ -19860,7 +20199,7 @@ } }, { - "id": 718, + "id": 717, "name": "PAUSED", "kind": 1024, "kindString": "Property", @@ -19883,7 +20222,7 @@ } }, { - "id": 719, + "id": 718, "name": "RUNNING", "kind": 1024, "kindString": "Property", @@ -19906,7 +20245,7 @@ } }, { - "id": 720, + "id": 719, "name": "SUCCESS", "kind": 1024, "kindString": "Property", @@ -19934,11 +20273,11 @@ "title": "Properties", "kind": 1024, "children": [ + 715, 716, 717, 718, - 719, - 720 + 719 ] } ], @@ -19956,24 +20295,24 @@ "title": "Classes", "kind": 128, "children": [ - 856 + 855 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 746, - 721, - 765, - 736, - 731, - 708, - 811, - 713, - 848, - 799, - 715 + 745, + 720, + 764, + 735, + 730, + 707, + 810, + 712, + 847, + 798, + 714 ] } ], @@ -19986,7 +20325,7 @@ ] }, { - "id": 884, + "id": 883, "name": "Utils", "kind": 2, "kindString": "Module", @@ -20005,7 +20344,7 @@ }, "children": [ { - "id": 886, + "id": 885, "name": "Module", "kind": 128, "kindString": "Class", @@ -20018,7 +20357,7 @@ }, "children": [ { - "id": 888, + "id": 887, "name": "app", "kind": 1024, "kindString": "Property", @@ -20042,7 +20381,7 @@ } }, { - "id": 887, + "id": 886, "name": "isRunningInTestLab", "kind": 1024, "kindString": "Property", @@ -20076,8 +20415,8 @@ "title": "Properties", "kind": 1024, "children": [ - 888, - 887 + 887, + 886 ] } ], @@ -20096,7 +20435,7 @@ ] }, { - "id": 885, + "id": 884, "name": "Statics", "kind": 256, "kindString": "Interface", @@ -20117,14 +20456,14 @@ "title": "Classes", "kind": 128, "children": [ - 886 + 885 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 885 + 884 ] } ], @@ -20137,7 +20476,7 @@ ] }, { - "id": 925, + "id": 924, "name": "ReactNativeFirebaseModule", "kind": 128, "kindString": "Class", @@ -20146,7 +20485,7 @@ }, "children": [ { - "id": 926, + "id": 925, "name": "app", "kind": 1024, "kindString": "Property", @@ -20163,7 +20502,7 @@ "type": { "type": "reference", "name": "FirebaseApp", - "id": 907 + "id": 906 } } ], @@ -20172,7 +20511,7 @@ "title": "Properties", "kind": 1024, "children": [ - 926 + 925 ] } ], @@ -20185,7 +20524,7 @@ ] }, { - "id": 907, + "id": 906, "name": "FirebaseApp", "kind": 256, "kindString": "Interface", @@ -20194,7 +20533,7 @@ }, "children": [ { - "id": 908, + "id": 907, "name": "name", "kind": 1024, "kindString": "Property", @@ -20217,7 +20556,7 @@ } }, { - "id": 909, + "id": 908, "name": "options", "kind": 1024, "kindString": "Property", @@ -20237,11 +20576,11 @@ "type": { "type": "reference", "name": "FirebaseOptions", - "id": 927 + "id": 926 } }, { - "id": 910, + "id": 909, "name": "delete", "kind": 2048, "kindString": "Method", @@ -20250,7 +20589,7 @@ }, "signatures": [ { - "id": 911, + "id": 910, "name": "delete", "kind": 4096, "kindString": "Call signature", @@ -20284,15 +20623,15 @@ "title": "Properties", "kind": 1024, "children": [ - 908, - 909 + 907, + 908 ] }, { "title": "Methods", "kind": 2048, "children": [ - 910 + 909 ] } ], @@ -20305,7 +20644,7 @@ ] }, { - "id": 903, + "id": 902, "name": "FirebaseAppConfig", "kind": 256, "kindString": "Interface", @@ -20314,7 +20653,7 @@ }, "children": [ { - "id": 905, + "id": 904, "name": "automaticDataCollectionEnabled", "kind": 1024, "kindString": "Property", @@ -20349,7 +20688,7 @@ } }, { - "id": 906, + "id": 905, "name": "automaticResourceManagement", "kind": 1024, "kindString": "Property", @@ -20386,7 +20725,7 @@ } }, { - "id": 904, + "id": 903, "name": "name", "kind": 1024, "kindString": "Property", @@ -20424,9 +20763,9 @@ "title": "Properties", "kind": 1024, "children": [ + 904, 905, - 906, - 904 + 903 ] } ], @@ -20439,7 +20778,7 @@ ] }, { - "id": 894, + "id": 893, "name": "NativeFirebaseError", "kind": 256, "kindString": "Interface", @@ -20448,7 +20787,7 @@ }, "children": [ { - "id": 902, + "id": 901, "name": "Error", "kind": 1024, "kindString": "Property", @@ -20457,7 +20796,7 @@ }, "sources": [ { - "fileName": "/Volumes/Projects/Projects/@react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", + "fileName": "/Users/elliot/Documents/react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 974, "character": 19 } @@ -20468,7 +20807,7 @@ } }, { - "id": 895, + "id": 894, "name": "code", "kind": 1024, "kindString": "Property", @@ -20491,7 +20830,7 @@ } }, { - "id": 896, + "id": 895, "name": "message", "kind": 1024, "kindString": "Property", @@ -20518,7 +20857,7 @@ } }, { - "id": 900, + "id": 899, "name": "name", "kind": 1024, "kindString": "Property", @@ -20527,7 +20866,7 @@ }, "sources": [ { - "fileName": "/Volumes/Projects/Projects/@react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", + "fileName": "/Users/elliot/Documents/react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 963, "character": 8 } @@ -20542,7 +20881,7 @@ } }, { - "id": 897, + "id": 896, "name": "namespace", "kind": 1024, "kindString": "Property", @@ -20565,7 +20904,7 @@ } }, { - "id": 898, + "id": 897, "name": "nativeErrorCode", "kind": 1024, "kindString": "Property", @@ -20597,7 +20936,7 @@ } }, { - "id": 899, + "id": 898, "name": "nativeErrorMessage", "kind": 1024, "kindString": "Property", @@ -20620,7 +20959,7 @@ } }, { - "id": 901, + "id": 900, "name": "stack", "kind": 1024, "kindString": "Property", @@ -20630,7 +20969,7 @@ }, "sources": [ { - "fileName": "/Volumes/Projects/Projects/@react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", + "fileName": "/Users/elliot/Documents/react-native-firebase/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts", "line": 965, "character": 9 } @@ -20663,14 +21002,14 @@ "title": "Properties", "kind": 1024, "children": [ - 902, + 901, + 894, 895, + 899, 896, - 900, 897, 898, - 899, - 901 + 900 ] } ], @@ -20689,7 +21028,7 @@ ] }, { - "id": 912, + "id": 911, "name": "ReactNativeFirebaseNamespace", "kind": 256, "kindString": "Interface", @@ -20698,7 +21037,7 @@ }, "children": [ { - "id": 924, + "id": 923, "name": "SDK_VERSION", "kind": 1024, "kindString": "Property", @@ -20721,7 +21060,7 @@ } }, { - "id": 923, + "id": 922, "name": "apps", "kind": 1024, "kindString": "Property", @@ -20743,12 +21082,12 @@ "elementType": { "type": "reference", "name": "FirebaseApp", - "id": 907 + "id": 906 } } }, { - "id": 920, + "id": 919, "name": "app", "kind": 2048, "kindString": "Method", @@ -20757,7 +21096,7 @@ }, "signatures": [ { - "id": 921, + "id": 920, "name": "app", "kind": 4096, "kindString": "Call signature", @@ -20773,7 +21112,7 @@ }, "parameters": [ { - "id": 922, + "id": 921, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -20801,7 +21140,7 @@ "type": { "type": "reference", "name": "FirebaseApp", - "id": 907 + "id": 906 } } ], @@ -20814,7 +21153,7 @@ ] }, { - "id": 913, + "id": 912, "name": "initializeApp", "kind": 2048, "kindString": "Method", @@ -20823,7 +21162,7 @@ }, "signatures": [ { - "id": 914, + "id": 913, "name": "initializeApp", "kind": 4096, "kindString": "Call signature", @@ -20833,7 +21172,7 @@ }, "parameters": [ { - "id": 915, + "id": 914, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -20844,11 +21183,11 @@ "type": { "type": "reference", "name": "FirebaseOptions", - "id": 927 + "id": 926 } }, { - "id": 916, + "id": 915, "name": "config", "kind": 32768, "kindString": "Parameter", @@ -20861,18 +21200,18 @@ "type": { "type": "reference", "name": "FirebaseAppConfig", - "id": 903 + "id": 902 } } ], "type": { "type": "reference", "name": "FirebaseApp", - "id": 907 + "id": 906 } }, { - "id": 917, + "id": 916, "name": "initializeApp", "kind": 4096, "kindString": "Call signature", @@ -20882,7 +21221,7 @@ }, "parameters": [ { - "id": 918, + "id": 917, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -20893,11 +21232,11 @@ "type": { "type": "reference", "name": "FirebaseOptions", - "id": 927 + "id": 926 } }, { - "id": 919, + "id": 918, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -20925,7 +21264,7 @@ "type": { "type": "reference", "name": "FirebaseApp", - "id": 907 + "id": 906 } } ], @@ -20948,16 +21287,16 @@ "title": "Properties", "kind": 1024, "children": [ - 924, - 923 + 923, + 922 ] }, { "title": "Methods", "kind": 2048, "children": [ - 920, - 913 + 919, + 912 ] } ], @@ -20970,7 +21309,7 @@ ] }, { - "id": 927, + "id": 926, "name": "FirebaseOptions", "kind": 4194304, "kindString": "Type alias", @@ -20987,21 +21326,21 @@ "type": { "type": "reflection", "declaration": { - "id": 928, + "id": 927, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { - "id": 939, + "id": 938, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 940, + "id": 939, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -21020,7 +21359,7 @@ ], "children": [ { - "id": 937, + "id": 936, "name": "androidClientId", "kind": 32, "kindString": "Variable", @@ -21052,7 +21391,7 @@ } }, { - "id": 930, + "id": 929, "name": "apiKey", "kind": 32, "kindString": "Variable", @@ -21084,7 +21423,7 @@ } }, { - "id": 929, + "id": 928, "name": "appId", "kind": 32, "kindString": "Variable", @@ -21105,7 +21444,7 @@ } }, { - "id": 936, + "id": 935, "name": "clientId", "kind": 32, "kindString": "Variable", @@ -21137,7 +21476,7 @@ } }, { - "id": 931, + "id": 930, "name": "databaseURL", "kind": 32, "kindString": "Variable", @@ -21169,7 +21508,7 @@ } }, { - "id": 938, + "id": 937, "name": "deepLinkURLScheme", "kind": 32, "kindString": "Variable", @@ -21201,7 +21540,7 @@ } }, { - "id": 933, + "id": 932, "name": "gaTrackingId", "kind": 32, "kindString": "Variable", @@ -21233,7 +21572,7 @@ } }, { - "id": 935, + "id": 934, "name": "messagingSenderId", "kind": 32, "kindString": "Variable", @@ -21265,7 +21604,7 @@ } }, { - "id": 932, + "id": 931, "name": "projectId", "kind": 32, "kindString": "Variable", @@ -21286,7 +21625,7 @@ } }, { - "id": 934, + "id": 933, "name": "storageBucket", "kind": 32, "kindString": "Variable", @@ -21323,16 +21662,16 @@ "title": "Variables", "kind": 32, "children": [ - 937, - 930, - 929, 936, - 931, - 938, - 933, + 929, + 928, 935, + 930, + 937, 932, - 934 + 934, + 931, + 933 ] } ], @@ -21347,7 +21686,7 @@ } }, { - "id": 960, + "id": 959, "name": "ReactNativeFirebaseModuleAndStatics", "kind": 4194304, "kindString": "Type alias", @@ -21356,14 +21695,14 @@ }, "typeParameter": [ { - "id": 961, + "id": 960, "name": "M", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 962, + "id": 961, "name": "S", "kind": 131072, "kindString": "Type parameter", @@ -21383,14 +21722,14 @@ { "type": "reflection", "declaration": { - "id": 963, + "id": 962, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 964, + "id": 963, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -21403,7 +21742,7 @@ ], "children": [ { - "id": 965, + "id": 964, "name": "SDK_VERSION", "kind": 32, "kindString": "Variable", @@ -21429,7 +21768,7 @@ "title": "Variables", "kind": 32, "children": [ - 965 + 964 ] } ], @@ -21450,7 +21789,7 @@ } }, { - "id": 966, + "id": 965, "name": "ReactNativeFirebaseModuleAndStaticsWithApp", "kind": 4194304, "kindString": "Type alias", @@ -21459,14 +21798,14 @@ }, "typeParameter": [ { - "id": 967, + "id": 966, "name": "M", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 968, + "id": 967, "name": "S", "kind": 131072, "kindString": "Type parameter", @@ -21486,21 +21825,21 @@ { "type": "reflection", "declaration": { - "id": 969, + "id": 968, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 970, + "id": 969, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 971, + "id": 970, "name": "app", "kind": 32768, "kindString": "Parameter", @@ -21522,7 +21861,7 @@ ], "children": [ { - "id": 972, + "id": 971, "name": "SDK_VERSION", "kind": 32, "kindString": "Variable", @@ -21548,7 +21887,7 @@ "title": "Variables", "kind": 32, "children": [ - 972 + 971 ] } ], @@ -21577,58 +21916,58 @@ 40, 50, 44, - 334, - 388, - 430, - 449, - 460, - 509, - 533, - 600, - 611, - 700, - 876, - 889, + 333, + 387, + 429, + 448, + 459, + 508, + 532, + 599, + 610, + 699, + 875, + 888, 1, - 941, + 940, 59, - 341, - 395, - 437, - 456, - 467, - 517, - 540, - 607, - 618, - 707, - 884 + 340, + 394, + 436, + 455, + 466, + 516, + 539, + 606, + 617, + 706, + 883 ] }, { "title": "Classes", "kind": 128, "children": [ - 925 + 924 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 907, - 903, - 894, - 912 + 906, + 902, + 893, + 911 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ - 927, - 960, - 966 + 926, + 959, + 965 ] } ] diff --git a/packages/auth/lib/index.d.ts b/packages/auth/lib/index.d.ts index 6df075b0..914f6b34 100644 --- a/packages/auth/lib/index.d.ts +++ b/packages/auth/lib/index.d.ts @@ -59,25 +59,115 @@ import { * @firebase auth */ export namespace Auth { - export interface AuthProviderCredential { + + /** + * Interface that represents the credentials returned by an auth provider. Implementations specify the details + * about each auth provider's credential requirements. + * + * TODO Missing; signInMethod, toJSON, fromJSON + * + * #### Example + * + * ```js + * const provider = firebase.auth.EmailAuthProvider; + * const authCredential = provider.credential('foo@bar.com', '123456'); + * + * await firebase.auth().linkWithCredential(authCredential); + * ``` + */ + export interface AuthCredential { + /** + * The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'. + */ providerId: string; token: string; secret: string; } + /** + * Interface that represents an auth provider. Implemented by other providers. + */ export interface AuthProvider { + /** + * The provider ID of the provider. + */ PROVIDER_ID: string; - credential: (token: string | null, secret?: string) => AuthProviderCredential; + /** + * Creates a new `AuthCredential`. + * + * @returns {@link auth.AuthCredential}. + * @param token A provider token. + * @param secret A provider secret. + */ + credential: (token: string | null, secret?: string) => AuthCredential; } + /** + * Email and password auth provider implementation. + */ export interface EmailAuthProvider { + /** + * The provider ID. Always returns `password`. + */ PROVIDER_ID: string; + /** + * This corresponds to the sign-in method identifier as returned in {@link auth.#fetchSignInMethodsForEmail}. + * + * #### Example + * + * ```js + * const signInMethods = await firebase.auth().fetchSignInMethodsForEmail('...'); + * if (signInMethods.indexOf(firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD) != -1) { + * // User can sign in with email/link + * } + * ``` + */ EMAIL_LINK_SIGN_IN_METHOD: string; + /** + * This corresponds to the sign-in method identifier as returned in {@link auth.#fetchSignInMethodsForEmail}. + * + * #### Example + * + * ```js + * const signInMethods = await firebase.auth().fetchSignInMethodsForEmail('...'); + * if (signInMethods.indexOf(firebase.auth.EmailAuthProvider.EMAIL_PASSWORD_SIGN_IN_METHOD) != -1) { + * // User can sign in with email/password + * } + * ``` + */ EMAIL_PASSWORD_SIGN_IN_METHOD: string; - credential: (email: string, password: string) => AuthProviderCredential; - credentialWithLink: (email: string, emailLink: string) => AuthProviderCredential; + /** + * Returns the auth provider credential. + * + * #### Example + * + * ```js + * const authCredential = firebase.auth.EmailAuthProvider.credential('joe.bloggs@example.com', '123456'); + * ``` + * + * @returns {@link auth.AuthCredential} + * @param email Users email address. + * @param password User account password. + */ + credential: (email: string, password: string) => AuthCredential; + /** + * Initialize an `EmailAuthProvider` credential using an email and an email link after a sign in with email link operation. + * + * #### Example + * + * ```js + * const authCredential = firebase.auth.EmailAuthProvider.credentialWithLink('joe.bloggs@example.com', 'https://myexample.com/invite'); + * ``` + * + * @param email Users email address. + * @param emailLink Sign-in email link. + */ + credentialWithLink: (email: string, emailLink: string) => AuthCredential; } + /** + * + */ export interface PhoneAuthState { CODE_SENT: 'sent'; AUTO_VERIFY_TIMEOUT: 'timeout'; @@ -85,43 +175,209 @@ export namespace Auth { ERROR: 'error'; } + /** + * firebase.auth.X + */ export interface Statics { + /** + * Email and password auth provider implementation. + * + * #### Example + * + * ```js + * firebase.auth.EmailAuthProvider; + * ``` + */ EmailAuthProvider: EmailAuthProvider; + /** + * Phone auth provider implementation. + * + * #### Example + * + * ```js + * firebase.auth.PhoneAuthProvider; + * ``` + */ PhoneAuthProvider: AuthProvider; + /** + * Google auth provider implementation. + * + * #### Example + * + * ```js + * firebase.auth.GoogleAuthProvider; + * ``` + */ GoogleAuthProvider: AuthProvider; + /** + * Github auth provider implementation. + * + * #### Example + * + * ```js + * firebase.auth.GithubAuthProvider; + * ``` + */ GithubAuthProvider: AuthProvider; + /** + * Twitter auth provider implementation. + * + * #### Example + * + * ```js + * firebase.auth.TwitterAuthProvider; + * ``` + */ TwitterAuthProvider: AuthProvider; + /** + * Facebook auth provider implementation. + * + * #### Example + * + * ```js + * firebase.auth.FacebookAuthProvider; + * ``` + */ FacebookAuthProvider: AuthProvider; + /** + * Custom OAuth auth provider implementation. + * + * #### Example + * + * ```js + * firebase.auth.OAuthProvider; + * ``` + */ OAuthProvider: AuthProvider; + /** + * A PhoneAuthState interface. + * + * #### Example + * + * ```js + * firebase.auth.PhoneAuthState; + * ``` + */ PhoneAuthState: PhoneAuthState; } + /** + * A structure containing additional user information from a federated identity provider via {@link auth.UserCredential}. + * + * #### Example + * + * ```js + * const userCredential = await firebase.auth().signInAnonymously(); + * console.log('Additional user info: ', userCredential.additionalUserInfo); + * ``` + */ export interface AdditionalUserInfo { + /** + * Returns whether the user is new or existing. + */ isNewUser: boolean; + /** + * Returns a Object containing IDP-specific user data if the provider is one of Facebook, + * GitHub, Google, Twitter, Microsoft, or Yahoo. + */ profile?: Object; + /** + * Returns the provider ID for specifying which provider the information in `profile` is for. + */ providerId: string; + /** + * Returns the username if the provider is GitHub or Twitter. + */ username?: string; } + /** + * A structure containing a User, an AuthCredential, the operationType, and any additional user + * information that was returned from the identity provider. operationType could be 'signIn' for + * a sign-in operation, 'link' for a linking operation and 'reauthenticate' for a reauthentication operation. + * + * TODO @salakar; missing credential, operationType + */ export interface UserCredential { + /** + * Any additional user information assigned to the user. + */ additionalUserInfo?: AdditionalUserInfo; + /** + * Returns the {@link auth.User} interface of this credential. + */ user: User; } + /** + * Holds the user metadata for the current {@link auth.User}. + * + * #### Example + * + * ```js + * const user = firebase.auth().currentUser; + * console.log('User metadata: ', user.metadata); + * ``` + */ export interface UserMetadata { + /** + * Returns the timestamp at which this account was created as dictated by the server clock + * as an ISO Date string. + */ creationTime?: string; + /** + * Returns the last signin timestamp as dictated by the server clock as an ISO Date string. + * This is only accurate up to a granularity of 2 minutes for consecutive sign-in attempts. + */ lastSignInTime?: string; } + /** + * Represents a collection of standard profile information for a user. Can be used to expose + * profile information returned by an identity provider, such as Google Sign-In or Facebook Login. + * + * TODO @salakar: isEmailVerified + * + * #### Example + * + * ```js + * const user = firebase.auth().currentUser; + * + * user.providerData.forEach((userInfo) => { + * console.log('User info for provider: ', userInfo); + * }); + * ``` + */ export interface UserInfo { + /** + * Returns the user's display name, if available. + */ displayName?: string; + /** + * Returns the email address corresponding to the user's account in the specified provider, if available. + */ email?: string; + /** + * Returns the phone number corresponding to the user's account, if available, or `null` if none exists. + */ phoneNumber?: string; + /** + * Returns a url to the user's profile picture, if available. + */ photoURL?: string; + /** + * Returns the unique identifier of the provider type that this instance corresponds to. + */ providerId: string; + /** + * Returns a user identifier as specified by the authentication provider. + */ uid: string; } + /** + * TODO + */ export interface IdTokenResult { token: string; authTime: string; @@ -133,36 +389,74 @@ export namespace Auth { }; } + /** + * Request used to update user profile information. + * + * #### Example + * + * ```js + * const update = { + * displayName: 'Alias', + * photoURL: 'https://my-cdn.com/assets/user/123.png', + * }; + * + * await firebase.auth().currentUser.updateProfile(update); + * ``` + */ export interface UpdateProfile { + /** + * An optional display name for the user. + */ displayName?: string; + /** + * An optional photo URL for the user. + */ photoURL?: string; } + /** + * TODO + */ export interface ConfirmationResult { confirm(verificationCode: string): Promise; verificationId: string | null; } + /** + * + */ export interface ActionCodeSettingsAndroid { installApp?: boolean; minimumVersion?: string; packageName: string; } + /** + * + */ export interface ActionCodeInfoData { email?: string; fromEmail?: string; } + /** + * + */ export interface ActionCodeInfo { data: ActionCodeInfoData; operation: 'PASSWORD_RESET' | 'VERIFY_EMAIL' | 'RECOVER_EMAIL' | 'EMAIL_SIGNIN' | 'ERROR'; } + /** + * + */ export interface ActionCodeSettingsIos { bundleId?: string; } + /** + * + */ export interface ActionCodeSettings { android: ActionCodeSettingsAndroid; handleCodeInApp?: boolean; @@ -170,8 +464,28 @@ export namespace Auth { url: string; } + /** + * An auth listener callback function for {@link auth#onAuthStateChanged}. + * + * #### Example + * + * ```js + * function listener(user) { + * if (user) { + * // Signed in + * } else { + * // Signed out + * } + * } + * + * firebase.auth().onAuthStateChanged(listener); + * ``` + */ export type AuthListenerCallback = (user: User | null) => void; + /** + * + */ export interface PhoneAuthSnapshot { state: 'sent' | 'timeout' | 'verified' | 'error'; verificationId: string; @@ -179,6 +493,9 @@ export namespace Auth { error: NativeFirebaseError | null; } + /** + * + */ export interface PhoneAuthError { code: string | null; verificationId: string; @@ -186,6 +503,9 @@ export namespace Auth { stack: string | null; } + /** + * + */ export interface PhoneAuthListener { on( event: string, @@ -226,6 +546,32 @@ export namespace Auth { setAutoRetrievedSmsCodeForPhoneNumber(phoneNumber: string, smsCode: string): Promise; } + /** + * Represents a user's profile information in your Firebase project's user database. It also + * contains helper methods to change or retrieve profile information, as well as to manage that user's authentication state. + * + * #### Example 1 + * + * Subscribing to the users authentication state. + * + * ```js + * firebase.auth().onAuthStateChanged((user) => { + * if (user) { + * console.log('User email: ', user.email'); + * } + * }); + * ``` + * + * #### Example 2 + * + * ```js + * const user = firebase.auth().currentUser; + * + * if (user) { + * console.log('User email: ', user.email'); + * } + * ``` + */ export interface User { /** * The user's display name (if available). @@ -240,26 +586,35 @@ export namespace Auth { */ emailVerified: boolean; /** - * + * Returns true if the user is anonymous; that is, the user account was created with + * {@link auth#signInAnonymously()} and has not been linked to another account + * with {@link auth#linkWithCredential}. */ isAnonymous: boolean; + /** + * Returns the {@link auth.UserMetadata} associated with this user. + */ metadata: UserMetadata; + /** + * Returns the phone number of the user, as stored in the Firebase project's user database, + * or null if none exists. This can be updated at any time by calling {@link auth.User#updatePhoneNumber}. + */ phoneNumber: string | null; /** - * - The URL of the user's profile picture (if available). + * The URL of the user's profile picture (if available). */ photoURL: string | null; /** - * - Additional provider-specific information about the user. + * Additional provider-specific information about the user. */ providerData: Array; /** - * - The authentication provider ID for the current user. + * The authentication provider ID for the current user. * For example, 'facebook.com', or 'google.com'. */ providerId: string; @@ -271,13 +626,26 @@ export namespace Auth { /** * Delete the current user. + * + * #### Example + * + * ```js + * await firebase.auth().currentUser.delete(); + * ``` */ delete(): Promise; /** * Returns the users authentication token. * - * @param forceRefresh: boolean - default to false + * #### Example + * + * ```js + * // Force a token refresh + * const idToken = await firebase.auth().currentUser.getIdToken(true); + * ``` + * + * @param forceRefresh A boolean value which forces Firebase to refresh the token. */ getIdToken(forceRefresh?: boolean): Promise; @@ -286,59 +654,159 @@ export namespace Auth { * other helper properties for getting different data associated with the token as well as * all the decoded payload claims. * + * #### Example + * + * ```js + * // Force a token refresh + * const idTokenResult = await firebase.auth().currentUser.getIdTokenResult(true); + * ``` + * * @param forceRefresh boolean Force refresh regardless of token expiration. */ getIdTokenResult(forceRefresh?: boolean): Promise; /** * Link the user with a 3rd party credential provider. + * + * #### Example + * + * ```js + * const facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook'); + * const userCredential = await firebase.auth().currentUser.linkWithCredential(facebookCredential); + * ``` + * + * @param credential A created {@link auth.AuthCredential}. */ - linkWithCredential(credential: AuthProviderCredential): Promise; + linkWithCredential(credential: AuthCredential): Promise; /** - * Re-authenticate a user with a third-party authentication provider + * Re-authenticate a user with a third-party authentication provider. + * + * #### Example + * + * ```js + * const facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook'); + * const userCredential = await firebase.auth().currentUser.reauthenticateWithCredential(facebookCredential); + * ``` + * + * @param credential A created {@link auth.AuthCredential}. */ - reauthenticateWithCredential(credential: AuthProviderCredential): Promise; + reauthenticateWithCredential(credential: AuthCredential): Promise; /** * Refreshes the current user. + * + * #### Example + * + * ```js + * await firebase.auth().currentUser.reload(); + * ``` */ reload(): Promise; /** * Sends a verification email to a user. - * This will Promise reject is the user is anonymous. + * + * #### Example + * + * ```js + * await firebase.auth().currentUser.sendEmailVerification({ + * handleCodeInApp: true, + * }); + * ``` + * + * > This will Promise reject is the user is anonymous. + * + * @param actionCodeSettings Any optional additional settings to be set before sending the verification email. */ sendEmailVerification(actionCodeSettings?: ActionCodeSettings): Promise; + /** + * Returns a JSON-serializable representation of this object. + * + * #### Example + * + * ```js + * const user = firebase.auth().currentUser.toJSON(); + * ``` + */ toJSON(): object; + /** + * Unlinks a provider from a user account. + * + * #### Example + * + * ```js + * const user = await firebase.auth().currentUser.unlink('facebook.com'); + * ``` + * + * @param providerId + */ unlink(providerId: string): Promise; /** * Updates the user's email address. + * * See Firebase docs for more information on security & email validation. - * This will Promise reject is the user is anonymous. + * + * #### Example + * + * ```js + * await firebase.auth().currentUser.updateEmail('joe.bloggs@new-email.com'); + * ``` + * + * > This will Promise reject is the user is anonymous. + * + * @param email The users new email address. */ updateEmail(email: string): Promise; /** + * Updates the users password. + * * Important: this is a security sensitive operation that requires the user to have recently signed in. * If this requirement isn't met, ask the user to authenticate again and then call firebase.User#reauthenticate. - * This will Promise reject is the user is anonymous. + * + * #### Example + * + * ```js + * await firebase.auth().currentUser.updatePassword('654321'); + * ``` + * + * > This will Promise reject is the user is anonymous. + * + * @param password The users new password. */ updatePassword(password: string): Promise; /** * Updates the user's phone number. + * * See Firebase docs for more information on security & email validation. - * This will Promise reject is the user is anonymous. + * + * #### Example + * + * ```js + * TODO ehesp + * ``` + * + * > This will Promise reject is the user is anonymous. + * + * @param credential A created `AuthCredential`. */ - updatePhoneNumber(credential: AuthProviderCredential): Promise; + updatePhoneNumber(credential: AuthCredential): Promise; /** * Updates a user's profile data. - * Profile data should be an object of fields to update: + * + * #### Example + * + * ```js + * await firebase.auth().currentUser.updateProfile({ + * displayName: 'Alias', + * }); + * ``` */ updateProfile(updates: UpdateProfile): Promise; } @@ -365,14 +833,46 @@ export namespace Auth { * */ export class Module extends ReactNativeFirebaseModule { - languageCode(): string; + /** + * Gets the current language code. + * + * #### Example + * + * ```js + * const language = firebase.auth().languageCode; + * ``` + */ + get languageCode(): string; + /** + * Sets the language code. + * + * #### Example + * + * ```js + * // Set language to French + * firebase.auth().languageCode = 'fr'; + * ``` + * + * @param code An ISO language code. + */ set languageCode(code: string): void; - get settings(): AuthSettings; + /** + * Returns the current `AuthSettings`. + */ + settings: AuthSettings; /** * Returns the currently signed-in user (or null if no user signed in). See the User interface documentation for detailed usage. + * + * #### Example + * + * ```js + * const user = firebase.auth().currentUser; + * ``` + * + * > It is recommended to use {@link auth#onAuthStateChanged} to track whether the user is currently signed in. */ get currentUser(): User | null; @@ -380,6 +880,23 @@ export namespace Auth { * Listen for changes in the users auth state (logging in and out). * This method returns a unsubscribe function to stop listening to events. * Always ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use. + * + * #### Example + * + * ```js + * const unsubscribe = firebase.auth().onAuthStateChanged((user) => { + * if (user) { + * // Signed in + * } else { + * // Signed out + * } + * }); + * + * // Unsubscribe from further state changes + * unsubscribe(); + * ``` + * + * @param listener A listener function which triggers when auth state changed (for example signing out). */ onAuthStateChanged(listener: AuthListenerCallback): () => void; @@ -387,27 +904,87 @@ export namespace Auth { * Listen for changes in id token. * This method returns a unsubscribe function to stop listening to events. * Always ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use. + * + * * #### Example + * + * ```js + * const unsubscribe = firebase.auth().onIdTokenChanged((user) => { + * if (user) { + * // User is signed in or token was refreshed. + * } + * }); + * + * // Unsubscribe from further state changes + * unsubscribe(); + * ``` + * + * @param listener A listener function which triggers when the users ID token changes. */ onIdTokenChanged(listener: AuthListenerCallback): () => void; /** - * Listen for changes in the user. - * This method returns a unsubscribe function to stop listening to events. - * Always ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use. + * Adds a listener to observe changes to the User object. This is a superset of everything from + * {@link auth#onAuthStateChanged}, {@ auth#onIdTokenChanged} and user changes. The goal of this + * method is to provide easier listening to all user changes, such as when credentials are + * linked and unlinked, without manually having to call {@link auth.User#reload}. + * + * #### Example + * + * ```js + * const unsubscribe = firebase.auth().onUserChanged((user) => { + * if (user) { + * // User is signed in or token was refreshed. + * } + * }); + * + * // Unsubscribe from further state changes + * unsubscribe(); + * ``` + * + * > This is an experimental feature and is only part of React Native Firebase. + * + * @react-native-firebase + * @param listener A listener function which triggers when the users data changes. */ onUserChanged(listener: AuthListenerCallback): () => void; + /** + * Signs the user out. + * + * Triggers the {@link auth#onAuthStateChanged} listener. + * + * #### Example + * + * ```js + * await firebase.auth().currentUser.signOut(); + * ``` + * + */ signOut(): Promise; /** * Sign in a user anonymously. If the user has already signed in, that user will be returned. + * + * #### Example + * + * ```js + * const userCredential = firebase.auth().signInAnonymously(); + * ``` */ signInAnonymously(): Promise; /** * Signs in the user using their phone number. - * @param phoneNumber - * @param forceResend + * + * #### Example + * + * ```js + * // Force a new message to be sent + * const result = await firebase.auth().signInWithPhoneNumber('#4423456789', true); + * ``` + * + * @param phoneNumber The devices phone number. + * @param forceResend Forces a new message to be sent if it was already recently sent. */ signInWithPhoneNumber(phoneNumber: string, forceResend?: boolean): Promise; @@ -416,6 +993,12 @@ export namespace Auth { * on the final completion event a PhoneAuthCredential can be generated for * authentication purposes. * + * #### Example + * + * ```js + * TODO ehesp + * ``` + * * @param phoneNumber * @param autoVerifyTimeoutOrForceResend * @param forceResend @@ -427,92 +1010,194 @@ export namespace Auth { ): PhoneAuthListener; /** + * Creates a new user with an email and password. * - * @param email - * @param password + * This method also signs the user in once the account has been created. + * + * #### Example + * + * ```js + * const userCredential = await firebase.auth().createUserWithEmailAndPassword('joe.bloggs@example.com', '123456'); + * ``` + * + * @param email The users email address. + * @param password The users password. */ createUserWithEmailAndPassword(email: string, password: string): Promise; /** + * Signs a user in with an email and password. * - * @param email - * @param password + * #### Example + * + * ```js + * const userCredential = await firebase.auth().signInWithEmailAndPassword('joe.bloggs@example.com', '123456'); + * ```` + * + * @param email The users email address. + * @param password The users password. */ signInWithEmailAndPassword(email: string, password: string): Promise; /** + * Signs a user in with a custom token. * - * @param customToken + * #### Example + * + * ```js + * // Create a custom token via the Firebase Admin SDK. + * const token = await firebase.auth().createCustomToken(uid, customClaims); + * ... + * // Use the token on the device to sign in. + * const userCredential = await firebase.auth().signInWithCustomToken(token); + * ``` + * + * @param customToken A custom token generated from the Firebase Admin SDK. */ signInWithCustomToken(customToken: string): Promise; /** + * Signs the user in with a generated credential. * - * @param credential + * #### Example + * + * ```js + * // Generate a Firebase credential + * const credential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook'); + * // Sign the user in with the credential + * const userCredential = await firebase.auth().signInWithCredential(credential); + * ``` + * + * @param credential A generated `AuthCredential`, for example from social auth. */ - signInWithCredential(credential: string): Promise; + signInWithCredential(credential: AuthCredential): Promise; /** * Sends a password reset email to the given email address. * Unlike the web SDK, the email will contain a password reset link rather than a code. * - * @param email - * @param actionCodeSettings + * #### Example + * + * ```js + * await firebase.auth().sendPasswordResetEmail('joe.bloggs@example.com'); + * ``` + * + * @param email The users email address. + * @param actionCodeSettings Additional settings to be set before sending the reset email. */ sendPasswordResetEmail(email: string, actionCodeSettings?: ActionCodeSettings): Promise; /** + * Sends a sign in link to the user. * - * @param email - * @param actionCodeSettings + * #### Example + * + * ```js + * await firebase.auth().sendSignInLinkToEmail('joe.bloggs@example.com'); + * ``` + * + * @param email The users email address. + * @param actionCodeSettings Additional settings to be set before sending the sign in email. */ sendSignInLinkToEmail(email: string, actionCodeSettings?: ActionCodeSettings): Promise; /** + * Returns whether the user signed in with a given email link. * - * @param emailLink + * #### Example + * + * ```js + * const signedInWithLink = firebase.auth().isSignInWithEmailLink(link); + * ``` + * + * @param emailLink The email link to check whether the user signed in with it. */ isSignInWithEmailLink(emailLink: string): boolean; /** + * Signs the user in with an email link. * - * @param email - * @param emailLink + * #### Example + * + * ```js + * const userCredential = await firebase.auth().signInWithEmailLink('joe.bloggs@example.com', link); + * ``` + * + * @param email The users email to sign in with. + * @param emailLink An email link. */ signInWithEmailLink(email: string, emailLink: string): Promise; /** - * Completes the password reset process with the confirmation code and new password. + * Completes the password reset process with the confirmation code and new password, via + * {@link auth#sendPasswordResetEmail}. * - * @param code - * @param newPassword + * #### Example + * + * ```js + * await firebase.auth().confirmPasswordReset('ABCD', '1234567'); + * ``` + * + * @param code The code from the password reset email. + * @param newPassword The users new password. */ confirmPasswordReset(code: string, newPassword: string): Promise; /** * Applies a verification code sent to the user by email or other out-of-band mechanism. * - * @param code + * #### Example + * + * ```js + * await firebase.auth().applyActionCode('ABCD'); + * ``` + * + * @param code A verification code sent to the user. */ applyActionCode(code: string): Promise; /** * Checks a verification code sent to the user by email or other out-of-band mechanism. * - * @param code + * #### Example + * + * ```js + * const actionCodeInfo = await firebase.auth().checkActionCode('ABCD'); + * console.log('Action code operation: ', actionCodeInfo.operation); + * ``` + * + * @param code A verification code sent to the user. */ checkActionCode(code: string): Promise; /** * Returns a list of authentication methods that can be used to sign in a given user (identified by its main email address). * - * @param email + * #### Example + * + * ```js + * const methods = await firebase.auth().fetchSignInMethodsForEmail('joe.bloggs@example.com'); + * + * methods.forEach((method) => { + * console.log(method); + * }); + * ``` + * + * @param email The users email address. */ fetchSignInMethodsForEmail(email: string): Promise>; /** + * Checks a password reset code sent to the user by email or other out-of-band mechanism. + * TODO salakar: confirm return behavior (Returns the user's email address if valid.) * - * @param code + * #### Example + * + * ```js + * await firebase.auth().verifyPasswordResetCode('ABCD'); + * ``` + * + * @param code A password reset code. */ verifyPasswordResetCode(code: string): Promise; }